google-api-client 0.32.1 → 0.40.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/.kokoro/continuous/linux.cfg +2 -2
- data/.kokoro/continuous/post.cfg +30 -0
- data/.kokoro/presubmit/linux.cfg +1 -1
- data/.kokoro/release.cfg +94 -0
- data/.repo-metadata.json +5 -0
- data/.rubocop.yml +5 -0
- data/.yardopts +16 -2
- data/CHANGELOG.md +1354 -0
- data/Gemfile +1 -0
- data/OVERVIEW.md +36 -0
- data/README.md +50 -2
- data/Rakefile +71 -2
- data/api_list_config.yaml +1 -0
- data/api_names.yaml +2 -0
- data/bin/generate-api +10 -2
- data/docs/api-keys.md +20 -0
- data/docs/auth.md +53 -0
- data/docs/client-secrets.md +69 -0
- data/docs/getting-started.md +340 -0
- data/docs/installation.md +0 -0
- data/docs/logging.md +34 -0
- data/docs/media-upload.md +25 -0
- data/docs/oauth-installed.md +191 -0
- data/docs/oauth-server.md +135 -0
- data/docs/oauth-web.md +280 -0
- data/docs/oauth.md +268 -0
- data/docs/pagination.md +29 -0
- data/docs/performance.md +25 -0
- data/generated/google/apis/abusiveexperiencereport_v1.rb +1 -4
- data/generated/google/apis/acceleratedmobilepageurl_v1.rb +1 -1
- data/generated/google/apis/accessapproval_v1/classes.rb +417 -0
- data/generated/google/apis/accessapproval_v1/representations.rb +203 -0
- data/generated/google/apis/accessapproval_v1/service.rb +869 -0
- data/generated/google/apis/{servicebroker_v1.rb → accessapproval_v1.rb} +8 -10
- data/generated/google/apis/accessapproval_v1beta1/classes.rb +35 -2
- data/generated/google/apis/accessapproval_v1beta1/representations.rb +13 -0
- data/generated/google/apis/accessapproval_v1beta1/service.rb +108 -6
- data/generated/google/apis/accessapproval_v1beta1.rb +1 -1
- data/generated/google/apis/accesscontextmanager_v1/classes.rb +357 -56
- data/generated/google/apis/accesscontextmanager_v1/representations.rb +137 -6
- data/generated/google/apis/accesscontextmanager_v1/service.rb +143 -5
- data/generated/google/apis/accesscontextmanager_v1.rb +1 -1
- data/generated/google/apis/accesscontextmanager_v1beta/classes.rb +133 -125
- data/generated/google/apis/accesscontextmanager_v1beta/representations.rb +21 -27
- data/generated/google/apis/accesscontextmanager_v1beta/service.rb +6 -5
- data/generated/google/apis/accesscontextmanager_v1beta.rb +1 -1
- data/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb +35 -5
- data/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb +4 -0
- data/generated/google/apis/adexchangebuyer2_v2beta1.rb +1 -1
- data/generated/google/apis/adexchangebuyer_v1_3/classes.rb +24 -2
- data/generated/google/apis/adexchangebuyer_v1_3/representations.rb +1 -0
- data/generated/google/apis/adexchangebuyer_v1_3.rb +1 -1
- data/generated/google/apis/adexchangebuyer_v1_4/classes.rb +25 -3
- data/generated/google/apis/adexchangebuyer_v1_4/representations.rb +1 -0
- data/generated/google/apis/adexchangebuyer_v1_4.rb +1 -1
- data/generated/google/apis/adexperiencereport_v1.rb +1 -4
- data/generated/google/apis/admin_datatransfer_v1/classes.rb +5 -5
- data/generated/google/apis/admin_datatransfer_v1/service.rb +2 -2
- data/generated/google/apis/admin_datatransfer_v1.rb +1 -1
- data/generated/google/apis/admin_directory_v1/classes.rb +4 -150
- data/generated/google/apis/admin_directory_v1/representations.rb +0 -54
- data/generated/google/apis/admin_directory_v1/service.rb +0 -60
- data/generated/google/apis/admin_directory_v1.rb +4 -1
- data/generated/google/apis/admin_reports_v1/classes.rb +87 -44
- data/generated/google/apis/admin_reports_v1/service.rb +310 -64
- data/generated/google/apis/admin_reports_v1.rb +2 -2
- data/generated/google/apis/admob_v1/classes.rb +951 -0
- data/generated/google/apis/admob_v1/representations.rb +378 -0
- data/generated/google/apis/admob_v1/service.rb +196 -0
- data/generated/google/apis/{analytics_v2_4/classes.rb → admob_v1.rb} +11 -6
- data/generated/google/apis/adsense_v1_4.rb +1 -1
- data/generated/google/apis/adsensehost_v4_1/service.rb +5 -1
- data/generated/google/apis/adsensehost_v4_1.rb +1 -1
- data/generated/google/apis/alertcenter_v1beta1/classes.rb +259 -7
- data/generated/google/apis/alertcenter_v1beta1/representations.rb +126 -0
- data/generated/google/apis/alertcenter_v1beta1.rb +1 -1
- data/generated/google/apis/analyticsreporting_v4.rb +1 -1
- data/generated/google/apis/androiddeviceprovisioning_v1/classes.rb +2 -2
- data/generated/google/apis/androiddeviceprovisioning_v1.rb +1 -1
- data/generated/google/apis/androidenterprise_v1/classes.rb +39 -60
- data/generated/google/apis/androidenterprise_v1/representations.rb +1 -0
- data/generated/google/apis/androidenterprise_v1/service.rb +0 -403
- data/generated/google/apis/androidenterprise_v1.rb +1 -1
- data/generated/google/apis/androidmanagement_v1/classes.rb +203 -6
- data/generated/google/apis/androidmanagement_v1/representations.rb +68 -0
- data/generated/google/apis/androidmanagement_v1/service.rb +6 -1
- data/generated/google/apis/androidmanagement_v1.rb +1 -1
- data/generated/google/apis/androidpublisher_v1/classes.rb +0 -41
- data/generated/google/apis/androidpublisher_v1/representations.rb +0 -16
- data/generated/google/apis/androidpublisher_v1/service.rb +1 -81
- data/generated/google/apis/androidpublisher_v1.rb +1 -4
- data/generated/google/apis/androidpublisher_v1_1/classes.rb +0 -41
- data/generated/google/apis/androidpublisher_v1_1/representations.rb +0 -16
- data/generated/google/apis/androidpublisher_v1_1/service.rb +0 -80
- data/generated/google/apis/androidpublisher_v1_1.rb +1 -1
- data/generated/google/apis/androidpublisher_v2/classes.rb +37 -1755
- data/generated/google/apis/androidpublisher_v2/representations.rb +15 -804
- data/generated/google/apis/androidpublisher_v2/service.rb +0 -2359
- data/generated/google/apis/androidpublisher_v2.rb +1 -1
- data/generated/google/apis/androidpublisher_v3/classes.rb +404 -65
- data/generated/google/apis/androidpublisher_v3/representations.rb +180 -27
- data/generated/google/apis/androidpublisher_v3/service.rb +162 -3
- data/generated/google/apis/androidpublisher_v3.rb +1 -1
- data/generated/google/apis/apigee_v1/classes.rb +4928 -0
- data/generated/google/apis/apigee_v1/representations.rb +1822 -0
- data/generated/google/apis/apigee_v1/service.rb +5578 -0
- data/generated/google/apis/apigee_v1.rb +40 -0
- data/generated/google/apis/appengine_v1/classes.rb +7 -0
- data/generated/google/apis/appengine_v1/representations.rb +1 -0
- data/generated/google/apis/appengine_v1/service.rb +10 -6
- data/generated/google/apis/appengine_v1.rb +1 -1
- data/generated/google/apis/appengine_v1alpha.rb +1 -1
- data/generated/google/apis/appengine_v1beta/classes.rb +7 -38
- data/generated/google/apis/appengine_v1beta/representations.rb +1 -17
- data/generated/google/apis/appengine_v1beta/service.rb +10 -6
- data/generated/google/apis/appengine_v1beta.rb +1 -1
- data/generated/google/apis/appsactivity_v1.rb +1 -1
- data/generated/google/apis/appsmarket_v2.rb +1 -1
- data/generated/google/apis/{cloudprivatecatalogproducer_v1beta1 → artifactregistry_v1beta1}/classes.rb +591 -765
- data/generated/google/apis/{servicebroker_v1alpha1 → artifactregistry_v1beta1}/representations.rb +128 -115
- data/generated/google/apis/artifactregistry_v1beta1/service.rb +957 -0
- data/generated/google/apis/artifactregistry_v1beta1.rb +38 -0
- data/generated/google/apis/bigquery_v2/classes.rb +993 -43
- data/generated/google/apis/bigquery_v2/representations.rb +273 -2
- data/generated/google/apis/bigquery_v2/service.rb +137 -4
- data/generated/google/apis/bigquery_v2.rb +1 -1
- data/generated/google/apis/bigqueryconnection_v1beta1/classes.rb +149 -59
- data/generated/google/apis/bigqueryconnection_v1beta1/representations.rb +2 -0
- data/generated/google/apis/bigqueryconnection_v1beta1/service.rb +11 -10
- data/generated/google/apis/bigqueryconnection_v1beta1.rb +1 -1
- data/generated/google/apis/bigquerydatatransfer_v1/classes.rb +49 -0
- data/generated/google/apis/bigquerydatatransfer_v1/representations.rb +19 -0
- data/generated/google/apis/bigquerydatatransfer_v1/service.rb +90 -34
- data/generated/google/apis/bigquerydatatransfer_v1.rb +1 -1
- data/generated/google/apis/bigqueryreservation_v1/classes.rb +392 -16
- data/generated/google/apis/bigqueryreservation_v1/representations.rb +174 -6
- data/generated/google/apis/bigqueryreservation_v1/service.rb +758 -0
- data/generated/google/apis/bigqueryreservation_v1.rb +1 -1
- data/generated/google/apis/bigqueryreservation_v1alpha2/classes.rb +109 -10
- data/generated/google/apis/bigqueryreservation_v1alpha2/representations.rb +26 -3
- data/generated/google/apis/bigqueryreservation_v1alpha2/service.rb +71 -0
- data/generated/google/apis/bigqueryreservation_v1alpha2.rb +1 -1
- data/generated/google/apis/bigqueryreservation_v1beta1/classes.rb +166 -160
- data/generated/google/apis/bigqueryreservation_v1beta1/representations.rb +49 -38
- data/generated/google/apis/bigqueryreservation_v1beta1/service.rb +257 -146
- data/generated/google/apis/bigqueryreservation_v1beta1.rb +1 -1
- data/generated/google/apis/bigtableadmin_v1/classes.rb +21 -18
- data/generated/google/apis/bigtableadmin_v1.rb +1 -1
- data/generated/google/apis/bigtableadmin_v2/classes.rb +189 -82
- data/generated/google/apis/bigtableadmin_v2/service.rb +170 -58
- data/generated/google/apis/bigtableadmin_v2.rb +1 -1
- data/generated/google/apis/billingbudgets_v1beta1/classes.rb +413 -0
- data/generated/google/apis/billingbudgets_v1beta1/representations.rb +197 -0
- data/generated/google/apis/billingbudgets_v1beta1/service.rb +244 -0
- data/generated/google/apis/{servicebroker_v1beta1.rb → billingbudgets_v1beta1.rb} +9 -10
- data/generated/google/apis/binaryauthorization_v1/classes.rb +143 -58
- data/generated/google/apis/binaryauthorization_v1/service.rb +10 -2
- data/generated/google/apis/binaryauthorization_v1.rb +1 -1
- data/generated/google/apis/binaryauthorization_v1beta1/classes.rb +139 -57
- data/generated/google/apis/binaryauthorization_v1beta1/service.rb +10 -2
- data/generated/google/apis/binaryauthorization_v1beta1.rb +1 -1
- data/generated/google/apis/blogger_v2/classes.rb +297 -45
- data/generated/google/apis/blogger_v2/representations.rb +105 -26
- data/generated/google/apis/blogger_v2/service.rb +79 -134
- data/generated/google/apis/blogger_v2.rb +5 -4
- data/generated/google/apis/blogger_v3/classes.rb +60 -53
- data/generated/google/apis/blogger_v3/representations.rb +10 -18
- data/generated/google/apis/blogger_v3/service.rb +183 -463
- data/generated/google/apis/blogger_v3.rb +4 -3
- data/generated/google/apis/books_v1/classes.rb +494 -242
- data/generated/google/apis/books_v1/representations.rb +145 -72
- data/generated/google/apis/books_v1/service.rb +354 -484
- data/generated/google/apis/books_v1.rb +3 -3
- data/generated/google/apis/calendar_v3/classes.rb +8 -21
- data/generated/google/apis/calendar_v3/service.rb +18 -30
- data/generated/google/apis/calendar_v3.rb +1 -1
- data/generated/google/apis/chat_v1/classes.rb +29 -3
- data/generated/google/apis/chat_v1/representations.rb +3 -0
- data/generated/google/apis/chat_v1/service.rb +5 -2
- data/generated/google/apis/chat_v1.rb +1 -1
- data/generated/google/apis/chromeuxreport_v1/classes.rb +297 -0
- data/generated/google/apis/chromeuxreport_v1/representations.rb +147 -0
- data/generated/google/apis/chromeuxreport_v1/service.rb +92 -0
- data/generated/google/apis/{pagespeedonline_v1.rb → chromeuxreport_v1.rb} +9 -9
- data/generated/google/apis/civicinfo_v2/classes.rb +0 -156
- data/generated/google/apis/civicinfo_v2/representations.rb +2 -60
- data/generated/google/apis/civicinfo_v2.rb +1 -1
- data/generated/google/apis/classroom_v1/classes.rb +14 -14
- data/generated/google/apis/classroom_v1/service.rb +11 -11
- data/generated/google/apis/classroom_v1.rb +1 -1
- data/generated/google/apis/cloudasset_v1/classes.rb +917 -195
- data/generated/google/apis/cloudasset_v1/representations.rb +234 -6
- data/generated/google/apis/cloudasset_v1/service.rb +363 -12
- data/generated/google/apis/cloudasset_v1.rb +2 -2
- data/generated/google/apis/cloudasset_v1beta1/classes.rb +139 -57
- data/generated/google/apis/cloudasset_v1beta1/service.rb +13 -4
- data/generated/google/apis/cloudasset_v1beta1.rb +2 -2
- data/generated/google/apis/cloudasset_v1p1beta1/classes.rb +701 -0
- data/generated/google/apis/cloudasset_v1p1beta1/representations.rb +201 -0
- data/generated/google/apis/cloudasset_v1p1beta1/service.rb +189 -0
- data/generated/google/apis/cloudasset_v1p1beta1.rb +34 -0
- data/generated/google/apis/cloudasset_v1p4beta1/classes.rb +924 -0
- data/generated/google/apis/cloudasset_v1p4beta1/representations.rb +377 -0
- data/generated/google/apis/cloudasset_v1p4beta1/service.rb +217 -0
- data/generated/google/apis/cloudasset_v1p4beta1.rb +34 -0
- data/generated/google/apis/cloudbilling_v1/classes.rb +179 -68
- data/generated/google/apis/cloudbilling_v1/representations.rb +0 -1
- data/generated/google/apis/cloudbilling_v1/service.rb +16 -9
- data/generated/google/apis/cloudbilling_v1.rb +1 -1
- data/generated/google/apis/cloudbuild_v1/classes.rb +55 -10
- data/generated/google/apis/cloudbuild_v1/representations.rb +5 -0
- data/generated/google/apis/cloudbuild_v1/service.rb +139 -18
- data/generated/google/apis/cloudbuild_v1.rb +1 -1
- data/generated/google/apis/cloudbuild_v1alpha1/classes.rb +170 -5
- data/generated/google/apis/cloudbuild_v1alpha1/representations.rb +63 -0
- data/generated/google/apis/cloudbuild_v1alpha1/service.rb +121 -5
- data/generated/google/apis/cloudbuild_v1alpha1.rb +1 -1
- data/generated/google/apis/cloudbuild_v1alpha2/classes.rb +1283 -0
- data/generated/google/apis/cloudbuild_v1alpha2/representations.rb +491 -0
- data/generated/google/apis/cloudbuild_v1alpha2/service.rb +353 -0
- data/generated/google/apis/cloudbuild_v1alpha2.rb +34 -0
- data/generated/google/apis/clouddebugger_v2/classes.rb +34 -0
- data/generated/google/apis/clouddebugger_v2/representations.rb +4 -0
- data/generated/google/apis/clouddebugger_v2/service.rb +24 -17
- data/generated/google/apis/clouddebugger_v2.rb +2 -2
- data/generated/google/apis/clouderrorreporting_v1beta1/classes.rb +1 -1
- data/generated/google/apis/clouderrorreporting_v1beta1/service.rb +13 -13
- data/generated/google/apis/clouderrorreporting_v1beta1.rb +2 -2
- data/generated/google/apis/cloudfunctions_v1/classes.rb +161 -59
- data/generated/google/apis/cloudfunctions_v1/representations.rb +3 -0
- data/generated/google/apis/cloudfunctions_v1/service.rb +13 -4
- data/generated/google/apis/cloudfunctions_v1.rb +1 -1
- data/generated/google/apis/cloudfunctions_v1beta2/classes.rb +7 -0
- data/generated/google/apis/cloudfunctions_v1beta2/representations.rb +1 -0
- data/generated/google/apis/cloudfunctions_v1beta2/service.rb +10 -4
- data/generated/google/apis/cloudfunctions_v1beta2.rb +1 -1
- data/generated/google/apis/cloudidentity_v1/classes.rb +11 -8
- data/generated/google/apis/cloudidentity_v1/service.rb +22 -14
- data/generated/google/apis/cloudidentity_v1.rb +1 -1
- data/generated/google/apis/cloudidentity_v1beta1/classes.rb +1009 -69
- data/generated/google/apis/cloudidentity_v1beta1/representations.rb +390 -0
- data/generated/google/apis/cloudidentity_v1beta1/service.rb +189 -78
- data/generated/google/apis/cloudidentity_v1beta1.rb +1 -1
- data/generated/google/apis/cloudiot_v1/classes.rb +142 -57
- data/generated/google/apis/cloudiot_v1.rb +1 -1
- data/generated/google/apis/cloudkms_v1/classes.rb +461 -61
- data/generated/google/apis/cloudkms_v1/representations.rb +33 -0
- data/generated/google/apis/cloudkms_v1/service.rb +15 -3
- data/generated/google/apis/cloudkms_v1.rb +1 -1
- data/generated/google/apis/cloudprofiler_v2.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v1/classes.rb +155 -71
- data/generated/google/apis/cloudresourcemanager_v1/service.rb +6 -3
- data/generated/google/apis/cloudresourcemanager_v1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +143 -59
- data/generated/google/apis/cloudresourcemanager_v1beta1/service.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v1beta1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v2/classes.rb +147 -67
- data/generated/google/apis/cloudresourcemanager_v2/service.rb +11 -13
- data/generated/google/apis/cloudresourcemanager_v2.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v2beta1/classes.rb +147 -67
- data/generated/google/apis/cloudresourcemanager_v2beta1/service.rb +11 -13
- data/generated/google/apis/cloudresourcemanager_v2beta1.rb +1 -1
- data/generated/google/apis/cloudscheduler_v1/classes.rb +3 -2
- data/generated/google/apis/cloudscheduler_v1.rb +1 -1
- data/generated/google/apis/cloudscheduler_v1beta1/classes.rb +3 -2
- data/generated/google/apis/cloudscheduler_v1beta1.rb +1 -1
- data/generated/google/apis/cloudsearch_v1/classes.rb +86 -195
- data/generated/google/apis/cloudsearch_v1/representations.rb +1 -75
- data/generated/google/apis/cloudsearch_v1/service.rb +62 -10
- data/generated/google/apis/cloudsearch_v1.rb +8 -8
- data/generated/google/apis/cloudshell_v1/classes.rb +24 -1
- data/generated/google/apis/cloudshell_v1/representations.rb +3 -0
- data/generated/google/apis/cloudshell_v1.rb +1 -1
- data/generated/google/apis/cloudshell_v1alpha1/classes.rb +30 -1
- data/generated/google/apis/cloudshell_v1alpha1/representations.rb +5 -0
- data/generated/google/apis/cloudshell_v1alpha1.rb +1 -1
- data/generated/google/apis/cloudtasks_v2/classes.rb +388 -70
- data/generated/google/apis/cloudtasks_v2/representations.rb +65 -0
- data/generated/google/apis/cloudtasks_v2.rb +1 -1
- data/generated/google/apis/cloudtasks_v2beta2/classes.rb +148 -66
- data/generated/google/apis/cloudtasks_v2beta2/service.rb +6 -1
- data/generated/google/apis/cloudtasks_v2beta2.rb +1 -1
- data/generated/google/apis/cloudtasks_v2beta3/classes.rb +156 -74
- data/generated/google/apis/cloudtasks_v2beta3.rb +1 -1
- data/generated/google/apis/cloudtrace_v1/service.rb +10 -4
- data/generated/google/apis/cloudtrace_v1.rb +5 -5
- data/generated/google/apis/cloudtrace_v2/classes.rb +8 -7
- data/generated/google/apis/cloudtrace_v2/service.rb +8 -4
- data/generated/google/apis/cloudtrace_v2.rb +5 -5
- data/generated/google/apis/cloudtrace_v2beta1/classes.rb +143 -0
- data/generated/google/apis/{oauth2_v1 → cloudtrace_v2beta1}/representations.rb +36 -27
- data/generated/google/apis/cloudtrace_v2beta1/service.rb +258 -0
- data/generated/google/apis/cloudtrace_v2beta1.rb +44 -0
- data/generated/google/apis/composer_v1/classes.rb +180 -0
- data/generated/google/apis/composer_v1/representations.rb +54 -0
- data/generated/google/apis/composer_v1.rb +1 -1
- data/generated/google/apis/composer_v1beta1/classes.rb +152 -5
- data/generated/google/apis/composer_v1beta1/representations.rb +64 -0
- data/generated/google/apis/composer_v1beta1/service.rb +5 -0
- data/generated/google/apis/composer_v1beta1.rb +1 -1
- data/generated/google/apis/compute_alpha/classes.rb +3252 -973
- data/generated/google/apis/compute_alpha/representations.rb +634 -69
- data/generated/google/apis/compute_alpha/service.rb +9085 -6210
- data/generated/google/apis/compute_alpha.rb +1 -1
- data/generated/google/apis/compute_beta/classes.rb +4787 -1066
- data/generated/google/apis/compute_beta/representations.rb +1394 -31
- data/generated/google/apis/compute_beta/service.rb +8858 -5018
- data/generated/google/apis/compute_beta.rb +1 -1
- data/generated/google/apis/compute_v1/classes.rb +2976 -599
- data/generated/google/apis/compute_v1/representations.rb +850 -0
- data/generated/google/apis/compute_v1/service.rb +4634 -2481
- data/generated/google/apis/compute_v1.rb +1 -1
- data/generated/google/apis/container_v1/classes.rb +925 -164
- data/generated/google/apis/container_v1/representations.rb +278 -0
- data/generated/google/apis/container_v1/service.rb +175 -158
- data/generated/google/apis/container_v1.rb +1 -1
- data/generated/google/apis/container_v1beta1/classes.rb +803 -340
- data/generated/google/apis/container_v1beta1/representations.rb +185 -39
- data/generated/google/apis/container_v1beta1/service.rb +294 -277
- data/generated/google/apis/container_v1beta1.rb +1 -1
- data/generated/google/apis/containeranalysis_v1alpha1/classes.rb +142 -57
- data/generated/google/apis/containeranalysis_v1alpha1.rb +1 -1
- data/generated/google/apis/containeranalysis_v1beta1/classes.rb +478 -59
- data/generated/google/apis/containeranalysis_v1beta1/representations.rb +159 -0
- data/generated/google/apis/containeranalysis_v1beta1/service.rb +26 -20
- data/generated/google/apis/containeranalysis_v1beta1.rb +1 -1
- data/generated/google/apis/content_v2/classes.rb +1566 -634
- data/generated/google/apis/content_v2/representations.rb +78 -115
- data/generated/google/apis/content_v2/service.rb +81 -206
- data/generated/google/apis/content_v2.rb +1 -1
- data/generated/google/apis/content_v2_1/classes.rb +2706 -683
- data/generated/google/apis/content_v2_1/representations.rb +551 -0
- data/generated/google/apis/content_v2_1/service.rb +520 -46
- data/generated/google/apis/content_v2_1.rb +1 -1
- data/generated/google/apis/customsearch_v1/classes.rb +1194 -353
- data/generated/google/apis/customsearch_v1/representations.rb +166 -95
- data/generated/google/apis/customsearch_v1/service.rb +373 -104
- data/generated/google/apis/customsearch_v1.rb +3 -3
- data/generated/google/apis/datacatalog_v1beta1/classes.rb +1907 -0
- data/generated/google/apis/datacatalog_v1beta1/representations.rb +739 -0
- data/generated/google/apis/datacatalog_v1beta1/service.rb +2247 -0
- data/generated/google/apis/{cloudprivatecatalog_v1beta1.rb → datacatalog_v1beta1.rb} +9 -9
- data/generated/google/apis/dataflow_v1b3/classes.rb +786 -11
- data/generated/google/apis/dataflow_v1b3/representations.rb +377 -1
- data/generated/google/apis/dataflow_v1b3/service.rb +626 -0
- data/generated/google/apis/dataflow_v1b3.rb +1 -1
- data/generated/google/apis/datafusion_v1beta1/classes.rb +245 -362
- data/generated/google/apis/datafusion_v1beta1/representations.rb +29 -112
- data/generated/google/apis/datafusion_v1beta1/service.rb +15 -2
- data/generated/google/apis/datafusion_v1beta1.rb +1 -1
- data/generated/google/apis/dataproc_v1/classes.rb +533 -177
- data/generated/google/apis/dataproc_v1/representations.rb +85 -0
- data/generated/google/apis/dataproc_v1/service.rb +102 -36
- data/generated/google/apis/dataproc_v1.rb +1 -1
- data/generated/google/apis/dataproc_v1beta2/classes.rb +477 -182
- data/generated/google/apis/dataproc_v1beta2/representations.rb +81 -0
- data/generated/google/apis/dataproc_v1beta2/service.rb +199 -43
- data/generated/google/apis/dataproc_v1beta2.rb +1 -1
- data/generated/google/apis/datastore_v1/classes.rb +17 -23
- data/generated/google/apis/datastore_v1/service.rb +93 -9
- data/generated/google/apis/datastore_v1.rb +1 -1
- data/generated/google/apis/datastore_v1beta1.rb +1 -1
- data/generated/google/apis/datastore_v1beta3/classes.rb +6 -5
- data/generated/google/apis/datastore_v1beta3/service.rb +7 -7
- data/generated/google/apis/datastore_v1beta3.rb +1 -1
- data/generated/google/apis/deploymentmanager_alpha/classes.rb +362 -176
- data/generated/google/apis/deploymentmanager_alpha/representations.rb +22 -4
- data/generated/google/apis/deploymentmanager_alpha/service.rb +198 -311
- data/generated/google/apis/deploymentmanager_alpha.rb +1 -1
- data/generated/google/apis/deploymentmanager_v2/classes.rb +295 -146
- data/generated/google/apis/deploymentmanager_v2/representations.rb +17 -1
- data/generated/google/apis/deploymentmanager_v2/service.rb +101 -99
- data/generated/google/apis/deploymentmanager_v2.rb +1 -1
- data/generated/google/apis/deploymentmanager_v2beta/classes.rb +350 -170
- data/generated/google/apis/deploymentmanager_v2beta/representations.rb +18 -1
- data/generated/google/apis/deploymentmanager_v2beta/service.rb +154 -152
- data/generated/google/apis/deploymentmanager_v2beta.rb +1 -1
- data/generated/google/apis/dfareporting_v3_3/classes.rb +39 -13
- data/generated/google/apis/dfareporting_v3_3/service.rb +9 -8
- data/generated/google/apis/dfareporting_v3_3.rb +1 -1
- data/generated/google/apis/{dfareporting_v3_2 → dfareporting_v3_4}/classes.rb +1361 -813
- data/generated/google/apis/{dfareporting_v3_2 → dfareporting_v3_4}/representations.rb +639 -396
- data/generated/google/apis/{dfareporting_v3_2 → dfareporting_v3_4}/service.rb +969 -1076
- data/generated/google/apis/{dfareporting_v3_2.rb → dfareporting_v3_4.rb} +6 -6
- data/generated/google/apis/dialogflow_v2/classes.rb +1778 -219
- data/generated/google/apis/dialogflow_v2/representations.rb +603 -0
- data/generated/google/apis/dialogflow_v2/service.rb +849 -158
- data/generated/google/apis/dialogflow_v2.rb +1 -1
- data/generated/google/apis/dialogflow_v2beta1/classes.rb +1776 -242
- data/generated/google/apis/dialogflow_v2beta1/representations.rb +592 -0
- data/generated/google/apis/dialogflow_v2beta1/service.rb +436 -172
- data/generated/google/apis/dialogflow_v2beta1.rb +1 -1
- data/generated/google/apis/dialogflow_v3alpha1/classes.rb +5579 -0
- data/generated/google/apis/dialogflow_v3alpha1/representations.rb +2295 -0
- data/generated/google/apis/dialogflow_v3alpha1/service.rb +296 -0
- data/generated/google/apis/dialogflow_v3alpha1.rb +38 -0
- data/generated/google/apis/digitalassetlinks_v1.rb +1 -1
- data/generated/google/apis/displayvideo_v1/classes.rb +7527 -0
- data/generated/google/apis/displayvideo_v1/representations.rb +3034 -0
- data/generated/google/apis/displayvideo_v1/service.rb +3126 -0
- data/generated/google/apis/displayvideo_v1.rb +38 -0
- data/generated/google/apis/dlp_v2/classes.rb +798 -130
- data/generated/google/apis/dlp_v2/representations.rb +277 -3
- data/generated/google/apis/dlp_v2/service.rb +2074 -231
- data/generated/google/apis/dlp_v2.rb +1 -1
- data/generated/google/apis/dns_v1/classes.rb +220 -251
- data/generated/google/apis/dns_v1/representations.rb +49 -0
- data/generated/google/apis/dns_v1/service.rb +21 -141
- data/generated/google/apis/dns_v1.rb +1 -1
- data/generated/google/apis/dns_v1beta2/classes.rb +224 -261
- data/generated/google/apis/dns_v1beta2/representations.rb +49 -0
- data/generated/google/apis/dns_v1beta2/service.rb +21 -141
- data/generated/google/apis/dns_v1beta2.rb +1 -1
- data/generated/google/apis/dns_v2beta1/classes.rb +220 -251
- data/generated/google/apis/dns_v2beta1/representations.rb +49 -0
- data/generated/google/apis/dns_v2beta1/service.rb +21 -141
- data/generated/google/apis/dns_v2beta1.rb +1 -1
- data/generated/google/apis/docs_v1/classes.rb +608 -2
- data/generated/google/apis/docs_v1/representations.rb +211 -0
- data/generated/google/apis/docs_v1.rb +1 -1
- data/generated/google/apis/domainsrdap_v1.rb +1 -1
- data/generated/google/apis/doubleclickbidmanager_v1/classes.rb +1 -1
- data/generated/google/apis/doubleclickbidmanager_v1.rb +1 -1
- data/generated/google/apis/doubleclickbidmanager_v1_1/classes.rb +860 -0
- data/generated/google/apis/doubleclickbidmanager_v1_1/representations.rb +388 -0
- data/generated/google/apis/{surveys_v2 → doubleclickbidmanager_v1_1}/service.rb +140 -110
- data/generated/google/apis/{proximitybeacon_v1beta1.rb → doubleclickbidmanager_v1_1.rb} +11 -11
- data/generated/google/apis/doubleclicksearch_v2/service.rb +0 -55
- data/generated/google/apis/doubleclicksearch_v2.rb +1 -1
- data/generated/google/apis/drive_v2/classes.rb +58 -5
- data/generated/google/apis/drive_v2/representations.rb +18 -0
- data/generated/google/apis/drive_v2/service.rb +92 -118
- data/generated/google/apis/drive_v2.rb +1 -1
- data/generated/google/apis/drive_v3/classes.rb +66 -5
- data/generated/google/apis/drive_v3/representations.rb +18 -0
- data/generated/google/apis/drive_v3/service.rb +46 -14
- data/generated/google/apis/drive_v3.rb +1 -1
- data/generated/google/apis/driveactivity_v2/classes.rb +15 -5
- data/generated/google/apis/driveactivity_v2/representations.rb +2 -0
- data/generated/google/apis/driveactivity_v2.rb +1 -1
- data/generated/google/apis/factchecktools_v1alpha1.rb +1 -1
- data/generated/google/apis/fcm_v1/classes.rb +15 -0
- data/generated/google/apis/fcm_v1/representations.rb +2 -0
- data/generated/google/apis/fcm_v1.rb +1 -1
- data/generated/google/apis/file_v1/classes.rb +1235 -158
- data/generated/google/apis/file_v1/representations.rb +401 -22
- data/generated/google/apis/file_v1/service.rb +14 -10
- data/generated/google/apis/file_v1.rb +1 -1
- data/generated/google/apis/file_v1beta1/classes.rb +1236 -159
- data/generated/google/apis/file_v1beta1/representations.rb +401 -22
- data/generated/google/apis/file_v1beta1/service.rb +18 -11
- data/generated/google/apis/file_v1beta1.rb +1 -1
- data/generated/google/apis/firebase_v1beta1/classes.rb +20 -16
- data/generated/google/apis/firebase_v1beta1/representations.rb +2 -0
- data/generated/google/apis/firebase_v1beta1/service.rb +22 -16
- data/generated/google/apis/firebase_v1beta1.rb +1 -1
- data/generated/google/apis/firebasedynamiclinks_v1.rb +1 -1
- data/generated/google/apis/firebasehosting_v1beta1/classes.rb +174 -1
- data/generated/google/apis/firebasehosting_v1beta1/representations.rb +65 -0
- data/generated/google/apis/firebasehosting_v1beta1/service.rb +805 -2
- data/generated/google/apis/firebasehosting_v1beta1.rb +1 -1
- data/generated/google/apis/firebaseml_v1/classes.rb +213 -0
- data/generated/google/apis/{servicebroker_v1 → firebaseml_v1}/representations.rb +26 -28
- data/generated/google/apis/firebaseml_v1/service.rb +181 -0
- data/generated/google/apis/firebaseml_v1.rb +34 -0
- data/generated/google/apis/firebaseml_v1beta2/classes.rb +344 -0
- data/generated/google/apis/{cloudprivatecatalog_v1beta1 → firebaseml_v1beta2}/representations.rb +62 -31
- data/generated/google/apis/firebaseml_v1beta2/service.rb +267 -0
- data/generated/google/apis/firebaseml_v1beta2.rb +34 -0
- data/generated/google/apis/firebaserules_v1/classes.rb +113 -0
- data/generated/google/apis/firebaserules_v1/representations.rb +52 -0
- data/generated/google/apis/firebaserules_v1.rb +1 -1
- data/generated/google/apis/firestore_v1/classes.rb +16 -5
- data/generated/google/apis/firestore_v1/representations.rb +2 -0
- data/generated/google/apis/firestore_v1/service.rb +26 -24
- data/generated/google/apis/firestore_v1.rb +1 -1
- data/generated/google/apis/firestore_v1beta1/classes.rb +16 -5
- data/generated/google/apis/firestore_v1beta1/representations.rb +2 -0
- data/generated/google/apis/firestore_v1beta1/service.rb +18 -16
- data/generated/google/apis/firestore_v1beta1.rb +1 -1
- data/generated/google/apis/firestore_v1beta2.rb +1 -1
- data/generated/google/apis/fitness_v1/classes.rb +189 -153
- data/generated/google/apis/fitness_v1/service.rb +192 -198
- data/generated/google/apis/fitness_v1.rb +14 -14
- data/generated/google/apis/games_configuration_v1configuration/classes.rb +38 -53
- data/generated/google/apis/games_configuration_v1configuration/service.rb +58 -169
- data/generated/google/apis/games_configuration_v1configuration.rb +4 -3
- data/generated/google/apis/games_management_v1management/classes.rb +50 -109
- data/generated/google/apis/games_management_v1management/representations.rb +0 -30
- data/generated/google/apis/games_management_v1management/service.rb +116 -452
- data/generated/google/apis/games_management_v1management.rb +6 -4
- data/generated/google/apis/games_v1/classes.rb +14 -293
- data/generated/google/apis/games_v1/representations.rb +2 -98
- data/generated/google/apis/games_v1/service.rb +3 -135
- data/generated/google/apis/games_v1.rb +1 -1
- data/generated/google/apis/gameservices_v1beta/classes.rb +2354 -0
- data/generated/google/apis/gameservices_v1beta/representations.rb +971 -0
- data/generated/google/apis/gameservices_v1beta/service.rb +1472 -0
- data/generated/google/apis/gameservices_v1beta.rb +34 -0
- data/generated/google/apis/genomics_v1.rb +1 -1
- data/generated/google/apis/genomics_v1alpha2.rb +1 -1
- data/generated/google/apis/genomics_v2alpha1/classes.rb +32 -0
- data/generated/google/apis/genomics_v2alpha1/representations.rb +16 -0
- data/generated/google/apis/genomics_v2alpha1/service.rb +34 -0
- data/generated/google/apis/genomics_v2alpha1.rb +1 -1
- data/generated/google/apis/gmail_v1/classes.rb +6 -2
- data/generated/google/apis/gmail_v1/service.rb +1 -1
- data/generated/google/apis/gmail_v1.rb +13 -1
- data/generated/google/apis/healthcare_v1/classes.rb +2659 -0
- data/generated/google/apis/healthcare_v1/representations.rb +1114 -0
- data/generated/google/apis/healthcare_v1/service.rb +3439 -0
- data/generated/google/apis/healthcare_v1.rb +34 -0
- data/generated/google/apis/healthcare_v1beta1/classes.rb +1013 -128
- data/generated/google/apis/healthcare_v1beta1/representations.rb +341 -1
- data/generated/google/apis/healthcare_v1beta1/service.rb +762 -275
- data/generated/google/apis/healthcare_v1beta1.rb +1 -1
- data/generated/google/apis/homegraph_v1/classes.rb +79 -56
- data/generated/google/apis/homegraph_v1/representations.rb +2 -1
- data/generated/google/apis/homegraph_v1/service.rb +43 -47
- data/generated/google/apis/homegraph_v1.rb +1 -1
- data/generated/google/apis/iam_v1/classes.rb +201 -169
- data/generated/google/apis/iam_v1/representations.rb +1 -6
- data/generated/google/apis/iam_v1/service.rb +18 -21
- data/generated/google/apis/iam_v1.rb +1 -1
- data/generated/google/apis/iamcredentials_v1/classes.rb +40 -8
- data/generated/google/apis/iamcredentials_v1/service.rb +4 -4
- data/generated/google/apis/iamcredentials_v1.rb +1 -1
- data/generated/google/apis/iap_v1/classes.rb +691 -59
- data/generated/google/apis/iap_v1/representations.rb +254 -0
- data/generated/google/apis/iap_v1/service.rb +362 -0
- data/generated/google/apis/iap_v1.rb +1 -1
- data/generated/google/apis/iap_v1beta1/classes.rb +144 -59
- data/generated/google/apis/iap_v1beta1.rb +1 -1
- data/generated/google/apis/indexing_v3.rb +1 -1
- data/generated/google/apis/jobs_v2/classes.rb +167 -0
- data/generated/google/apis/jobs_v2/representations.rb +40 -0
- data/generated/google/apis/jobs_v2.rb +1 -1
- data/generated/google/apis/jobs_v3/classes.rb +180 -0
- data/generated/google/apis/jobs_v3/representations.rb +41 -0
- data/generated/google/apis/jobs_v3.rb +1 -1
- data/generated/google/apis/jobs_v3p1beta1/classes.rb +187 -2
- data/generated/google/apis/jobs_v3p1beta1/representations.rb +41 -0
- data/generated/google/apis/jobs_v3p1beta1.rb +1 -1
- data/generated/google/apis/kgsearch_v1.rb +1 -1
- data/generated/google/apis/language_v1/classes.rb +6 -6
- data/generated/google/apis/language_v1.rb +1 -1
- data/generated/google/apis/language_v1beta1/classes.rb +5 -5
- data/generated/google/apis/language_v1beta1.rb +1 -1
- data/generated/google/apis/language_v1beta2/classes.rb +23 -7
- data/generated/google/apis/language_v1beta2/representations.rb +2 -0
- data/generated/google/apis/language_v1beta2.rb +1 -1
- data/generated/google/apis/libraryagent_v1.rb +1 -1
- data/generated/google/apis/licensing_v1/classes.rb +15 -7
- data/generated/google/apis/licensing_v1/service.rb +81 -37
- data/generated/google/apis/licensing_v1.rb +4 -4
- data/generated/google/apis/lifesciences_v2beta/classes.rb +1329 -0
- data/generated/google/apis/lifesciences_v2beta/representations.rb +533 -0
- data/generated/google/apis/lifesciences_v2beta/service.rb +303 -0
- data/generated/google/apis/lifesciences_v2beta.rb +35 -0
- data/generated/google/apis/logging_v2/classes.rb +292 -91
- data/generated/google/apis/logging_v2/representations.rb +51 -0
- data/generated/google/apis/logging_v2/service.rb +888 -15
- data/generated/google/apis/logging_v2.rb +6 -6
- data/generated/google/apis/managedidentities_v1/classes.rb +1571 -0
- data/generated/google/apis/managedidentities_v1/representations.rb +560 -0
- data/generated/google/apis/managedidentities_v1/service.rb +779 -0
- data/generated/google/apis/managedidentities_v1.rb +35 -0
- data/generated/google/apis/managedidentities_v1alpha1/classes.rb +1570 -0
- data/generated/google/apis/managedidentities_v1alpha1/representations.rb +560 -0
- data/generated/google/apis/managedidentities_v1alpha1/service.rb +782 -0
- data/generated/google/apis/{servicebroker_v1alpha1.rb → managedidentities_v1alpha1.rb} +9 -10
- data/generated/google/apis/managedidentities_v1beta1/classes.rb +1568 -0
- data/generated/google/apis/managedidentities_v1beta1/representations.rb +560 -0
- data/generated/google/apis/managedidentities_v1beta1/service.rb +778 -0
- data/generated/google/apis/managedidentities_v1beta1.rb +35 -0
- data/generated/google/apis/manufacturers_v1/classes.rb +7 -0
- data/generated/google/apis/manufacturers_v1/representations.rb +1 -0
- data/generated/google/apis/manufacturers_v1.rb +1 -1
- data/generated/google/apis/memcache_v1beta2/classes.rb +1587 -0
- data/generated/google/apis/memcache_v1beta2/representations.rb +557 -0
- data/generated/google/apis/memcache_v1beta2/service.rb +677 -0
- data/generated/google/apis/memcache_v1beta2.rb +35 -0
- data/generated/google/apis/ml_v1/classes.rb +1518 -233
- data/generated/google/apis/ml_v1/representations.rb +559 -0
- data/generated/google/apis/ml_v1/service.rb +560 -25
- data/generated/google/apis/ml_v1.rb +5 -2
- data/generated/google/apis/monitoring_v1/classes.rb +1231 -0
- data/generated/google/apis/monitoring_v1/representations.rb +513 -0
- data/generated/google/apis/monitoring_v1/service.rb +246 -0
- data/generated/google/apis/monitoring_v1.rb +47 -0
- data/generated/google/apis/monitoring_v3/classes.rb +1330 -172
- data/generated/google/apis/monitoring_v3/representations.rb +482 -1
- data/generated/google/apis/monitoring_v3/service.rb +614 -162
- data/generated/google/apis/monitoring_v3.rb +7 -8
- data/generated/google/apis/networkmanagement_v1/classes.rb +1868 -0
- data/generated/google/apis/networkmanagement_v1/representations.rb +661 -0
- data/generated/google/apis/networkmanagement_v1/service.rb +667 -0
- data/generated/google/apis/networkmanagement_v1.rb +35 -0
- data/generated/google/apis/networkmanagement_v1beta1/classes.rb +1868 -0
- data/generated/google/apis/networkmanagement_v1beta1/representations.rb +661 -0
- data/generated/google/apis/networkmanagement_v1beta1/service.rb +667 -0
- data/generated/google/apis/{cloudprivatecatalogproducer_v1beta1.rb → networkmanagement_v1beta1.rb} +9 -9
- data/generated/google/apis/oauth2_v2/classes.rb +1 -81
- data/generated/google/apis/oauth2_v2/representations.rb +2 -36
- data/generated/google/apis/oauth2_v2/service.rb +10 -42
- data/generated/google/apis/oauth2_v2.rb +5 -5
- data/generated/google/apis/osconfig_v1/classes.rb +1225 -0
- data/generated/google/apis/osconfig_v1/representations.rb +506 -0
- data/generated/google/apis/osconfig_v1/service.rb +386 -0
- data/generated/google/apis/osconfig_v1.rb +35 -0
- data/generated/google/apis/osconfig_v1beta/classes.rb +2362 -0
- data/generated/google/apis/osconfig_v1beta/representations.rb +966 -0
- data/generated/google/apis/osconfig_v1beta/service.rb +605 -0
- data/generated/google/apis/osconfig_v1beta.rb +35 -0
- data/generated/google/apis/oslogin_v1/classes.rb +1 -1
- data/generated/google/apis/oslogin_v1/service.rb +10 -7
- data/generated/google/apis/oslogin_v1.rb +1 -2
- data/generated/google/apis/oslogin_v1alpha/service.rb +0 -1
- data/generated/google/apis/oslogin_v1alpha.rb +1 -2
- data/generated/google/apis/oslogin_v1beta/classes.rb +1 -1
- data/generated/google/apis/oslogin_v1beta/service.rb +9 -6
- data/generated/google/apis/oslogin_v1beta.rb +1 -2
- data/generated/google/apis/pagespeedonline_v5/classes.rb +534 -495
- data/generated/google/apis/pagespeedonline_v5/representations.rb +226 -221
- data/generated/google/apis/pagespeedonline_v5/service.rb +22 -24
- data/generated/google/apis/pagespeedonline_v5.rb +9 -4
- data/generated/google/apis/people_v1/classes.rb +104 -81
- data/generated/google/apis/people_v1/representations.rb +1 -0
- data/generated/google/apis/people_v1/service.rb +72 -79
- data/generated/google/apis/people_v1.rb +10 -1
- data/generated/google/apis/policytroubleshooter_v1/classes.rb +765 -0
- data/generated/google/apis/policytroubleshooter_v1/representations.rb +203 -0
- data/generated/google/apis/policytroubleshooter_v1/service.rb +90 -0
- data/generated/google/apis/policytroubleshooter_v1.rb +34 -0
- data/generated/google/apis/policytroubleshooter_v1beta/classes.rb +254 -111
- data/generated/google/apis/policytroubleshooter_v1beta/service.rb +2 -3
- data/generated/google/apis/policytroubleshooter_v1beta.rb +1 -1
- data/generated/google/apis/poly_v1.rb +1 -1
- data/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb +1137 -0
- data/generated/google/apis/prod_tt_sasportal_v1alpha1/representations.rb +532 -0
- data/generated/google/apis/prod_tt_sasportal_v1alpha1/service.rb +1676 -0
- data/generated/google/apis/{pagespeedonline_v4.rb → prod_tt_sasportal_v1alpha1.rb} +12 -10
- data/generated/google/apis/pubsub_v1/classes.rb +248 -76
- data/generated/google/apis/pubsub_v1/representations.rb +18 -0
- data/generated/google/apis/pubsub_v1/service.rb +43 -31
- data/generated/google/apis/pubsub_v1.rb +1 -1
- data/generated/google/apis/pubsub_v1beta1a.rb +1 -1
- data/generated/google/apis/pubsub_v1beta2/classes.rb +144 -59
- data/generated/google/apis/pubsub_v1beta2/service.rb +10 -2
- data/generated/google/apis/pubsub_v1beta2.rb +1 -1
- data/generated/google/apis/recommender_v1beta1/classes.rb +221 -7
- data/generated/google/apis/recommender_v1beta1/representations.rb +96 -0
- data/generated/google/apis/recommender_v1beta1/service.rb +146 -19
- data/generated/google/apis/recommender_v1beta1.rb +1 -1
- data/generated/google/apis/redis_v1/classes.rb +48 -18
- data/generated/google/apis/redis_v1/representations.rb +14 -0
- data/generated/google/apis/redis_v1/service.rb +41 -5
- data/generated/google/apis/redis_v1.rb +1 -1
- data/generated/google/apis/redis_v1beta1/classes.rb +48 -18
- data/generated/google/apis/redis_v1beta1/representations.rb +14 -0
- data/generated/google/apis/redis_v1beta1/service.rb +41 -5
- data/generated/google/apis/redis_v1beta1.rb +1 -1
- data/generated/google/apis/remotebuildexecution_v1/classes.rb +352 -37
- data/generated/google/apis/remotebuildexecution_v1/representations.rb +99 -0
- data/generated/google/apis/remotebuildexecution_v1.rb +1 -1
- data/generated/google/apis/remotebuildexecution_v1alpha/classes.rb +352 -37
- data/generated/google/apis/remotebuildexecution_v1alpha/representations.rb +99 -0
- data/generated/google/apis/remotebuildexecution_v1alpha.rb +1 -1
- data/generated/google/apis/remotebuildexecution_v2/classes.rb +362 -45
- data/generated/google/apis/remotebuildexecution_v2/representations.rb +100 -0
- data/generated/google/apis/remotebuildexecution_v2/service.rb +5 -1
- data/generated/google/apis/remotebuildexecution_v2.rb +1 -1
- data/generated/google/apis/reseller_v1/service.rb +1 -1
- data/generated/google/apis/reseller_v1.rb +1 -1
- data/generated/google/apis/run_v1/classes.rb +308 -325
- data/generated/google/apis/run_v1/representations.rb +63 -103
- data/generated/google/apis/run_v1/service.rb +336 -933
- data/generated/google/apis/run_v1.rb +1 -1
- data/generated/google/apis/run_v1alpha1/classes.rb +1045 -392
- data/generated/google/apis/run_v1alpha1/representations.rb +343 -144
- data/generated/google/apis/run_v1alpha1/service.rb +1735 -492
- data/generated/google/apis/run_v1alpha1.rb +1 -1
- data/generated/google/apis/run_v1beta1/classes.rb +1 -1
- data/generated/google/apis/run_v1beta1.rb +4 -1
- data/generated/google/apis/runtimeconfig_v1.rb +1 -1
- data/generated/google/apis/runtimeconfig_v1beta1/classes.rb +139 -57
- data/generated/google/apis/runtimeconfig_v1beta1/service.rb +8 -5
- data/generated/google/apis/runtimeconfig_v1beta1.rb +1 -1
- data/generated/google/apis/safebrowsing_v4/classes.rb +2 -2
- data/generated/google/apis/safebrowsing_v4.rb +1 -1
- data/generated/google/apis/sasportal_v1alpha1/classes.rb +1137 -0
- data/generated/google/apis/sasportal_v1alpha1/representations.rb +532 -0
- data/generated/google/apis/sasportal_v1alpha1/service.rb +1676 -0
- data/generated/google/apis/{pagespeedonline_v2.rb → sasportal_v1alpha1.rb} +12 -10
- data/generated/google/apis/script_v1/classes.rb +4 -22
- data/generated/google/apis/script_v1.rb +1 -1
- data/generated/google/apis/searchconsole_v1.rb +1 -1
- data/generated/google/apis/secretmanager_v1/classes.rb +982 -0
- data/generated/google/apis/{cloudprivatecatalogproducer_v1beta1 → secretmanager_v1}/representations.rb +105 -116
- data/generated/google/apis/secretmanager_v1/service.rb +681 -0
- data/generated/google/apis/secretmanager_v1.rb +35 -0
- data/generated/google/apis/secretmanager_v1beta1/classes.rb +982 -0
- data/generated/google/apis/{servicebroker_v1beta1 → secretmanager_v1beta1}/representations.rb +114 -142
- data/generated/google/apis/secretmanager_v1beta1/service.rb +681 -0
- data/generated/google/apis/secretmanager_v1beta1.rb +35 -0
- data/generated/google/apis/securitycenter_v1/classes.rb +862 -138
- data/generated/google/apis/securitycenter_v1/representations.rb +221 -0
- data/generated/google/apis/securitycenter_v1/service.rb +225 -21
- data/generated/google/apis/securitycenter_v1.rb +4 -4
- data/generated/google/apis/securitycenter_v1beta1/classes.rb +782 -125
- data/generated/google/apis/securitycenter_v1beta1/representations.rb +192 -2
- data/generated/google/apis/securitycenter_v1beta1/service.rb +53 -51
- data/generated/google/apis/securitycenter_v1beta1.rb +4 -4
- data/generated/google/apis/securitycenter_v1p1alpha1/classes.rb +568 -0
- data/generated/google/apis/securitycenter_v1p1alpha1/representations.rb +190 -0
- data/generated/google/apis/securitycenter_v1p1alpha1/service.rb +3 -3
- data/generated/google/apis/securitycenter_v1p1alpha1.rb +4 -4
- data/generated/google/apis/securitycenter_v1p1beta1/classes.rb +2205 -0
- data/generated/google/apis/securitycenter_v1p1beta1/representations.rb +751 -0
- data/generated/google/apis/securitycenter_v1p1beta1/service.rb +1329 -0
- data/generated/google/apis/securitycenter_v1p1beta1.rb +35 -0
- data/generated/google/apis/serviceconsumermanagement_v1/classes.rb +419 -64
- data/generated/google/apis/serviceconsumermanagement_v1/representations.rb +98 -0
- data/generated/google/apis/serviceconsumermanagement_v1.rb +1 -1
- data/generated/google/apis/serviceconsumermanagement_v1beta1/classes.rb +4159 -0
- data/generated/google/apis/serviceconsumermanagement_v1beta1/representations.rb +1307 -0
- data/generated/google/apis/serviceconsumermanagement_v1beta1/service.rb +428 -0
- data/generated/google/apis/serviceconsumermanagement_v1beta1.rb +34 -0
- data/generated/google/apis/servicecontrol_v1/classes.rb +255 -20
- data/generated/google/apis/servicecontrol_v1/representations.rb +87 -1
- data/generated/google/apis/servicecontrol_v1/service.rb +2 -1
- data/generated/google/apis/servicecontrol_v1.rb +1 -1
- data/generated/google/apis/servicedirectory_v1beta1/classes.rb +816 -0
- data/generated/google/apis/{surveys_v2 → servicedirectory_v1beta1}/representations.rb +103 -104
- data/generated/google/apis/servicedirectory_v1beta1/service.rb +992 -0
- data/generated/google/apis/servicedirectory_v1beta1.rb +35 -0
- data/generated/google/apis/servicemanagement_v1/classes.rb +459 -125
- data/generated/google/apis/servicemanagement_v1/representations.rb +61 -0
- data/generated/google/apis/servicemanagement_v1/service.rb +40 -29
- data/generated/google/apis/servicemanagement_v1.rb +1 -1
- data/generated/google/apis/servicenetworking_v1/classes.rb +986 -68
- data/generated/google/apis/servicenetworking_v1/representations.rb +403 -0
- data/generated/google/apis/servicenetworking_v1/service.rb +351 -23
- data/generated/google/apis/servicenetworking_v1.rb +1 -1
- data/generated/google/apis/servicenetworking_v1beta/classes.rb +575 -57
- data/generated/google/apis/servicenetworking_v1beta/representations.rb +223 -0
- data/generated/google/apis/servicenetworking_v1beta.rb +1 -1
- data/generated/google/apis/serviceusage_v1/classes.rb +417 -64
- data/generated/google/apis/serviceusage_v1/representations.rb +110 -0
- data/generated/google/apis/serviceusage_v1/service.rb +42 -0
- data/generated/google/apis/serviceusage_v1.rb +1 -1
- data/generated/google/apis/serviceusage_v1beta1/classes.rb +644 -64
- data/generated/google/apis/serviceusage_v1beta1/representations.rb +198 -0
- data/generated/google/apis/serviceusage_v1beta1/service.rb +472 -0
- data/generated/google/apis/serviceusage_v1beta1.rb +1 -1
- data/generated/google/apis/sheets_v4/classes.rb +1741 -253
- data/generated/google/apis/sheets_v4/representations.rb +283 -0
- data/generated/google/apis/sheets_v4/service.rb +9 -11
- data/generated/google/apis/sheets_v4.rb +1 -1
- data/generated/google/apis/slides_v1/classes.rb +1 -1
- data/generated/google/apis/slides_v1/service.rb +1 -1
- data/generated/google/apis/slides_v1.rb +1 -1
- data/generated/google/apis/sourcerepo_v1/classes.rb +173 -67
- data/generated/google/apis/sourcerepo_v1/service.rb +9 -1
- data/generated/google/apis/sourcerepo_v1.rb +1 -1
- data/generated/google/apis/spanner_v1/classes.rb +706 -71
- data/generated/google/apis/spanner_v1/representations.rb +194 -0
- data/generated/google/apis/spanner_v1/service.rb +770 -7
- data/generated/google/apis/spanner_v1.rb +1 -1
- data/generated/google/apis/speech_v1/classes.rb +15 -11
- data/generated/google/apis/speech_v1/representations.rb +2 -1
- data/generated/google/apis/speech_v1.rb +1 -1
- data/generated/google/apis/speech_v1p1beta1/classes.rb +197 -11
- data/generated/google/apis/speech_v1p1beta1/representations.rb +79 -1
- data/generated/google/apis/speech_v1p1beta1.rb +1 -1
- data/generated/google/apis/{speech_v2beta → speech_v2beta1}/classes.rb +16 -8
- data/generated/google/apis/{speech_v2beta → speech_v2beta1}/representations.rb +7 -6
- data/generated/google/apis/{speech_v2beta → speech_v2beta1}/service.rb +13 -13
- data/generated/google/apis/{speech_v2beta.rb → speech_v2beta1.rb} +6 -6
- data/generated/google/apis/{sqladmin_v1beta4 → sql_v1beta4}/classes.rb +701 -383
- data/generated/google/apis/{sqladmin_v1beta4 → sql_v1beta4}/representations.rb +209 -104
- data/generated/google/apis/{sqladmin_v1beta4 → sql_v1beta4}/service.rb +579 -597
- data/generated/google/apis/{sqladmin_v1beta4.rb → sql_v1beta4.rb} +7 -8
- data/generated/google/apis/storage_v1/classes.rb +73 -7
- data/generated/google/apis/storage_v1/representations.rb +10 -0
- data/generated/google/apis/storage_v1/service.rb +29 -4
- data/generated/google/apis/storage_v1.rb +1 -1
- data/generated/google/apis/storage_v1beta2/service.rb +1 -1
- data/generated/google/apis/storage_v1beta2.rb +1 -1
- data/generated/google/apis/storagetransfer_v1/classes.rb +280 -79
- data/generated/google/apis/storagetransfer_v1/representations.rb +52 -0
- data/generated/google/apis/storagetransfer_v1/service.rb +19 -41
- data/generated/google/apis/storagetransfer_v1.rb +1 -1
- data/generated/google/apis/streetviewpublish_v1/classes.rb +1 -1
- data/generated/google/apis/streetviewpublish_v1/service.rb +1 -1
- data/generated/google/apis/streetviewpublish_v1.rb +1 -1
- data/generated/google/apis/tagmanager_v1/classes.rb +2 -0
- data/generated/google/apis/tagmanager_v1/service.rb +1 -1
- data/generated/google/apis/tagmanager_v1.rb +1 -1
- data/generated/google/apis/tagmanager_v2/classes.rb +170 -0
- data/generated/google/apis/tagmanager_v2/representations.rb +49 -0
- data/generated/google/apis/tagmanager_v2/service.rb +1 -1
- data/generated/google/apis/tagmanager_v2.rb +1 -1
- data/generated/google/apis/tasks_v1/classes.rb +26 -25
- data/generated/google/apis/tasks_v1/representations.rb +4 -8
- data/generated/google/apis/tasks_v1/service.rb +78 -124
- data/generated/google/apis/tasks_v1.rb +3 -3
- data/generated/google/apis/testing_v1/classes.rb +187 -1
- data/generated/google/apis/testing_v1/representations.rb +93 -0
- data/generated/google/apis/testing_v1.rb +1 -1
- data/generated/google/apis/texttospeech_v1.rb +1 -1
- data/generated/google/apis/texttospeech_v1beta1.rb +1 -1
- data/generated/google/apis/toolresults_v1beta3/classes.rb +2061 -1133
- data/generated/google/apis/toolresults_v1beta3/representations.rb +723 -13
- data/generated/google/apis/toolresults_v1beta3/service.rb +663 -591
- data/generated/google/apis/toolresults_v1beta3.rb +2 -2
- data/generated/google/apis/tpu_v1/classes.rb +3 -4
- data/generated/google/apis/tpu_v1.rb +1 -1
- data/generated/google/apis/tpu_v1alpha1/classes.rb +3 -4
- data/generated/google/apis/tpu_v1alpha1.rb +1 -1
- data/generated/google/apis/translate_v3/classes.rb +946 -0
- data/generated/google/apis/translate_v3/representations.rb +439 -0
- data/generated/google/apis/translate_v3/service.rb +781 -0
- data/generated/google/apis/translate_v3.rb +37 -0
- data/generated/google/apis/translate_v3beta1.rb +1 -1
- data/generated/google/apis/vault_v1/classes.rb +10 -7
- data/generated/google/apis/vault_v1/service.rb +7 -7
- data/generated/google/apis/vault_v1.rb +1 -1
- data/generated/google/apis/verifiedaccess_v1/service.rb +2 -2
- data/generated/google/apis/verifiedaccess_v1.rb +3 -3
- data/generated/google/apis/videointelligence_v1/classes.rb +1205 -118
- data/generated/google/apis/videointelligence_v1/representations.rb +492 -0
- data/generated/google/apis/videointelligence_v1.rb +1 -1
- data/generated/google/apis/videointelligence_v1beta2/classes.rb +1205 -118
- data/generated/google/apis/videointelligence_v1beta2/representations.rb +492 -0
- data/generated/google/apis/videointelligence_v1beta2.rb +1 -1
- data/generated/google/apis/videointelligence_v1p1beta1/classes.rb +1216 -129
- data/generated/google/apis/videointelligence_v1p1beta1/representations.rb +492 -0
- data/generated/google/apis/videointelligence_v1p1beta1.rb +1 -1
- data/generated/google/apis/videointelligence_v1p2beta1/classes.rb +1205 -118
- data/generated/google/apis/videointelligence_v1p2beta1/representations.rb +492 -0
- data/generated/google/apis/videointelligence_v1p2beta1.rb +1 -1
- data/generated/google/apis/videointelligence_v1p3beta1/classes.rb +1290 -116
- data/generated/google/apis/videointelligence_v1p3beta1/representations.rb +526 -0
- data/generated/google/apis/videointelligence_v1p3beta1.rb +1 -1
- data/generated/google/apis/vision_v1/classes.rb +67 -1
- data/generated/google/apis/vision_v1/representations.rb +32 -0
- data/generated/google/apis/vision_v1/service.rb +1 -1
- data/generated/google/apis/vision_v1.rb +1 -1
- data/generated/google/apis/vision_v1p1beta1/classes.rb +67 -1
- data/generated/google/apis/vision_v1p1beta1/representations.rb +32 -0
- data/generated/google/apis/vision_v1p1beta1.rb +1 -1
- data/generated/google/apis/vision_v1p2beta1/classes.rb +67 -1
- data/generated/google/apis/vision_v1p2beta1/representations.rb +32 -0
- data/generated/google/apis/vision_v1p2beta1.rb +1 -1
- data/generated/google/apis/websecurityscanner_v1/classes.rb +75 -4
- data/generated/google/apis/websecurityscanner_v1/representations.rb +32 -0
- data/generated/google/apis/websecurityscanner_v1/service.rb +1 -1
- data/generated/google/apis/websecurityscanner_v1.rb +2 -2
- data/generated/google/apis/websecurityscanner_v1alpha/classes.rb +5 -4
- data/generated/google/apis/websecurityscanner_v1alpha/service.rb +1 -1
- data/generated/google/apis/websecurityscanner_v1alpha.rb +2 -2
- data/generated/google/apis/websecurityscanner_v1beta/classes.rb +77 -6
- data/generated/google/apis/websecurityscanner_v1beta/representations.rb +32 -0
- data/generated/google/apis/websecurityscanner_v1beta/service.rb +1 -1
- data/generated/google/apis/websecurityscanner_v1beta.rb +2 -2
- data/generated/google/apis/youtube_analytics_v1.rb +1 -1
- data/generated/google/apis/youtube_analytics_v2.rb +1 -1
- data/generated/google/apis/youtube_partner_v1/service.rb +2 -2
- data/generated/google/apis/youtube_partner_v1.rb +1 -1
- data/generated/google/apis/youtube_v3/classes.rb +1376 -1262
- data/generated/google/apis/youtube_v3/representations.rb +99 -191
- data/generated/google/apis/youtube_v3/service.rb +1829 -2150
- data/generated/google/apis/youtube_v3.rb +8 -5
- data/generated/google/apis/youtubereporting_v1.rb +1 -1
- data/google-api-client.gemspec +6 -3
- data/lib/google/apis/core/api_command.rb +7 -0
- data/lib/google/apis/core/base_service.rb +1 -1
- data/lib/google/apis/core/http_command.rb +11 -10
- data/lib/google/apis/core/upload.rb +4 -0
- data/lib/google/apis/generator/annotator.rb +1 -1
- data/lib/google/apis/version.rb +9 -4
- data/rakelib/devsite/devsite_builder.rb +126 -0
- data/rakelib/devsite/link_checker.rb +64 -0
- data/rakelib/devsite/repo_metadata.rb +56 -0
- metadata +193 -110
- data/generated/google/apis/analytics_v2_4/representations.rb +0 -26
- data/generated/google/apis/analytics_v2_4/service.rb +0 -331
- data/generated/google/apis/analytics_v2_4.rb +0 -37
- data/generated/google/apis/cloudprivatecatalog_v1beta1/classes.rb +0 -358
- data/generated/google/apis/cloudprivatecatalog_v1beta1/service.rb +0 -486
- data/generated/google/apis/cloudprivatecatalogproducer_v1beta1/service.rb +0 -1081
- data/generated/google/apis/commentanalyzer_v1alpha1/classes.rb +0 -485
- data/generated/google/apis/commentanalyzer_v1alpha1/representations.rb +0 -210
- data/generated/google/apis/commentanalyzer_v1alpha1/service.rb +0 -124
- data/generated/google/apis/commentanalyzer_v1alpha1.rb +0 -39
- data/generated/google/apis/fusiontables_v1/classes.rb +0 -977
- data/generated/google/apis/fusiontables_v1/representations.rb +0 -449
- data/generated/google/apis/fusiontables_v1/service.rb +0 -1307
- data/generated/google/apis/fusiontables_v1.rb +0 -37
- data/generated/google/apis/fusiontables_v2/classes.rb +0 -1049
- data/generated/google/apis/fusiontables_v2/representations.rb +0 -457
- data/generated/google/apis/fusiontables_v2/service.rb +0 -1431
- data/generated/google/apis/fusiontables_v2.rb +0 -37
- data/generated/google/apis/mirror_v1/classes.rb +0 -1072
- data/generated/google/apis/mirror_v1/representations.rb +0 -390
- data/generated/google/apis/mirror_v1/service.rb +0 -928
- data/generated/google/apis/mirror_v1.rb +0 -37
- data/generated/google/apis/oauth2_v1/classes.rb +0 -197
- data/generated/google/apis/oauth2_v1/service.rb +0 -160
- data/generated/google/apis/oauth2_v1.rb +0 -40
- data/generated/google/apis/pagespeedonline_v1/classes.rb +0 -542
- data/generated/google/apis/pagespeedonline_v1/representations.rb +0 -258
- data/generated/google/apis/pagespeedonline_v1/service.rb +0 -116
- data/generated/google/apis/pagespeedonline_v2/classes.rb +0 -621
- data/generated/google/apis/pagespeedonline_v2/representations.rb +0 -273
- data/generated/google/apis/pagespeedonline_v2/service.rb +0 -116
- data/generated/google/apis/pagespeedonline_v4/classes.rb +0 -795
- data/generated/google/apis/pagespeedonline_v4/representations.rb +0 -335
- data/generated/google/apis/pagespeedonline_v4/service.rb +0 -125
- data/generated/google/apis/plus_domains_v1/classes.rb +0 -2609
- data/generated/google/apis/plus_domains_v1/representations.rb +0 -1111
- data/generated/google/apis/plus_domains_v1/service.rb +0 -489
- data/generated/google/apis/plus_domains_v1.rb +0 -55
- data/generated/google/apis/proximitybeacon_v1beta1/classes.rb +0 -845
- data/generated/google/apis/proximitybeacon_v1beta1/representations.rb +0 -350
- data/generated/google/apis/proximitybeacon_v1beta1/service.rb +0 -933
- data/generated/google/apis/replicapool_v1beta1/classes.rb +0 -918
- data/generated/google/apis/replicapool_v1beta1/representations.rb +0 -409
- data/generated/google/apis/replicapool_v1beta1/service.rb +0 -489
- data/generated/google/apis/replicapool_v1beta1.rb +0 -50
- data/generated/google/apis/servicebroker_v1/classes.rb +0 -333
- data/generated/google/apis/servicebroker_v1/service.rb +0 -177
- data/generated/google/apis/servicebroker_v1alpha1/classes.rb +0 -1037
- data/generated/google/apis/servicebroker_v1alpha1/service.rb +0 -737
- data/generated/google/apis/servicebroker_v1beta1/classes.rb +0 -1173
- data/generated/google/apis/servicebroker_v1beta1/service.rb +0 -926
- data/generated/google/apis/storage_v1beta1/classes.rb +0 -616
- data/generated/google/apis/storage_v1beta1/representations.rb +0 -249
- data/generated/google/apis/storage_v1beta1/service.rb +0 -1032
- data/generated/google/apis/storage_v1beta1.rb +0 -40
- data/generated/google/apis/surveys_v2/classes.rb +0 -691
- data/generated/google/apis/surveys_v2.rb +0 -40
- data/generated/google/apis/urlshortener_v1/classes.rb +0 -246
- data/generated/google/apis/urlshortener_v1/representations.rb +0 -121
- data/generated/google/apis/urlshortener_v1/service.rb +0 -169
- data/generated/google/apis/urlshortener_v1.rb +0 -34
@@ -0,0 +1,3126 @@
|
|
1
|
+
# Copyright 2015 Google Inc.
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'google/apis/core/base_service'
|
16
|
+
require 'google/apis/core/json_representation'
|
17
|
+
require 'google/apis/core/hashable'
|
18
|
+
require 'google/apis/errors'
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Apis
|
22
|
+
module DisplayvideoV1
|
23
|
+
# Display & Video 360 API
|
24
|
+
#
|
25
|
+
# Display & Video 360 API allows users to manage and create campaigns and
|
26
|
+
# reports.
|
27
|
+
#
|
28
|
+
# @example
|
29
|
+
# require 'google/apis/displayvideo_v1'
|
30
|
+
#
|
31
|
+
# Displayvideo = Google::Apis::DisplayvideoV1 # Alias the module
|
32
|
+
# service = Displayvideo::DisplayVideoService.new
|
33
|
+
#
|
34
|
+
# @see https://developers.google.com/display-video/
|
35
|
+
class DisplayVideoService < Google::Apis::Core::BaseService
|
36
|
+
# @return [String]
|
37
|
+
# API key. Your API key identifies your project and provides you with API access,
|
38
|
+
# quota, and reports. Required unless you provide an OAuth 2.0 token.
|
39
|
+
attr_accessor :key
|
40
|
+
|
41
|
+
# @return [String]
|
42
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
43
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
44
|
+
attr_accessor :quota_user
|
45
|
+
|
46
|
+
def initialize
|
47
|
+
super('https://displayvideo.googleapis.com/', '')
|
48
|
+
@batch_path = 'batch'
|
49
|
+
end
|
50
|
+
|
51
|
+
# Bulk edits targeting options under a single advertiser.
|
52
|
+
# The operation will delete the assigned targeting options provided in
|
53
|
+
# BulkEditAdvertiserAssignedTargetingOptionsRequest.delete_requests and
|
54
|
+
# then create the assigned targeting options provided in
|
55
|
+
# BulkEditAdvertiserAssignedTargetingOptionsRequest.create_requests .
|
56
|
+
# @param [Fixnum] advertiser_id
|
57
|
+
# Required. The ID of the advertiser.
|
58
|
+
# @param [Google::Apis::DisplayvideoV1::BulkEditAdvertiserAssignedTargetingOptionsRequest] bulk_edit_advertiser_assigned_targeting_options_request_object
|
59
|
+
# @param [String] fields
|
60
|
+
# Selector specifying which fields to include in a partial response.
|
61
|
+
# @param [String] quota_user
|
62
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
63
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
64
|
+
# @param [Google::Apis::RequestOptions] options
|
65
|
+
# Request-specific options
|
66
|
+
#
|
67
|
+
# @yield [result, err] Result & error if block supplied
|
68
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::BulkEditAdvertiserAssignedTargetingOptionsResponse] parsed result object
|
69
|
+
# @yieldparam err [StandardError] error object if request failed
|
70
|
+
#
|
71
|
+
# @return [Google::Apis::DisplayvideoV1::BulkEditAdvertiserAssignedTargetingOptionsResponse]
|
72
|
+
#
|
73
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
74
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
75
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
76
|
+
def bulk_edit_advertiser_assigned_targeting_options(advertiser_id, bulk_edit_advertiser_assigned_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
77
|
+
command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}:bulkEditAdvertiserAssignedTargetingOptions', options)
|
78
|
+
command.request_representation = Google::Apis::DisplayvideoV1::BulkEditAdvertiserAssignedTargetingOptionsRequest::Representation
|
79
|
+
command.request_object = bulk_edit_advertiser_assigned_targeting_options_request_object
|
80
|
+
command.response_representation = Google::Apis::DisplayvideoV1::BulkEditAdvertiserAssignedTargetingOptionsResponse::Representation
|
81
|
+
command.response_class = Google::Apis::DisplayvideoV1::BulkEditAdvertiserAssignedTargetingOptionsResponse
|
82
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
83
|
+
command.query['fields'] = fields unless fields.nil?
|
84
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
85
|
+
execute_or_queue_command(command, &block)
|
86
|
+
end
|
87
|
+
|
88
|
+
# Lists assigned targeting options of an advertiser across targeting types.
|
89
|
+
# @param [Fixnum] advertiser_id
|
90
|
+
# Required. The ID of the advertiser the line item belongs to.
|
91
|
+
# @param [String] filter
|
92
|
+
# Allows filtering by assigned targeting option properties.
|
93
|
+
# Supported syntax:
|
94
|
+
# * Filter expressions are made up of one or more restrictions.
|
95
|
+
# * Restrictions can be combined by the logical operator `OR`..
|
96
|
+
# * A restriction has the form of ``field` `operator` `value``.
|
97
|
+
# * The operator must be `EQUALS (=)`.
|
98
|
+
# * Supported fields:
|
99
|
+
# - `targetingType`
|
100
|
+
# Examples:
|
101
|
+
# * targetingType with value TARGETING_TYPE_CHANNEL
|
102
|
+
# `targetingType="TARGETING_TYPE_CHANNEL"`
|
103
|
+
# The length of this field should be no more than 500 characters.
|
104
|
+
# @param [String] order_by
|
105
|
+
# Field by which to sort the list.
|
106
|
+
# Acceptable values are:
|
107
|
+
# * `targetingType` (default)
|
108
|
+
# The default sorting order is ascending. To specify descending order for
|
109
|
+
# a field, a suffix "desc" should be added to the field name. Example:
|
110
|
+
# `targetingType desc`.
|
111
|
+
# @param [Fixnum] page_size
|
112
|
+
# Requested page size.
|
113
|
+
# The size must be an integer between `1` and `5000`. If unspecified,
|
114
|
+
# the default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid
|
115
|
+
# value is specified.
|
116
|
+
# @param [String] page_token
|
117
|
+
# A token that lets the client fetch the next page of results.
|
118
|
+
# Typically, this is the value of
|
119
|
+
# next_page_token
|
120
|
+
# returned from the previous call to
|
121
|
+
# `BulkListAdvertiserAssignedTargetingOptions` method.
|
122
|
+
# If not specified, the first page of results will be returned.
|
123
|
+
# @param [String] fields
|
124
|
+
# Selector specifying which fields to include in a partial response.
|
125
|
+
# @param [String] quota_user
|
126
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
127
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
128
|
+
# @param [Google::Apis::RequestOptions] options
|
129
|
+
# Request-specific options
|
130
|
+
#
|
131
|
+
# @yield [result, err] Result & error if block supplied
|
132
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::BulkListAdvertiserAssignedTargetingOptionsResponse] parsed result object
|
133
|
+
# @yieldparam err [StandardError] error object if request failed
|
134
|
+
#
|
135
|
+
# @return [Google::Apis::DisplayvideoV1::BulkListAdvertiserAssignedTargetingOptionsResponse]
|
136
|
+
#
|
137
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
138
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
139
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
140
|
+
def bulk_advertiser_list_advertiser_assigned_targeting_options(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
141
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}:bulkListAdvertiserAssignedTargetingOptions', options)
|
142
|
+
command.response_representation = Google::Apis::DisplayvideoV1::BulkListAdvertiserAssignedTargetingOptionsResponse::Representation
|
143
|
+
command.response_class = Google::Apis::DisplayvideoV1::BulkListAdvertiserAssignedTargetingOptionsResponse
|
144
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
145
|
+
command.query['filter'] = filter unless filter.nil?
|
146
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
147
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
148
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
149
|
+
command.query['fields'] = fields unless fields.nil?
|
150
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
151
|
+
execute_or_queue_command(command, &block)
|
152
|
+
end
|
153
|
+
|
154
|
+
# Creates a new advertiser.
|
155
|
+
# Returns the newly created advertiser if successful.
|
156
|
+
# This method can take up to 180 seconds to complete.
|
157
|
+
# @param [Google::Apis::DisplayvideoV1::Advertiser] advertiser_object
|
158
|
+
# @param [String] fields
|
159
|
+
# Selector specifying which fields to include in a partial response.
|
160
|
+
# @param [String] quota_user
|
161
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
162
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
163
|
+
# @param [Google::Apis::RequestOptions] options
|
164
|
+
# Request-specific options
|
165
|
+
#
|
166
|
+
# @yield [result, err] Result & error if block supplied
|
167
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Advertiser] parsed result object
|
168
|
+
# @yieldparam err [StandardError] error object if request failed
|
169
|
+
#
|
170
|
+
# @return [Google::Apis::DisplayvideoV1::Advertiser]
|
171
|
+
#
|
172
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
173
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
174
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
175
|
+
def create_advertiser(advertiser_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
176
|
+
command = make_simple_command(:post, 'v1/advertisers', options)
|
177
|
+
command.request_representation = Google::Apis::DisplayvideoV1::Advertiser::Representation
|
178
|
+
command.request_object = advertiser_object
|
179
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Advertiser::Representation
|
180
|
+
command.response_class = Google::Apis::DisplayvideoV1::Advertiser
|
181
|
+
command.query['fields'] = fields unless fields.nil?
|
182
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
183
|
+
execute_or_queue_command(command, &block)
|
184
|
+
end
|
185
|
+
|
186
|
+
# Deletes an advertiser.
|
187
|
+
# Deleting an advertiser will delete all of its child resources, for example,
|
188
|
+
# campaigns, insertion orders and line items.
|
189
|
+
# A deleted advertiser cannot be recovered.
|
190
|
+
# @param [Fixnum] advertiser_id
|
191
|
+
# The ID of the advertiser we need to delete.
|
192
|
+
# @param [String] fields
|
193
|
+
# Selector specifying which fields to include in a partial response.
|
194
|
+
# @param [String] quota_user
|
195
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
196
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
197
|
+
# @param [Google::Apis::RequestOptions] options
|
198
|
+
# Request-specific options
|
199
|
+
#
|
200
|
+
# @yield [result, err] Result & error if block supplied
|
201
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
202
|
+
# @yieldparam err [StandardError] error object if request failed
|
203
|
+
#
|
204
|
+
# @return [Google::Apis::DisplayvideoV1::Empty]
|
205
|
+
#
|
206
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
207
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
208
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
209
|
+
def delete_advertiser(advertiser_id, fields: nil, quota_user: nil, options: nil, &block)
|
210
|
+
command = make_simple_command(:delete, 'v1/advertisers/{+advertiserId}', options)
|
211
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
212
|
+
command.response_class = Google::Apis::DisplayvideoV1::Empty
|
213
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
214
|
+
command.query['fields'] = fields unless fields.nil?
|
215
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
216
|
+
execute_or_queue_command(command, &block)
|
217
|
+
end
|
218
|
+
|
219
|
+
# Gets an advertiser.
|
220
|
+
# @param [Fixnum] advertiser_id
|
221
|
+
# Required. The ID of the advertiser to fetch.
|
222
|
+
# @param [String] fields
|
223
|
+
# Selector specifying which fields to include in a partial response.
|
224
|
+
# @param [String] quota_user
|
225
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
226
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
227
|
+
# @param [Google::Apis::RequestOptions] options
|
228
|
+
# Request-specific options
|
229
|
+
#
|
230
|
+
# @yield [result, err] Result & error if block supplied
|
231
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Advertiser] parsed result object
|
232
|
+
# @yieldparam err [StandardError] error object if request failed
|
233
|
+
#
|
234
|
+
# @return [Google::Apis::DisplayvideoV1::Advertiser]
|
235
|
+
#
|
236
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
237
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
238
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
239
|
+
def get_advertiser(advertiser_id, fields: nil, quota_user: nil, options: nil, &block)
|
240
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}', options)
|
241
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Advertiser::Representation
|
242
|
+
command.response_class = Google::Apis::DisplayvideoV1::Advertiser
|
243
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
244
|
+
command.query['fields'] = fields unless fields.nil?
|
245
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
246
|
+
execute_or_queue_command(command, &block)
|
247
|
+
end
|
248
|
+
|
249
|
+
# Lists advertisers that are accessible to the current user.
|
250
|
+
# The order is defined by the order_by
|
251
|
+
# parameter.
|
252
|
+
# A single partner_id is required.
|
253
|
+
# Cross-partner listing is not supported.
|
254
|
+
# @param [String] filter
|
255
|
+
# Allows filtering by advertiser properties.
|
256
|
+
# Supported syntax:
|
257
|
+
# * Filter expressions are made up of one or more restrictions.
|
258
|
+
# * Restrictions can be combined by `AND` or `OR` logical operators. A
|
259
|
+
# sequence of restrictions implicitly uses `AND`.
|
260
|
+
# * A restriction has the form of ``field` `operator` `value``.
|
261
|
+
# * The operator must be `EQUALS (=)`.
|
262
|
+
# * Supported fields:
|
263
|
+
# - `entityStatus`
|
264
|
+
# Examples:
|
265
|
+
# * All active advertisers under a partner:
|
266
|
+
# `entityStatus="ENTITY_STATUS_ACTIVE"`
|
267
|
+
# The length of this field should be no more than 500 characters.
|
268
|
+
# @param [String] order_by
|
269
|
+
# Field by which to sort the list.
|
270
|
+
# Acceptable values are:
|
271
|
+
# * `displayName` (default)
|
272
|
+
# * `entityStatus`
|
273
|
+
# The default sorting order is ascending. To specify descending order for
|
274
|
+
# a field, a suffix "desc" should be added to the field name. For example,
|
275
|
+
# `displayName desc`.
|
276
|
+
# @param [Fixnum] page_size
|
277
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
278
|
+
# default to `100`.
|
279
|
+
# @param [String] page_token
|
280
|
+
# A token identifying a page of results the server should return.
|
281
|
+
# Typically, this is the value of
|
282
|
+
# next_page_token
|
283
|
+
# returned from the previous call to `ListAdvertisers` method.
|
284
|
+
# If not specified, the first page of results will be returned.
|
285
|
+
# @param [Fixnum] partner_id
|
286
|
+
# Required. The ID of the partner that the fetched advertisers should all belong
|
287
|
+
# to.
|
288
|
+
# The system only supports listing advertisers for one partner at a time.
|
289
|
+
# @param [String] fields
|
290
|
+
# Selector specifying which fields to include in a partial response.
|
291
|
+
# @param [String] quota_user
|
292
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
293
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
294
|
+
# @param [Google::Apis::RequestOptions] options
|
295
|
+
# Request-specific options
|
296
|
+
#
|
297
|
+
# @yield [result, err] Result & error if block supplied
|
298
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListAdvertisersResponse] parsed result object
|
299
|
+
# @yieldparam err [StandardError] error object if request failed
|
300
|
+
#
|
301
|
+
# @return [Google::Apis::DisplayvideoV1::ListAdvertisersResponse]
|
302
|
+
#
|
303
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
304
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
305
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
306
|
+
def list_advertisers(filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
307
|
+
command = make_simple_command(:get, 'v1/advertisers', options)
|
308
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListAdvertisersResponse::Representation
|
309
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListAdvertisersResponse
|
310
|
+
command.query['filter'] = filter unless filter.nil?
|
311
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
312
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
313
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
314
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
315
|
+
command.query['fields'] = fields unless fields.nil?
|
316
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
317
|
+
execute_or_queue_command(command, &block)
|
318
|
+
end
|
319
|
+
|
320
|
+
# Updates an existing advertiser.
|
321
|
+
# Returns the updated advertiser if successful.
|
322
|
+
# @param [Fixnum] advertiser_id
|
323
|
+
# Output only. The unique ID of the advertiser. Assigned by the system.
|
324
|
+
# @param [Google::Apis::DisplayvideoV1::Advertiser] advertiser_object
|
325
|
+
# @param [String] update_mask
|
326
|
+
# Required. The mask to control which fields to update.
|
327
|
+
# @param [String] fields
|
328
|
+
# Selector specifying which fields to include in a partial response.
|
329
|
+
# @param [String] quota_user
|
330
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
331
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
332
|
+
# @param [Google::Apis::RequestOptions] options
|
333
|
+
# Request-specific options
|
334
|
+
#
|
335
|
+
# @yield [result, err] Result & error if block supplied
|
336
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Advertiser] parsed result object
|
337
|
+
# @yieldparam err [StandardError] error object if request failed
|
338
|
+
#
|
339
|
+
# @return [Google::Apis::DisplayvideoV1::Advertiser]
|
340
|
+
#
|
341
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
342
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
343
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
344
|
+
def patch_advertiser(advertiser_id, advertiser_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
345
|
+
command = make_simple_command(:patch, 'v1/advertisers/{+advertiserId}', options)
|
346
|
+
command.request_representation = Google::Apis::DisplayvideoV1::Advertiser::Representation
|
347
|
+
command.request_object = advertiser_object
|
348
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Advertiser::Representation
|
349
|
+
command.response_class = Google::Apis::DisplayvideoV1::Advertiser
|
350
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
351
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
352
|
+
command.query['fields'] = fields unless fields.nil?
|
353
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
354
|
+
execute_or_queue_command(command, &block)
|
355
|
+
end
|
356
|
+
|
357
|
+
# Uploads an asset.
|
358
|
+
# Returns the ID of the newly uploaded asset if successful.
|
359
|
+
# The asset file size should be no more than 10 MB for images, 200 MB for
|
360
|
+
# ZIP files, and 1 GB for videos.
|
361
|
+
# @param [Fixnum] advertiser_id
|
362
|
+
# Required. The ID of the advertiser this asset belongs to.
|
363
|
+
# @param [Google::Apis::DisplayvideoV1::CreateAssetRequest] create_asset_request_object
|
364
|
+
# @param [String] fields
|
365
|
+
# Selector specifying which fields to include in a partial response.
|
366
|
+
# @param [String] quota_user
|
367
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
368
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
369
|
+
# @param [IO, String] upload_source
|
370
|
+
# IO stream or filename containing content to upload
|
371
|
+
# @param [String] content_type
|
372
|
+
# Content type of the uploaded content.
|
373
|
+
# @param [Google::Apis::RequestOptions] options
|
374
|
+
# Request-specific options
|
375
|
+
#
|
376
|
+
# @yield [result, err] Result & error if block supplied
|
377
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::CreateAssetResponse] parsed result object
|
378
|
+
# @yieldparam err [StandardError] error object if request failed
|
379
|
+
#
|
380
|
+
# @return [Google::Apis::DisplayvideoV1::CreateAssetResponse]
|
381
|
+
#
|
382
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
383
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
384
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
385
|
+
def upload_advertiser_asset(advertiser_id, create_asset_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
|
386
|
+
if upload_source.nil?
|
387
|
+
command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/assets', options)
|
388
|
+
else
|
389
|
+
command = make_upload_command(:post, 'v1/advertisers/{+advertiserId}/assets', options)
|
390
|
+
command.upload_source = upload_source
|
391
|
+
command.upload_content_type = content_type
|
392
|
+
end
|
393
|
+
command.request_representation = Google::Apis::DisplayvideoV1::CreateAssetRequest::Representation
|
394
|
+
command.request_object = create_asset_request_object
|
395
|
+
command.response_representation = Google::Apis::DisplayvideoV1::CreateAssetResponse::Representation
|
396
|
+
command.response_class = Google::Apis::DisplayvideoV1::CreateAssetResponse
|
397
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
398
|
+
command.query['fields'] = fields unless fields.nil?
|
399
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
400
|
+
execute_or_queue_command(command, &block)
|
401
|
+
end
|
402
|
+
|
403
|
+
# Creates a new campaign.
|
404
|
+
# Returns the newly created campaign if successful.
|
405
|
+
# @param [Fixnum] advertiser_id
|
406
|
+
# Output only. The unique ID of the advertiser the campaign belongs to.
|
407
|
+
# @param [Google::Apis::DisplayvideoV1::Campaign] campaign_object
|
408
|
+
# @param [String] fields
|
409
|
+
# Selector specifying which fields to include in a partial response.
|
410
|
+
# @param [String] quota_user
|
411
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
412
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
413
|
+
# @param [Google::Apis::RequestOptions] options
|
414
|
+
# Request-specific options
|
415
|
+
#
|
416
|
+
# @yield [result, err] Result & error if block supplied
|
417
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Campaign] parsed result object
|
418
|
+
# @yieldparam err [StandardError] error object if request failed
|
419
|
+
#
|
420
|
+
# @return [Google::Apis::DisplayvideoV1::Campaign]
|
421
|
+
#
|
422
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
423
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
424
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
425
|
+
def create_advertiser_campaign(advertiser_id, campaign_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
426
|
+
command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/campaigns', options)
|
427
|
+
command.request_representation = Google::Apis::DisplayvideoV1::Campaign::Representation
|
428
|
+
command.request_object = campaign_object
|
429
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Campaign::Representation
|
430
|
+
command.response_class = Google::Apis::DisplayvideoV1::Campaign
|
431
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
432
|
+
command.query['fields'] = fields unless fields.nil?
|
433
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
434
|
+
execute_or_queue_command(command, &block)
|
435
|
+
end
|
436
|
+
|
437
|
+
# Permanently deletes a campaign. A deleted campaign cannot be recovered.
|
438
|
+
# The campaign should be archived first, i.e. set
|
439
|
+
# entity_status to `ENTITY_STATUS_ARCHIVED`, to be
|
440
|
+
# able to delete it.
|
441
|
+
# @param [Fixnum] advertiser_id
|
442
|
+
# The ID of the advertiser this campaign belongs to.
|
443
|
+
# @param [Fixnum] campaign_id
|
444
|
+
# The ID of the campaign we need to delete.
|
445
|
+
# @param [String] fields
|
446
|
+
# Selector specifying which fields to include in a partial response.
|
447
|
+
# @param [String] quota_user
|
448
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
449
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
450
|
+
# @param [Google::Apis::RequestOptions] options
|
451
|
+
# Request-specific options
|
452
|
+
#
|
453
|
+
# @yield [result, err] Result & error if block supplied
|
454
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
455
|
+
# @yieldparam err [StandardError] error object if request failed
|
456
|
+
#
|
457
|
+
# @return [Google::Apis::DisplayvideoV1::Empty]
|
458
|
+
#
|
459
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
460
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
461
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
462
|
+
def delete_advertiser_campaign(advertiser_id, campaign_id, fields: nil, quota_user: nil, options: nil, &block)
|
463
|
+
command = make_simple_command(:delete, 'v1/advertisers/{+advertiserId}/campaigns/{+campaignId}', options)
|
464
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
465
|
+
command.response_class = Google::Apis::DisplayvideoV1::Empty
|
466
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
467
|
+
command.params['campaignId'] = campaign_id unless campaign_id.nil?
|
468
|
+
command.query['fields'] = fields unless fields.nil?
|
469
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
470
|
+
execute_or_queue_command(command, &block)
|
471
|
+
end
|
472
|
+
|
473
|
+
# Gets a campaign.
|
474
|
+
# @param [Fixnum] advertiser_id
|
475
|
+
# Required. The ID of the advertiser this campaign belongs to.
|
476
|
+
# @param [Fixnum] campaign_id
|
477
|
+
# Required. The ID of the campaign to fetch.
|
478
|
+
# @param [String] fields
|
479
|
+
# Selector specifying which fields to include in a partial response.
|
480
|
+
# @param [String] quota_user
|
481
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
482
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
483
|
+
# @param [Google::Apis::RequestOptions] options
|
484
|
+
# Request-specific options
|
485
|
+
#
|
486
|
+
# @yield [result, err] Result & error if block supplied
|
487
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Campaign] parsed result object
|
488
|
+
# @yieldparam err [StandardError] error object if request failed
|
489
|
+
#
|
490
|
+
# @return [Google::Apis::DisplayvideoV1::Campaign]
|
491
|
+
#
|
492
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
493
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
494
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
495
|
+
def get_advertiser_campaign(advertiser_id, campaign_id, fields: nil, quota_user: nil, options: nil, &block)
|
496
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/campaigns/{+campaignId}', options)
|
497
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Campaign::Representation
|
498
|
+
command.response_class = Google::Apis::DisplayvideoV1::Campaign
|
499
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
500
|
+
command.params['campaignId'] = campaign_id unless campaign_id.nil?
|
501
|
+
command.query['fields'] = fields unless fields.nil?
|
502
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
503
|
+
execute_or_queue_command(command, &block)
|
504
|
+
end
|
505
|
+
|
506
|
+
# Lists campaigns in an advertiser.
|
507
|
+
# The order is defined by the order_by
|
508
|
+
# parameter.
|
509
|
+
# If a filter by
|
510
|
+
# entity_status is not specified, campaigns with
|
511
|
+
# `ENTITY_STATUS_ARCHIVED` will not be included in the results.
|
512
|
+
# @param [Fixnum] advertiser_id
|
513
|
+
# The ID of the advertiser to list campaigns for.
|
514
|
+
# @param [String] filter
|
515
|
+
# Allows filtering by campaign properties.
|
516
|
+
# Supported syntax:
|
517
|
+
# * Filter expressions are made up of one or more restrictions.
|
518
|
+
# * Restrictions can be combined by `AND` or `OR` logical operators. A
|
519
|
+
# sequence of restrictions implicitly uses `AND`.
|
520
|
+
# * A restriction has the form of ``field` `operator` `value``.
|
521
|
+
# * The operator must be `EQUALS (=)`.
|
522
|
+
# * Supported fields:
|
523
|
+
# - `entityStatus`
|
524
|
+
# Examples:
|
525
|
+
# * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an
|
526
|
+
# advertiser:
|
527
|
+
# `(entityStatus="ENTITY_STATUS_ACTIVE" OR
|
528
|
+
# entityStatus="ENTITY_STATUS_PAUSED")`
|
529
|
+
# The length of this field should be no more than 500 characters.
|
530
|
+
# @param [String] order_by
|
531
|
+
# Field by which to sort the list.
|
532
|
+
# Acceptable values are:
|
533
|
+
# * `displayName` (default)
|
534
|
+
# * `entityStatus`
|
535
|
+
# The default sorting order is ascending. To specify descending order for
|
536
|
+
# a field, a suffix "desc" should be added to the field name. Example:
|
537
|
+
# `displayName desc`.
|
538
|
+
# @param [Fixnum] page_size
|
539
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
540
|
+
# default to `100`.
|
541
|
+
# @param [String] page_token
|
542
|
+
# A token identifying a page of results the server should return.
|
543
|
+
# Typically, this is the value of
|
544
|
+
# next_page_token returned from the
|
545
|
+
# previous call to `ListCampaigns` method. If not specified, the first page
|
546
|
+
# of results will be returned.
|
547
|
+
# @param [String] fields
|
548
|
+
# Selector specifying which fields to include in a partial response.
|
549
|
+
# @param [String] quota_user
|
550
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
551
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
552
|
+
# @param [Google::Apis::RequestOptions] options
|
553
|
+
# Request-specific options
|
554
|
+
#
|
555
|
+
# @yield [result, err] Result & error if block supplied
|
556
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListCampaignsResponse] parsed result object
|
557
|
+
# @yieldparam err [StandardError] error object if request failed
|
558
|
+
#
|
559
|
+
# @return [Google::Apis::DisplayvideoV1::ListCampaignsResponse]
|
560
|
+
#
|
561
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
562
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
563
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
564
|
+
def list_advertiser_campaigns(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
565
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/campaigns', options)
|
566
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListCampaignsResponse::Representation
|
567
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListCampaignsResponse
|
568
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
569
|
+
command.query['filter'] = filter unless filter.nil?
|
570
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
571
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
572
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
573
|
+
command.query['fields'] = fields unless fields.nil?
|
574
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
575
|
+
execute_or_queue_command(command, &block)
|
576
|
+
end
|
577
|
+
|
578
|
+
# Updates an existing campaign.
|
579
|
+
# Returns the updated campaign if successful.
|
580
|
+
# @param [Fixnum] advertiser_id
|
581
|
+
# Output only. The unique ID of the advertiser the campaign belongs to.
|
582
|
+
# @param [Fixnum] campaign_id
|
583
|
+
# Output only. The unique ID of the campaign. Assigned by the system.
|
584
|
+
# @param [Google::Apis::DisplayvideoV1::Campaign] campaign_object
|
585
|
+
# @param [String] update_mask
|
586
|
+
# Required. The mask to control which fields to update.
|
587
|
+
# @param [String] fields
|
588
|
+
# Selector specifying which fields to include in a partial response.
|
589
|
+
# @param [String] quota_user
|
590
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
591
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
592
|
+
# @param [Google::Apis::RequestOptions] options
|
593
|
+
# Request-specific options
|
594
|
+
#
|
595
|
+
# @yield [result, err] Result & error if block supplied
|
596
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Campaign] parsed result object
|
597
|
+
# @yieldparam err [StandardError] error object if request failed
|
598
|
+
#
|
599
|
+
# @return [Google::Apis::DisplayvideoV1::Campaign]
|
600
|
+
#
|
601
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
602
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
603
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
604
|
+
def patch_advertiser_campaign(advertiser_id, campaign_id, campaign_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
605
|
+
command = make_simple_command(:patch, 'v1/advertisers/{+advertiserId}/campaigns/{+campaignId}', options)
|
606
|
+
command.request_representation = Google::Apis::DisplayvideoV1::Campaign::Representation
|
607
|
+
command.request_object = campaign_object
|
608
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Campaign::Representation
|
609
|
+
command.response_class = Google::Apis::DisplayvideoV1::Campaign
|
610
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
611
|
+
command.params['campaignId'] = campaign_id unless campaign_id.nil?
|
612
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
613
|
+
command.query['fields'] = fields unless fields.nil?
|
614
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
615
|
+
execute_or_queue_command(command, &block)
|
616
|
+
end
|
617
|
+
|
618
|
+
# Gets a channel for a partner or advertiser.
|
619
|
+
# @param [Fixnum] advertiser_id
|
620
|
+
# The ID of the advertiser that owns the fetched channel.
|
621
|
+
# @param [Fixnum] channel_id
|
622
|
+
# Required. The ID of the channel to fetch.
|
623
|
+
# @param [Fixnum] partner_id
|
624
|
+
# The ID of the partner that owns the fetched channel.
|
625
|
+
# @param [String] fields
|
626
|
+
# Selector specifying which fields to include in a partial response.
|
627
|
+
# @param [String] quota_user
|
628
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
629
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
630
|
+
# @param [Google::Apis::RequestOptions] options
|
631
|
+
# Request-specific options
|
632
|
+
#
|
633
|
+
# @yield [result, err] Result & error if block supplied
|
634
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Channel] parsed result object
|
635
|
+
# @yieldparam err [StandardError] error object if request failed
|
636
|
+
#
|
637
|
+
# @return [Google::Apis::DisplayvideoV1::Channel]
|
638
|
+
#
|
639
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
640
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
641
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
642
|
+
def get_advertiser_channel(advertiser_id, channel_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
643
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/channels/{+channelId}', options)
|
644
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Channel::Representation
|
645
|
+
command.response_class = Google::Apis::DisplayvideoV1::Channel
|
646
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
647
|
+
command.params['channelId'] = channel_id unless channel_id.nil?
|
648
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
649
|
+
command.query['fields'] = fields unless fields.nil?
|
650
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
651
|
+
execute_or_queue_command(command, &block)
|
652
|
+
end
|
653
|
+
|
654
|
+
# Lists channels for a partner or advertiser.
|
655
|
+
# @param [Fixnum] advertiser_id
|
656
|
+
# The ID of the advertiser that owns the channels.
|
657
|
+
# @param [String] filter
|
658
|
+
# Allows filtering by channel fields.
|
659
|
+
# Supported syntax:
|
660
|
+
# * Filter expressions for channel currently can only contain at most one
|
661
|
+
# * restriction.
|
662
|
+
# * A restriction has the form of ``field` `operator` `value``.
|
663
|
+
# * The operator must be `CONTAINS (:)`.
|
664
|
+
# * Supported fields:
|
665
|
+
# - `displayName`
|
666
|
+
# Examples:
|
667
|
+
# * All channels for which the display name contains "google":
|
668
|
+
# `displayName : "google"`.
|
669
|
+
# The length of this field should be no more than 500 characters.
|
670
|
+
# @param [String] order_by
|
671
|
+
# Field by which to sort the list.
|
672
|
+
# Acceptable values are:
|
673
|
+
# * `displayName` (default)
|
674
|
+
# * `channelId`
|
675
|
+
# The default sorting order is ascending. To specify descending order for a
|
676
|
+
# field, a suffix " desc" should be added to the field name. Example:
|
677
|
+
# `displayName desc`.
|
678
|
+
# @param [Fixnum] page_size
|
679
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
680
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
681
|
+
# is specified.
|
682
|
+
# @param [String] page_token
|
683
|
+
# A token identifying a page of results the server should return.
|
684
|
+
# Typically, this is the value of
|
685
|
+
# next_page_token returned from the
|
686
|
+
# previous call to `ListChannels` method. If not specified, the first page
|
687
|
+
# of results will be returned.
|
688
|
+
# @param [Fixnum] partner_id
|
689
|
+
# The ID of the partner that owns the channels.
|
690
|
+
# @param [String] fields
|
691
|
+
# Selector specifying which fields to include in a partial response.
|
692
|
+
# @param [String] quota_user
|
693
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
694
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
695
|
+
# @param [Google::Apis::RequestOptions] options
|
696
|
+
# Request-specific options
|
697
|
+
#
|
698
|
+
# @yield [result, err] Result & error if block supplied
|
699
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListChannelsResponse] parsed result object
|
700
|
+
# @yieldparam err [StandardError] error object if request failed
|
701
|
+
#
|
702
|
+
# @return [Google::Apis::DisplayvideoV1::ListChannelsResponse]
|
703
|
+
#
|
704
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
705
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
706
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
707
|
+
def list_advertiser_channels(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
708
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/channels', options)
|
709
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListChannelsResponse::Representation
|
710
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListChannelsResponse
|
711
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
712
|
+
command.query['filter'] = filter unless filter.nil?
|
713
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
714
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
715
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
716
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
717
|
+
command.query['fields'] = fields unless fields.nil?
|
718
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
719
|
+
execute_or_queue_command(command, &block)
|
720
|
+
end
|
721
|
+
|
722
|
+
# Creates a new creative.
|
723
|
+
# Returns the newly created creative if successful.
|
724
|
+
# @param [Fixnum] advertiser_id
|
725
|
+
# Output only. The unique ID of the advertiser the creative belongs to.
|
726
|
+
# @param [Google::Apis::DisplayvideoV1::Creative] creative_object
|
727
|
+
# @param [String] fields
|
728
|
+
# Selector specifying which fields to include in a partial response.
|
729
|
+
# @param [String] quota_user
|
730
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
731
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
732
|
+
# @param [Google::Apis::RequestOptions] options
|
733
|
+
# Request-specific options
|
734
|
+
#
|
735
|
+
# @yield [result, err] Result & error if block supplied
|
736
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Creative] parsed result object
|
737
|
+
# @yieldparam err [StandardError] error object if request failed
|
738
|
+
#
|
739
|
+
# @return [Google::Apis::DisplayvideoV1::Creative]
|
740
|
+
#
|
741
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
742
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
743
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
744
|
+
def create_advertiser_creative(advertiser_id, creative_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
745
|
+
command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/creatives', options)
|
746
|
+
command.request_representation = Google::Apis::DisplayvideoV1::Creative::Representation
|
747
|
+
command.request_object = creative_object
|
748
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Creative::Representation
|
749
|
+
command.response_class = Google::Apis::DisplayvideoV1::Creative
|
750
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
751
|
+
command.query['fields'] = fields unless fields.nil?
|
752
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
753
|
+
execute_or_queue_command(command, &block)
|
754
|
+
end
|
755
|
+
|
756
|
+
# Deletes a creative.
|
757
|
+
# Returns error code `NOT_FOUND` if the creative does not exist.
|
758
|
+
# The creative should be archived first, i.e. set
|
759
|
+
# entity_status to `ENTITY_STATUS_ARCHIVED`, before
|
760
|
+
# it can be deleted.
|
761
|
+
# @param [Fixnum] advertiser_id
|
762
|
+
# The ID of the advertiser this creative belongs to.
|
763
|
+
# @param [Fixnum] creative_id
|
764
|
+
# The ID of the creative to be deleted.
|
765
|
+
# @param [String] fields
|
766
|
+
# Selector specifying which fields to include in a partial response.
|
767
|
+
# @param [String] quota_user
|
768
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
769
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
770
|
+
# @param [Google::Apis::RequestOptions] options
|
771
|
+
# Request-specific options
|
772
|
+
#
|
773
|
+
# @yield [result, err] Result & error if block supplied
|
774
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
775
|
+
# @yieldparam err [StandardError] error object if request failed
|
776
|
+
#
|
777
|
+
# @return [Google::Apis::DisplayvideoV1::Empty]
|
778
|
+
#
|
779
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
780
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
781
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
782
|
+
def delete_advertiser_creative(advertiser_id, creative_id, fields: nil, quota_user: nil, options: nil, &block)
|
783
|
+
command = make_simple_command(:delete, 'v1/advertisers/{+advertiserId}/creatives/{+creativeId}', options)
|
784
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
785
|
+
command.response_class = Google::Apis::DisplayvideoV1::Empty
|
786
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
787
|
+
command.params['creativeId'] = creative_id unless creative_id.nil?
|
788
|
+
command.query['fields'] = fields unless fields.nil?
|
789
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
790
|
+
execute_or_queue_command(command, &block)
|
791
|
+
end
|
792
|
+
|
793
|
+
# Gets a creative.
|
794
|
+
# @param [Fixnum] advertiser_id
|
795
|
+
# Required. The ID of the advertiser this creative belongs to.
|
796
|
+
# @param [Fixnum] creative_id
|
797
|
+
# Required. The ID of the creative to fetch.
|
798
|
+
# @param [String] fields
|
799
|
+
# Selector specifying which fields to include in a partial response.
|
800
|
+
# @param [String] quota_user
|
801
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
802
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
803
|
+
# @param [Google::Apis::RequestOptions] options
|
804
|
+
# Request-specific options
|
805
|
+
#
|
806
|
+
# @yield [result, err] Result & error if block supplied
|
807
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Creative] parsed result object
|
808
|
+
# @yieldparam err [StandardError] error object if request failed
|
809
|
+
#
|
810
|
+
# @return [Google::Apis::DisplayvideoV1::Creative]
|
811
|
+
#
|
812
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
813
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
814
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
815
|
+
def get_advertiser_creative(advertiser_id, creative_id, fields: nil, quota_user: nil, options: nil, &block)
|
816
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/creatives/{+creativeId}', options)
|
817
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Creative::Representation
|
818
|
+
command.response_class = Google::Apis::DisplayvideoV1::Creative
|
819
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
820
|
+
command.params['creativeId'] = creative_id unless creative_id.nil?
|
821
|
+
command.query['fields'] = fields unless fields.nil?
|
822
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
823
|
+
execute_or_queue_command(command, &block)
|
824
|
+
end
|
825
|
+
|
826
|
+
# Lists creatives in an advertiser.
|
827
|
+
# The order is defined by the order_by
|
828
|
+
# parameter.
|
829
|
+
# If a filter by
|
830
|
+
# entity_status is not specified, creatives with
|
831
|
+
# `ENTITY_STATUS_ARCHIVED` will not be included in the results.
|
832
|
+
# @param [Fixnum] advertiser_id
|
833
|
+
# Required. The ID of the advertiser to list creatives for.
|
834
|
+
# @param [String] filter
|
835
|
+
# Allows filtering by creative properties.
|
836
|
+
# Supported syntax:
|
837
|
+
# * Filter expressions are made up of one or more restrictions.
|
838
|
+
# * Restriction for the same field must be combined by `OR`.
|
839
|
+
# * Restriction for different fields must be combined by `AND`.
|
840
|
+
# * Between `(` and `)` there can only be restrictions combined by `OR`
|
841
|
+
# for the same field.
|
842
|
+
# * A restriction has the form of ``field` `operator` `value``.
|
843
|
+
# * The operator must be `EQUALS (=)` for the following fields:
|
844
|
+
# - `entityStatus`
|
845
|
+
# - `creativeType`.
|
846
|
+
# - `dimensions`
|
847
|
+
# - `minDuration`
|
848
|
+
# - `maxDuration`
|
849
|
+
# - `approvalStatus`
|
850
|
+
# - `exchangeReviewStatus`
|
851
|
+
# - `dynamic`
|
852
|
+
# * The operator must be `HAS (:)` for the following fields:
|
853
|
+
# - `lineItemIds`
|
854
|
+
# * For `entityStatus`, `minDuration`, `maxDuration`, and `dynamic` there may
|
855
|
+
# be at most one restriction.
|
856
|
+
# * For `dimensions`, the value is in the form of `"`width`x`height`"`.
|
857
|
+
# * For `exchangeReviewStatus`, the value is in the form of
|
858
|
+
# ``exchange`-`reviewStatus``.
|
859
|
+
# * For `minDuration` and `maxDuration`, the value is in the form of
|
860
|
+
# `"`duration`s"`. Only seconds are supported with millisecond granularity.
|
861
|
+
# * There may be multiple `lineItemIds` restrictions in order to search
|
862
|
+
# against multiple possible line item IDs.
|
863
|
+
# Examples:
|
864
|
+
# * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"`
|
865
|
+
# * All active creatives with 300x400 or 50x100 dimensions:
|
866
|
+
# `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400"
|
867
|
+
# OR dimensions="50x100")`
|
868
|
+
# * All dynamic creatives that are approved by AdX or
|
869
|
+
# AppNexus, with a minimum duration of 5 seconds and 200ms.
|
870
|
+
# `dynamic="true" AND minDuration="5.2s" AND
|
871
|
+
# (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED"
|
872
|
+
# OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")`
|
873
|
+
# * All video creatives that are associated with line item ID 1 or 2:
|
874
|
+
# creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)
|
875
|
+
# The length of this field should be no more than 500 characters.
|
876
|
+
# @param [String] order_by
|
877
|
+
# Field by which to sort the list.
|
878
|
+
# Acceptable values are:
|
879
|
+
# * `creativeId` (default)
|
880
|
+
# * `createTime`
|
881
|
+
# * `mediaDuration`
|
882
|
+
# * `dimensions` (sorts by width first, then by height)
|
883
|
+
# The default sorting order is ascending. To specify descending order for
|
884
|
+
# a field, a suffix "desc" should be added to the field name.
|
885
|
+
# Example: `createTime desc`.
|
886
|
+
# @param [Fixnum] page_size
|
887
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
888
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
889
|
+
# is specified.
|
890
|
+
# @param [String] page_token
|
891
|
+
# A token identifying a page of results the server should return.
|
892
|
+
# Typically, this is the value of
|
893
|
+
# next_page_token
|
894
|
+
# returned from the previous call to `ListCreatives` method.
|
895
|
+
# If not specified, the first page of results will be returned.
|
896
|
+
# @param [String] fields
|
897
|
+
# Selector specifying which fields to include in a partial response.
|
898
|
+
# @param [String] quota_user
|
899
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
900
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
901
|
+
# @param [Google::Apis::RequestOptions] options
|
902
|
+
# Request-specific options
|
903
|
+
#
|
904
|
+
# @yield [result, err] Result & error if block supplied
|
905
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListCreativesResponse] parsed result object
|
906
|
+
# @yieldparam err [StandardError] error object if request failed
|
907
|
+
#
|
908
|
+
# @return [Google::Apis::DisplayvideoV1::ListCreativesResponse]
|
909
|
+
#
|
910
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
911
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
912
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
913
|
+
def list_advertiser_creatives(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
914
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/creatives', options)
|
915
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListCreativesResponse::Representation
|
916
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListCreativesResponse
|
917
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
918
|
+
command.query['filter'] = filter unless filter.nil?
|
919
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
920
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
921
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
922
|
+
command.query['fields'] = fields unless fields.nil?
|
923
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
924
|
+
execute_or_queue_command(command, &block)
|
925
|
+
end
|
926
|
+
|
927
|
+
# Updates an existing creative.
|
928
|
+
# Returns the updated creative if successful.
|
929
|
+
# @param [Fixnum] advertiser_id
|
930
|
+
# Output only. The unique ID of the advertiser the creative belongs to.
|
931
|
+
# @param [Fixnum] creative_id
|
932
|
+
# Output only. The unique ID of the creative. Assigned by the system.
|
933
|
+
# @param [Google::Apis::DisplayvideoV1::Creative] creative_object
|
934
|
+
# @param [String] update_mask
|
935
|
+
# Required. The mask to control which fields to update.
|
936
|
+
# @param [String] fields
|
937
|
+
# Selector specifying which fields to include in a partial response.
|
938
|
+
# @param [String] quota_user
|
939
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
940
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
941
|
+
# @param [Google::Apis::RequestOptions] options
|
942
|
+
# Request-specific options
|
943
|
+
#
|
944
|
+
# @yield [result, err] Result & error if block supplied
|
945
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Creative] parsed result object
|
946
|
+
# @yieldparam err [StandardError] error object if request failed
|
947
|
+
#
|
948
|
+
# @return [Google::Apis::DisplayvideoV1::Creative]
|
949
|
+
#
|
950
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
951
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
952
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
953
|
+
def patch_advertiser_creative(advertiser_id, creative_id, creative_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
954
|
+
command = make_simple_command(:patch, 'v1/advertisers/{+advertiserId}/creatives/{+creativeId}', options)
|
955
|
+
command.request_representation = Google::Apis::DisplayvideoV1::Creative::Representation
|
956
|
+
command.request_object = creative_object
|
957
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Creative::Representation
|
958
|
+
command.response_class = Google::Apis::DisplayvideoV1::Creative
|
959
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
960
|
+
command.params['creativeId'] = creative_id unless creative_id.nil?
|
961
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
962
|
+
command.query['fields'] = fields unless fields.nil?
|
963
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
964
|
+
execute_or_queue_command(command, &block)
|
965
|
+
end
|
966
|
+
|
967
|
+
# Creates a new insertion order.
|
968
|
+
# Returns the newly created insertion order if successful.
|
969
|
+
# @param [Fixnum] advertiser_id
|
970
|
+
# Output only. The unique ID of the advertiser the insertion order belongs to.
|
971
|
+
# @param [Google::Apis::DisplayvideoV1::InsertionOrder] insertion_order_object
|
972
|
+
# @param [String] fields
|
973
|
+
# Selector specifying which fields to include in a partial response.
|
974
|
+
# @param [String] quota_user
|
975
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
976
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
977
|
+
# @param [Google::Apis::RequestOptions] options
|
978
|
+
# Request-specific options
|
979
|
+
#
|
980
|
+
# @yield [result, err] Result & error if block supplied
|
981
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::InsertionOrder] parsed result object
|
982
|
+
# @yieldparam err [StandardError] error object if request failed
|
983
|
+
#
|
984
|
+
# @return [Google::Apis::DisplayvideoV1::InsertionOrder]
|
985
|
+
#
|
986
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
987
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
988
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
989
|
+
def create_advertiser_insertion_order(advertiser_id, insertion_order_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
990
|
+
command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/insertionOrders', options)
|
991
|
+
command.request_representation = Google::Apis::DisplayvideoV1::InsertionOrder::Representation
|
992
|
+
command.request_object = insertion_order_object
|
993
|
+
command.response_representation = Google::Apis::DisplayvideoV1::InsertionOrder::Representation
|
994
|
+
command.response_class = Google::Apis::DisplayvideoV1::InsertionOrder
|
995
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
996
|
+
command.query['fields'] = fields unless fields.nil?
|
997
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
998
|
+
execute_or_queue_command(command, &block)
|
999
|
+
end
|
1000
|
+
|
1001
|
+
# Deletes an insertion order.
|
1002
|
+
# Returns error code `NOT_FOUND` if the insertion order does not exist.
|
1003
|
+
# The insertion order should be archived first, i.e. set
|
1004
|
+
# entity_status to `ENTITY_STATUS_ARCHIVED`,
|
1005
|
+
# to be able to delete it.
|
1006
|
+
# @param [Fixnum] advertiser_id
|
1007
|
+
# The ID of the advertiser this insertion order belongs to.
|
1008
|
+
# @param [Fixnum] insertion_order_id
|
1009
|
+
# The ID of the insertion order we need to delete.
|
1010
|
+
# @param [String] fields
|
1011
|
+
# Selector specifying which fields to include in a partial response.
|
1012
|
+
# @param [String] quota_user
|
1013
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1014
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1015
|
+
# @param [Google::Apis::RequestOptions] options
|
1016
|
+
# Request-specific options
|
1017
|
+
#
|
1018
|
+
# @yield [result, err] Result & error if block supplied
|
1019
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
1020
|
+
# @yieldparam err [StandardError] error object if request failed
|
1021
|
+
#
|
1022
|
+
# @return [Google::Apis::DisplayvideoV1::Empty]
|
1023
|
+
#
|
1024
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1025
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1026
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1027
|
+
def delete_advertiser_insertion_order(advertiser_id, insertion_order_id, fields: nil, quota_user: nil, options: nil, &block)
|
1028
|
+
command = make_simple_command(:delete, 'v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}', options)
|
1029
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
1030
|
+
command.response_class = Google::Apis::DisplayvideoV1::Empty
|
1031
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1032
|
+
command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
|
1033
|
+
command.query['fields'] = fields unless fields.nil?
|
1034
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1035
|
+
execute_or_queue_command(command, &block)
|
1036
|
+
end
|
1037
|
+
|
1038
|
+
# Gets an insertion order.
|
1039
|
+
# Returns error code `NOT_FOUND` if the insertion order does not exist.
|
1040
|
+
# @param [Fixnum] advertiser_id
|
1041
|
+
# Required. The ID of the advertiser this insertion order belongs to.
|
1042
|
+
# @param [Fixnum] insertion_order_id
|
1043
|
+
# Required. The ID of the insertion order to fetch.
|
1044
|
+
# @param [String] fields
|
1045
|
+
# Selector specifying which fields to include in a partial response.
|
1046
|
+
# @param [String] quota_user
|
1047
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1048
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1049
|
+
# @param [Google::Apis::RequestOptions] options
|
1050
|
+
# Request-specific options
|
1051
|
+
#
|
1052
|
+
# @yield [result, err] Result & error if block supplied
|
1053
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::InsertionOrder] parsed result object
|
1054
|
+
# @yieldparam err [StandardError] error object if request failed
|
1055
|
+
#
|
1056
|
+
# @return [Google::Apis::DisplayvideoV1::InsertionOrder]
|
1057
|
+
#
|
1058
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1059
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1060
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1061
|
+
def get_advertiser_insertion_order(advertiser_id, insertion_order_id, fields: nil, quota_user: nil, options: nil, &block)
|
1062
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}', options)
|
1063
|
+
command.response_representation = Google::Apis::DisplayvideoV1::InsertionOrder::Representation
|
1064
|
+
command.response_class = Google::Apis::DisplayvideoV1::InsertionOrder
|
1065
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1066
|
+
command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
|
1067
|
+
command.query['fields'] = fields unless fields.nil?
|
1068
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1069
|
+
execute_or_queue_command(command, &block)
|
1070
|
+
end
|
1071
|
+
|
1072
|
+
# Lists insertion orders in an advertiser.
|
1073
|
+
# The order is defined by the order_by
|
1074
|
+
# parameter.
|
1075
|
+
# If a filter by
|
1076
|
+
# entity_status is not specified, insertion
|
1077
|
+
# orders with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
|
1078
|
+
# @param [Fixnum] advertiser_id
|
1079
|
+
# Required. The ID of the advertiser to list insertion orders for.
|
1080
|
+
# @param [String] filter
|
1081
|
+
# Allows filtering by insertion order properties.
|
1082
|
+
# Supported syntax:
|
1083
|
+
# * Filter expressions are made up of one or more restrictions.
|
1084
|
+
# * Restrictions can be combined by `AND` or `OR` logical operators. A
|
1085
|
+
# sequence of restrictions implicitly uses `AND`.
|
1086
|
+
# * A restriction has the form of ``field` `operator` `value``.
|
1087
|
+
# * The operator must be `EQUALS (=)`.
|
1088
|
+
# * Supported fields:
|
1089
|
+
# - `campaignId`
|
1090
|
+
# - `entityStatus`
|
1091
|
+
# Examples:
|
1092
|
+
# * All insertion orders under a campaign: `campaignId="1234"`
|
1093
|
+
# * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders
|
1094
|
+
# under an advertiser:
|
1095
|
+
# `(entityStatus="ENTITY_STATUS_ACTIVE" OR
|
1096
|
+
# entityStatus="ENTITY_STATUS_PAUSED")`
|
1097
|
+
# The length of this field should be no more than 500 characters.
|
1098
|
+
# @param [String] order_by
|
1099
|
+
# Field by which to sort the list.
|
1100
|
+
# Acceptable values are:
|
1101
|
+
# * "displayName" (default)
|
1102
|
+
# * "entityStatus"
|
1103
|
+
# The default sorting order is ascending. To specify descending order for
|
1104
|
+
# a field, a suffix "desc" should be added to the field name. Example:
|
1105
|
+
# `displayName desc`.
|
1106
|
+
# @param [Fixnum] page_size
|
1107
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
1108
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
1109
|
+
# is specified.
|
1110
|
+
# @param [String] page_token
|
1111
|
+
# A token identifying a page of results the server should return.
|
1112
|
+
# Typically, this is the value of
|
1113
|
+
# next_page_token returned
|
1114
|
+
# from the previous call to `ListInsertionOrders` method. If not specified,
|
1115
|
+
# the first page of results will be returned.
|
1116
|
+
# @param [String] fields
|
1117
|
+
# Selector specifying which fields to include in a partial response.
|
1118
|
+
# @param [String] quota_user
|
1119
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1120
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1121
|
+
# @param [Google::Apis::RequestOptions] options
|
1122
|
+
# Request-specific options
|
1123
|
+
#
|
1124
|
+
# @yield [result, err] Result & error if block supplied
|
1125
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListInsertionOrdersResponse] parsed result object
|
1126
|
+
# @yieldparam err [StandardError] error object if request failed
|
1127
|
+
#
|
1128
|
+
# @return [Google::Apis::DisplayvideoV1::ListInsertionOrdersResponse]
|
1129
|
+
#
|
1130
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1131
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1132
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1133
|
+
def list_advertiser_insertion_orders(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1134
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/insertionOrders', options)
|
1135
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListInsertionOrdersResponse::Representation
|
1136
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListInsertionOrdersResponse
|
1137
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1138
|
+
command.query['filter'] = filter unless filter.nil?
|
1139
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
1140
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1141
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1142
|
+
command.query['fields'] = fields unless fields.nil?
|
1143
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1144
|
+
execute_or_queue_command(command, &block)
|
1145
|
+
end
|
1146
|
+
|
1147
|
+
# Updates an existing insertion order.
|
1148
|
+
# Returns the updated insertion order if successful.
|
1149
|
+
# @param [Fixnum] advertiser_id
|
1150
|
+
# Output only. The unique ID of the advertiser the insertion order belongs to.
|
1151
|
+
# @param [Fixnum] insertion_order_id
|
1152
|
+
# Output only. The unique ID of the insertion order. Assigned by the system.
|
1153
|
+
# @param [Google::Apis::DisplayvideoV1::InsertionOrder] insertion_order_object
|
1154
|
+
# @param [String] update_mask
|
1155
|
+
# Required. The mask to control which fields to update.
|
1156
|
+
# @param [String] fields
|
1157
|
+
# Selector specifying which fields to include in a partial response.
|
1158
|
+
# @param [String] quota_user
|
1159
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1160
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1161
|
+
# @param [Google::Apis::RequestOptions] options
|
1162
|
+
# Request-specific options
|
1163
|
+
#
|
1164
|
+
# @yield [result, err] Result & error if block supplied
|
1165
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::InsertionOrder] parsed result object
|
1166
|
+
# @yieldparam err [StandardError] error object if request failed
|
1167
|
+
#
|
1168
|
+
# @return [Google::Apis::DisplayvideoV1::InsertionOrder]
|
1169
|
+
#
|
1170
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1171
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1172
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1173
|
+
def patch_advertiser_insertion_order(advertiser_id, insertion_order_id, insertion_order_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1174
|
+
command = make_simple_command(:patch, 'v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}', options)
|
1175
|
+
command.request_representation = Google::Apis::DisplayvideoV1::InsertionOrder::Representation
|
1176
|
+
command.request_object = insertion_order_object
|
1177
|
+
command.response_representation = Google::Apis::DisplayvideoV1::InsertionOrder::Representation
|
1178
|
+
command.response_class = Google::Apis::DisplayvideoV1::InsertionOrder
|
1179
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1180
|
+
command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
|
1181
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1182
|
+
command.query['fields'] = fields unless fields.nil?
|
1183
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1184
|
+
execute_or_queue_command(command, &block)
|
1185
|
+
end
|
1186
|
+
|
1187
|
+
# Bulk edits targeting options under a single line item.
|
1188
|
+
# The operation will delete the assigned targeting options provided in
|
1189
|
+
# BulkEditLineItemAssignedTargetingOptionsRequest.delete_requests and
|
1190
|
+
# then create the assigned targeting options provided in
|
1191
|
+
# BulkEditLineItemAssignedTargetingOptionsRequest.create_requests .
|
1192
|
+
# @param [Fixnum] advertiser_id
|
1193
|
+
# Required. The ID of the advertiser the line item belongs to.
|
1194
|
+
# @param [Fixnum] line_item_id
|
1195
|
+
# Required. The ID of the line item the assigned targeting option will belong to.
|
1196
|
+
# @param [Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsRequest] bulk_edit_line_item_assigned_targeting_options_request_object
|
1197
|
+
# @param [String] fields
|
1198
|
+
# Selector specifying which fields to include in a partial response.
|
1199
|
+
# @param [String] quota_user
|
1200
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1201
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1202
|
+
# @param [Google::Apis::RequestOptions] options
|
1203
|
+
# Request-specific options
|
1204
|
+
#
|
1205
|
+
# @yield [result, err] Result & error if block supplied
|
1206
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsResponse] parsed result object
|
1207
|
+
# @yieldparam err [StandardError] error object if request failed
|
1208
|
+
#
|
1209
|
+
# @return [Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsResponse]
|
1210
|
+
#
|
1211
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1212
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1213
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1214
|
+
def bulk_edit_line_item_assigned_targeting_options(advertiser_id, line_item_id, bulk_edit_line_item_assigned_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1215
|
+
command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}:bulkEditLineItemAssignedTargetingOptions', options)
|
1216
|
+
command.request_representation = Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsRequest::Representation
|
1217
|
+
command.request_object = bulk_edit_line_item_assigned_targeting_options_request_object
|
1218
|
+
command.response_representation = Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsResponse::Representation
|
1219
|
+
command.response_class = Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsResponse
|
1220
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1221
|
+
command.params['lineItemId'] = line_item_id unless line_item_id.nil?
|
1222
|
+
command.query['fields'] = fields unless fields.nil?
|
1223
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1224
|
+
execute_or_queue_command(command, &block)
|
1225
|
+
end
|
1226
|
+
|
1227
|
+
# Lists assigned targeting options of a line item across targeting types.
|
1228
|
+
# @param [Fixnum] advertiser_id
|
1229
|
+
# Required. The ID of the advertiser the line item belongs to.
|
1230
|
+
# @param [Fixnum] line_item_id
|
1231
|
+
# Required. The ID of the line item to list assigned targeting options for.
|
1232
|
+
# @param [String] filter
|
1233
|
+
# Allows filtering by assigned targeting option properties.
|
1234
|
+
# Supported syntax:
|
1235
|
+
# * Filter expressions are made up of one or more restrictions.
|
1236
|
+
# * Restrictions can be combined by the logical operator `OR` on the same
|
1237
|
+
# field.
|
1238
|
+
# * A restriction has the form of ``field` `operator` `value``.
|
1239
|
+
# * The operator must be `EQUALS (=)`.
|
1240
|
+
# * Supported fields:
|
1241
|
+
# - `targetingType`
|
1242
|
+
# - `inheritance`
|
1243
|
+
# Examples:
|
1244
|
+
# * AssignedTargetingOptions of targeting type
|
1245
|
+
# TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL
|
1246
|
+
# `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR
|
1247
|
+
# targetingType="TARGETING_TYPE_CHANNEL"`
|
1248
|
+
# * AssignedTargetingOptions with inheritance status of NOT_INHERITED or
|
1249
|
+
# INHERITED_FROM_PARTNER
|
1250
|
+
# `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"`
|
1251
|
+
# The length of this field should be no more than 500 characters.
|
1252
|
+
# @param [String] order_by
|
1253
|
+
# Field by which to sort the list.
|
1254
|
+
# Acceptable values are:
|
1255
|
+
# * `targetingType` (default)
|
1256
|
+
# The default sorting order is ascending. To specify descending order for
|
1257
|
+
# a field, a suffix "desc" should be added to the field name. Example:
|
1258
|
+
# `targetingType desc`.
|
1259
|
+
# @param [Fixnum] page_size
|
1260
|
+
# Requested page size.
|
1261
|
+
# The size must be an integer between `1` and `5000`. If unspecified,
|
1262
|
+
# the default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid
|
1263
|
+
# value is specified.
|
1264
|
+
# @param [String] page_token
|
1265
|
+
# A token that lets the client fetch the next page of results.
|
1266
|
+
# Typically, this is the value of
|
1267
|
+
# next_page_token
|
1268
|
+
# returned from the previous call to
|
1269
|
+
# `BulkListLineItemAssignedTargetingOptions` method.
|
1270
|
+
# If not specified, the first page of results will be returned.
|
1271
|
+
# @param [String] fields
|
1272
|
+
# Selector specifying which fields to include in a partial response.
|
1273
|
+
# @param [String] quota_user
|
1274
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1275
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1276
|
+
# @param [Google::Apis::RequestOptions] options
|
1277
|
+
# Request-specific options
|
1278
|
+
#
|
1279
|
+
# @yield [result, err] Result & error if block supplied
|
1280
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::BulkListLineItemAssignedTargetingOptionsResponse] parsed result object
|
1281
|
+
# @yieldparam err [StandardError] error object if request failed
|
1282
|
+
#
|
1283
|
+
# @return [Google::Apis::DisplayvideoV1::BulkListLineItemAssignedTargetingOptionsResponse]
|
1284
|
+
#
|
1285
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1286
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1287
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1288
|
+
def bulk_advertiser_line_item_list_line_item_assigned_targeting_options(advertiser_id, line_item_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1289
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}:bulkListLineItemAssignedTargetingOptions', options)
|
1290
|
+
command.response_representation = Google::Apis::DisplayvideoV1::BulkListLineItemAssignedTargetingOptionsResponse::Representation
|
1291
|
+
command.response_class = Google::Apis::DisplayvideoV1::BulkListLineItemAssignedTargetingOptionsResponse
|
1292
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1293
|
+
command.params['lineItemId'] = line_item_id unless line_item_id.nil?
|
1294
|
+
command.query['filter'] = filter unless filter.nil?
|
1295
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
1296
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1297
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1298
|
+
command.query['fields'] = fields unless fields.nil?
|
1299
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1300
|
+
execute_or_queue_command(command, &block)
|
1301
|
+
end
|
1302
|
+
|
1303
|
+
# Creates a new line item.
|
1304
|
+
# Returns the newly created line item if successful.
|
1305
|
+
# @param [Fixnum] advertiser_id
|
1306
|
+
# Output only. The unique ID of the advertiser the line item belongs to.
|
1307
|
+
# @param [Google::Apis::DisplayvideoV1::LineItem] line_item_object
|
1308
|
+
# @param [String] fields
|
1309
|
+
# Selector specifying which fields to include in a partial response.
|
1310
|
+
# @param [String] quota_user
|
1311
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1312
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1313
|
+
# @param [Google::Apis::RequestOptions] options
|
1314
|
+
# Request-specific options
|
1315
|
+
#
|
1316
|
+
# @yield [result, err] Result & error if block supplied
|
1317
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::LineItem] parsed result object
|
1318
|
+
# @yieldparam err [StandardError] error object if request failed
|
1319
|
+
#
|
1320
|
+
# @return [Google::Apis::DisplayvideoV1::LineItem]
|
1321
|
+
#
|
1322
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1323
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1324
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1325
|
+
def create_advertiser_line_item(advertiser_id, line_item_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1326
|
+
command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/lineItems', options)
|
1327
|
+
command.request_representation = Google::Apis::DisplayvideoV1::LineItem::Representation
|
1328
|
+
command.request_object = line_item_object
|
1329
|
+
command.response_representation = Google::Apis::DisplayvideoV1::LineItem::Representation
|
1330
|
+
command.response_class = Google::Apis::DisplayvideoV1::LineItem
|
1331
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1332
|
+
command.query['fields'] = fields unless fields.nil?
|
1333
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1334
|
+
execute_or_queue_command(command, &block)
|
1335
|
+
end
|
1336
|
+
|
1337
|
+
# Deletes a line item.
|
1338
|
+
# Returns error code `NOT_FOUND` if the line item does not exist.
|
1339
|
+
# The line item should be archived first, i.e. set
|
1340
|
+
# entity_status to `ENTITY_STATUS_ARCHIVED`, to be
|
1341
|
+
# able to delete it.
|
1342
|
+
# @param [Fixnum] advertiser_id
|
1343
|
+
# The ID of the advertiser this line item belongs to.
|
1344
|
+
# @param [Fixnum] line_item_id
|
1345
|
+
# The ID of the line item we need to fetch.
|
1346
|
+
# @param [String] fields
|
1347
|
+
# Selector specifying which fields to include in a partial response.
|
1348
|
+
# @param [String] quota_user
|
1349
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1350
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1351
|
+
# @param [Google::Apis::RequestOptions] options
|
1352
|
+
# Request-specific options
|
1353
|
+
#
|
1354
|
+
# @yield [result, err] Result & error if block supplied
|
1355
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
1356
|
+
# @yieldparam err [StandardError] error object if request failed
|
1357
|
+
#
|
1358
|
+
# @return [Google::Apis::DisplayvideoV1::Empty]
|
1359
|
+
#
|
1360
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1361
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1362
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1363
|
+
def delete_advertiser_line_item(advertiser_id, line_item_id, fields: nil, quota_user: nil, options: nil, &block)
|
1364
|
+
command = make_simple_command(:delete, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}', options)
|
1365
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
1366
|
+
command.response_class = Google::Apis::DisplayvideoV1::Empty
|
1367
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1368
|
+
command.params['lineItemId'] = line_item_id unless line_item_id.nil?
|
1369
|
+
command.query['fields'] = fields unless fields.nil?
|
1370
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1371
|
+
execute_or_queue_command(command, &block)
|
1372
|
+
end
|
1373
|
+
|
1374
|
+
# Gets a line item.
|
1375
|
+
# @param [Fixnum] advertiser_id
|
1376
|
+
# Required. The ID of the advertiser this line item belongs to.
|
1377
|
+
# @param [Fixnum] line_item_id
|
1378
|
+
# Required. The ID of the line item to fetch.
|
1379
|
+
# @param [String] fields
|
1380
|
+
# Selector specifying which fields to include in a partial response.
|
1381
|
+
# @param [String] quota_user
|
1382
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1383
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1384
|
+
# @param [Google::Apis::RequestOptions] options
|
1385
|
+
# Request-specific options
|
1386
|
+
#
|
1387
|
+
# @yield [result, err] Result & error if block supplied
|
1388
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::LineItem] parsed result object
|
1389
|
+
# @yieldparam err [StandardError] error object if request failed
|
1390
|
+
#
|
1391
|
+
# @return [Google::Apis::DisplayvideoV1::LineItem]
|
1392
|
+
#
|
1393
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1394
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1395
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1396
|
+
def get_advertiser_line_item(advertiser_id, line_item_id, fields: nil, quota_user: nil, options: nil, &block)
|
1397
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}', options)
|
1398
|
+
command.response_representation = Google::Apis::DisplayvideoV1::LineItem::Representation
|
1399
|
+
command.response_class = Google::Apis::DisplayvideoV1::LineItem
|
1400
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1401
|
+
command.params['lineItemId'] = line_item_id unless line_item_id.nil?
|
1402
|
+
command.query['fields'] = fields unless fields.nil?
|
1403
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1404
|
+
execute_or_queue_command(command, &block)
|
1405
|
+
end
|
1406
|
+
|
1407
|
+
# Lists line items in an advertiser.
|
1408
|
+
# The order is defined by the order_by
|
1409
|
+
# parameter.
|
1410
|
+
# If a filter by
|
1411
|
+
# entity_status is not specified, line items with
|
1412
|
+
# `ENTITY_STATUS_ARCHIVED` will not be included in the results.
|
1413
|
+
# @param [Fixnum] advertiser_id
|
1414
|
+
# Required. The ID of the advertiser to list line items for.
|
1415
|
+
# @param [String] filter
|
1416
|
+
# Allows filtering by line item properties.
|
1417
|
+
# Supported syntax:
|
1418
|
+
# * Filter expressions are made up of one or more restrictions.
|
1419
|
+
# * Restrictions can be combined by `AND` or `OR` logical operators. A
|
1420
|
+
# sequence of restrictions implicitly uses `AND`.
|
1421
|
+
# * A restriction has the form of ``field` `operator` `value``.
|
1422
|
+
# * The operator must be `EQUALS (=)`.
|
1423
|
+
# * Supported fields:
|
1424
|
+
# - `campaignId`
|
1425
|
+
# - `insertionOrderId`
|
1426
|
+
# - `entityStatus`
|
1427
|
+
# - `lineItemType`.
|
1428
|
+
# Examples:
|
1429
|
+
# * All line items under an insertion order: `insertionOrderId="1234"`
|
1430
|
+
# * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`
|
1431
|
+
# and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser:
|
1432
|
+
# `(entityStatus="ENTITY_STATUS_ACTIVE" OR
|
1433
|
+
# entityStatus="ENTITY_STATUS_PAUSED") AND
|
1434
|
+
# lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"`
|
1435
|
+
# The length of this field should be no more than 500 characters.
|
1436
|
+
# @param [String] order_by
|
1437
|
+
# Field by which to sort the list.
|
1438
|
+
# Acceptable values are:
|
1439
|
+
# * "displayName" (default)
|
1440
|
+
# * "entityStatus"
|
1441
|
+
# The default sorting order is ascending. To specify descending order for
|
1442
|
+
# a field, a suffix "desc" should be added to the field name. Example:
|
1443
|
+
# `displayName desc`.
|
1444
|
+
# @param [Fixnum] page_size
|
1445
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
1446
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
1447
|
+
# is specified.
|
1448
|
+
# @param [String] page_token
|
1449
|
+
# A token identifying a page of results the server should return.
|
1450
|
+
# Typically, this is the value of
|
1451
|
+
# next_page_token
|
1452
|
+
# returned from the previous call to `ListLineItems` method.
|
1453
|
+
# If not specified, the first page of results will be returned.
|
1454
|
+
# @param [String] fields
|
1455
|
+
# Selector specifying which fields to include in a partial response.
|
1456
|
+
# @param [String] quota_user
|
1457
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1458
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1459
|
+
# @param [Google::Apis::RequestOptions] options
|
1460
|
+
# Request-specific options
|
1461
|
+
#
|
1462
|
+
# @yield [result, err] Result & error if block supplied
|
1463
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListLineItemsResponse] parsed result object
|
1464
|
+
# @yieldparam err [StandardError] error object if request failed
|
1465
|
+
#
|
1466
|
+
# @return [Google::Apis::DisplayvideoV1::ListLineItemsResponse]
|
1467
|
+
#
|
1468
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1469
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1470
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1471
|
+
def list_advertiser_line_items(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1472
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/lineItems', options)
|
1473
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListLineItemsResponse::Representation
|
1474
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListLineItemsResponse
|
1475
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1476
|
+
command.query['filter'] = filter unless filter.nil?
|
1477
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
1478
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1479
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1480
|
+
command.query['fields'] = fields unless fields.nil?
|
1481
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1482
|
+
execute_or_queue_command(command, &block)
|
1483
|
+
end
|
1484
|
+
|
1485
|
+
# Updates an existing line item.
|
1486
|
+
# Returns the updated line item if successful.
|
1487
|
+
# @param [Fixnum] advertiser_id
|
1488
|
+
# Output only. The unique ID of the advertiser the line item belongs to.
|
1489
|
+
# @param [Fixnum] line_item_id
|
1490
|
+
# Output only. The unique ID of the line item. Assigned by the system.
|
1491
|
+
# @param [Google::Apis::DisplayvideoV1::LineItem] line_item_object
|
1492
|
+
# @param [String] update_mask
|
1493
|
+
# Required. The mask to control which fields to update.
|
1494
|
+
# @param [String] fields
|
1495
|
+
# Selector specifying which fields to include in a partial response.
|
1496
|
+
# @param [String] quota_user
|
1497
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1498
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1499
|
+
# @param [Google::Apis::RequestOptions] options
|
1500
|
+
# Request-specific options
|
1501
|
+
#
|
1502
|
+
# @yield [result, err] Result & error if block supplied
|
1503
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::LineItem] parsed result object
|
1504
|
+
# @yieldparam err [StandardError] error object if request failed
|
1505
|
+
#
|
1506
|
+
# @return [Google::Apis::DisplayvideoV1::LineItem]
|
1507
|
+
#
|
1508
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1509
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1510
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1511
|
+
def patch_advertiser_line_item(advertiser_id, line_item_id, line_item_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1512
|
+
command = make_simple_command(:patch, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}', options)
|
1513
|
+
command.request_representation = Google::Apis::DisplayvideoV1::LineItem::Representation
|
1514
|
+
command.request_object = line_item_object
|
1515
|
+
command.response_representation = Google::Apis::DisplayvideoV1::LineItem::Representation
|
1516
|
+
command.response_class = Google::Apis::DisplayvideoV1::LineItem
|
1517
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1518
|
+
command.params['lineItemId'] = line_item_id unless line_item_id.nil?
|
1519
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1520
|
+
command.query['fields'] = fields unless fields.nil?
|
1521
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1522
|
+
execute_or_queue_command(command, &block)
|
1523
|
+
end
|
1524
|
+
|
1525
|
+
# Assigns a targeting option to a line item.
|
1526
|
+
# Returns the assigned targeting option if successful.
|
1527
|
+
# @param [Fixnum] advertiser_id
|
1528
|
+
# Required. The ID of the advertiser the line item belongs to.
|
1529
|
+
# @param [Fixnum] line_item_id
|
1530
|
+
# Required. The ID of the line item the assigned targeting option will belong to.
|
1531
|
+
# @param [String] targeting_type
|
1532
|
+
# Required. Identifies the type of this assigned targeting option.
|
1533
|
+
# @param [Google::Apis::DisplayvideoV1::AssignedTargetingOption] assigned_targeting_option_object
|
1534
|
+
# @param [String] fields
|
1535
|
+
# Selector specifying which fields to include in a partial response.
|
1536
|
+
# @param [String] quota_user
|
1537
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1538
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1539
|
+
# @param [Google::Apis::RequestOptions] options
|
1540
|
+
# Request-specific options
|
1541
|
+
#
|
1542
|
+
# @yield [result, err] Result & error if block supplied
|
1543
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::AssignedTargetingOption] parsed result object
|
1544
|
+
# @yieldparam err [StandardError] error object if request failed
|
1545
|
+
#
|
1546
|
+
# @return [Google::Apis::DisplayvideoV1::AssignedTargetingOption]
|
1547
|
+
#
|
1548
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1549
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1550
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1551
|
+
def create_advertiser_line_item_targeting_type_assigned_targeting_option(advertiser_id, line_item_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1552
|
+
command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
|
1553
|
+
command.request_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
1554
|
+
command.request_object = assigned_targeting_option_object
|
1555
|
+
command.response_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
1556
|
+
command.response_class = Google::Apis::DisplayvideoV1::AssignedTargetingOption
|
1557
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1558
|
+
command.params['lineItemId'] = line_item_id unless line_item_id.nil?
|
1559
|
+
command.params['targetingType'] = targeting_type unless targeting_type.nil?
|
1560
|
+
command.query['fields'] = fields unless fields.nil?
|
1561
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1562
|
+
execute_or_queue_command(command, &block)
|
1563
|
+
end
|
1564
|
+
|
1565
|
+
# Deletes an assigned targeting option from a line item.
|
1566
|
+
# @param [Fixnum] advertiser_id
|
1567
|
+
# Required. The ID of the advertiser the line item belongs to.
|
1568
|
+
# @param [Fixnum] line_item_id
|
1569
|
+
# Required. The ID of the line item the assigned targeting option belongs to.
|
1570
|
+
# @param [String] targeting_type
|
1571
|
+
# Required. Identifies the type of this assigned targeting option.
|
1572
|
+
# @param [String] assigned_targeting_option_id
|
1573
|
+
# Required. The ID of the assigned targeting option to delete.
|
1574
|
+
# @param [String] fields
|
1575
|
+
# Selector specifying which fields to include in a partial response.
|
1576
|
+
# @param [String] quota_user
|
1577
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1578
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1579
|
+
# @param [Google::Apis::RequestOptions] options
|
1580
|
+
# Request-specific options
|
1581
|
+
#
|
1582
|
+
# @yield [result, err] Result & error if block supplied
|
1583
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
1584
|
+
# @yieldparam err [StandardError] error object if request failed
|
1585
|
+
#
|
1586
|
+
# @return [Google::Apis::DisplayvideoV1::Empty]
|
1587
|
+
#
|
1588
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1589
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1590
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1591
|
+
def delete_advertiser_line_item_targeting_type_assigned_targeting_option(advertiser_id, line_item_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
|
1592
|
+
command = make_simple_command(:delete, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
|
1593
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
1594
|
+
command.response_class = Google::Apis::DisplayvideoV1::Empty
|
1595
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1596
|
+
command.params['lineItemId'] = line_item_id unless line_item_id.nil?
|
1597
|
+
command.params['targetingType'] = targeting_type unless targeting_type.nil?
|
1598
|
+
command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
|
1599
|
+
command.query['fields'] = fields unless fields.nil?
|
1600
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1601
|
+
execute_or_queue_command(command, &block)
|
1602
|
+
end
|
1603
|
+
|
1604
|
+
# Gets a single targeting option assigned to a line item.
|
1605
|
+
# @param [Fixnum] advertiser_id
|
1606
|
+
# Required. The ID of the advertiser the line item belongs to.
|
1607
|
+
# @param [Fixnum] line_item_id
|
1608
|
+
# Required. The ID of the line item the assigned targeting option belongs to.
|
1609
|
+
# @param [String] targeting_type
|
1610
|
+
# Required. Identifies the type of this assigned targeting option.
|
1611
|
+
# @param [String] assigned_targeting_option_id
|
1612
|
+
# Required. An identifier unique to the targeting type in this line item that
|
1613
|
+
# identifies the assigned targeting option being requested.
|
1614
|
+
# @param [String] fields
|
1615
|
+
# Selector specifying which fields to include in a partial response.
|
1616
|
+
# @param [String] quota_user
|
1617
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1618
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1619
|
+
# @param [Google::Apis::RequestOptions] options
|
1620
|
+
# Request-specific options
|
1621
|
+
#
|
1622
|
+
# @yield [result, err] Result & error if block supplied
|
1623
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::AssignedTargetingOption] parsed result object
|
1624
|
+
# @yieldparam err [StandardError] error object if request failed
|
1625
|
+
#
|
1626
|
+
# @return [Google::Apis::DisplayvideoV1::AssignedTargetingOption]
|
1627
|
+
#
|
1628
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1629
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1630
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1631
|
+
def get_advertiser_line_item_targeting_type_assigned_targeting_option(advertiser_id, line_item_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
|
1632
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
|
1633
|
+
command.response_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
1634
|
+
command.response_class = Google::Apis::DisplayvideoV1::AssignedTargetingOption
|
1635
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1636
|
+
command.params['lineItemId'] = line_item_id unless line_item_id.nil?
|
1637
|
+
command.params['targetingType'] = targeting_type unless targeting_type.nil?
|
1638
|
+
command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
|
1639
|
+
command.query['fields'] = fields unless fields.nil?
|
1640
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1641
|
+
execute_or_queue_command(command, &block)
|
1642
|
+
end
|
1643
|
+
|
1644
|
+
# Lists the targeting options assigned to a line item.
|
1645
|
+
# @param [Fixnum] advertiser_id
|
1646
|
+
# Required. The ID of the advertiser the line item belongs to.
|
1647
|
+
# @param [Fixnum] line_item_id
|
1648
|
+
# Required. The ID of the line item to list assigned targeting options for.
|
1649
|
+
# @param [String] targeting_type
|
1650
|
+
# Required. Identifies the type of assigned targeting options to list.
|
1651
|
+
# @param [String] filter
|
1652
|
+
# Allows filtering by assigned targeting option properties.
|
1653
|
+
# Supported syntax:
|
1654
|
+
# * Filter expressions are made up of one or more restrictions.
|
1655
|
+
# * Restrictions can be combined by the logical operator `OR`.
|
1656
|
+
# * A restriction has the form of ``field` `operator` `value``.
|
1657
|
+
# * The operator must be `EQUALS (=)`.
|
1658
|
+
# * Supported fields:
|
1659
|
+
# - `assignedTargetingOptionId`
|
1660
|
+
# - `inheritance`
|
1661
|
+
# Examples:
|
1662
|
+
# * AssignedTargetingOptions with ID 1 or 2
|
1663
|
+
# `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"`
|
1664
|
+
# * AssignedTargetingOptions with inheritance status of NOT_INHERITED or
|
1665
|
+
# INHERITED_FROM_PARTNER
|
1666
|
+
# `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"`
|
1667
|
+
# The length of this field should be no more than 500 characters.
|
1668
|
+
# @param [String] order_by
|
1669
|
+
# Field by which to sort the list.
|
1670
|
+
# Acceptable values are:
|
1671
|
+
# * `assignedTargetingOptionId` (default)
|
1672
|
+
# The default sorting order is ascending. To specify descending order for
|
1673
|
+
# a field, a suffix "desc" should be added to the field name. Example:
|
1674
|
+
# `assignedTargetingOptionId desc`.
|
1675
|
+
# @param [Fixnum] page_size
|
1676
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
1677
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
1678
|
+
# is specified.
|
1679
|
+
# @param [String] page_token
|
1680
|
+
# A token identifying a page of results the server should return.
|
1681
|
+
# Typically, this is the value of
|
1682
|
+
# next_page_token
|
1683
|
+
# returned from the previous call to `ListLineItemAssignedTargetingOptions`
|
1684
|
+
# method. If not specified, the first page of results will be returned.
|
1685
|
+
# @param [String] fields
|
1686
|
+
# Selector specifying which fields to include in a partial response.
|
1687
|
+
# @param [String] quota_user
|
1688
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1689
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1690
|
+
# @param [Google::Apis::RequestOptions] options
|
1691
|
+
# Request-specific options
|
1692
|
+
#
|
1693
|
+
# @yield [result, err] Result & error if block supplied
|
1694
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListLineItemAssignedTargetingOptionsResponse] parsed result object
|
1695
|
+
# @yieldparam err [StandardError] error object if request failed
|
1696
|
+
#
|
1697
|
+
# @return [Google::Apis::DisplayvideoV1::ListLineItemAssignedTargetingOptionsResponse]
|
1698
|
+
#
|
1699
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1700
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1701
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1702
|
+
def list_advertiser_line_item_targeting_type_assigned_targeting_options(advertiser_id, line_item_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1703
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
|
1704
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListLineItemAssignedTargetingOptionsResponse::Representation
|
1705
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListLineItemAssignedTargetingOptionsResponse
|
1706
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1707
|
+
command.params['lineItemId'] = line_item_id unless line_item_id.nil?
|
1708
|
+
command.params['targetingType'] = targeting_type unless targeting_type.nil?
|
1709
|
+
command.query['filter'] = filter unless filter.nil?
|
1710
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
1711
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1712
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1713
|
+
command.query['fields'] = fields unless fields.nil?
|
1714
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1715
|
+
execute_or_queue_command(command, &block)
|
1716
|
+
end
|
1717
|
+
|
1718
|
+
# Gets a location list.
|
1719
|
+
# @param [Fixnum] advertiser_id
|
1720
|
+
# Required. The ID of the DV360 advertiser to which the fetched location list
|
1721
|
+
# belongs.
|
1722
|
+
# @param [Fixnum] location_list_id
|
1723
|
+
# Required. The ID of the location list to fetch.
|
1724
|
+
# @param [String] fields
|
1725
|
+
# Selector specifying which fields to include in a partial response.
|
1726
|
+
# @param [String] quota_user
|
1727
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1728
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1729
|
+
# @param [Google::Apis::RequestOptions] options
|
1730
|
+
# Request-specific options
|
1731
|
+
#
|
1732
|
+
# @yield [result, err] Result & error if block supplied
|
1733
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::LocationList] parsed result object
|
1734
|
+
# @yieldparam err [StandardError] error object if request failed
|
1735
|
+
#
|
1736
|
+
# @return [Google::Apis::DisplayvideoV1::LocationList]
|
1737
|
+
#
|
1738
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1739
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1740
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1741
|
+
def get_advertiser_location_list(advertiser_id, location_list_id, fields: nil, quota_user: nil, options: nil, &block)
|
1742
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/locationLists/{+locationListId}', options)
|
1743
|
+
command.response_representation = Google::Apis::DisplayvideoV1::LocationList::Representation
|
1744
|
+
command.response_class = Google::Apis::DisplayvideoV1::LocationList
|
1745
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1746
|
+
command.params['locationListId'] = location_list_id unless location_list_id.nil?
|
1747
|
+
command.query['fields'] = fields unless fields.nil?
|
1748
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1749
|
+
execute_or_queue_command(command, &block)
|
1750
|
+
end
|
1751
|
+
|
1752
|
+
# Lists location lists based on a given advertiser id.
|
1753
|
+
# @param [Fixnum] advertiser_id
|
1754
|
+
# Required. The ID of the DV360 advertiser to which the fetched location lists
|
1755
|
+
# belong.
|
1756
|
+
# @param [String] filter
|
1757
|
+
# Allows filtering by location list fields.
|
1758
|
+
# Supported syntax:
|
1759
|
+
# * Filter expressions are made up of one or more restrictions.
|
1760
|
+
# * Restrictions can be combined by `AND` or `OR` logical operators. A
|
1761
|
+
# sequence of restrictions implicitly uses `AND`.
|
1762
|
+
# * A restriction has the form of ``field` `operator` `value``.
|
1763
|
+
# * The operator must be `EQUALS (=)`.
|
1764
|
+
# * Supported fields:
|
1765
|
+
# - `locationType`
|
1766
|
+
# Examples:
|
1767
|
+
# * All regional location list:
|
1768
|
+
# `locationType="TARGETING_LOCATION_TYPE_REGIONAL"`
|
1769
|
+
# * All proximity location list:
|
1770
|
+
# `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"`
|
1771
|
+
# @param [String] order_by
|
1772
|
+
# Field by which to sort the list.
|
1773
|
+
# Acceptable values are:
|
1774
|
+
# * `locationListId` (default)
|
1775
|
+
# * `displayName`
|
1776
|
+
# The default sorting order is ascending. To specify descending order for
|
1777
|
+
# a field, a suffix "desc" should be added to the field name. Example:
|
1778
|
+
# `displayName desc`.
|
1779
|
+
# @param [Fixnum] page_size
|
1780
|
+
# Requested page size. Must be between `1` and `100`.
|
1781
|
+
# Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an
|
1782
|
+
# invalid value is specified.
|
1783
|
+
# @param [String] page_token
|
1784
|
+
# A token identifying a page of results the server should return.
|
1785
|
+
# Typically, this is the value of
|
1786
|
+
# next_page_token
|
1787
|
+
# returned from the previous call to `ListLocationLists` method.
|
1788
|
+
# If not specified, the first page of results will be returned.
|
1789
|
+
# @param [String] fields
|
1790
|
+
# Selector specifying which fields to include in a partial response.
|
1791
|
+
# @param [String] quota_user
|
1792
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1793
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1794
|
+
# @param [Google::Apis::RequestOptions] options
|
1795
|
+
# Request-specific options
|
1796
|
+
#
|
1797
|
+
# @yield [result, err] Result & error if block supplied
|
1798
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListLocationListsResponse] parsed result object
|
1799
|
+
# @yieldparam err [StandardError] error object if request failed
|
1800
|
+
#
|
1801
|
+
# @return [Google::Apis::DisplayvideoV1::ListLocationListsResponse]
|
1802
|
+
#
|
1803
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1804
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1805
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1806
|
+
def list_advertiser_location_lists(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1807
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/locationLists', options)
|
1808
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListLocationListsResponse::Representation
|
1809
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListLocationListsResponse
|
1810
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1811
|
+
command.query['filter'] = filter unless filter.nil?
|
1812
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
1813
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1814
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1815
|
+
command.query['fields'] = fields unless fields.nil?
|
1816
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1817
|
+
execute_or_queue_command(command, &block)
|
1818
|
+
end
|
1819
|
+
|
1820
|
+
# Gets a negative keyword list given an advertiser ID and a negative keyword
|
1821
|
+
# list ID.
|
1822
|
+
# @param [Fixnum] advertiser_id
|
1823
|
+
# Required. The ID of the DV360 advertiser to which the fetched negative keyword
|
1824
|
+
# list
|
1825
|
+
# belongs.
|
1826
|
+
# @param [Fixnum] negative_keyword_list_id
|
1827
|
+
# Required. The ID of the negative keyword list to fetch.
|
1828
|
+
# @param [String] fields
|
1829
|
+
# Selector specifying which fields to include in a partial response.
|
1830
|
+
# @param [String] quota_user
|
1831
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1832
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1833
|
+
# @param [Google::Apis::RequestOptions] options
|
1834
|
+
# Request-specific options
|
1835
|
+
#
|
1836
|
+
# @yield [result, err] Result & error if block supplied
|
1837
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::NegativeKeywordList] parsed result object
|
1838
|
+
# @yieldparam err [StandardError] error object if request failed
|
1839
|
+
#
|
1840
|
+
# @return [Google::Apis::DisplayvideoV1::NegativeKeywordList]
|
1841
|
+
#
|
1842
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1843
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1844
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1845
|
+
def get_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_id, fields: nil, quota_user: nil, options: nil, &block)
|
1846
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}', options)
|
1847
|
+
command.response_representation = Google::Apis::DisplayvideoV1::NegativeKeywordList::Representation
|
1848
|
+
command.response_class = Google::Apis::DisplayvideoV1::NegativeKeywordList
|
1849
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1850
|
+
command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
|
1851
|
+
command.query['fields'] = fields unless fields.nil?
|
1852
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1853
|
+
execute_or_queue_command(command, &block)
|
1854
|
+
end
|
1855
|
+
|
1856
|
+
# Lists negative keyword lists based on a given advertiser id.
|
1857
|
+
# @param [Fixnum] advertiser_id
|
1858
|
+
# Required. The ID of the DV360 advertiser to which the fetched negative keyword
|
1859
|
+
# lists
|
1860
|
+
# belong.
|
1861
|
+
# @param [Fixnum] page_size
|
1862
|
+
# Requested page size. Must be between `1` and `100`.
|
1863
|
+
# Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an
|
1864
|
+
# invalid value is specified.
|
1865
|
+
# @param [String] page_token
|
1866
|
+
# A token identifying a page of results the server should return.
|
1867
|
+
# Typically, this is the value of
|
1868
|
+
# next_page_token
|
1869
|
+
# returned from the previous call to `ListNegativeKeywordLists` method.
|
1870
|
+
# If not specified, the first page of results will be returned.
|
1871
|
+
# @param [String] fields
|
1872
|
+
# Selector specifying which fields to include in a partial response.
|
1873
|
+
# @param [String] quota_user
|
1874
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1875
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1876
|
+
# @param [Google::Apis::RequestOptions] options
|
1877
|
+
# Request-specific options
|
1878
|
+
#
|
1879
|
+
# @yield [result, err] Result & error if block supplied
|
1880
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListNegativeKeywordListsResponse] parsed result object
|
1881
|
+
# @yieldparam err [StandardError] error object if request failed
|
1882
|
+
#
|
1883
|
+
# @return [Google::Apis::DisplayvideoV1::ListNegativeKeywordListsResponse]
|
1884
|
+
#
|
1885
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1886
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1887
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1888
|
+
def list_advertiser_negative_keyword_lists(advertiser_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1889
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/negativeKeywordLists', options)
|
1890
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListNegativeKeywordListsResponse::Representation
|
1891
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListNegativeKeywordListsResponse
|
1892
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1893
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1894
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1895
|
+
command.query['fields'] = fields unless fields.nil?
|
1896
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1897
|
+
execute_or_queue_command(command, &block)
|
1898
|
+
end
|
1899
|
+
|
1900
|
+
# Assigns a targeting option to an advertiser.
|
1901
|
+
# Returns the assigned targeting option if successful.
|
1902
|
+
# @param [Fixnum] advertiser_id
|
1903
|
+
# Required. The ID of the advertiser.
|
1904
|
+
# @param [String] targeting_type
|
1905
|
+
# Required. Identifies the type of this assigned targeting option.
|
1906
|
+
# @param [Google::Apis::DisplayvideoV1::AssignedTargetingOption] assigned_targeting_option_object
|
1907
|
+
# @param [String] fields
|
1908
|
+
# Selector specifying which fields to include in a partial response.
|
1909
|
+
# @param [String] quota_user
|
1910
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1911
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1912
|
+
# @param [Google::Apis::RequestOptions] options
|
1913
|
+
# Request-specific options
|
1914
|
+
#
|
1915
|
+
# @yield [result, err] Result & error if block supplied
|
1916
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::AssignedTargetingOption] parsed result object
|
1917
|
+
# @yieldparam err [StandardError] error object if request failed
|
1918
|
+
#
|
1919
|
+
# @return [Google::Apis::DisplayvideoV1::AssignedTargetingOption]
|
1920
|
+
#
|
1921
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1922
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1923
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1924
|
+
def create_advertiser_targeting_type_assigned_targeting_option(advertiser_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1925
|
+
command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
|
1926
|
+
command.request_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
1927
|
+
command.request_object = assigned_targeting_option_object
|
1928
|
+
command.response_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
1929
|
+
command.response_class = Google::Apis::DisplayvideoV1::AssignedTargetingOption
|
1930
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1931
|
+
command.params['targetingType'] = targeting_type unless targeting_type.nil?
|
1932
|
+
command.query['fields'] = fields unless fields.nil?
|
1933
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1934
|
+
execute_or_queue_command(command, &block)
|
1935
|
+
end
|
1936
|
+
|
1937
|
+
# Deletes an assigned targeting option from an advertiser.
|
1938
|
+
# @param [Fixnum] advertiser_id
|
1939
|
+
# Required. The ID of the advertiser.
|
1940
|
+
# @param [String] targeting_type
|
1941
|
+
# Required. Identifies the type of this assigned targeting option.
|
1942
|
+
# @param [String] assigned_targeting_option_id
|
1943
|
+
# Required. The ID of the assigned targeting option to delete.
|
1944
|
+
# @param [String] fields
|
1945
|
+
# Selector specifying which fields to include in a partial response.
|
1946
|
+
# @param [String] quota_user
|
1947
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1948
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1949
|
+
# @param [Google::Apis::RequestOptions] options
|
1950
|
+
# Request-specific options
|
1951
|
+
#
|
1952
|
+
# @yield [result, err] Result & error if block supplied
|
1953
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
1954
|
+
# @yieldparam err [StandardError] error object if request failed
|
1955
|
+
#
|
1956
|
+
# @return [Google::Apis::DisplayvideoV1::Empty]
|
1957
|
+
#
|
1958
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1959
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1960
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1961
|
+
def delete_advertiser_targeting_type_assigned_targeting_option(advertiser_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
|
1962
|
+
command = make_simple_command(:delete, 'v1/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
|
1963
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
1964
|
+
command.response_class = Google::Apis::DisplayvideoV1::Empty
|
1965
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1966
|
+
command.params['targetingType'] = targeting_type unless targeting_type.nil?
|
1967
|
+
command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
|
1968
|
+
command.query['fields'] = fields unless fields.nil?
|
1969
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1970
|
+
execute_or_queue_command(command, &block)
|
1971
|
+
end
|
1972
|
+
|
1973
|
+
# Gets a single targeting option assigned to an advertiser.
|
1974
|
+
# @param [Fixnum] advertiser_id
|
1975
|
+
# Required. The ID of the advertiser.
|
1976
|
+
# @param [String] targeting_type
|
1977
|
+
# Required. Identifies the type of this assigned targeting option.
|
1978
|
+
# @param [String] assigned_targeting_option_id
|
1979
|
+
# Required. An identifier unique to the targeting type in this advertiser that
|
1980
|
+
# identifies the assigned targeting option being requested.
|
1981
|
+
# @param [String] fields
|
1982
|
+
# Selector specifying which fields to include in a partial response.
|
1983
|
+
# @param [String] quota_user
|
1984
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1985
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1986
|
+
# @param [Google::Apis::RequestOptions] options
|
1987
|
+
# Request-specific options
|
1988
|
+
#
|
1989
|
+
# @yield [result, err] Result & error if block supplied
|
1990
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::AssignedTargetingOption] parsed result object
|
1991
|
+
# @yieldparam err [StandardError] error object if request failed
|
1992
|
+
#
|
1993
|
+
# @return [Google::Apis::DisplayvideoV1::AssignedTargetingOption]
|
1994
|
+
#
|
1995
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1996
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1997
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1998
|
+
def get_advertiser_targeting_type_assigned_targeting_option(advertiser_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
|
1999
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
|
2000
|
+
command.response_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
2001
|
+
command.response_class = Google::Apis::DisplayvideoV1::AssignedTargetingOption
|
2002
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
2003
|
+
command.params['targetingType'] = targeting_type unless targeting_type.nil?
|
2004
|
+
command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
|
2005
|
+
command.query['fields'] = fields unless fields.nil?
|
2006
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2007
|
+
execute_or_queue_command(command, &block)
|
2008
|
+
end
|
2009
|
+
|
2010
|
+
# Lists the targeting options assigned to an advertiser.
|
2011
|
+
# @param [Fixnum] advertiser_id
|
2012
|
+
# Required. The ID of the advertiser.
|
2013
|
+
# @param [String] targeting_type
|
2014
|
+
# Required. Identifies the type of assigned targeting options to list.
|
2015
|
+
# @param [String] filter
|
2016
|
+
# Allows filtering by assigned targeting option properties.
|
2017
|
+
# Supported syntax:
|
2018
|
+
# * Filter expressions are made up of one or more restrictions.
|
2019
|
+
# * Restrictions can be combined by the logical operator `OR`.
|
2020
|
+
# * A restriction has the form of ``field` `operator` `value``.
|
2021
|
+
# * The operator must be `EQUALS (=)`.
|
2022
|
+
# * Supported fields:
|
2023
|
+
# - `assignedTargetingOptionId`
|
2024
|
+
# Examples:
|
2025
|
+
# * AssignedTargetingOption with ID 123456
|
2026
|
+
# `assignedTargetingOptionId="123456"`
|
2027
|
+
# The length of this field should be no more than 500 characters.
|
2028
|
+
# @param [String] order_by
|
2029
|
+
# Field by which to sort the list.
|
2030
|
+
# Acceptable values are:
|
2031
|
+
# * `assignedTargetingOptionId` (default)
|
2032
|
+
# The default sorting order is ascending. To specify descending order for
|
2033
|
+
# a field, a suffix "desc" should be added to the field name. Example:
|
2034
|
+
# `assignedTargetingOptionId desc`.
|
2035
|
+
# @param [Fixnum] page_size
|
2036
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
2037
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
2038
|
+
# is specified.
|
2039
|
+
# @param [String] page_token
|
2040
|
+
# A token identifying a page of results the server should return.
|
2041
|
+
# Typically, this is the value of
|
2042
|
+
# next_page_token
|
2043
|
+
# returned from the previous call to `ListAdvertiserAssignedTargetingOptions`
|
2044
|
+
# method. If not specified, the first page of results will be returned.
|
2045
|
+
# @param [String] fields
|
2046
|
+
# Selector specifying which fields to include in a partial response.
|
2047
|
+
# @param [String] quota_user
|
2048
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2049
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2050
|
+
# @param [Google::Apis::RequestOptions] options
|
2051
|
+
# Request-specific options
|
2052
|
+
#
|
2053
|
+
# @yield [result, err] Result & error if block supplied
|
2054
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListAdvertiserAssignedTargetingOptionsResponse] parsed result object
|
2055
|
+
# @yieldparam err [StandardError] error object if request failed
|
2056
|
+
#
|
2057
|
+
# @return [Google::Apis::DisplayvideoV1::ListAdvertiserAssignedTargetingOptionsResponse]
|
2058
|
+
#
|
2059
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2060
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2061
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2062
|
+
def list_advertiser_targeting_type_assigned_targeting_options(advertiser_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2063
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
|
2064
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListAdvertiserAssignedTargetingOptionsResponse::Representation
|
2065
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListAdvertiserAssignedTargetingOptionsResponse
|
2066
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
2067
|
+
command.params['targetingType'] = targeting_type unless targeting_type.nil?
|
2068
|
+
command.query['filter'] = filter unless filter.nil?
|
2069
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
2070
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
2071
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
2072
|
+
command.query['fields'] = fields unless fields.nil?
|
2073
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2074
|
+
execute_or_queue_command(command, &block)
|
2075
|
+
end
|
2076
|
+
|
2077
|
+
# Gets a combined audience.
|
2078
|
+
# @param [Fixnum] combined_audience_id
|
2079
|
+
# Required. The ID of the combined audience to fetch.
|
2080
|
+
# @param [Fixnum] advertiser_id
|
2081
|
+
# The ID of the advertiser that has access to the fetched combined
|
2082
|
+
# audience.
|
2083
|
+
# @param [Fixnum] partner_id
|
2084
|
+
# The ID of the partner that has access to the fetched combined audience.
|
2085
|
+
# @param [String] fields
|
2086
|
+
# Selector specifying which fields to include in a partial response.
|
2087
|
+
# @param [String] quota_user
|
2088
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2089
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2090
|
+
# @param [Google::Apis::RequestOptions] options
|
2091
|
+
# Request-specific options
|
2092
|
+
#
|
2093
|
+
# @yield [result, err] Result & error if block supplied
|
2094
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::CombinedAudience] parsed result object
|
2095
|
+
# @yieldparam err [StandardError] error object if request failed
|
2096
|
+
#
|
2097
|
+
# @return [Google::Apis::DisplayvideoV1::CombinedAudience]
|
2098
|
+
#
|
2099
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2100
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2101
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2102
|
+
def get_combined_audience(combined_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2103
|
+
command = make_simple_command(:get, 'v1/combinedAudiences/{+combinedAudienceId}', options)
|
2104
|
+
command.response_representation = Google::Apis::DisplayvideoV1::CombinedAudience::Representation
|
2105
|
+
command.response_class = Google::Apis::DisplayvideoV1::CombinedAudience
|
2106
|
+
command.params['combinedAudienceId'] = combined_audience_id unless combined_audience_id.nil?
|
2107
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
2108
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
2109
|
+
command.query['fields'] = fields unless fields.nil?
|
2110
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2111
|
+
execute_or_queue_command(command, &block)
|
2112
|
+
end
|
2113
|
+
|
2114
|
+
# Lists combined audiences.
|
2115
|
+
# The order is defined by the
|
2116
|
+
# order_by parameter.
|
2117
|
+
# @param [Fixnum] advertiser_id
|
2118
|
+
# The ID of the advertiser that has access to the fetched combined
|
2119
|
+
# audiences.
|
2120
|
+
# @param [String] filter
|
2121
|
+
# Allows filtering by combined audience fields.
|
2122
|
+
# Supported syntax:
|
2123
|
+
# * Filter expressions for combined audiences currently can only contain at
|
2124
|
+
# most one restriction.
|
2125
|
+
# * A restriction has the form of ``field` `operator` `value``.
|
2126
|
+
# * The operator must be `CONTAINS (:)`.
|
2127
|
+
# * Supported fields:
|
2128
|
+
# - `displayName`
|
2129
|
+
# Examples:
|
2130
|
+
# * All combined audiences for which the display name contains "Google":
|
2131
|
+
# `displayName : "Google"`.
|
2132
|
+
# The length of this field should be no more than 500 characters.
|
2133
|
+
# @param [String] order_by
|
2134
|
+
# Field by which to sort the list.
|
2135
|
+
# Acceptable values are:
|
2136
|
+
# * `combinedAudienceId` (default)
|
2137
|
+
# * `displayName`
|
2138
|
+
# The default sorting order is ascending. To specify descending order for
|
2139
|
+
# a field, a suffix "desc" should be added to the field name. Example:
|
2140
|
+
# `displayName desc`.
|
2141
|
+
# @param [Fixnum] page_size
|
2142
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
2143
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
2144
|
+
# is specified.
|
2145
|
+
# @param [String] page_token
|
2146
|
+
# A token identifying a page of results the server should return.
|
2147
|
+
# Typically, this is the value of
|
2148
|
+
# next_page_token
|
2149
|
+
# returned from the previous call to `ListCombinedAudiences` method.
|
2150
|
+
# If not specified, the first page of results will be returned.
|
2151
|
+
# @param [Fixnum] partner_id
|
2152
|
+
# The ID of the partner that has access to the fetched combined audiences.
|
2153
|
+
# @param [String] fields
|
2154
|
+
# Selector specifying which fields to include in a partial response.
|
2155
|
+
# @param [String] quota_user
|
2156
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2157
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2158
|
+
# @param [Google::Apis::RequestOptions] options
|
2159
|
+
# Request-specific options
|
2160
|
+
#
|
2161
|
+
# @yield [result, err] Result & error if block supplied
|
2162
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListCombinedAudiencesResponse] parsed result object
|
2163
|
+
# @yieldparam err [StandardError] error object if request failed
|
2164
|
+
#
|
2165
|
+
# @return [Google::Apis::DisplayvideoV1::ListCombinedAudiencesResponse]
|
2166
|
+
#
|
2167
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2168
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2169
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2170
|
+
def list_combined_audiences(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2171
|
+
command = make_simple_command(:get, 'v1/combinedAudiences', options)
|
2172
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListCombinedAudiencesResponse::Representation
|
2173
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListCombinedAudiencesResponse
|
2174
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
2175
|
+
command.query['filter'] = filter unless filter.nil?
|
2176
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
2177
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
2178
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
2179
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
2180
|
+
command.query['fields'] = fields unless fields.nil?
|
2181
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2182
|
+
execute_or_queue_command(command, &block)
|
2183
|
+
end
|
2184
|
+
|
2185
|
+
# Gets a custom list.
|
2186
|
+
# @param [Fixnum] custom_list_id
|
2187
|
+
# Required. The ID of the custom list to fetch.
|
2188
|
+
# @param [Fixnum] advertiser_id
|
2189
|
+
# The ID of the DV360 advertiser that has access to the fetched custom
|
2190
|
+
# lists.
|
2191
|
+
# @param [String] fields
|
2192
|
+
# Selector specifying which fields to include in a partial response.
|
2193
|
+
# @param [String] quota_user
|
2194
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2195
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2196
|
+
# @param [Google::Apis::RequestOptions] options
|
2197
|
+
# Request-specific options
|
2198
|
+
#
|
2199
|
+
# @yield [result, err] Result & error if block supplied
|
2200
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::CustomList] parsed result object
|
2201
|
+
# @yieldparam err [StandardError] error object if request failed
|
2202
|
+
#
|
2203
|
+
# @return [Google::Apis::DisplayvideoV1::CustomList]
|
2204
|
+
#
|
2205
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2206
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2207
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2208
|
+
def get_custom_list(custom_list_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2209
|
+
command = make_simple_command(:get, 'v1/customLists/{+customListId}', options)
|
2210
|
+
command.response_representation = Google::Apis::DisplayvideoV1::CustomList::Representation
|
2211
|
+
command.response_class = Google::Apis::DisplayvideoV1::CustomList
|
2212
|
+
command.params['customListId'] = custom_list_id unless custom_list_id.nil?
|
2213
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
2214
|
+
command.query['fields'] = fields unless fields.nil?
|
2215
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2216
|
+
execute_or_queue_command(command, &block)
|
2217
|
+
end
|
2218
|
+
|
2219
|
+
# Lists custom lists.
|
2220
|
+
# The order is defined by the order_by
|
2221
|
+
# parameter.
|
2222
|
+
# @param [Fixnum] advertiser_id
|
2223
|
+
# The ID of the DV360 advertiser that has access to the fetched custom
|
2224
|
+
# lists.
|
2225
|
+
# @param [String] filter
|
2226
|
+
# Allows filtering by custom list fields.
|
2227
|
+
# Supported syntax:
|
2228
|
+
# * Filter expressions for custom lists currently can only contain at
|
2229
|
+
# most one restriction.
|
2230
|
+
# * A restriction has the form of ``field` `operator` `value``.
|
2231
|
+
# * The operator must be `CONTAINS (:)`.
|
2232
|
+
# * Supported fields:
|
2233
|
+
# - `displayName`
|
2234
|
+
# Examples:
|
2235
|
+
# * All custom lists for which the display name contains "Google":
|
2236
|
+
# `displayName : "Google"`.
|
2237
|
+
# The length of this field should be no more than 500 characters.
|
2238
|
+
# @param [String] order_by
|
2239
|
+
# Field by which to sort the list.
|
2240
|
+
# Acceptable values are:
|
2241
|
+
# * `customListId` (default)
|
2242
|
+
# * `displayName`
|
2243
|
+
# The default sorting order is ascending. To specify descending order for
|
2244
|
+
# a field, a suffix "desc" should be added to the field name. Example:
|
2245
|
+
# `displayName desc`.
|
2246
|
+
# @param [Fixnum] page_size
|
2247
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
2248
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
2249
|
+
# is specified.
|
2250
|
+
# @param [String] page_token
|
2251
|
+
# A token identifying a page of results the server should return.
|
2252
|
+
# Typically, this is the value of
|
2253
|
+
# next_page_token
|
2254
|
+
# returned from the previous call to `ListCustomLists` method.
|
2255
|
+
# If not specified, the first page of results will be returned.
|
2256
|
+
# @param [String] fields
|
2257
|
+
# Selector specifying which fields to include in a partial response.
|
2258
|
+
# @param [String] quota_user
|
2259
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2260
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2261
|
+
# @param [Google::Apis::RequestOptions] options
|
2262
|
+
# Request-specific options
|
2263
|
+
#
|
2264
|
+
# @yield [result, err] Result & error if block supplied
|
2265
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListCustomListsResponse] parsed result object
|
2266
|
+
# @yieldparam err [StandardError] error object if request failed
|
2267
|
+
#
|
2268
|
+
# @return [Google::Apis::DisplayvideoV1::ListCustomListsResponse]
|
2269
|
+
#
|
2270
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2271
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2272
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2273
|
+
def list_custom_lists(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2274
|
+
command = make_simple_command(:get, 'v1/customLists', options)
|
2275
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListCustomListsResponse::Representation
|
2276
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListCustomListsResponse
|
2277
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
2278
|
+
command.query['filter'] = filter unless filter.nil?
|
2279
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
2280
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
2281
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
2282
|
+
command.query['fields'] = fields unless fields.nil?
|
2283
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2284
|
+
execute_or_queue_command(command, &block)
|
2285
|
+
end
|
2286
|
+
|
2287
|
+
# Gets a first and third party audience.
|
2288
|
+
# @param [Fixnum] first_and_third_party_audience_id
|
2289
|
+
# Required. The ID of the first and third party audience to fetch.
|
2290
|
+
# @param [Fixnum] advertiser_id
|
2291
|
+
# The ID of the advertiser that has access to the fetched first and
|
2292
|
+
# third party audience.
|
2293
|
+
# @param [Fixnum] partner_id
|
2294
|
+
# The ID of the partner that has access to the fetched first and
|
2295
|
+
# third party audience.
|
2296
|
+
# @param [String] fields
|
2297
|
+
# Selector specifying which fields to include in a partial response.
|
2298
|
+
# @param [String] quota_user
|
2299
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2300
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2301
|
+
# @param [Google::Apis::RequestOptions] options
|
2302
|
+
# Request-specific options
|
2303
|
+
#
|
2304
|
+
# @yield [result, err] Result & error if block supplied
|
2305
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudience] parsed result object
|
2306
|
+
# @yieldparam err [StandardError] error object if request failed
|
2307
|
+
#
|
2308
|
+
# @return [Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudience]
|
2309
|
+
#
|
2310
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2311
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2312
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2313
|
+
def get_first_and_third_party_audience(first_and_third_party_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2314
|
+
command = make_simple_command(:get, 'v1/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}', options)
|
2315
|
+
command.response_representation = Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudience::Representation
|
2316
|
+
command.response_class = Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudience
|
2317
|
+
command.params['firstAndThirdPartyAudienceId'] = first_and_third_party_audience_id unless first_and_third_party_audience_id.nil?
|
2318
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
2319
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
2320
|
+
command.query['fields'] = fields unless fields.nil?
|
2321
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2322
|
+
execute_or_queue_command(command, &block)
|
2323
|
+
end
|
2324
|
+
|
2325
|
+
# Lists first and third party audiences.
|
2326
|
+
# The order is defined by the
|
2327
|
+
# order_by parameter.
|
2328
|
+
# @param [Fixnum] advertiser_id
|
2329
|
+
# The ID of the advertiser that has access to the fetched first and
|
2330
|
+
# third party audiences.
|
2331
|
+
# @param [String] filter
|
2332
|
+
# Allows filtering by first and third party audience fields.
|
2333
|
+
# Supported syntax:
|
2334
|
+
# * Filter expressions for first and third party audiences currently can
|
2335
|
+
# only contain at most one restriction.
|
2336
|
+
# * A restriction has the form of ``field` `operator` `value``.
|
2337
|
+
# * The operator must be `CONTAINS (:)`.
|
2338
|
+
# * Supported fields:
|
2339
|
+
# - `displayName`
|
2340
|
+
# Examples:
|
2341
|
+
# * All first and third party audiences for which the display name contains
|
2342
|
+
# "Google": `displayName : "Google"`.
|
2343
|
+
# The length of this field should be no more than 500 characters.
|
2344
|
+
# @param [String] order_by
|
2345
|
+
# Field by which to sort the list.
|
2346
|
+
# Acceptable values are:
|
2347
|
+
# * `firstAndThirdPartyAudienceId` (default)
|
2348
|
+
# * `displayName`
|
2349
|
+
# The default sorting order is ascending. To specify descending order for
|
2350
|
+
# a field, a suffix "desc" should be added to the field name. Example:
|
2351
|
+
# `displayName desc`.
|
2352
|
+
# @param [Fixnum] page_size
|
2353
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
2354
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
2355
|
+
# is specified.
|
2356
|
+
# @param [String] page_token
|
2357
|
+
# A token identifying a page of results the server should return.
|
2358
|
+
# Typically, this is the value of
|
2359
|
+
# next_page_token
|
2360
|
+
# returned from the previous call to `ListFirstAndThirdPartyAudiences`
|
2361
|
+
# method. If not specified, the first page of results will be returned.
|
2362
|
+
# @param [Fixnum] partner_id
|
2363
|
+
# The ID of the partner that has access to the fetched first and
|
2364
|
+
# third party audiences.
|
2365
|
+
# @param [String] fields
|
2366
|
+
# Selector specifying which fields to include in a partial response.
|
2367
|
+
# @param [String] quota_user
|
2368
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2369
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2370
|
+
# @param [Google::Apis::RequestOptions] options
|
2371
|
+
# Request-specific options
|
2372
|
+
#
|
2373
|
+
# @yield [result, err] Result & error if block supplied
|
2374
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListFirstAndThirdPartyAudiencesResponse] parsed result object
|
2375
|
+
# @yieldparam err [StandardError] error object if request failed
|
2376
|
+
#
|
2377
|
+
# @return [Google::Apis::DisplayvideoV1::ListFirstAndThirdPartyAudiencesResponse]
|
2378
|
+
#
|
2379
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2380
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2381
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2382
|
+
def list_first_and_third_party_audiences(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2383
|
+
command = make_simple_command(:get, 'v1/firstAndThirdPartyAudiences', options)
|
2384
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListFirstAndThirdPartyAudiencesResponse::Representation
|
2385
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListFirstAndThirdPartyAudiencesResponse
|
2386
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
2387
|
+
command.query['filter'] = filter unless filter.nil?
|
2388
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
2389
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
2390
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
2391
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
2392
|
+
command.query['fields'] = fields unless fields.nil?
|
2393
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2394
|
+
execute_or_queue_command(command, &block)
|
2395
|
+
end
|
2396
|
+
|
2397
|
+
# Gets a Floodlight group.
|
2398
|
+
# @param [Fixnum] floodlight_group_id
|
2399
|
+
# Required. The ID of the Floodlight group to fetch.
|
2400
|
+
# @param [Fixnum] partner_id
|
2401
|
+
# Required. The partner context by which the Floodlight group is being accessed.
|
2402
|
+
# @param [String] fields
|
2403
|
+
# Selector specifying which fields to include in a partial response.
|
2404
|
+
# @param [String] quota_user
|
2405
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2406
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2407
|
+
# @param [Google::Apis::RequestOptions] options
|
2408
|
+
# Request-specific options
|
2409
|
+
#
|
2410
|
+
# @yield [result, err] Result & error if block supplied
|
2411
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::FloodlightGroup] parsed result object
|
2412
|
+
# @yieldparam err [StandardError] error object if request failed
|
2413
|
+
#
|
2414
|
+
# @return [Google::Apis::DisplayvideoV1::FloodlightGroup]
|
2415
|
+
#
|
2416
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2417
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2418
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2419
|
+
def get_floodlight_group(floodlight_group_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2420
|
+
command = make_simple_command(:get, 'v1/floodlightGroups/{+floodlightGroupId}', options)
|
2421
|
+
command.response_representation = Google::Apis::DisplayvideoV1::FloodlightGroup::Representation
|
2422
|
+
command.response_class = Google::Apis::DisplayvideoV1::FloodlightGroup
|
2423
|
+
command.params['floodlightGroupId'] = floodlight_group_id unless floodlight_group_id.nil?
|
2424
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
2425
|
+
command.query['fields'] = fields unless fields.nil?
|
2426
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2427
|
+
execute_or_queue_command(command, &block)
|
2428
|
+
end
|
2429
|
+
|
2430
|
+
# Updates an existing Floodlight group.
|
2431
|
+
# Returns the updated Floodlight group if successful.
|
2432
|
+
# @param [Fixnum] floodlight_group_id
|
2433
|
+
# Output only. The unique ID of the Floodlight group. Assigned by the system.
|
2434
|
+
# @param [Google::Apis::DisplayvideoV1::FloodlightGroup] floodlight_group_object
|
2435
|
+
# @param [Fixnum] partner_id
|
2436
|
+
# Required. The partner context by which the Floodlight group is being accessed.
|
2437
|
+
# @param [String] update_mask
|
2438
|
+
# Required. The mask to control which fields to update.
|
2439
|
+
# @param [String] fields
|
2440
|
+
# Selector specifying which fields to include in a partial response.
|
2441
|
+
# @param [String] quota_user
|
2442
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2443
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2444
|
+
# @param [Google::Apis::RequestOptions] options
|
2445
|
+
# Request-specific options
|
2446
|
+
#
|
2447
|
+
# @yield [result, err] Result & error if block supplied
|
2448
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::FloodlightGroup] parsed result object
|
2449
|
+
# @yieldparam err [StandardError] error object if request failed
|
2450
|
+
#
|
2451
|
+
# @return [Google::Apis::DisplayvideoV1::FloodlightGroup]
|
2452
|
+
#
|
2453
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2454
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2455
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2456
|
+
def patch_floodlight_group(floodlight_group_id, floodlight_group_object = nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2457
|
+
command = make_simple_command(:patch, 'v1/floodlightGroups/{floodlightGroupId}', options)
|
2458
|
+
command.request_representation = Google::Apis::DisplayvideoV1::FloodlightGroup::Representation
|
2459
|
+
command.request_object = floodlight_group_object
|
2460
|
+
command.response_representation = Google::Apis::DisplayvideoV1::FloodlightGroup::Representation
|
2461
|
+
command.response_class = Google::Apis::DisplayvideoV1::FloodlightGroup
|
2462
|
+
command.params['floodlightGroupId'] = floodlight_group_id unless floodlight_group_id.nil?
|
2463
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
2464
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
2465
|
+
command.query['fields'] = fields unless fields.nil?
|
2466
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2467
|
+
execute_or_queue_command(command, &block)
|
2468
|
+
end
|
2469
|
+
|
2470
|
+
# Gets a Google audience.
|
2471
|
+
# @param [Fixnum] google_audience_id
|
2472
|
+
# Required. The ID of the Google audience to fetch.
|
2473
|
+
# @param [Fixnum] advertiser_id
|
2474
|
+
# The ID of the advertiser that has access to the fetched Google audience.
|
2475
|
+
# @param [Fixnum] partner_id
|
2476
|
+
# The ID of the partner that has access to the fetched Google audience.
|
2477
|
+
# @param [String] fields
|
2478
|
+
# Selector specifying which fields to include in a partial response.
|
2479
|
+
# @param [String] quota_user
|
2480
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2481
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2482
|
+
# @param [Google::Apis::RequestOptions] options
|
2483
|
+
# Request-specific options
|
2484
|
+
#
|
2485
|
+
# @yield [result, err] Result & error if block supplied
|
2486
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::GoogleAudience] parsed result object
|
2487
|
+
# @yieldparam err [StandardError] error object if request failed
|
2488
|
+
#
|
2489
|
+
# @return [Google::Apis::DisplayvideoV1::GoogleAudience]
|
2490
|
+
#
|
2491
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2492
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2493
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2494
|
+
def get_google_audience(google_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2495
|
+
command = make_simple_command(:get, 'v1/googleAudiences/{+googleAudienceId}', options)
|
2496
|
+
command.response_representation = Google::Apis::DisplayvideoV1::GoogleAudience::Representation
|
2497
|
+
command.response_class = Google::Apis::DisplayvideoV1::GoogleAudience
|
2498
|
+
command.params['googleAudienceId'] = google_audience_id unless google_audience_id.nil?
|
2499
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
2500
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
2501
|
+
command.query['fields'] = fields unless fields.nil?
|
2502
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2503
|
+
execute_or_queue_command(command, &block)
|
2504
|
+
end
|
2505
|
+
|
2506
|
+
# Lists Google audiences.
|
2507
|
+
# The order is defined by the order_by
|
2508
|
+
# parameter.
|
2509
|
+
# @param [Fixnum] advertiser_id
|
2510
|
+
# The ID of the advertiser that has access to the fetched Google audiences.
|
2511
|
+
# @param [String] filter
|
2512
|
+
# Allows filtering by Google audience fields.
|
2513
|
+
# Supported syntax:
|
2514
|
+
# * Filter expressions for Google audiences currently can only contain at
|
2515
|
+
# most one restriction.
|
2516
|
+
# * A restriction has the form of ``field` `operator` `value``.
|
2517
|
+
# * The operator must be `CONTAINS (:)`.
|
2518
|
+
# * Supported fields:
|
2519
|
+
# - `displayName`
|
2520
|
+
# Examples:
|
2521
|
+
# * All Google audiences for which the display name contains "Google":
|
2522
|
+
# `displayName : "Google"`.
|
2523
|
+
# The length of this field should be no more than 500 characters.
|
2524
|
+
# @param [String] order_by
|
2525
|
+
# Field by which to sort the list.
|
2526
|
+
# Acceptable values are:
|
2527
|
+
# * `googleAudienceId` (default)
|
2528
|
+
# * `displayName`
|
2529
|
+
# The default sorting order is ascending. To specify descending order for
|
2530
|
+
# a field, a suffix "desc" should be added to the field name. Example:
|
2531
|
+
# `displayName desc`.
|
2532
|
+
# @param [Fixnum] page_size
|
2533
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
2534
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
2535
|
+
# is specified.
|
2536
|
+
# @param [String] page_token
|
2537
|
+
# A token identifying a page of results the server should return.
|
2538
|
+
# Typically, this is the value of
|
2539
|
+
# next_page_token
|
2540
|
+
# returned from the previous call to `ListGoogleAudiences` method.
|
2541
|
+
# If not specified, the first page of results will be returned.
|
2542
|
+
# @param [Fixnum] partner_id
|
2543
|
+
# The ID of the partner that has access to the fetched Google audiences.
|
2544
|
+
# @param [String] fields
|
2545
|
+
# Selector specifying which fields to include in a partial response.
|
2546
|
+
# @param [String] quota_user
|
2547
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2548
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2549
|
+
# @param [Google::Apis::RequestOptions] options
|
2550
|
+
# Request-specific options
|
2551
|
+
#
|
2552
|
+
# @yield [result, err] Result & error if block supplied
|
2553
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListGoogleAudiencesResponse] parsed result object
|
2554
|
+
# @yieldparam err [StandardError] error object if request failed
|
2555
|
+
#
|
2556
|
+
# @return [Google::Apis::DisplayvideoV1::ListGoogleAudiencesResponse]
|
2557
|
+
#
|
2558
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2559
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2560
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2561
|
+
def list_google_audiences(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2562
|
+
command = make_simple_command(:get, 'v1/googleAudiences', options)
|
2563
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListGoogleAudiencesResponse::Representation
|
2564
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListGoogleAudiencesResponse
|
2565
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
2566
|
+
command.query['filter'] = filter unless filter.nil?
|
2567
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
2568
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
2569
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
2570
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
2571
|
+
command.query['fields'] = fields unless fields.nil?
|
2572
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2573
|
+
execute_or_queue_command(command, &block)
|
2574
|
+
end
|
2575
|
+
|
2576
|
+
# Gets an inventory source group.
|
2577
|
+
# @param [Fixnum] inventory_source_group_id
|
2578
|
+
# Required. The ID of the inventory source group to fetch.
|
2579
|
+
# @param [Fixnum] advertiser_id
|
2580
|
+
# The ID of the advertiser that has access to the inventory source group.
|
2581
|
+
# If an inventory source group is partner-owned, only advertisers to which
|
2582
|
+
# the group is explicitly shared can access the group.
|
2583
|
+
# @param [Fixnum] partner_id
|
2584
|
+
# The ID of the partner that has access to the inventory source group.
|
2585
|
+
# A partner cannot access an advertiser-owned inventory source group.
|
2586
|
+
# @param [String] fields
|
2587
|
+
# Selector specifying which fields to include in a partial response.
|
2588
|
+
# @param [String] quota_user
|
2589
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2590
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2591
|
+
# @param [Google::Apis::RequestOptions] options
|
2592
|
+
# Request-specific options
|
2593
|
+
#
|
2594
|
+
# @yield [result, err] Result & error if block supplied
|
2595
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::InventorySourceGroup] parsed result object
|
2596
|
+
# @yieldparam err [StandardError] error object if request failed
|
2597
|
+
#
|
2598
|
+
# @return [Google::Apis::DisplayvideoV1::InventorySourceGroup]
|
2599
|
+
#
|
2600
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2601
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2602
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2603
|
+
def get_inventory_source_group(inventory_source_group_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2604
|
+
command = make_simple_command(:get, 'v1/inventorySourceGroups/{+inventorySourceGroupId}', options)
|
2605
|
+
command.response_representation = Google::Apis::DisplayvideoV1::InventorySourceGroup::Representation
|
2606
|
+
command.response_class = Google::Apis::DisplayvideoV1::InventorySourceGroup
|
2607
|
+
command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
|
2608
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
2609
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
2610
|
+
command.query['fields'] = fields unless fields.nil?
|
2611
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2612
|
+
execute_or_queue_command(command, &block)
|
2613
|
+
end
|
2614
|
+
|
2615
|
+
# Lists inventory source groups that are accessible to the current user.
|
2616
|
+
# The order is defined by the
|
2617
|
+
# order_by parameter.
|
2618
|
+
# @param [Fixnum] advertiser_id
|
2619
|
+
# The ID of the advertiser that has access to the inventory source group.
|
2620
|
+
# If an inventory source group is partner-owned, only advertisers to which
|
2621
|
+
# the group is explicitly shared can access the group.
|
2622
|
+
# @param [String] filter
|
2623
|
+
# Allows filtering by inventory source group properties.
|
2624
|
+
# Supported syntax:
|
2625
|
+
# * Filter expressions are made up of one or more restrictions.
|
2626
|
+
# * Restrictions can be combined by the logical operator `OR`.
|
2627
|
+
# * A restriction has the form of ``field` `operator` `value``.
|
2628
|
+
# * The operator must be `EQUALS (=)`.
|
2629
|
+
# * Supported fields:
|
2630
|
+
# - `inventorySourceGroupId`
|
2631
|
+
# The length of this field should be no more than 500 characters.
|
2632
|
+
# @param [String] order_by
|
2633
|
+
# Field by which to sort the list.
|
2634
|
+
# Acceptable values are:
|
2635
|
+
# * `displayName` (default)
|
2636
|
+
# * `inventorySourceGroupId`
|
2637
|
+
# The default sorting order is ascending. To specify descending order for
|
2638
|
+
# a field, a suffix "desc" should be added to the field name. For example,
|
2639
|
+
# `displayName desc`.
|
2640
|
+
# @param [Fixnum] page_size
|
2641
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
2642
|
+
# default to `100`.
|
2643
|
+
# @param [String] page_token
|
2644
|
+
# A token identifying a page of results the server should return.
|
2645
|
+
# Typically, this is the value of
|
2646
|
+
# next_page_token
|
2647
|
+
# returned from the previous call to `ListInventorySources` method.
|
2648
|
+
# If not specified, the first page of results will be returned.
|
2649
|
+
# @param [Fixnum] partner_id
|
2650
|
+
# The ID of the partner that has access to the inventory source group.
|
2651
|
+
# A partner cannot access advertiser-owned inventory source groups.
|
2652
|
+
# @param [String] fields
|
2653
|
+
# Selector specifying which fields to include in a partial response.
|
2654
|
+
# @param [String] quota_user
|
2655
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2656
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2657
|
+
# @param [Google::Apis::RequestOptions] options
|
2658
|
+
# Request-specific options
|
2659
|
+
#
|
2660
|
+
# @yield [result, err] Result & error if block supplied
|
2661
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListInventorySourceGroupsResponse] parsed result object
|
2662
|
+
# @yieldparam err [StandardError] error object if request failed
|
2663
|
+
#
|
2664
|
+
# @return [Google::Apis::DisplayvideoV1::ListInventorySourceGroupsResponse]
|
2665
|
+
#
|
2666
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2667
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2668
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2669
|
+
def list_inventory_source_groups(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2670
|
+
command = make_simple_command(:get, 'v1/inventorySourceGroups', options)
|
2671
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListInventorySourceGroupsResponse::Representation
|
2672
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListInventorySourceGroupsResponse
|
2673
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
2674
|
+
command.query['filter'] = filter unless filter.nil?
|
2675
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
2676
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
2677
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
2678
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
2679
|
+
command.query['fields'] = fields unless fields.nil?
|
2680
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2681
|
+
execute_or_queue_command(command, &block)
|
2682
|
+
end
|
2683
|
+
|
2684
|
+
# Gets an inventory source.
|
2685
|
+
# @param [Fixnum] inventory_source_id
|
2686
|
+
# Required. The ID of the inventory source to fetch.
|
2687
|
+
# @param [Fixnum] partner_id
|
2688
|
+
# Required. The ID of the DV360 partner to which the fetched inventory source
|
2689
|
+
# is permissioned.
|
2690
|
+
# @param [String] fields
|
2691
|
+
# Selector specifying which fields to include in a partial response.
|
2692
|
+
# @param [String] quota_user
|
2693
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2694
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2695
|
+
# @param [Google::Apis::RequestOptions] options
|
2696
|
+
# Request-specific options
|
2697
|
+
#
|
2698
|
+
# @yield [result, err] Result & error if block supplied
|
2699
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::InventorySource] parsed result object
|
2700
|
+
# @yieldparam err [StandardError] error object if request failed
|
2701
|
+
#
|
2702
|
+
# @return [Google::Apis::DisplayvideoV1::InventorySource]
|
2703
|
+
#
|
2704
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2705
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2706
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2707
|
+
def get_inventory_source(inventory_source_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2708
|
+
command = make_simple_command(:get, 'v1/inventorySources/{+inventorySourceId}', options)
|
2709
|
+
command.response_representation = Google::Apis::DisplayvideoV1::InventorySource::Representation
|
2710
|
+
command.response_class = Google::Apis::DisplayvideoV1::InventorySource
|
2711
|
+
command.params['inventorySourceId'] = inventory_source_id unless inventory_source_id.nil?
|
2712
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
2713
|
+
command.query['fields'] = fields unless fields.nil?
|
2714
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2715
|
+
execute_or_queue_command(command, &block)
|
2716
|
+
end
|
2717
|
+
|
2718
|
+
# Lists inventory sources that are accessible to the current user.
|
2719
|
+
# The order is defined by the
|
2720
|
+
# order_by parameter.
|
2721
|
+
# If a filter by
|
2722
|
+
# entity_status is not
|
2723
|
+
# specified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED`
|
2724
|
+
# will not be included in the results.
|
2725
|
+
# @param [Fixnum] advertiser_id
|
2726
|
+
# The ID of the advertiser that has access to the inventory source.
|
2727
|
+
# @param [String] filter
|
2728
|
+
# Allows filtering by inventory source properties.
|
2729
|
+
# Supported syntax:
|
2730
|
+
# * Filter expressions are made up of one or more restrictions.
|
2731
|
+
# * Restrictions can be combined by `AND` or `OR` logical operators. A
|
2732
|
+
# sequence of restrictions implicitly uses `AND`.
|
2733
|
+
# * A restriction has the form of ``field` `operator` `value``.
|
2734
|
+
# * The operator must be `EQUALS (=)`.
|
2735
|
+
# * Supported fields:
|
2736
|
+
# - `status.entityStatus`
|
2737
|
+
# - `commitment`
|
2738
|
+
# - `deliveryMethod`
|
2739
|
+
# - `rateDetails.rateType`
|
2740
|
+
# - `exchange`
|
2741
|
+
# Examples:
|
2742
|
+
# * All active inventory sources:
|
2743
|
+
# `status.entityStatus="ENTITY_STATUS_ACTIVE"`
|
2744
|
+
# * Inventory sources belonging to Google Ad Manager or Rubicon exchanges:
|
2745
|
+
# `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"`
|
2746
|
+
# The length of this field should be no more than 500 characters.
|
2747
|
+
# @param [String] order_by
|
2748
|
+
# Field by which to sort the list.
|
2749
|
+
# Acceptable values are:
|
2750
|
+
# * `displayName` (default)
|
2751
|
+
# The default sorting order is ascending. To specify descending order for
|
2752
|
+
# a field, a suffix "desc" should be added to the field name. For example,
|
2753
|
+
# `displayName desc`.
|
2754
|
+
# @param [Fixnum] page_size
|
2755
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
2756
|
+
# default to `100`.
|
2757
|
+
# @param [String] page_token
|
2758
|
+
# A token identifying a page of results the server should return.
|
2759
|
+
# Typically, this is the value of
|
2760
|
+
# next_page_token
|
2761
|
+
# returned from the previous call to `ListInventorySources` method.
|
2762
|
+
# If not specified, the first page of results will be returned.
|
2763
|
+
# @param [Fixnum] partner_id
|
2764
|
+
# The ID of the partner that has access to the inventory source.
|
2765
|
+
# @param [String] fields
|
2766
|
+
# Selector specifying which fields to include in a partial response.
|
2767
|
+
# @param [String] quota_user
|
2768
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2769
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2770
|
+
# @param [Google::Apis::RequestOptions] options
|
2771
|
+
# Request-specific options
|
2772
|
+
#
|
2773
|
+
# @yield [result, err] Result & error if block supplied
|
2774
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListInventorySourcesResponse] parsed result object
|
2775
|
+
# @yieldparam err [StandardError] error object if request failed
|
2776
|
+
#
|
2777
|
+
# @return [Google::Apis::DisplayvideoV1::ListInventorySourcesResponse]
|
2778
|
+
#
|
2779
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2780
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2781
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2782
|
+
def list_inventory_sources(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2783
|
+
command = make_simple_command(:get, 'v1/inventorySources', options)
|
2784
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListInventorySourcesResponse::Representation
|
2785
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListInventorySourcesResponse
|
2786
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
2787
|
+
command.query['filter'] = filter unless filter.nil?
|
2788
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
2789
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
2790
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
2791
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
2792
|
+
command.query['fields'] = fields unless fields.nil?
|
2793
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2794
|
+
execute_or_queue_command(command, &block)
|
2795
|
+
end
|
2796
|
+
|
2797
|
+
# Downloads media. Download is supported on the URI `/download/`resource_name=**`
|
2798
|
+
# ?alt=media.`
|
2799
|
+
# **Note**: Download requests will not be successful without including `alt=
|
2800
|
+
# media` query string.
|
2801
|
+
# @param [String] resource_name
|
2802
|
+
# Name of the media that is being downloaded. See
|
2803
|
+
# ReadRequest.resource_name.
|
2804
|
+
# @param [String] fields
|
2805
|
+
# Selector specifying which fields to include in a partial response.
|
2806
|
+
# @param [String] quota_user
|
2807
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2808
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2809
|
+
# @param [IO, String] download_dest
|
2810
|
+
# IO stream or filename to receive content download
|
2811
|
+
# @param [Google::Apis::RequestOptions] options
|
2812
|
+
# Request-specific options
|
2813
|
+
#
|
2814
|
+
# @yield [result, err] Result & error if block supplied
|
2815
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::GoogleBytestreamMedia] parsed result object
|
2816
|
+
# @yieldparam err [StandardError] error object if request failed
|
2817
|
+
#
|
2818
|
+
# @return [Google::Apis::DisplayvideoV1::GoogleBytestreamMedia]
|
2819
|
+
#
|
2820
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2821
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2822
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2823
|
+
def download_medium(resource_name, fields: nil, quota_user: nil, download_dest: nil, options: nil, &block)
|
2824
|
+
if download_dest.nil?
|
2825
|
+
command = make_simple_command(:get, 'download/{+resourceName}', options)
|
2826
|
+
else
|
2827
|
+
command = make_download_command(:get, 'download/{+resourceName}', options)
|
2828
|
+
command.download_dest = download_dest
|
2829
|
+
end
|
2830
|
+
command.response_representation = Google::Apis::DisplayvideoV1::GoogleBytestreamMedia::Representation
|
2831
|
+
command.response_class = Google::Apis::DisplayvideoV1::GoogleBytestreamMedia
|
2832
|
+
command.params['resourceName'] = resource_name unless resource_name.nil?
|
2833
|
+
command.query['fields'] = fields unless fields.nil?
|
2834
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2835
|
+
execute_or_queue_command(command, &block)
|
2836
|
+
end
|
2837
|
+
|
2838
|
+
# Gets a channel for a partner or advertiser.
|
2839
|
+
# @param [Fixnum] partner_id
|
2840
|
+
# The ID of the partner that owns the fetched channel.
|
2841
|
+
# @param [Fixnum] channel_id
|
2842
|
+
# Required. The ID of the channel to fetch.
|
2843
|
+
# @param [Fixnum] advertiser_id
|
2844
|
+
# The ID of the advertiser that owns the fetched channel.
|
2845
|
+
# @param [String] fields
|
2846
|
+
# Selector specifying which fields to include in a partial response.
|
2847
|
+
# @param [String] quota_user
|
2848
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2849
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2850
|
+
# @param [Google::Apis::RequestOptions] options
|
2851
|
+
# Request-specific options
|
2852
|
+
#
|
2853
|
+
# @yield [result, err] Result & error if block supplied
|
2854
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Channel] parsed result object
|
2855
|
+
# @yieldparam err [StandardError] error object if request failed
|
2856
|
+
#
|
2857
|
+
# @return [Google::Apis::DisplayvideoV1::Channel]
|
2858
|
+
#
|
2859
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2860
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2861
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2862
|
+
def get_partner_channel(partner_id, channel_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2863
|
+
command = make_simple_command(:get, 'v1/partners/{+partnerId}/channels/{+channelId}', options)
|
2864
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Channel::Representation
|
2865
|
+
command.response_class = Google::Apis::DisplayvideoV1::Channel
|
2866
|
+
command.params['partnerId'] = partner_id unless partner_id.nil?
|
2867
|
+
command.params['channelId'] = channel_id unless channel_id.nil?
|
2868
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
2869
|
+
command.query['fields'] = fields unless fields.nil?
|
2870
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2871
|
+
execute_or_queue_command(command, &block)
|
2872
|
+
end
|
2873
|
+
|
2874
|
+
# Lists channels for a partner or advertiser.
|
2875
|
+
# @param [Fixnum] partner_id
|
2876
|
+
# The ID of the partner that owns the channels.
|
2877
|
+
# @param [Fixnum] advertiser_id
|
2878
|
+
# The ID of the advertiser that owns the channels.
|
2879
|
+
# @param [String] filter
|
2880
|
+
# Allows filtering by channel fields.
|
2881
|
+
# Supported syntax:
|
2882
|
+
# * Filter expressions for channel currently can only contain at most one
|
2883
|
+
# * restriction.
|
2884
|
+
# * A restriction has the form of ``field` `operator` `value``.
|
2885
|
+
# * The operator must be `CONTAINS (:)`.
|
2886
|
+
# * Supported fields:
|
2887
|
+
# - `displayName`
|
2888
|
+
# Examples:
|
2889
|
+
# * All channels for which the display name contains "google":
|
2890
|
+
# `displayName : "google"`.
|
2891
|
+
# The length of this field should be no more than 500 characters.
|
2892
|
+
# @param [String] order_by
|
2893
|
+
# Field by which to sort the list.
|
2894
|
+
# Acceptable values are:
|
2895
|
+
# * `displayName` (default)
|
2896
|
+
# * `channelId`
|
2897
|
+
# The default sorting order is ascending. To specify descending order for a
|
2898
|
+
# field, a suffix " desc" should be added to the field name. Example:
|
2899
|
+
# `displayName desc`.
|
2900
|
+
# @param [Fixnum] page_size
|
2901
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
2902
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
2903
|
+
# is specified.
|
2904
|
+
# @param [String] page_token
|
2905
|
+
# A token identifying a page of results the server should return.
|
2906
|
+
# Typically, this is the value of
|
2907
|
+
# next_page_token returned from the
|
2908
|
+
# previous call to `ListChannels` method. If not specified, the first page
|
2909
|
+
# of results will be returned.
|
2910
|
+
# @param [String] fields
|
2911
|
+
# Selector specifying which fields to include in a partial response.
|
2912
|
+
# @param [String] quota_user
|
2913
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2914
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2915
|
+
# @param [Google::Apis::RequestOptions] options
|
2916
|
+
# Request-specific options
|
2917
|
+
#
|
2918
|
+
# @yield [result, err] Result & error if block supplied
|
2919
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListChannelsResponse] parsed result object
|
2920
|
+
# @yieldparam err [StandardError] error object if request failed
|
2921
|
+
#
|
2922
|
+
# @return [Google::Apis::DisplayvideoV1::ListChannelsResponse]
|
2923
|
+
#
|
2924
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2925
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2926
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2927
|
+
def list_partner_channels(partner_id, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2928
|
+
command = make_simple_command(:get, 'v1/partners/{+partnerId}/channels', options)
|
2929
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListChannelsResponse::Representation
|
2930
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListChannelsResponse
|
2931
|
+
command.params['partnerId'] = partner_id unless partner_id.nil?
|
2932
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
2933
|
+
command.query['filter'] = filter unless filter.nil?
|
2934
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
2935
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
2936
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
2937
|
+
command.query['fields'] = fields unless fields.nil?
|
2938
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2939
|
+
execute_or_queue_command(command, &block)
|
2940
|
+
end
|
2941
|
+
|
2942
|
+
# Creates an SDF Download Task. Returns an
|
2943
|
+
# Operation.
|
2944
|
+
# An SDF Download Task is a long-running, asynchronous operation. The
|
2945
|
+
# metadata type of this operation is
|
2946
|
+
# SdfDownloadTaskMetadata. If the request is successful, the
|
2947
|
+
# response type of the operation is
|
2948
|
+
# SdfDownloadTask. The response will not include the download files,
|
2949
|
+
# which must be retrieved with
|
2950
|
+
# media.download. The state of
|
2951
|
+
# operation can be retrieved with
|
2952
|
+
# sdfdownloadtask.operations.get.
|
2953
|
+
# Any errors can be found in the
|
2954
|
+
# error.message. Note
|
2955
|
+
# that error.details is expected to be
|
2956
|
+
# empty.
|
2957
|
+
# @param [Google::Apis::DisplayvideoV1::CreateSdfDownloadTaskRequest] create_sdf_download_task_request_object
|
2958
|
+
# @param [String] fields
|
2959
|
+
# Selector specifying which fields to include in a partial response.
|
2960
|
+
# @param [String] quota_user
|
2961
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2962
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2963
|
+
# @param [Google::Apis::RequestOptions] options
|
2964
|
+
# Request-specific options
|
2965
|
+
#
|
2966
|
+
# @yield [result, err] Result & error if block supplied
|
2967
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Operation] parsed result object
|
2968
|
+
# @yieldparam err [StandardError] error object if request failed
|
2969
|
+
#
|
2970
|
+
# @return [Google::Apis::DisplayvideoV1::Operation]
|
2971
|
+
#
|
2972
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2973
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2974
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2975
|
+
def create_sdfdownloadtask_sdf_download_task(create_sdf_download_task_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2976
|
+
command = make_simple_command(:post, 'v1/sdfdownloadtasks', options)
|
2977
|
+
command.request_representation = Google::Apis::DisplayvideoV1::CreateSdfDownloadTaskRequest::Representation
|
2978
|
+
command.request_object = create_sdf_download_task_request_object
|
2979
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Operation::Representation
|
2980
|
+
command.response_class = Google::Apis::DisplayvideoV1::Operation
|
2981
|
+
command.query['fields'] = fields unless fields.nil?
|
2982
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2983
|
+
execute_or_queue_command(command, &block)
|
2984
|
+
end
|
2985
|
+
|
2986
|
+
# Gets the latest state of an asynchronous SDF download task operation. Clients
|
2987
|
+
# should poll this method at intervals of 30 seconds.
|
2988
|
+
# @param [String] name
|
2989
|
+
# The name of the operation resource.
|
2990
|
+
# @param [String] fields
|
2991
|
+
# Selector specifying which fields to include in a partial response.
|
2992
|
+
# @param [String] quota_user
|
2993
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2994
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2995
|
+
# @param [Google::Apis::RequestOptions] options
|
2996
|
+
# Request-specific options
|
2997
|
+
#
|
2998
|
+
# @yield [result, err] Result & error if block supplied
|
2999
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Operation] parsed result object
|
3000
|
+
# @yieldparam err [StandardError] error object if request failed
|
3001
|
+
#
|
3002
|
+
# @return [Google::Apis::DisplayvideoV1::Operation]
|
3003
|
+
#
|
3004
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3005
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3006
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3007
|
+
def get_sdfdownloadtask_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
3008
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
3009
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Operation::Representation
|
3010
|
+
command.response_class = Google::Apis::DisplayvideoV1::Operation
|
3011
|
+
command.params['name'] = name unless name.nil?
|
3012
|
+
command.query['fields'] = fields unless fields.nil?
|
3013
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3014
|
+
execute_or_queue_command(command, &block)
|
3015
|
+
end
|
3016
|
+
|
3017
|
+
# Gets a single targeting option.
|
3018
|
+
# @param [String] targeting_type
|
3019
|
+
# Required. The type of targeting option to retrieve.
|
3020
|
+
# @param [String] targeting_option_id
|
3021
|
+
# Required. The ID of the of targeting option to retrieve.
|
3022
|
+
# @param [Fixnum] advertiser_id
|
3023
|
+
# Required. The Advertiser this request is being made in the context of.
|
3024
|
+
# @param [String] fields
|
3025
|
+
# Selector specifying which fields to include in a partial response.
|
3026
|
+
# @param [String] quota_user
|
3027
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3028
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3029
|
+
# @param [Google::Apis::RequestOptions] options
|
3030
|
+
# Request-specific options
|
3031
|
+
#
|
3032
|
+
# @yield [result, err] Result & error if block supplied
|
3033
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::TargetingOption] parsed result object
|
3034
|
+
# @yieldparam err [StandardError] error object if request failed
|
3035
|
+
#
|
3036
|
+
# @return [Google::Apis::DisplayvideoV1::TargetingOption]
|
3037
|
+
#
|
3038
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3039
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3040
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3041
|
+
def get_targeting_type_targeting_option(targeting_type, targeting_option_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3042
|
+
command = make_simple_command(:get, 'v1/targetingTypes/{+targetingType}/targetingOptions/{+targetingOptionId}', options)
|
3043
|
+
command.response_representation = Google::Apis::DisplayvideoV1::TargetingOption::Representation
|
3044
|
+
command.response_class = Google::Apis::DisplayvideoV1::TargetingOption
|
3045
|
+
command.params['targetingType'] = targeting_type unless targeting_type.nil?
|
3046
|
+
command.params['targetingOptionId'] = targeting_option_id unless targeting_option_id.nil?
|
3047
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
3048
|
+
command.query['fields'] = fields unless fields.nil?
|
3049
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3050
|
+
execute_or_queue_command(command, &block)
|
3051
|
+
end
|
3052
|
+
|
3053
|
+
# Lists targeting options of a given type.
|
3054
|
+
# @param [String] targeting_type
|
3055
|
+
# Required. The type of targeting option to be listed.
|
3056
|
+
# @param [Fixnum] advertiser_id
|
3057
|
+
# Required. The Advertiser this request is being made in the context of.
|
3058
|
+
# @param [String] filter
|
3059
|
+
# Allows filtering by targeting option properties.
|
3060
|
+
# Supported syntax:
|
3061
|
+
# * Filter expressions are made up of one or more restrictions.
|
3062
|
+
# * Restrictions can be combined by `OR` logical operators.
|
3063
|
+
# * A restriction has the form of ``field` `operator` `value``.
|
3064
|
+
# * The operator must be "=" (equal sign).
|
3065
|
+
# * Supported fields:
|
3066
|
+
# - `targetingOptionId`
|
3067
|
+
# The length of this field should be no more than 500 characters.
|
3068
|
+
# @param [String] order_by
|
3069
|
+
# Field by which to sort the list.
|
3070
|
+
# Acceptable values are:
|
3071
|
+
# * `targetingOptionId` (default)
|
3072
|
+
# The default sorting order is ascending. To specify descending order for
|
3073
|
+
# a field, a suffix "desc" should be added to the field name.
|
3074
|
+
# Example: `targetingOptionId desc`.
|
3075
|
+
# @param [Fixnum] page_size
|
3076
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
3077
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
3078
|
+
# is specified.
|
3079
|
+
# @param [String] page_token
|
3080
|
+
# A token identifying a page of results the server should return.
|
3081
|
+
# Typically, this is the value of
|
3082
|
+
# next_page_token
|
3083
|
+
# returned from the previous call to `ListTargetingOptions` method.
|
3084
|
+
# If not specified, the first page of results will be returned.
|
3085
|
+
# @param [String] fields
|
3086
|
+
# Selector specifying which fields to include in a partial response.
|
3087
|
+
# @param [String] quota_user
|
3088
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3089
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3090
|
+
# @param [Google::Apis::RequestOptions] options
|
3091
|
+
# Request-specific options
|
3092
|
+
#
|
3093
|
+
# @yield [result, err] Result & error if block supplied
|
3094
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListTargetingOptionsResponse] parsed result object
|
3095
|
+
# @yieldparam err [StandardError] error object if request failed
|
3096
|
+
#
|
3097
|
+
# @return [Google::Apis::DisplayvideoV1::ListTargetingOptionsResponse]
|
3098
|
+
#
|
3099
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3100
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3101
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3102
|
+
def list_targeting_type_targeting_options(targeting_type, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3103
|
+
command = make_simple_command(:get, 'v1/targetingTypes/{+targetingType}/targetingOptions', options)
|
3104
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListTargetingOptionsResponse::Representation
|
3105
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListTargetingOptionsResponse
|
3106
|
+
command.params['targetingType'] = targeting_type unless targeting_type.nil?
|
3107
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
3108
|
+
command.query['filter'] = filter unless filter.nil?
|
3109
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
3110
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
3111
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
3112
|
+
command.query['fields'] = fields unless fields.nil?
|
3113
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3114
|
+
execute_or_queue_command(command, &block)
|
3115
|
+
end
|
3116
|
+
|
3117
|
+
protected
|
3118
|
+
|
3119
|
+
def apply_command_defaults(command)
|
3120
|
+
command.query['key'] = key unless key.nil?
|
3121
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3122
|
+
end
|
3123
|
+
end
|
3124
|
+
end
|
3125
|
+
end
|
3126
|
+
end
|