google-api-client 0.40.0 → 0.41.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +184 -0
- data/generated/google/apis/admob_v1/classes.rb +5 -6
- data/generated/google/apis/admob_v1.rb +1 -1
- data/generated/google/apis/androidenterprise_v1/classes.rb +547 -724
- data/generated/google/apis/androidenterprise_v1/representations.rb +0 -54
- data/generated/google/apis/androidenterprise_v1/service.rb +540 -795
- data/generated/google/apis/androidenterprise_v1.rb +2 -2
- data/generated/google/apis/androidmanagement_v1/classes.rb +117 -0
- data/generated/google/apis/androidmanagement_v1/representations.rb +39 -0
- data/generated/google/apis/androidmanagement_v1.rb +1 -1
- data/generated/google/apis/androidpublisher_v3/classes.rb +473 -736
- data/generated/google/apis/androidpublisher_v3/representations.rb +10 -201
- data/generated/google/apis/androidpublisher_v3/service.rb +531 -863
- data/generated/google/apis/androidpublisher_v3.rb +3 -3
- data/generated/google/apis/apigee_v1/classes.rb +12 -6
- data/generated/google/apis/apigee_v1/representations.rb +1 -0
- data/generated/google/apis/apigee_v1.rb +1 -1
- data/generated/google/apis/appsmarket_v2/classes.rb +160 -159
- data/generated/google/apis/appsmarket_v2/representations.rb +78 -78
- data/generated/google/apis/appsmarket_v2/service.rb +24 -39
- data/generated/google/apis/appsmarket_v2.rb +3 -3
- data/generated/google/apis/artifactregistry_v1beta1/classes.rb +122 -0
- data/generated/google/apis/artifactregistry_v1beta1/representations.rb +62 -0
- data/generated/google/apis/artifactregistry_v1beta1.rb +1 -1
- data/generated/google/apis/bigquery_v2/classes.rb +15 -7
- data/generated/google/apis/bigquery_v2.rb +1 -1
- data/generated/google/apis/bigquerydatatransfer_v1/classes.rb +4 -4
- data/generated/google/apis/bigquerydatatransfer_v1.rb +1 -1
- data/generated/google/apis/bigtableadmin_v1/classes.rb +5 -10
- data/generated/google/apis/bigtableadmin_v1.rb +1 -1
- data/generated/google/apis/bigtableadmin_v2/classes.rb +39 -31
- data/generated/google/apis/bigtableadmin_v2/service.rb +1 -5
- data/generated/google/apis/bigtableadmin_v2.rb +1 -1
- data/generated/google/apis/binaryauthorization_v1/classes.rb +1 -4
- data/generated/google/apis/binaryauthorization_v1.rb +1 -1
- data/generated/google/apis/books_v1/service.rb +2 -2
- data/generated/google/apis/books_v1.rb +1 -1
- data/generated/google/apis/calendar_v3.rb +1 -1
- data/generated/google/apis/chat_v1/classes.rb +2 -0
- data/generated/google/apis/chat_v1.rb +1 -1
- data/generated/google/apis/cloudasset_v1/classes.rb +37 -345
- data/generated/google/apis/cloudasset_v1/representations.rb +1 -96
- data/generated/google/apis/cloudasset_v1/service.rb +11 -186
- data/generated/google/apis/cloudasset_v1.rb +1 -1
- data/generated/google/apis/cloudasset_v1beta1/classes.rb +954 -42
- data/generated/google/apis/cloudasset_v1beta1/representations.rb +241 -0
- data/generated/google/apis/cloudasset_v1beta1/service.rb +8 -8
- data/generated/google/apis/cloudasset_v1beta1.rb +1 -1
- data/generated/google/apis/cloudasset_v1p1beta1/classes.rb +6 -6
- data/generated/google/apis/cloudasset_v1p1beta1/service.rb +15 -16
- data/generated/google/apis/cloudasset_v1p1beta1.rb +1 -1
- data/generated/google/apis/cloudasset_v1p4beta1/classes.rb +40 -23
- data/generated/google/apis/cloudasset_v1p4beta1/service.rb +34 -9
- data/generated/google/apis/cloudasset_v1p4beta1.rb +1 -1
- data/generated/google/apis/cloudbuild_v1/classes.rb +16 -4
- data/generated/google/apis/cloudbuild_v1/representations.rb +1 -0
- data/generated/google/apis/cloudbuild_v1/service.rb +42 -0
- data/generated/google/apis/cloudbuild_v1.rb +1 -1
- data/generated/google/apis/cloudbuild_v1alpha1/classes.rb +14 -2
- data/generated/google/apis/cloudbuild_v1alpha1/representations.rb +1 -0
- data/generated/google/apis/cloudbuild_v1alpha1.rb +1 -1
- data/generated/google/apis/cloudbuild_v1alpha2/classes.rb +14 -2
- data/generated/google/apis/cloudbuild_v1alpha2/representations.rb +1 -0
- data/generated/google/apis/cloudbuild_v1alpha2.rb +1 -1
- data/generated/google/apis/clouderrorreporting_v1beta1/classes.rb +1 -1
- data/generated/google/apis/clouderrorreporting_v1beta1/service.rb +5 -6
- data/generated/google/apis/clouderrorreporting_v1beta1.rb +1 -1
- data/generated/google/apis/cloudidentity_v1.rb +1 -1
- data/generated/google/apis/cloudidentity_v1beta1.rb +1 -1
- data/generated/google/apis/cloudkms_v1/classes.rb +7 -7
- data/generated/google/apis/cloudkms_v1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v1/classes.rb +20 -15
- data/generated/google/apis/cloudresourcemanager_v1/service.rb +21 -14
- data/generated/google/apis/cloudresourcemanager_v1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +10 -8
- data/generated/google/apis/cloudresourcemanager_v1beta1/service.rb +8 -8
- data/generated/google/apis/cloudresourcemanager_v1beta1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v2/classes.rb +6 -6
- data/generated/google/apis/cloudresourcemanager_v2.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v2beta1/classes.rb +6 -6
- data/generated/google/apis/cloudresourcemanager_v2beta1.rb +1 -1
- data/generated/google/apis/cloudsearch_v1/service.rb +1 -1
- data/generated/google/apis/cloudsearch_v1.rb +1 -1
- data/generated/google/apis/cloudtasks_v2/classes.rb +6 -4
- data/generated/google/apis/cloudtasks_v2.rb +1 -1
- data/generated/google/apis/cloudtasks_v2beta3/classes.rb +9 -0
- data/generated/google/apis/cloudtasks_v2beta3/representations.rb +1 -0
- data/generated/google/apis/cloudtasks_v2beta3.rb +1 -1
- data/generated/google/apis/compute_alpha/classes.rb +689 -145
- data/generated/google/apis/compute_alpha/representations.rb +217 -32
- data/generated/google/apis/compute_alpha/service.rb +869 -82
- data/generated/google/apis/compute_alpha.rb +1 -1
- data/generated/google/apis/compute_beta/classes.rb +173 -71
- data/generated/google/apis/compute_beta/representations.rb +25 -0
- data/generated/google/apis/compute_beta.rb +1 -1
- data/generated/google/apis/compute_v1/classes.rb +30 -18
- data/generated/google/apis/compute_v1/representations.rb +1 -0
- data/generated/google/apis/compute_v1.rb +1 -1
- data/generated/google/apis/container_v1beta1/classes.rb +21 -7
- data/generated/google/apis/container_v1beta1.rb +1 -1
- data/generated/google/apis/content_v2/classes.rb +41 -1
- data/generated/google/apis/content_v2/representations.rb +17 -0
- data/generated/google/apis/content_v2/service.rb +15 -6
- data/generated/google/apis/content_v2.rb +1 -1
- data/generated/google/apis/content_v2_1/classes.rb +444 -6
- data/generated/google/apis/content_v2_1/representations.rb +172 -0
- data/generated/google/apis/content_v2_1/service.rb +95 -6
- data/generated/google/apis/content_v2_1.rb +1 -1
- data/generated/google/apis/datafusion_v1beta1/classes.rb +64 -19
- data/generated/google/apis/datafusion_v1beta1/representations.rb +16 -0
- data/generated/google/apis/datafusion_v1beta1/service.rb +49 -2
- data/generated/google/apis/datafusion_v1beta1.rb +1 -1
- data/generated/google/apis/dataproc_v1/classes.rb +68 -22
- data/generated/google/apis/dataproc_v1/representations.rb +17 -0
- data/generated/google/apis/dataproc_v1.rb +1 -1
- data/generated/google/apis/dataproc_v1beta2/classes.rb +35 -23
- data/generated/google/apis/dataproc_v1beta2/representations.rb +1 -0
- data/generated/google/apis/dataproc_v1beta2.rb +1 -1
- data/generated/google/apis/dialogflow_v2/classes.rb +9 -29
- data/generated/google/apis/dialogflow_v2/representations.rb +0 -4
- data/generated/google/apis/dialogflow_v2/service.rb +14 -2
- data/generated/google/apis/dialogflow_v2.rb +1 -1
- data/generated/google/apis/dialogflow_v2beta1/classes.rb +0 -28
- data/generated/google/apis/dialogflow_v2beta1/representations.rb +0 -4
- data/generated/google/apis/dialogflow_v2beta1/service.rb +28 -4
- data/generated/google/apis/dialogflow_v2beta1.rb +1 -1
- data/generated/google/apis/displayvideo_v1/classes.rb +464 -1
- data/generated/google/apis/displayvideo_v1/representations.rb +238 -0
- data/generated/google/apis/displayvideo_v1/service.rb +1722 -376
- data/generated/google/apis/displayvideo_v1.rb +1 -1
- data/generated/google/apis/dlp_v2/classes.rb +8 -6
- data/generated/google/apis/dlp_v2/service.rb +170 -64
- data/generated/google/apis/dlp_v2.rb +1 -1
- data/generated/google/apis/documentai_v1beta2/classes.rb +3284 -0
- data/generated/google/apis/documentai_v1beta2/representations.rb +1344 -0
- data/generated/google/apis/{dialogflow_v3alpha1 → documentai_v1beta2}/service.rb +91 -118
- data/generated/google/apis/{dialogflow_v3alpha1.rb → documentai_v1beta2.rb} +11 -13
- data/generated/google/apis/drive_v2/service.rb +26 -78
- data/generated/google/apis/drive_v2.rb +1 -1
- data/generated/google/apis/drive_v3/service.rb +18 -54
- data/generated/google/apis/drive_v3.rb +1 -1
- data/generated/google/apis/fcm_v1/classes.rb +6 -0
- data/generated/google/apis/fcm_v1.rb +1 -1
- data/generated/google/apis/file_v1/classes.rb +0 -1156
- data/generated/google/apis/file_v1/representations.rb +0 -381
- data/generated/google/apis/file_v1.rb +1 -1
- data/generated/google/apis/file_v1beta1/classes.rb +67 -1156
- data/generated/google/apis/file_v1beta1/representations.rb +14 -376
- data/generated/google/apis/file_v1beta1.rb +1 -1
- data/generated/google/apis/firebase_v1beta1/classes.rb +7 -6
- data/generated/google/apis/firebase_v1beta1/service.rb +53 -49
- data/generated/google/apis/firebase_v1beta1.rb +1 -1
- data/generated/google/apis/firebasehosting_v1beta1/classes.rb +30 -25
- data/generated/google/apis/firebasehosting_v1beta1.rb +1 -1
- data/generated/google/apis/fitness_v1/classes.rb +1 -1
- data/generated/google/apis/fitness_v1.rb +1 -1
- data/generated/google/apis/games_v1.rb +1 -1
- data/generated/google/apis/genomics_v2alpha1/classes.rb +84 -0
- data/generated/google/apis/genomics_v2alpha1/representations.rb +28 -0
- data/generated/google/apis/genomics_v2alpha1/service.rb +38 -2
- data/generated/google/apis/genomics_v2alpha1.rb +1 -1
- data/generated/google/apis/gmail_v1/classes.rb +263 -200
- data/generated/google/apis/gmail_v1/service.rb +551 -743
- data/generated/google/apis/gmail_v1.rb +3 -2
- data/generated/google/apis/groupsmigration_v1/service.rb +10 -17
- data/generated/google/apis/groupsmigration_v1.rb +3 -2
- data/generated/google/apis/healthcare_v1/classes.rb +3 -3
- data/generated/google/apis/healthcare_v1/service.rb +5 -3
- data/generated/google/apis/healthcare_v1.rb +1 -1
- data/generated/google/apis/healthcare_v1beta1/classes.rb +913 -46
- data/generated/google/apis/healthcare_v1beta1/representations.rb +404 -0
- data/generated/google/apis/healthcare_v1beta1/service.rb +520 -3
- data/generated/google/apis/healthcare_v1beta1.rb +1 -1
- data/generated/google/apis/iam_v1/classes.rb +92 -81
- data/generated/google/apis/iam_v1/service.rb +167 -148
- data/generated/google/apis/iam_v1.rb +1 -1
- data/generated/google/apis/iamcredentials_v1/classes.rb +4 -3
- data/generated/google/apis/iamcredentials_v1/service.rb +1 -1
- data/generated/google/apis/iamcredentials_v1.rb +2 -2
- data/generated/google/apis/jobs_v3/classes.rb +4 -2
- data/generated/google/apis/jobs_v3.rb +1 -1
- data/generated/google/apis/jobs_v3p1beta1/classes.rb +4 -2
- data/generated/google/apis/jobs_v3p1beta1.rb +1 -1
- data/generated/google/apis/lifesciences_v2beta/classes.rb +10 -0
- data/generated/google/apis/lifesciences_v2beta/representations.rb +1 -0
- data/generated/google/apis/lifesciences_v2beta.rb +1 -1
- data/generated/google/apis/memcache_v1beta2/classes.rb +42 -11
- data/generated/google/apis/memcache_v1beta2/representations.rb +15 -0
- data/generated/google/apis/memcache_v1beta2.rb +1 -1
- data/generated/google/apis/monitoring_v1/classes.rb +46 -0
- data/generated/google/apis/monitoring_v1/representations.rb +18 -0
- data/generated/google/apis/monitoring_v1.rb +1 -1
- data/generated/google/apis/monitoring_v3/classes.rb +66 -17
- data/generated/google/apis/monitoring_v3/representations.rb +1 -0
- data/generated/google/apis/monitoring_v3.rb +1 -1
- data/generated/google/apis/osconfig_v1/classes.rb +2 -2
- data/generated/google/apis/osconfig_v1.rb +1 -1
- data/generated/google/apis/osconfig_v1beta/classes.rb +6 -7
- data/generated/google/apis/osconfig_v1beta.rb +1 -1
- data/generated/google/apis/pagespeedonline_v5/classes.rb +7 -0
- data/generated/google/apis/pagespeedonline_v5/representations.rb +1 -0
- data/generated/google/apis/pagespeedonline_v5.rb +1 -1
- data/generated/google/apis/people_v1/classes.rb +216 -0
- data/generated/google/apis/people_v1/representations.rb +82 -0
- data/generated/google/apis/people_v1/service.rb +371 -8
- data/generated/google/apis/people_v1.rb +1 -1
- data/generated/google/apis/playcustomapp_v1/classes.rb +7 -0
- data/generated/google/apis/playcustomapp_v1/representations.rb +1 -0
- data/generated/google/apis/playcustomapp_v1/service.rb +11 -19
- data/generated/google/apis/playcustomapp_v1.rb +3 -3
- data/generated/google/apis/policytroubleshooter_v1/classes.rb +6 -6
- data/generated/google/apis/policytroubleshooter_v1.rb +1 -1
- data/generated/google/apis/policytroubleshooter_v1beta/classes.rb +6 -6
- data/generated/google/apis/policytroubleshooter_v1beta.rb +1 -1
- data/generated/google/apis/prod_tt_sasportal_v1alpha1/service.rb +30 -0
- data/generated/google/apis/prod_tt_sasportal_v1alpha1.rb +1 -1
- data/generated/google/apis/pubsub_v1/classes.rb +64 -8
- data/generated/google/apis/pubsub_v1/representations.rb +28 -0
- data/generated/google/apis/pubsub_v1/service.rb +35 -1
- data/generated/google/apis/pubsub_v1.rb +1 -1
- data/generated/google/apis/recommender_v1/classes.rb +505 -0
- data/generated/google/apis/recommender_v1/representations.rb +232 -0
- data/generated/google/apis/recommender_v1/service.rb +266 -0
- data/generated/google/apis/{customsearch_v1.rb → recommender_v1.rb} +11 -8
- data/generated/google/apis/run_v1/classes.rb +15 -6
- data/generated/google/apis/run_v1/representations.rb +1 -0
- data/generated/google/apis/run_v1.rb +1 -1
- data/generated/google/apis/run_v1alpha1/classes.rb +15 -6
- data/generated/google/apis/run_v1alpha1/representations.rb +1 -0
- data/generated/google/apis/run_v1alpha1.rb +1 -1
- data/generated/google/apis/run_v1beta1.rb +1 -1
- data/generated/google/apis/sasportal_v1alpha1/service.rb +30 -0
- data/generated/google/apis/sasportal_v1alpha1.rb +1 -1
- data/generated/google/apis/secretmanager_v1/classes.rb +6 -6
- data/generated/google/apis/secretmanager_v1.rb +1 -1
- data/generated/google/apis/secretmanager_v1beta1/classes.rb +6 -6
- data/generated/google/apis/secretmanager_v1beta1.rb +1 -1
- data/generated/google/apis/securitycenter_v1/classes.rb +116 -16
- data/generated/google/apis/securitycenter_v1/representations.rb +38 -0
- data/generated/google/apis/securitycenter_v1/service.rb +10 -10
- data/generated/google/apis/securitycenter_v1.rb +1 -1
- data/generated/google/apis/securitycenter_v1beta1/classes.rb +106 -6
- data/generated/google/apis/securitycenter_v1beta1/representations.rb +38 -0
- data/generated/google/apis/securitycenter_v1beta1.rb +1 -1
- data/generated/google/apis/securitycenter_v1p1alpha1/classes.rb +100 -0
- data/generated/google/apis/securitycenter_v1p1alpha1/representations.rb +38 -0
- data/generated/google/apis/securitycenter_v1p1alpha1.rb +1 -1
- data/generated/google/apis/securitycenter_v1p1beta1/classes.rb +116 -16
- data/generated/google/apis/securitycenter_v1p1beta1/representations.rb +38 -0
- data/generated/google/apis/securitycenter_v1p1beta1/service.rb +10 -10
- data/generated/google/apis/securitycenter_v1p1beta1.rb +1 -1
- data/generated/google/apis/serviceconsumermanagement_v1/classes.rb +223 -43
- data/generated/google/apis/serviceconsumermanagement_v1/representations.rb +33 -1
- data/generated/google/apis/serviceconsumermanagement_v1.rb +1 -1
- data/generated/google/apis/serviceconsumermanagement_v1beta1/classes.rb +229 -43
- data/generated/google/apis/serviceconsumermanagement_v1beta1/representations.rb +34 -1
- data/generated/google/apis/serviceconsumermanagement_v1beta1.rb +1 -1
- data/generated/google/apis/servicecontrol_v1/classes.rb +3 -3
- data/generated/google/apis/servicecontrol_v1.rb +1 -1
- data/generated/google/apis/servicemanagement_v1/classes.rb +123 -49
- data/generated/google/apis/servicemanagement_v1/representations.rb +0 -1
- data/generated/google/apis/servicemanagement_v1.rb +1 -1
- data/generated/google/apis/servicenetworking_v1/classes.rb +119 -43
- data/generated/google/apis/servicenetworking_v1/representations.rb +0 -1
- data/generated/google/apis/servicenetworking_v1.rb +1 -1
- data/generated/google/apis/servicenetworking_v1beta/classes.rb +119 -43
- data/generated/google/apis/servicenetworking_v1beta/representations.rb +0 -1
- data/generated/google/apis/servicenetworking_v1beta.rb +1 -1
- data/generated/google/apis/serviceusage_v1/classes.rb +221 -43
- data/generated/google/apis/serviceusage_v1/representations.rb +34 -1
- data/generated/google/apis/serviceusage_v1.rb +1 -1
- data/generated/google/apis/serviceusage_v1beta1/classes.rb +272 -43
- data/generated/google/apis/serviceusage_v1beta1/representations.rb +63 -1
- data/generated/google/apis/serviceusage_v1beta1/service.rb +71 -0
- data/generated/google/apis/serviceusage_v1beta1.rb +1 -1
- data/generated/google/apis/slides_v1/classes.rb +4 -0
- data/generated/google/apis/slides_v1.rb +1 -1
- data/generated/google/apis/sourcerepo_v1/classes.rb +23 -10
- data/generated/google/apis/sourcerepo_v1/service.rb +3 -0
- data/generated/google/apis/sourcerepo_v1.rb +1 -1
- data/generated/google/apis/spanner_v1/classes.rb +1 -2
- data/generated/google/apis/spanner_v1/service.rb +8 -8
- data/generated/google/apis/spanner_v1.rb +1 -1
- data/generated/google/apis/sql_v1beta4/classes.rb +7 -0
- data/generated/google/apis/sql_v1beta4/representations.rb +1 -0
- data/generated/google/apis/sql_v1beta4.rb +1 -1
- data/generated/google/apis/storagetransfer_v1/classes.rb +2 -1
- data/generated/google/apis/storagetransfer_v1.rb +1 -1
- data/generated/google/apis/testing_v1/classes.rb +2 -1
- data/generated/google/apis/testing_v1.rb +1 -1
- data/generated/google/apis/texttospeech_v1/classes.rb +1 -1
- data/generated/google/apis/texttospeech_v1.rb +1 -1
- data/generated/google/apis/texttospeech_v1beta1/classes.rb +1 -1
- data/generated/google/apis/texttospeech_v1beta1.rb +1 -1
- data/generated/google/apis/videointelligence_v1/classes.rb +1 -1
- data/generated/google/apis/videointelligence_v1/service.rb +32 -0
- data/generated/google/apis/videointelligence_v1.rb +1 -1
- data/generated/google/apis/videointelligence_v1beta2/classes.rb +1 -1
- data/generated/google/apis/videointelligence_v1beta2.rb +1 -1
- data/generated/google/apis/videointelligence_v1p1beta1/classes.rb +1 -1
- data/generated/google/apis/videointelligence_v1p1beta1.rb +1 -1
- data/generated/google/apis/videointelligence_v1p2beta1/classes.rb +1 -1
- data/generated/google/apis/videointelligence_v1p2beta1.rb +1 -1
- data/generated/google/apis/videointelligence_v1p3beta1/classes.rb +1 -1
- data/generated/google/apis/videointelligence_v1p3beta1.rb +1 -1
- data/generated/google/apis/vision_v1/classes.rb +18 -0
- data/generated/google/apis/vision_v1.rb +1 -1
- data/generated/google/apis/vision_v1p1beta1/classes.rb +18 -0
- data/generated/google/apis/vision_v1p1beta1.rb +1 -1
- data/generated/google/apis/vision_v1p2beta1/classes.rb +18 -0
- data/generated/google/apis/vision_v1p2beta1.rb +1 -1
- data/generated/google/apis/youtube_partner_v1.rb +1 -1
- data/generated/google/apis/youtube_v3/classes.rb +38 -0
- data/generated/google/apis/youtube_v3/representations.rb +27 -0
- data/generated/google/apis/youtube_v3/service.rb +32 -0
- data/generated/google/apis/youtube_v3.rb +1 -1
- data/lib/google/apis/core/api_command.rb +12 -7
- data/lib/google/apis/options.rb +5 -1
- data/lib/google/apis/version.rb +1 -1
- metadata +11 -11
- data/generated/google/apis/customsearch_v1/classes.rb +0 -1606
- data/generated/google/apis/customsearch_v1/representations.rb +0 -372
- data/generated/google/apis/customsearch_v1/service.rb +0 -608
- data/generated/google/apis/dialogflow_v3alpha1/classes.rb +0 -5579
- data/generated/google/apis/dialogflow_v3alpha1/representations.rb +0 -2295
|
@@ -615,6 +615,8 @@ module Google
|
|
|
615
615
|
execute_or_queue_command(command, &block)
|
|
616
616
|
end
|
|
617
617
|
|
|
618
|
+
# Updates an existing inventory source.
|
|
619
|
+
# Returns the updated inventory source if successful.
|
|
618
620
|
# Gets a channel for a partner or advertiser.
|
|
619
621
|
# @param [Fixnum] advertiser_id
|
|
620
622
|
# The ID of the advertiser that owns the fetched channel.
|
|
@@ -719,6 +721,234 @@ module Google
|
|
|
719
721
|
execute_or_queue_command(command, &block)
|
|
720
722
|
end
|
|
721
723
|
|
|
724
|
+
# Updates a channel. Returns the updated channel if successful.
|
|
725
|
+
# @param [Fixnum] advertiser_id
|
|
726
|
+
# The ID of the advertiser that owns the created channel.
|
|
727
|
+
# @param [Fixnum] channel_id
|
|
728
|
+
# Output only. The unique ID of the channel. Assigned by the system.
|
|
729
|
+
# @param [Google::Apis::DisplayvideoV1::Channel] channel_object
|
|
730
|
+
# @param [Fixnum] partner_id
|
|
731
|
+
# The ID of the partner that owns the created channel.
|
|
732
|
+
# @param [String] update_mask
|
|
733
|
+
# Required. The mask to control which fields to update.
|
|
734
|
+
# @param [String] fields
|
|
735
|
+
# Selector specifying which fields to include in a partial response.
|
|
736
|
+
# @param [String] quota_user
|
|
737
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
738
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
739
|
+
# @param [Google::Apis::RequestOptions] options
|
|
740
|
+
# Request-specific options
|
|
741
|
+
#
|
|
742
|
+
# @yield [result, err] Result & error if block supplied
|
|
743
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Channel] parsed result object
|
|
744
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
745
|
+
#
|
|
746
|
+
# @return [Google::Apis::DisplayvideoV1::Channel]
|
|
747
|
+
#
|
|
748
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
749
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
750
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
751
|
+
def patch_advertiser_channel(advertiser_id, channel_id, channel_object = nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
752
|
+
command = make_simple_command(:patch, 'v1/advertisers/{+advertiserId}/channels/{channelId}', options)
|
|
753
|
+
command.request_representation = Google::Apis::DisplayvideoV1::Channel::Representation
|
|
754
|
+
command.request_object = channel_object
|
|
755
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Channel::Representation
|
|
756
|
+
command.response_class = Google::Apis::DisplayvideoV1::Channel
|
|
757
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
758
|
+
command.params['channelId'] = channel_id unless channel_id.nil?
|
|
759
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
|
760
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
761
|
+
command.query['fields'] = fields unless fields.nil?
|
|
762
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
763
|
+
execute_or_queue_command(command, &block)
|
|
764
|
+
end
|
|
765
|
+
|
|
766
|
+
# Bulk edits sites under a single channel.
|
|
767
|
+
# The operation will delete the sites provided in
|
|
768
|
+
# BulkEditSitesRequest.deleted_sites and then create the sites
|
|
769
|
+
# provided in BulkEditSitesRequest.created_sites.
|
|
770
|
+
# @param [Fixnum] advertiser_id
|
|
771
|
+
# The ID of the advertiser that owns the parent channel.
|
|
772
|
+
# @param [Fixnum] channel_id
|
|
773
|
+
# Required. The ID of the parent channel to which the sites belong.
|
|
774
|
+
# @param [Google::Apis::DisplayvideoV1::BulkEditSitesRequest] bulk_edit_sites_request_object
|
|
775
|
+
# @param [String] fields
|
|
776
|
+
# Selector specifying which fields to include in a partial response.
|
|
777
|
+
# @param [String] quota_user
|
|
778
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
779
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
780
|
+
# @param [Google::Apis::RequestOptions] options
|
|
781
|
+
# Request-specific options
|
|
782
|
+
#
|
|
783
|
+
# @yield [result, err] Result & error if block supplied
|
|
784
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::BulkEditSitesResponse] parsed result object
|
|
785
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
786
|
+
#
|
|
787
|
+
# @return [Google::Apis::DisplayvideoV1::BulkEditSitesResponse]
|
|
788
|
+
#
|
|
789
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
790
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
791
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
792
|
+
def bulk_advertiser_channel_site_edit(advertiser_id, channel_id, bulk_edit_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
793
|
+
command = make_simple_command(:post, 'v1/advertisers/{advertiserId}/channels/{+channelId}/sites:bulkEdit', options)
|
|
794
|
+
command.request_representation = Google::Apis::DisplayvideoV1::BulkEditSitesRequest::Representation
|
|
795
|
+
command.request_object = bulk_edit_sites_request_object
|
|
796
|
+
command.response_representation = Google::Apis::DisplayvideoV1::BulkEditSitesResponse::Representation
|
|
797
|
+
command.response_class = Google::Apis::DisplayvideoV1::BulkEditSitesResponse
|
|
798
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
799
|
+
command.params['channelId'] = channel_id unless channel_id.nil?
|
|
800
|
+
command.query['fields'] = fields unless fields.nil?
|
|
801
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
802
|
+
execute_or_queue_command(command, &block)
|
|
803
|
+
end
|
|
804
|
+
|
|
805
|
+
# Creates a site in a channel.
|
|
806
|
+
# @param [Fixnum] advertiser_id
|
|
807
|
+
# The ID of the advertiser that owns the parent channel.
|
|
808
|
+
# @param [Fixnum] channel_id
|
|
809
|
+
# Required. The ID of the parent channel in which the site will be created.
|
|
810
|
+
# @param [Google::Apis::DisplayvideoV1::Site] site_object
|
|
811
|
+
# @param [Fixnum] partner_id
|
|
812
|
+
# The ID of the partner that owns the parent channel.
|
|
813
|
+
# @param [String] fields
|
|
814
|
+
# Selector specifying which fields to include in a partial response.
|
|
815
|
+
# @param [String] quota_user
|
|
816
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
817
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
818
|
+
# @param [Google::Apis::RequestOptions] options
|
|
819
|
+
# Request-specific options
|
|
820
|
+
#
|
|
821
|
+
# @yield [result, err] Result & error if block supplied
|
|
822
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Site] parsed result object
|
|
823
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
824
|
+
#
|
|
825
|
+
# @return [Google::Apis::DisplayvideoV1::Site]
|
|
826
|
+
#
|
|
827
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
828
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
829
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
830
|
+
def create_advertiser_channel_site(advertiser_id, channel_id, site_object = nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
831
|
+
command = make_simple_command(:post, 'v1/advertisers/{advertiserId}/channels/{+channelId}/sites', options)
|
|
832
|
+
command.request_representation = Google::Apis::DisplayvideoV1::Site::Representation
|
|
833
|
+
command.request_object = site_object
|
|
834
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Site::Representation
|
|
835
|
+
command.response_class = Google::Apis::DisplayvideoV1::Site
|
|
836
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
837
|
+
command.params['channelId'] = channel_id unless channel_id.nil?
|
|
838
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
|
839
|
+
command.query['fields'] = fields unless fields.nil?
|
|
840
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
841
|
+
execute_or_queue_command(command, &block)
|
|
842
|
+
end
|
|
843
|
+
|
|
844
|
+
# Deletes a site from a channel.
|
|
845
|
+
# @param [Fixnum] advertiser_id
|
|
846
|
+
# The ID of the advertiser that owns the parent channel.
|
|
847
|
+
# @param [Fixnum] channel_id
|
|
848
|
+
# Required. The ID of the parent channel to which the site belongs.
|
|
849
|
+
# @param [String] url_or_app_id
|
|
850
|
+
# Required. The URL or app ID of the site to delete.
|
|
851
|
+
# @param [Fixnum] partner_id
|
|
852
|
+
# The ID of the partner that owns the parent channel.
|
|
853
|
+
# @param [String] fields
|
|
854
|
+
# Selector specifying which fields to include in a partial response.
|
|
855
|
+
# @param [String] quota_user
|
|
856
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
857
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
858
|
+
# @param [Google::Apis::RequestOptions] options
|
|
859
|
+
# Request-specific options
|
|
860
|
+
#
|
|
861
|
+
# @yield [result, err] Result & error if block supplied
|
|
862
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
|
863
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
864
|
+
#
|
|
865
|
+
# @return [Google::Apis::DisplayvideoV1::Empty]
|
|
866
|
+
#
|
|
867
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
868
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
869
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
870
|
+
def delete_advertiser_channel_site(advertiser_id, channel_id, url_or_app_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
871
|
+
command = make_simple_command(:delete, 'v1/advertisers/{advertiserId}/channels/{+channelId}/sites/{+urlOrAppId}', options)
|
|
872
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
|
873
|
+
command.response_class = Google::Apis::DisplayvideoV1::Empty
|
|
874
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
875
|
+
command.params['channelId'] = channel_id unless channel_id.nil?
|
|
876
|
+
command.params['urlOrAppId'] = url_or_app_id unless url_or_app_id.nil?
|
|
877
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
|
878
|
+
command.query['fields'] = fields unless fields.nil?
|
|
879
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
880
|
+
execute_or_queue_command(command, &block)
|
|
881
|
+
end
|
|
882
|
+
|
|
883
|
+
# Lists sites in a channel.
|
|
884
|
+
# @param [Fixnum] advertiser_id
|
|
885
|
+
# The ID of the advertiser that owns the parent channel.
|
|
886
|
+
# @param [Fixnum] channel_id
|
|
887
|
+
# Required. The ID of the parent channel to which the requested sites belong.
|
|
888
|
+
# @param [String] filter
|
|
889
|
+
# Allows filtering by site fields.
|
|
890
|
+
# Supported syntax:
|
|
891
|
+
# * Filter expressions for site currently can only contain at most one
|
|
892
|
+
# * restriction.
|
|
893
|
+
# * A restriction has the form of ``field` `operator` `value``.
|
|
894
|
+
# * The operator must be `CONTAINS (:)`.
|
|
895
|
+
# * Supported fields:
|
|
896
|
+
# - `urlOrAppId`
|
|
897
|
+
# Examples:
|
|
898
|
+
# * All sites for which the URL or app ID contains "google":
|
|
899
|
+
# `urlOrAppId : "google"`
|
|
900
|
+
# @param [String] order_by
|
|
901
|
+
# Field by which to sort the list.
|
|
902
|
+
# Acceptable values are:
|
|
903
|
+
# * `urlOrAppId` (default)
|
|
904
|
+
# The default sorting order is ascending. To specify descending order for a
|
|
905
|
+
# field, a suffix " desc" should be added to the field name. Example:
|
|
906
|
+
# `urlOrAppId desc`.
|
|
907
|
+
# @param [Fixnum] page_size
|
|
908
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
909
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
|
910
|
+
# is specified.
|
|
911
|
+
# @param [String] page_token
|
|
912
|
+
# A token identifying a page of results the server should return.
|
|
913
|
+
# Typically, this is the value of
|
|
914
|
+
# next_page_token returned from the
|
|
915
|
+
# previous call to `ListSites` method. If not specified, the first page
|
|
916
|
+
# of results will be returned.
|
|
917
|
+
# @param [Fixnum] partner_id
|
|
918
|
+
# The ID of the partner that owns the parent channel.
|
|
919
|
+
# @param [String] fields
|
|
920
|
+
# Selector specifying which fields to include in a partial response.
|
|
921
|
+
# @param [String] quota_user
|
|
922
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
923
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
924
|
+
# @param [Google::Apis::RequestOptions] options
|
|
925
|
+
# Request-specific options
|
|
926
|
+
#
|
|
927
|
+
# @yield [result, err] Result & error if block supplied
|
|
928
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListSitesResponse] parsed result object
|
|
929
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
930
|
+
#
|
|
931
|
+
# @return [Google::Apis::DisplayvideoV1::ListSitesResponse]
|
|
932
|
+
#
|
|
933
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
934
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
935
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
936
|
+
def list_advertiser_channel_sites(advertiser_id, channel_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
937
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/channels/{+channelId}/sites', options)
|
|
938
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListSitesResponse::Representation
|
|
939
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListSitesResponse
|
|
940
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
941
|
+
command.params['channelId'] = channel_id unless channel_id.nil?
|
|
942
|
+
command.query['filter'] = filter unless filter.nil?
|
|
943
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
|
944
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
945
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
946
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
|
947
|
+
command.query['fields'] = fields unless fields.nil?
|
|
948
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
949
|
+
execute_or_queue_command(command, &block)
|
|
950
|
+
end
|
|
951
|
+
|
|
722
952
|
# Creates a new creative.
|
|
723
953
|
# Returns the newly created creative if successful.
|
|
724
954
|
# @param [Fixnum] advertiser_id
|
|
@@ -1715,6 +1945,40 @@ module Google
|
|
|
1715
1945
|
execute_or_queue_command(command, &block)
|
|
1716
1946
|
end
|
|
1717
1947
|
|
|
1948
|
+
# Creates a new location list. Returns the newly created location list if
|
|
1949
|
+
# successful.
|
|
1950
|
+
# @param [Fixnum] advertiser_id
|
|
1951
|
+
# Required. The ID of the DV360 advertiser to which the location list belongs.
|
|
1952
|
+
# @param [Google::Apis::DisplayvideoV1::LocationList] location_list_object
|
|
1953
|
+
# @param [String] fields
|
|
1954
|
+
# Selector specifying which fields to include in a partial response.
|
|
1955
|
+
# @param [String] quota_user
|
|
1956
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1957
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1958
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1959
|
+
# Request-specific options
|
|
1960
|
+
#
|
|
1961
|
+
# @yield [result, err] Result & error if block supplied
|
|
1962
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::LocationList] parsed result object
|
|
1963
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1964
|
+
#
|
|
1965
|
+
# @return [Google::Apis::DisplayvideoV1::LocationList]
|
|
1966
|
+
#
|
|
1967
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1968
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1969
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1970
|
+
def create_advertiser_location_list(advertiser_id, location_list_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1971
|
+
command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/locationLists', options)
|
|
1972
|
+
command.request_representation = Google::Apis::DisplayvideoV1::LocationList::Representation
|
|
1973
|
+
command.request_object = location_list_object
|
|
1974
|
+
command.response_representation = Google::Apis::DisplayvideoV1::LocationList::Representation
|
|
1975
|
+
command.response_class = Google::Apis::DisplayvideoV1::LocationList
|
|
1976
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
1977
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1978
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1979
|
+
execute_or_queue_command(command, &block)
|
|
1980
|
+
end
|
|
1981
|
+
|
|
1718
1982
|
# Gets a location list.
|
|
1719
1983
|
# @param [Fixnum] advertiser_id
|
|
1720
1984
|
# Required. The ID of the DV360 advertiser to which the fetched location list
|
|
@@ -1817,14 +2081,14 @@ module Google
|
|
|
1817
2081
|
execute_or_queue_command(command, &block)
|
|
1818
2082
|
end
|
|
1819
2083
|
|
|
1820
|
-
#
|
|
1821
|
-
# list ID.
|
|
2084
|
+
# Updates a location list. Returns the updated location list if successful.
|
|
1822
2085
|
# @param [Fixnum] advertiser_id
|
|
1823
|
-
# Required. The ID of the DV360 advertiser to which the
|
|
1824
|
-
#
|
|
1825
|
-
#
|
|
1826
|
-
# @param [
|
|
1827
|
-
#
|
|
2086
|
+
# Required. The ID of the DV360 advertiser to which the location lists belongs.
|
|
2087
|
+
# @param [Fixnum] location_list_id
|
|
2088
|
+
# Output only. The unique ID of the location list. Assigned by the system.
|
|
2089
|
+
# @param [Google::Apis::DisplayvideoV1::LocationList] location_list_object
|
|
2090
|
+
# @param [String] update_mask
|
|
2091
|
+
# Required. The mask to control which fields to update.
|
|
1828
2092
|
# @param [String] fields
|
|
1829
2093
|
# Selector specifying which fields to include in a partial response.
|
|
1830
2094
|
# @param [String] quota_user
|
|
@@ -1834,40 +2098,39 @@ module Google
|
|
|
1834
2098
|
# Request-specific options
|
|
1835
2099
|
#
|
|
1836
2100
|
# @yield [result, err] Result & error if block supplied
|
|
1837
|
-
# @yieldparam result [Google::Apis::DisplayvideoV1::
|
|
2101
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::LocationList] parsed result object
|
|
1838
2102
|
# @yieldparam err [StandardError] error object if request failed
|
|
1839
2103
|
#
|
|
1840
|
-
# @return [Google::Apis::DisplayvideoV1::
|
|
2104
|
+
# @return [Google::Apis::DisplayvideoV1::LocationList]
|
|
1841
2105
|
#
|
|
1842
2106
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1843
2107
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1844
2108
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1845
|
-
def
|
|
1846
|
-
command = make_simple_command(:
|
|
1847
|
-
command.
|
|
1848
|
-
command.
|
|
2109
|
+
def patch_advertiser_location_list(advertiser_id, location_list_id, location_list_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
2110
|
+
command = make_simple_command(:patch, 'v1/advertisers/{+advertiserId}/locationLists/{locationListId}', options)
|
|
2111
|
+
command.request_representation = Google::Apis::DisplayvideoV1::LocationList::Representation
|
|
2112
|
+
command.request_object = location_list_object
|
|
2113
|
+
command.response_representation = Google::Apis::DisplayvideoV1::LocationList::Representation
|
|
2114
|
+
command.response_class = Google::Apis::DisplayvideoV1::LocationList
|
|
1849
2115
|
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
1850
|
-
command.params['
|
|
2116
|
+
command.params['locationListId'] = location_list_id unless location_list_id.nil?
|
|
2117
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
1851
2118
|
command.query['fields'] = fields unless fields.nil?
|
|
1852
2119
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1853
2120
|
execute_or_queue_command(command, &block)
|
|
1854
2121
|
end
|
|
1855
2122
|
|
|
1856
|
-
#
|
|
2123
|
+
# Bulk edits multiple assignments between locations and a single location
|
|
2124
|
+
# list.
|
|
2125
|
+
# The operation will delete the assigned locations provided in
|
|
2126
|
+
# BulkEditAssignedLocationsRequest.deleted_assigned_locations and then
|
|
2127
|
+
# create the assigned locations provided in
|
|
2128
|
+
# BulkEditAssignedLocationsRequest.created_assigned_locations.
|
|
1857
2129
|
# @param [Fixnum] advertiser_id
|
|
1858
|
-
# Required. The ID of the DV360 advertiser to which the
|
|
1859
|
-
#
|
|
1860
|
-
#
|
|
1861
|
-
# @param [
|
|
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.
|
|
2130
|
+
# Required. The ID of the DV360 advertiser to which the location list belongs.
|
|
2131
|
+
# @param [Fixnum] location_list_id
|
|
2132
|
+
# Required. The ID of the location list to which these assignments are assigned.
|
|
2133
|
+
# @param [Google::Apis::DisplayvideoV1::BulkEditAssignedLocationsRequest] bulk_edit_assigned_locations_request_object
|
|
1871
2134
|
# @param [String] fields
|
|
1872
2135
|
# Selector specifying which fields to include in a partial response.
|
|
1873
2136
|
# @param [String] quota_user
|
|
@@ -1877,33 +2140,33 @@ module Google
|
|
|
1877
2140
|
# Request-specific options
|
|
1878
2141
|
#
|
|
1879
2142
|
# @yield [result, err] Result & error if block supplied
|
|
1880
|
-
# @yieldparam result [Google::Apis::DisplayvideoV1::
|
|
2143
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::BulkEditAssignedLocationsResponse] parsed result object
|
|
1881
2144
|
# @yieldparam err [StandardError] error object if request failed
|
|
1882
2145
|
#
|
|
1883
|
-
# @return [Google::Apis::DisplayvideoV1::
|
|
2146
|
+
# @return [Google::Apis::DisplayvideoV1::BulkEditAssignedLocationsResponse]
|
|
1884
2147
|
#
|
|
1885
2148
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1886
2149
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1887
2150
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1888
|
-
def
|
|
1889
|
-
command = make_simple_command(:
|
|
1890
|
-
command.
|
|
1891
|
-
command.
|
|
2151
|
+
def bulk_edit_assigned_locations(advertiser_id, location_list_id, bulk_edit_assigned_locations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
2152
|
+
command = make_simple_command(:post, 'v1/advertisers/{advertiserId}/locationLists/{+locationListId}/assignedLocations:bulkEdit', options)
|
|
2153
|
+
command.request_representation = Google::Apis::DisplayvideoV1::BulkEditAssignedLocationsRequest::Representation
|
|
2154
|
+
command.request_object = bulk_edit_assigned_locations_request_object
|
|
2155
|
+
command.response_representation = Google::Apis::DisplayvideoV1::BulkEditAssignedLocationsResponse::Representation
|
|
2156
|
+
command.response_class = Google::Apis::DisplayvideoV1::BulkEditAssignedLocationsResponse
|
|
1892
2157
|
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
1893
|
-
command.
|
|
1894
|
-
command.query['pageToken'] = page_token unless page_token.nil?
|
|
2158
|
+
command.params['locationListId'] = location_list_id unless location_list_id.nil?
|
|
1895
2159
|
command.query['fields'] = fields unless fields.nil?
|
|
1896
2160
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1897
2161
|
execute_or_queue_command(command, &block)
|
|
1898
2162
|
end
|
|
1899
2163
|
|
|
1900
|
-
#
|
|
1901
|
-
# Returns the assigned targeting option if successful.
|
|
2164
|
+
# Creates an assignment between a location and a location list.
|
|
1902
2165
|
# @param [Fixnum] advertiser_id
|
|
1903
|
-
# Required. The ID of the advertiser.
|
|
1904
|
-
# @param [
|
|
1905
|
-
# Required.
|
|
1906
|
-
# @param [Google::Apis::DisplayvideoV1::
|
|
2166
|
+
# Required. The ID of the DV360 advertiser to which the location list belongs.
|
|
2167
|
+
# @param [Fixnum] location_list_id
|
|
2168
|
+
# Required. The ID of the location list for which the assignment will be created.
|
|
2169
|
+
# @param [Google::Apis::DisplayvideoV1::AssignedLocation] assigned_location_object
|
|
1907
2170
|
# @param [String] fields
|
|
1908
2171
|
# Selector specifying which fields to include in a partial response.
|
|
1909
2172
|
# @param [String] quota_user
|
|
@@ -1913,34 +2176,873 @@ module Google
|
|
|
1913
2176
|
# Request-specific options
|
|
1914
2177
|
#
|
|
1915
2178
|
# @yield [result, err] Result & error if block supplied
|
|
1916
|
-
# @yieldparam result [Google::Apis::DisplayvideoV1::
|
|
2179
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::AssignedLocation] parsed result object
|
|
1917
2180
|
# @yieldparam err [StandardError] error object if request failed
|
|
1918
2181
|
#
|
|
1919
|
-
# @return [Google::Apis::DisplayvideoV1::
|
|
2182
|
+
# @return [Google::Apis::DisplayvideoV1::AssignedLocation]
|
|
1920
2183
|
#
|
|
1921
2184
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1922
2185
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1923
2186
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1924
|
-
def
|
|
1925
|
-
command = make_simple_command(:post, 'v1/advertisers/{
|
|
1926
|
-
command.request_representation = Google::Apis::DisplayvideoV1::
|
|
1927
|
-
command.request_object =
|
|
1928
|
-
command.response_representation = Google::Apis::DisplayvideoV1::
|
|
1929
|
-
command.response_class = Google::Apis::DisplayvideoV1::
|
|
2187
|
+
def create_advertiser_location_list_assigned_location(advertiser_id, location_list_id, assigned_location_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
2188
|
+
command = make_simple_command(:post, 'v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations', options)
|
|
2189
|
+
command.request_representation = Google::Apis::DisplayvideoV1::AssignedLocation::Representation
|
|
2190
|
+
command.request_object = assigned_location_object
|
|
2191
|
+
command.response_representation = Google::Apis::DisplayvideoV1::AssignedLocation::Representation
|
|
2192
|
+
command.response_class = Google::Apis::DisplayvideoV1::AssignedLocation
|
|
1930
2193
|
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
1931
|
-
command.params['
|
|
2194
|
+
command.params['locationListId'] = location_list_id unless location_list_id.nil?
|
|
1932
2195
|
command.query['fields'] = fields unless fields.nil?
|
|
1933
2196
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1934
2197
|
execute_or_queue_command(command, &block)
|
|
1935
2198
|
end
|
|
1936
2199
|
|
|
1937
|
-
# Deletes
|
|
2200
|
+
# Deletes the assignment between a location and a location list.
|
|
1938
2201
|
# @param [Fixnum] advertiser_id
|
|
1939
|
-
# Required. The ID of the advertiser.
|
|
2202
|
+
# Required. The ID of the DV360 advertiser to which the location list belongs.
|
|
2203
|
+
# @param [Fixnum] location_list_id
|
|
2204
|
+
# Required. The ID of the location list to which this assignment is assigned.
|
|
2205
|
+
# @param [Fixnum] assigned_location_id
|
|
2206
|
+
# Required. The ID of the assigned location to delete.
|
|
2207
|
+
# @param [String] fields
|
|
2208
|
+
# Selector specifying which fields to include in a partial response.
|
|
2209
|
+
# @param [String] quota_user
|
|
2210
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2211
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2212
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2213
|
+
# Request-specific options
|
|
2214
|
+
#
|
|
2215
|
+
# @yield [result, err] Result & error if block supplied
|
|
2216
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
|
2217
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2218
|
+
#
|
|
2219
|
+
# @return [Google::Apis::DisplayvideoV1::Empty]
|
|
2220
|
+
#
|
|
2221
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2222
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2223
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2224
|
+
def delete_advertiser_location_list_assigned_location(advertiser_id, location_list_id, assigned_location_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
2225
|
+
command = make_simple_command(:delete, 'v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{+assignedLocationId}', options)
|
|
2226
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
|
2227
|
+
command.response_class = Google::Apis::DisplayvideoV1::Empty
|
|
2228
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
2229
|
+
command.params['locationListId'] = location_list_id unless location_list_id.nil?
|
|
2230
|
+
command.params['assignedLocationId'] = assigned_location_id unless assigned_location_id.nil?
|
|
2231
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2232
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2233
|
+
execute_or_queue_command(command, &block)
|
|
2234
|
+
end
|
|
2235
|
+
|
|
2236
|
+
# Lists locations assigned to a location list.
|
|
2237
|
+
# @param [Fixnum] advertiser_id
|
|
2238
|
+
# Required. The ID of the DV360 advertiser to which the location list belongs.
|
|
2239
|
+
# @param [Fixnum] location_list_id
|
|
2240
|
+
# Required. The ID of the location list to which these assignments are assigned.
|
|
2241
|
+
# @param [String] filter
|
|
2242
|
+
# Allows filtering by location list assignment fields.
|
|
2243
|
+
# Supported syntax:
|
|
2244
|
+
# * Filter expressions are made up of one or more restrictions.
|
|
2245
|
+
# * Restrictions can be combined by the logical operator `OR`.
|
|
2246
|
+
# * A restriction has the form of ``field` `operator` `value``.
|
|
2247
|
+
# * The operator must be `EQUALS (=)`.
|
|
2248
|
+
# * Supported fields:
|
|
2249
|
+
# - `assignedLocationId`
|
|
2250
|
+
# The length of this field should be no more than 500 characters.
|
|
2251
|
+
# @param [String] order_by
|
|
2252
|
+
# Field by which to sort the list.
|
|
2253
|
+
# Acceptable values are:
|
|
2254
|
+
# * `assignedLocationId` (default)
|
|
2255
|
+
# The default sorting order is ascending. To specify descending order for a
|
|
2256
|
+
# field, a suffix " desc" should be added to the field name. Example:
|
|
2257
|
+
# `assignedLocationId desc`.
|
|
2258
|
+
# @param [Fixnum] page_size
|
|
2259
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
2260
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
|
2261
|
+
# is specified.
|
|
2262
|
+
# @param [String] page_token
|
|
2263
|
+
# A token identifying a page of results the server should return.
|
|
2264
|
+
# Typically, this is the value of
|
|
2265
|
+
# next_page_token
|
|
2266
|
+
# returned from the previous call to `ListAssignedLocations`
|
|
2267
|
+
# method. If not specified, the first page of results will be returned.
|
|
2268
|
+
# @param [String] fields
|
|
2269
|
+
# Selector specifying which fields to include in a partial response.
|
|
2270
|
+
# @param [String] quota_user
|
|
2271
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2272
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2273
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2274
|
+
# Request-specific options
|
|
2275
|
+
#
|
|
2276
|
+
# @yield [result, err] Result & error if block supplied
|
|
2277
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListAssignedLocationsResponse] parsed result object
|
|
2278
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2279
|
+
#
|
|
2280
|
+
# @return [Google::Apis::DisplayvideoV1::ListAssignedLocationsResponse]
|
|
2281
|
+
#
|
|
2282
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2283
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2284
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2285
|
+
def list_advertiser_location_list_assigned_locations(advertiser_id, location_list_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
2286
|
+
command = make_simple_command(:get, 'v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations', options)
|
|
2287
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListAssignedLocationsResponse::Representation
|
|
2288
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListAssignedLocationsResponse
|
|
2289
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
2290
|
+
command.params['locationListId'] = location_list_id unless location_list_id.nil?
|
|
2291
|
+
command.query['filter'] = filter unless filter.nil?
|
|
2292
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
|
2293
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
2294
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
2295
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2296
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2297
|
+
execute_or_queue_command(command, &block)
|
|
2298
|
+
end
|
|
2299
|
+
|
|
2300
|
+
# Creates a new negative keyword list. Returns the newly created negative
|
|
2301
|
+
# keyword list if successful.
|
|
2302
|
+
# @param [Fixnum] advertiser_id
|
|
2303
|
+
# Required. The ID of the DV360 advertiser to which the negative keyword list
|
|
2304
|
+
# will
|
|
2305
|
+
# belong.
|
|
2306
|
+
# @param [Google::Apis::DisplayvideoV1::NegativeKeywordList] negative_keyword_list_object
|
|
2307
|
+
# @param [String] fields
|
|
2308
|
+
# Selector specifying which fields to include in a partial response.
|
|
2309
|
+
# @param [String] quota_user
|
|
2310
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2311
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2312
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2313
|
+
# Request-specific options
|
|
2314
|
+
#
|
|
2315
|
+
# @yield [result, err] Result & error if block supplied
|
|
2316
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::NegativeKeywordList] parsed result object
|
|
2317
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2318
|
+
#
|
|
2319
|
+
# @return [Google::Apis::DisplayvideoV1::NegativeKeywordList]
|
|
2320
|
+
#
|
|
2321
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2322
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2323
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2324
|
+
def create_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
2325
|
+
command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/negativeKeywordLists', options)
|
|
2326
|
+
command.request_representation = Google::Apis::DisplayvideoV1::NegativeKeywordList::Representation
|
|
2327
|
+
command.request_object = negative_keyword_list_object
|
|
2328
|
+
command.response_representation = Google::Apis::DisplayvideoV1::NegativeKeywordList::Representation
|
|
2329
|
+
command.response_class = Google::Apis::DisplayvideoV1::NegativeKeywordList
|
|
2330
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
2331
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2332
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2333
|
+
execute_or_queue_command(command, &block)
|
|
2334
|
+
end
|
|
2335
|
+
|
|
2336
|
+
# Deletes a negative keyword list given an advertiser ID and a negative
|
|
2337
|
+
# keyword list ID.
|
|
2338
|
+
# @param [Fixnum] advertiser_id
|
|
2339
|
+
# Required. The ID of the DV360 advertiser to which the negative keyword list
|
|
2340
|
+
# belongs.
|
|
2341
|
+
# @param [Fixnum] negative_keyword_list_id
|
|
2342
|
+
# Required. The ID of the negative keyword list to delete.
|
|
2343
|
+
# @param [String] fields
|
|
2344
|
+
# Selector specifying which fields to include in a partial response.
|
|
2345
|
+
# @param [String] quota_user
|
|
2346
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2347
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2348
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2349
|
+
# Request-specific options
|
|
2350
|
+
#
|
|
2351
|
+
# @yield [result, err] Result & error if block supplied
|
|
2352
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
|
2353
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2354
|
+
#
|
|
2355
|
+
# @return [Google::Apis::DisplayvideoV1::Empty]
|
|
2356
|
+
#
|
|
2357
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2358
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2359
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2360
|
+
def delete_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
2361
|
+
command = make_simple_command(:delete, 'v1/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}', options)
|
|
2362
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
|
2363
|
+
command.response_class = Google::Apis::DisplayvideoV1::Empty
|
|
2364
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
2365
|
+
command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
|
|
2366
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2367
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2368
|
+
execute_or_queue_command(command, &block)
|
|
2369
|
+
end
|
|
2370
|
+
|
|
2371
|
+
# Gets a negative keyword list given an advertiser ID and a negative keyword
|
|
2372
|
+
# list ID.
|
|
2373
|
+
# @param [Fixnum] advertiser_id
|
|
2374
|
+
# Required. The ID of the DV360 advertiser to which the fetched negative keyword
|
|
2375
|
+
# list
|
|
2376
|
+
# belongs.
|
|
2377
|
+
# @param [Fixnum] negative_keyword_list_id
|
|
2378
|
+
# Required. The ID of the negative keyword list to fetch.
|
|
2379
|
+
# @param [String] fields
|
|
2380
|
+
# Selector specifying which fields to include in a partial response.
|
|
2381
|
+
# @param [String] quota_user
|
|
2382
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2383
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2384
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2385
|
+
# Request-specific options
|
|
2386
|
+
#
|
|
2387
|
+
# @yield [result, err] Result & error if block supplied
|
|
2388
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::NegativeKeywordList] parsed result object
|
|
2389
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2390
|
+
#
|
|
2391
|
+
# @return [Google::Apis::DisplayvideoV1::NegativeKeywordList]
|
|
2392
|
+
#
|
|
2393
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2394
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2395
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2396
|
+
def get_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
2397
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}', options)
|
|
2398
|
+
command.response_representation = Google::Apis::DisplayvideoV1::NegativeKeywordList::Representation
|
|
2399
|
+
command.response_class = Google::Apis::DisplayvideoV1::NegativeKeywordList
|
|
2400
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
2401
|
+
command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
|
|
2402
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2403
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2404
|
+
execute_or_queue_command(command, &block)
|
|
2405
|
+
end
|
|
2406
|
+
|
|
2407
|
+
# Lists negative keyword lists based on a given advertiser id.
|
|
2408
|
+
# @param [Fixnum] advertiser_id
|
|
2409
|
+
# Required. The ID of the DV360 advertiser to which the fetched negative keyword
|
|
2410
|
+
# lists
|
|
2411
|
+
# belong.
|
|
2412
|
+
# @param [Fixnum] page_size
|
|
2413
|
+
# Requested page size. Must be between `1` and `100`.
|
|
2414
|
+
# Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an
|
|
2415
|
+
# invalid value is specified.
|
|
2416
|
+
# @param [String] page_token
|
|
2417
|
+
# A token identifying a page of results the server should return.
|
|
2418
|
+
# Typically, this is the value of
|
|
2419
|
+
# next_page_token
|
|
2420
|
+
# returned from the previous call to `ListNegativeKeywordLists` method.
|
|
2421
|
+
# If not specified, the first page of results will be returned.
|
|
2422
|
+
# @param [String] fields
|
|
2423
|
+
# Selector specifying which fields to include in a partial response.
|
|
2424
|
+
# @param [String] quota_user
|
|
2425
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2426
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2427
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2428
|
+
# Request-specific options
|
|
2429
|
+
#
|
|
2430
|
+
# @yield [result, err] Result & error if block supplied
|
|
2431
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListNegativeKeywordListsResponse] parsed result object
|
|
2432
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2433
|
+
#
|
|
2434
|
+
# @return [Google::Apis::DisplayvideoV1::ListNegativeKeywordListsResponse]
|
|
2435
|
+
#
|
|
2436
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2437
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2438
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2439
|
+
def list_advertiser_negative_keyword_lists(advertiser_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
2440
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/negativeKeywordLists', options)
|
|
2441
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListNegativeKeywordListsResponse::Representation
|
|
2442
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListNegativeKeywordListsResponse
|
|
2443
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
2444
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
2445
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
2446
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2447
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2448
|
+
execute_or_queue_command(command, &block)
|
|
2449
|
+
end
|
|
2450
|
+
|
|
2451
|
+
# Updates a negative keyword list. Returns the updated negative keyword list
|
|
2452
|
+
# if successful.
|
|
2453
|
+
# @param [Fixnum] advertiser_id
|
|
2454
|
+
# Required. The ID of the DV360 advertiser to which the negative keyword list
|
|
2455
|
+
# belongs.
|
|
2456
|
+
# @param [Fixnum] negative_keyword_list_id
|
|
2457
|
+
# Output only. The unique ID of the negative keyword list. Assigned by the
|
|
2458
|
+
# system.
|
|
2459
|
+
# @param [Google::Apis::DisplayvideoV1::NegativeKeywordList] negative_keyword_list_object
|
|
2460
|
+
# @param [String] update_mask
|
|
2461
|
+
# Required. The mask to control which fields to update.
|
|
2462
|
+
# @param [String] fields
|
|
2463
|
+
# Selector specifying which fields to include in a partial response.
|
|
2464
|
+
# @param [String] quota_user
|
|
2465
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2466
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2467
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2468
|
+
# Request-specific options
|
|
2469
|
+
#
|
|
2470
|
+
# @yield [result, err] Result & error if block supplied
|
|
2471
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::NegativeKeywordList] parsed result object
|
|
2472
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2473
|
+
#
|
|
2474
|
+
# @return [Google::Apis::DisplayvideoV1::NegativeKeywordList]
|
|
2475
|
+
#
|
|
2476
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2477
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2478
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2479
|
+
def patch_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_id, negative_keyword_list_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
2480
|
+
command = make_simple_command(:patch, 'v1/advertisers/{+advertiserId}/negativeKeywordLists/{negativeKeywordListId}', options)
|
|
2481
|
+
command.request_representation = Google::Apis::DisplayvideoV1::NegativeKeywordList::Representation
|
|
2482
|
+
command.request_object = negative_keyword_list_object
|
|
2483
|
+
command.response_representation = Google::Apis::DisplayvideoV1::NegativeKeywordList::Representation
|
|
2484
|
+
command.response_class = Google::Apis::DisplayvideoV1::NegativeKeywordList
|
|
2485
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
2486
|
+
command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
|
|
2487
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
2488
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2489
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2490
|
+
execute_or_queue_command(command, &block)
|
|
2491
|
+
end
|
|
2492
|
+
|
|
2493
|
+
# Bulk edits negative keywords in a single negative keyword list.
|
|
2494
|
+
# The operation will delete the negative keywords provided in
|
|
2495
|
+
# BulkEditNegativeKeywordsRequest.deleted_negative_keywords and then
|
|
2496
|
+
# create the negative keywords provided in
|
|
2497
|
+
# BulkEditNegativeKeywordsRequest.created_negative_keywords.
|
|
2498
|
+
# This operation is guaranteed to be atomic and will never result in a
|
|
2499
|
+
# partial success or partial failure.
|
|
2500
|
+
# @param [Fixnum] advertiser_id
|
|
2501
|
+
# Required. The ID of the DV360 advertiser to which the parent negative keyword
|
|
2502
|
+
# list
|
|
2503
|
+
# belongs.
|
|
2504
|
+
# @param [Fixnum] negative_keyword_list_id
|
|
2505
|
+
# Required. The ID of the parent negative keyword list to which the negative
|
|
2506
|
+
# keywords
|
|
2507
|
+
# belong.
|
|
2508
|
+
# @param [Google::Apis::DisplayvideoV1::BulkEditNegativeKeywordsRequest] bulk_edit_negative_keywords_request_object
|
|
2509
|
+
# @param [String] fields
|
|
2510
|
+
# Selector specifying which fields to include in a partial response.
|
|
2511
|
+
# @param [String] quota_user
|
|
2512
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2513
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2514
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2515
|
+
# Request-specific options
|
|
2516
|
+
#
|
|
2517
|
+
# @yield [result, err] Result & error if block supplied
|
|
2518
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::BulkEditNegativeKeywordsResponse] parsed result object
|
|
2519
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2520
|
+
#
|
|
2521
|
+
# @return [Google::Apis::DisplayvideoV1::BulkEditNegativeKeywordsResponse]
|
|
2522
|
+
#
|
|
2523
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2524
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2525
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2526
|
+
def bulk_edit_negative_keywords(advertiser_id, negative_keyword_list_id, bulk_edit_negative_keywords_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
2527
|
+
command = make_simple_command(:post, 'v1/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:bulkEdit', options)
|
|
2528
|
+
command.request_representation = Google::Apis::DisplayvideoV1::BulkEditNegativeKeywordsRequest::Representation
|
|
2529
|
+
command.request_object = bulk_edit_negative_keywords_request_object
|
|
2530
|
+
command.response_representation = Google::Apis::DisplayvideoV1::BulkEditNegativeKeywordsResponse::Representation
|
|
2531
|
+
command.response_class = Google::Apis::DisplayvideoV1::BulkEditNegativeKeywordsResponse
|
|
2532
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
2533
|
+
command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
|
|
2534
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2535
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2536
|
+
execute_or_queue_command(command, &block)
|
|
2537
|
+
end
|
|
2538
|
+
|
|
2539
|
+
# Creates a negative keyword in a negative keyword list.
|
|
2540
|
+
# @param [Fixnum] advertiser_id
|
|
2541
|
+
# Required. The ID of the DV360 advertiser to which the parent negative keyword
|
|
2542
|
+
# list
|
|
2543
|
+
# belongs.
|
|
2544
|
+
# @param [Fixnum] negative_keyword_list_id
|
|
2545
|
+
# Required. The ID of the parent negative keyword list in which the negative
|
|
2546
|
+
# keyword
|
|
2547
|
+
# will be created.
|
|
2548
|
+
# @param [Google::Apis::DisplayvideoV1::NegativeKeyword] negative_keyword_object
|
|
2549
|
+
# @param [String] fields
|
|
2550
|
+
# Selector specifying which fields to include in a partial response.
|
|
2551
|
+
# @param [String] quota_user
|
|
2552
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2553
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2554
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2555
|
+
# Request-specific options
|
|
2556
|
+
#
|
|
2557
|
+
# @yield [result, err] Result & error if block supplied
|
|
2558
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::NegativeKeyword] parsed result object
|
|
2559
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2560
|
+
#
|
|
2561
|
+
# @return [Google::Apis::DisplayvideoV1::NegativeKeyword]
|
|
2562
|
+
#
|
|
2563
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2564
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2565
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2566
|
+
def create_advertiser_negative_keyword_list_negative_keyword(advertiser_id, negative_keyword_list_id, negative_keyword_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
2567
|
+
command = make_simple_command(:post, 'v1/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords', options)
|
|
2568
|
+
command.request_representation = Google::Apis::DisplayvideoV1::NegativeKeyword::Representation
|
|
2569
|
+
command.request_object = negative_keyword_object
|
|
2570
|
+
command.response_representation = Google::Apis::DisplayvideoV1::NegativeKeyword::Representation
|
|
2571
|
+
command.response_class = Google::Apis::DisplayvideoV1::NegativeKeyword
|
|
2572
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
2573
|
+
command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
|
|
2574
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2575
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2576
|
+
execute_or_queue_command(command, &block)
|
|
2577
|
+
end
|
|
2578
|
+
|
|
2579
|
+
# Deletes a negative keyword from a negative keyword list.
|
|
2580
|
+
# @param [Fixnum] advertiser_id
|
|
2581
|
+
# Required. The ID of the DV360 advertiser to which the parent negative keyword
|
|
2582
|
+
# list
|
|
2583
|
+
# belongs.
|
|
2584
|
+
# @param [Fixnum] negative_keyword_list_id
|
|
2585
|
+
# Required. The ID of the parent negative keyword list to which the negative
|
|
2586
|
+
# keyword
|
|
2587
|
+
# belongs.
|
|
2588
|
+
# @param [String] keyword_value
|
|
2589
|
+
# Required. The keyword value of the negative keyword to delete.
|
|
2590
|
+
# @param [String] fields
|
|
2591
|
+
# Selector specifying which fields to include in a partial response.
|
|
2592
|
+
# @param [String] quota_user
|
|
2593
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2594
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2595
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2596
|
+
# Request-specific options
|
|
2597
|
+
#
|
|
2598
|
+
# @yield [result, err] Result & error if block supplied
|
|
2599
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
|
2600
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2601
|
+
#
|
|
2602
|
+
# @return [Google::Apis::DisplayvideoV1::Empty]
|
|
2603
|
+
#
|
|
2604
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2605
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2606
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2607
|
+
def delete_advertiser_negative_keyword_list_negative_keyword(advertiser_id, negative_keyword_list_id, keyword_value, fields: nil, quota_user: nil, options: nil, &block)
|
|
2608
|
+
command = make_simple_command(:delete, 'v1/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords/{+keywordValue}', options)
|
|
2609
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
|
2610
|
+
command.response_class = Google::Apis::DisplayvideoV1::Empty
|
|
2611
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
2612
|
+
command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
|
|
2613
|
+
command.params['keywordValue'] = keyword_value unless keyword_value.nil?
|
|
2614
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2615
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2616
|
+
execute_or_queue_command(command, &block)
|
|
2617
|
+
end
|
|
2618
|
+
|
|
2619
|
+
# Lists negative keywords in a negative keyword list.
|
|
2620
|
+
# @param [Fixnum] advertiser_id
|
|
2621
|
+
# Required. The ID of the DV360 advertiser to which the parent negative keyword
|
|
2622
|
+
# list
|
|
2623
|
+
# belongs.
|
|
2624
|
+
# @param [Fixnum] negative_keyword_list_id
|
|
2625
|
+
# Required. The ID of the parent negative keyword list to which the requested
|
|
2626
|
+
# negative
|
|
2627
|
+
# keywords belong.
|
|
2628
|
+
# @param [String] filter
|
|
2629
|
+
# Allows filtering by negative keyword fields.
|
|
2630
|
+
# Supported syntax:
|
|
2631
|
+
# * Filter expressions for negative keyword currently can only contain at
|
|
2632
|
+
# most one
|
|
2633
|
+
# * restriction.
|
|
2634
|
+
# * A restriction has the form of ``field` `operator` `value``.
|
|
2635
|
+
# * The operator must be `CONTAINS (:)`.
|
|
2636
|
+
# * Supported fields:
|
|
2637
|
+
# - `keywordValue`
|
|
2638
|
+
# Examples:
|
|
2639
|
+
# * All negative keywords for which the keyword value contains "google":
|
|
2640
|
+
# `keywordValue : "google"`
|
|
2641
|
+
# @param [String] order_by
|
|
2642
|
+
# Field by which to sort the list.
|
|
2643
|
+
# Acceptable values are:
|
|
2644
|
+
# * `keywordValue` (default)
|
|
2645
|
+
# The default sorting order is ascending. To specify descending order for a
|
|
2646
|
+
# field, a suffix " desc" should be added to the field name. Example:
|
|
2647
|
+
# `keywordValue desc`.
|
|
2648
|
+
# @param [Fixnum] page_size
|
|
2649
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
2650
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
|
2651
|
+
# is specified.
|
|
2652
|
+
# @param [String] page_token
|
|
2653
|
+
# A token identifying a page of results the server should return.
|
|
2654
|
+
# Typically, this is the value of
|
|
2655
|
+
# next_page_token returned
|
|
2656
|
+
# from the previous call to `ListNegativeKeywords` method. If not specified,
|
|
2657
|
+
# the first page of results will be returned.
|
|
2658
|
+
# @param [String] fields
|
|
2659
|
+
# Selector specifying which fields to include in a partial response.
|
|
2660
|
+
# @param [String] quota_user
|
|
2661
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2662
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2663
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2664
|
+
# Request-specific options
|
|
2665
|
+
#
|
|
2666
|
+
# @yield [result, err] Result & error if block supplied
|
|
2667
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListNegativeKeywordsResponse] parsed result object
|
|
2668
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2669
|
+
#
|
|
2670
|
+
# @return [Google::Apis::DisplayvideoV1::ListNegativeKeywordsResponse]
|
|
2671
|
+
#
|
|
2672
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2673
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2674
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2675
|
+
def list_advertiser_negative_keyword_list_negative_keywords(advertiser_id, negative_keyword_list_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
2676
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords', options)
|
|
2677
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListNegativeKeywordsResponse::Representation
|
|
2678
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListNegativeKeywordsResponse
|
|
2679
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
2680
|
+
command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
|
|
2681
|
+
command.query['filter'] = filter unless filter.nil?
|
|
2682
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
|
2683
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
2684
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
2685
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2686
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2687
|
+
execute_or_queue_command(command, &block)
|
|
2688
|
+
end
|
|
2689
|
+
|
|
2690
|
+
# Assigns a targeting option to an advertiser.
|
|
2691
|
+
# Returns the assigned targeting option if successful.
|
|
2692
|
+
# @param [Fixnum] advertiser_id
|
|
2693
|
+
# Required. The ID of the advertiser.
|
|
2694
|
+
# @param [String] targeting_type
|
|
2695
|
+
# Required. Identifies the type of this assigned targeting option.
|
|
2696
|
+
# @param [Google::Apis::DisplayvideoV1::AssignedTargetingOption] assigned_targeting_option_object
|
|
2697
|
+
# @param [String] fields
|
|
2698
|
+
# Selector specifying which fields to include in a partial response.
|
|
2699
|
+
# @param [String] quota_user
|
|
2700
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2701
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2702
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2703
|
+
# Request-specific options
|
|
2704
|
+
#
|
|
2705
|
+
# @yield [result, err] Result & error if block supplied
|
|
2706
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::AssignedTargetingOption] parsed result object
|
|
2707
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2708
|
+
#
|
|
2709
|
+
# @return [Google::Apis::DisplayvideoV1::AssignedTargetingOption]
|
|
2710
|
+
#
|
|
2711
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2712
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2713
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2714
|
+
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)
|
|
2715
|
+
command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
|
|
2716
|
+
command.request_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
|
2717
|
+
command.request_object = assigned_targeting_option_object
|
|
2718
|
+
command.response_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
|
2719
|
+
command.response_class = Google::Apis::DisplayvideoV1::AssignedTargetingOption
|
|
2720
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
2721
|
+
command.params['targetingType'] = targeting_type unless targeting_type.nil?
|
|
2722
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2723
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2724
|
+
execute_or_queue_command(command, &block)
|
|
2725
|
+
end
|
|
2726
|
+
|
|
2727
|
+
# Deletes an assigned targeting option from an advertiser.
|
|
2728
|
+
# @param [Fixnum] advertiser_id
|
|
2729
|
+
# Required. The ID of the advertiser.
|
|
2730
|
+
# @param [String] targeting_type
|
|
2731
|
+
# Required. Identifies the type of this assigned targeting option.
|
|
2732
|
+
# @param [String] assigned_targeting_option_id
|
|
2733
|
+
# Required. The ID of the assigned targeting option to delete.
|
|
2734
|
+
# @param [String] fields
|
|
2735
|
+
# Selector specifying which fields to include in a partial response.
|
|
2736
|
+
# @param [String] quota_user
|
|
2737
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2738
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2739
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2740
|
+
# Request-specific options
|
|
2741
|
+
#
|
|
2742
|
+
# @yield [result, err] Result & error if block supplied
|
|
2743
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
|
2744
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2745
|
+
#
|
|
2746
|
+
# @return [Google::Apis::DisplayvideoV1::Empty]
|
|
2747
|
+
#
|
|
2748
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2749
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2750
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2751
|
+
def delete_advertiser_targeting_type_assigned_targeting_option(advertiser_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
2752
|
+
command = make_simple_command(:delete, 'v1/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
|
|
2753
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
|
2754
|
+
command.response_class = Google::Apis::DisplayvideoV1::Empty
|
|
2755
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
2756
|
+
command.params['targetingType'] = targeting_type unless targeting_type.nil?
|
|
2757
|
+
command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
|
|
2758
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2759
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2760
|
+
execute_or_queue_command(command, &block)
|
|
2761
|
+
end
|
|
2762
|
+
|
|
2763
|
+
# Gets a single targeting option assigned to an advertiser.
|
|
2764
|
+
# @param [Fixnum] advertiser_id
|
|
2765
|
+
# Required. The ID of the advertiser.
|
|
1940
2766
|
# @param [String] targeting_type
|
|
1941
2767
|
# Required. Identifies the type of this assigned targeting option.
|
|
1942
2768
|
# @param [String] assigned_targeting_option_id
|
|
1943
|
-
# Required.
|
|
2769
|
+
# Required. An identifier unique to the targeting type in this advertiser that
|
|
2770
|
+
# identifies the assigned targeting option being requested.
|
|
2771
|
+
# @param [String] fields
|
|
2772
|
+
# Selector specifying which fields to include in a partial response.
|
|
2773
|
+
# @param [String] quota_user
|
|
2774
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2775
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2776
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2777
|
+
# Request-specific options
|
|
2778
|
+
#
|
|
2779
|
+
# @yield [result, err] Result & error if block supplied
|
|
2780
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::AssignedTargetingOption] parsed result object
|
|
2781
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2782
|
+
#
|
|
2783
|
+
# @return [Google::Apis::DisplayvideoV1::AssignedTargetingOption]
|
|
2784
|
+
#
|
|
2785
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2786
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2787
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2788
|
+
def get_advertiser_targeting_type_assigned_targeting_option(advertiser_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
2789
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
|
|
2790
|
+
command.response_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
|
2791
|
+
command.response_class = Google::Apis::DisplayvideoV1::AssignedTargetingOption
|
|
2792
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
2793
|
+
command.params['targetingType'] = targeting_type unless targeting_type.nil?
|
|
2794
|
+
command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
|
|
2795
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2796
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2797
|
+
execute_or_queue_command(command, &block)
|
|
2798
|
+
end
|
|
2799
|
+
|
|
2800
|
+
# Lists the targeting options assigned to an advertiser.
|
|
2801
|
+
# @param [Fixnum] advertiser_id
|
|
2802
|
+
# Required. The ID of the advertiser.
|
|
2803
|
+
# @param [String] targeting_type
|
|
2804
|
+
# Required. Identifies the type of assigned targeting options to list.
|
|
2805
|
+
# @param [String] filter
|
|
2806
|
+
# Allows filtering by assigned targeting option properties.
|
|
2807
|
+
# Supported syntax:
|
|
2808
|
+
# * Filter expressions are made up of one or more restrictions.
|
|
2809
|
+
# * Restrictions can be combined by the logical operator `OR`.
|
|
2810
|
+
# * A restriction has the form of ``field` `operator` `value``.
|
|
2811
|
+
# * The operator must be `EQUALS (=)`.
|
|
2812
|
+
# * Supported fields:
|
|
2813
|
+
# - `assignedTargetingOptionId`
|
|
2814
|
+
# Examples:
|
|
2815
|
+
# * AssignedTargetingOption with ID 123456
|
|
2816
|
+
# `assignedTargetingOptionId="123456"`
|
|
2817
|
+
# The length of this field should be no more than 500 characters.
|
|
2818
|
+
# @param [String] order_by
|
|
2819
|
+
# Field by which to sort the list.
|
|
2820
|
+
# Acceptable values are:
|
|
2821
|
+
# * `assignedTargetingOptionId` (default)
|
|
2822
|
+
# The default sorting order is ascending. To specify descending order for
|
|
2823
|
+
# a field, a suffix "desc" should be added to the field name. Example:
|
|
2824
|
+
# `assignedTargetingOptionId desc`.
|
|
2825
|
+
# @param [Fixnum] page_size
|
|
2826
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
2827
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
|
2828
|
+
# is specified.
|
|
2829
|
+
# @param [String] page_token
|
|
2830
|
+
# A token identifying a page of results the server should return.
|
|
2831
|
+
# Typically, this is the value of
|
|
2832
|
+
# next_page_token
|
|
2833
|
+
# returned from the previous call to `ListAdvertiserAssignedTargetingOptions`
|
|
2834
|
+
# method. If not specified, the first page of results will be returned.
|
|
2835
|
+
# @param [String] fields
|
|
2836
|
+
# Selector specifying which fields to include in a partial response.
|
|
2837
|
+
# @param [String] quota_user
|
|
2838
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2839
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2840
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2841
|
+
# Request-specific options
|
|
2842
|
+
#
|
|
2843
|
+
# @yield [result, err] Result & error if block supplied
|
|
2844
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListAdvertiserAssignedTargetingOptionsResponse] parsed result object
|
|
2845
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2846
|
+
#
|
|
2847
|
+
# @return [Google::Apis::DisplayvideoV1::ListAdvertiserAssignedTargetingOptionsResponse]
|
|
2848
|
+
#
|
|
2849
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2850
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2851
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2852
|
+
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)
|
|
2853
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
|
|
2854
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListAdvertiserAssignedTargetingOptionsResponse::Representation
|
|
2855
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListAdvertiserAssignedTargetingOptionsResponse
|
|
2856
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
2857
|
+
command.params['targetingType'] = targeting_type unless targeting_type.nil?
|
|
2858
|
+
command.query['filter'] = filter unless filter.nil?
|
|
2859
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
|
2860
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
2861
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
2862
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2863
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2864
|
+
execute_or_queue_command(command, &block)
|
|
2865
|
+
end
|
|
2866
|
+
|
|
2867
|
+
# Gets a combined audience.
|
|
2868
|
+
# @param [Fixnum] combined_audience_id
|
|
2869
|
+
# Required. The ID of the combined audience to fetch.
|
|
2870
|
+
# @param [Fixnum] advertiser_id
|
|
2871
|
+
# The ID of the advertiser that has access to the fetched combined
|
|
2872
|
+
# audience.
|
|
2873
|
+
# @param [Fixnum] partner_id
|
|
2874
|
+
# The ID of the partner that has access to the fetched combined audience.
|
|
2875
|
+
# @param [String] fields
|
|
2876
|
+
# Selector specifying which fields to include in a partial response.
|
|
2877
|
+
# @param [String] quota_user
|
|
2878
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2879
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2880
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2881
|
+
# Request-specific options
|
|
2882
|
+
#
|
|
2883
|
+
# @yield [result, err] Result & error if block supplied
|
|
2884
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::CombinedAudience] parsed result object
|
|
2885
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2886
|
+
#
|
|
2887
|
+
# @return [Google::Apis::DisplayvideoV1::CombinedAudience]
|
|
2888
|
+
#
|
|
2889
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2890
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2891
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2892
|
+
def get_combined_audience(combined_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
2893
|
+
command = make_simple_command(:get, 'v1/combinedAudiences/{+combinedAudienceId}', options)
|
|
2894
|
+
command.response_representation = Google::Apis::DisplayvideoV1::CombinedAudience::Representation
|
|
2895
|
+
command.response_class = Google::Apis::DisplayvideoV1::CombinedAudience
|
|
2896
|
+
command.params['combinedAudienceId'] = combined_audience_id unless combined_audience_id.nil?
|
|
2897
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
2898
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
|
2899
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2900
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2901
|
+
execute_or_queue_command(command, &block)
|
|
2902
|
+
end
|
|
2903
|
+
|
|
2904
|
+
# Lists combined audiences.
|
|
2905
|
+
# The order is defined by the
|
|
2906
|
+
# order_by parameter.
|
|
2907
|
+
# @param [Fixnum] advertiser_id
|
|
2908
|
+
# The ID of the advertiser that has access to the fetched combined
|
|
2909
|
+
# audiences.
|
|
2910
|
+
# @param [String] filter
|
|
2911
|
+
# Allows filtering by combined audience fields.
|
|
2912
|
+
# Supported syntax:
|
|
2913
|
+
# * Filter expressions for combined audiences currently can only contain at
|
|
2914
|
+
# most one restriction.
|
|
2915
|
+
# * A restriction has the form of ``field` `operator` `value``.
|
|
2916
|
+
# * The operator must be `CONTAINS (:)`.
|
|
2917
|
+
# * Supported fields:
|
|
2918
|
+
# - `displayName`
|
|
2919
|
+
# Examples:
|
|
2920
|
+
# * All combined audiences for which the display name contains "Google":
|
|
2921
|
+
# `displayName : "Google"`.
|
|
2922
|
+
# The length of this field should be no more than 500 characters.
|
|
2923
|
+
# @param [String] order_by
|
|
2924
|
+
# Field by which to sort the list.
|
|
2925
|
+
# Acceptable values are:
|
|
2926
|
+
# * `combinedAudienceId` (default)
|
|
2927
|
+
# * `displayName`
|
|
2928
|
+
# The default sorting order is ascending. To specify descending order for
|
|
2929
|
+
# a field, a suffix "desc" should be added to the field name. Example:
|
|
2930
|
+
# `displayName desc`.
|
|
2931
|
+
# @param [Fixnum] page_size
|
|
2932
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
2933
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
|
2934
|
+
# is specified.
|
|
2935
|
+
# @param [String] page_token
|
|
2936
|
+
# A token identifying a page of results the server should return.
|
|
2937
|
+
# Typically, this is the value of
|
|
2938
|
+
# next_page_token
|
|
2939
|
+
# returned from the previous call to `ListCombinedAudiences` method.
|
|
2940
|
+
# If not specified, the first page of results will be returned.
|
|
2941
|
+
# @param [Fixnum] partner_id
|
|
2942
|
+
# The ID of the partner that has access to the fetched combined audiences.
|
|
2943
|
+
# @param [String] fields
|
|
2944
|
+
# Selector specifying which fields to include in a partial response.
|
|
2945
|
+
# @param [String] quota_user
|
|
2946
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2947
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2948
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2949
|
+
# Request-specific options
|
|
2950
|
+
#
|
|
2951
|
+
# @yield [result, err] Result & error if block supplied
|
|
2952
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListCombinedAudiencesResponse] parsed result object
|
|
2953
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2954
|
+
#
|
|
2955
|
+
# @return [Google::Apis::DisplayvideoV1::ListCombinedAudiencesResponse]
|
|
2956
|
+
#
|
|
2957
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2958
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2959
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2960
|
+
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)
|
|
2961
|
+
command = make_simple_command(:get, 'v1/combinedAudiences', options)
|
|
2962
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListCombinedAudiencesResponse::Representation
|
|
2963
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListCombinedAudiencesResponse
|
|
2964
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
2965
|
+
command.query['filter'] = filter unless filter.nil?
|
|
2966
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
|
2967
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
2968
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
2969
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
|
2970
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2971
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2972
|
+
execute_or_queue_command(command, &block)
|
|
2973
|
+
end
|
|
2974
|
+
|
|
2975
|
+
# Gets a custom list.
|
|
2976
|
+
# @param [Fixnum] custom_list_id
|
|
2977
|
+
# Required. The ID of the custom list to fetch.
|
|
2978
|
+
# @param [Fixnum] advertiser_id
|
|
2979
|
+
# The ID of the DV360 advertiser that has access to the fetched custom
|
|
2980
|
+
# lists.
|
|
2981
|
+
# @param [String] fields
|
|
2982
|
+
# Selector specifying which fields to include in a partial response.
|
|
2983
|
+
# @param [String] quota_user
|
|
2984
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2985
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2986
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2987
|
+
# Request-specific options
|
|
2988
|
+
#
|
|
2989
|
+
# @yield [result, err] Result & error if block supplied
|
|
2990
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::CustomList] parsed result object
|
|
2991
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2992
|
+
#
|
|
2993
|
+
# @return [Google::Apis::DisplayvideoV1::CustomList]
|
|
2994
|
+
#
|
|
2995
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2996
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2997
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2998
|
+
def get_custom_list(custom_list_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
2999
|
+
command = make_simple_command(:get, 'v1/customLists/{+customListId}', options)
|
|
3000
|
+
command.response_representation = Google::Apis::DisplayvideoV1::CustomList::Representation
|
|
3001
|
+
command.response_class = Google::Apis::DisplayvideoV1::CustomList
|
|
3002
|
+
command.params['customListId'] = custom_list_id unless custom_list_id.nil?
|
|
3003
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
3004
|
+
command.query['fields'] = fields unless fields.nil?
|
|
3005
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
3006
|
+
execute_or_queue_command(command, &block)
|
|
3007
|
+
end
|
|
3008
|
+
|
|
3009
|
+
# Lists custom lists.
|
|
3010
|
+
# The order is defined by the order_by
|
|
3011
|
+
# parameter.
|
|
3012
|
+
# @param [Fixnum] advertiser_id
|
|
3013
|
+
# The ID of the DV360 advertiser that has access to the fetched custom
|
|
3014
|
+
# lists.
|
|
3015
|
+
# @param [String] filter
|
|
3016
|
+
# Allows filtering by custom list fields.
|
|
3017
|
+
# Supported syntax:
|
|
3018
|
+
# * Filter expressions for custom lists currently can only contain at
|
|
3019
|
+
# most one restriction.
|
|
3020
|
+
# * A restriction has the form of ``field` `operator` `value``.
|
|
3021
|
+
# * The operator must be `CONTAINS (:)`.
|
|
3022
|
+
# * Supported fields:
|
|
3023
|
+
# - `displayName`
|
|
3024
|
+
# Examples:
|
|
3025
|
+
# * All custom lists for which the display name contains "Google":
|
|
3026
|
+
# `displayName : "Google"`.
|
|
3027
|
+
# The length of this field should be no more than 500 characters.
|
|
3028
|
+
# @param [String] order_by
|
|
3029
|
+
# Field by which to sort the list.
|
|
3030
|
+
# Acceptable values are:
|
|
3031
|
+
# * `customListId` (default)
|
|
3032
|
+
# * `displayName`
|
|
3033
|
+
# The default sorting order is ascending. To specify descending order for
|
|
3034
|
+
# a field, a suffix "desc" should be added to the field name. Example:
|
|
3035
|
+
# `displayName desc`.
|
|
3036
|
+
# @param [Fixnum] page_size
|
|
3037
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
3038
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
|
3039
|
+
# is specified.
|
|
3040
|
+
# @param [String] page_token
|
|
3041
|
+
# A token identifying a page of results the server should return.
|
|
3042
|
+
# Typically, this is the value of
|
|
3043
|
+
# next_page_token
|
|
3044
|
+
# returned from the previous call to `ListCustomLists` method.
|
|
3045
|
+
# If not specified, the first page of results will be returned.
|
|
1944
3046
|
# @param [String] fields
|
|
1945
3047
|
# Selector specifying which fields to include in a partial response.
|
|
1946
3048
|
# @param [String] quota_user
|
|
@@ -1950,34 +3052,37 @@ module Google
|
|
|
1950
3052
|
# Request-specific options
|
|
1951
3053
|
#
|
|
1952
3054
|
# @yield [result, err] Result & error if block supplied
|
|
1953
|
-
# @yieldparam result [Google::Apis::DisplayvideoV1::
|
|
3055
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListCustomListsResponse] parsed result object
|
|
1954
3056
|
# @yieldparam err [StandardError] error object if request failed
|
|
1955
3057
|
#
|
|
1956
|
-
# @return [Google::Apis::DisplayvideoV1::
|
|
3058
|
+
# @return [Google::Apis::DisplayvideoV1::ListCustomListsResponse]
|
|
1957
3059
|
#
|
|
1958
3060
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1959
3061
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1960
3062
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1961
|
-
def
|
|
1962
|
-
command = make_simple_command(:
|
|
1963
|
-
command.response_representation = Google::Apis::DisplayvideoV1::
|
|
1964
|
-
command.response_class = Google::Apis::DisplayvideoV1::
|
|
1965
|
-
command.
|
|
1966
|
-
command.
|
|
1967
|
-
command.
|
|
3063
|
+
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)
|
|
3064
|
+
command = make_simple_command(:get, 'v1/customLists', options)
|
|
3065
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListCustomListsResponse::Representation
|
|
3066
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListCustomListsResponse
|
|
3067
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
3068
|
+
command.query['filter'] = filter unless filter.nil?
|
|
3069
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
|
3070
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
3071
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
1968
3072
|
command.query['fields'] = fields unless fields.nil?
|
|
1969
3073
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1970
3074
|
execute_or_queue_command(command, &block)
|
|
1971
3075
|
end
|
|
1972
3076
|
|
|
1973
|
-
# Gets a
|
|
3077
|
+
# Gets a first and third party audience.
|
|
3078
|
+
# @param [Fixnum] first_and_third_party_audience_id
|
|
3079
|
+
# Required. The ID of the first and third party audience to fetch.
|
|
1974
3080
|
# @param [Fixnum] advertiser_id
|
|
1975
|
-
#
|
|
1976
|
-
#
|
|
1977
|
-
#
|
|
1978
|
-
#
|
|
1979
|
-
#
|
|
1980
|
-
# identifies the assigned targeting option being requested.
|
|
3081
|
+
# The ID of the advertiser that has access to the fetched first and
|
|
3082
|
+
# third party audience.
|
|
3083
|
+
# @param [Fixnum] partner_id
|
|
3084
|
+
# The ID of the partner that has access to the fetched first and
|
|
3085
|
+
# third party audience.
|
|
1981
3086
|
# @param [String] fields
|
|
1982
3087
|
# Selector specifying which fields to include in a partial response.
|
|
1983
3088
|
# @param [String] quota_user
|
|
@@ -1987,51 +3092,53 @@ module Google
|
|
|
1987
3092
|
# Request-specific options
|
|
1988
3093
|
#
|
|
1989
3094
|
# @yield [result, err] Result & error if block supplied
|
|
1990
|
-
# @yieldparam result [Google::Apis::DisplayvideoV1::
|
|
3095
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudience] parsed result object
|
|
1991
3096
|
# @yieldparam err [StandardError] error object if request failed
|
|
1992
3097
|
#
|
|
1993
|
-
# @return [Google::Apis::DisplayvideoV1::
|
|
3098
|
+
# @return [Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudience]
|
|
1994
3099
|
#
|
|
1995
3100
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1996
3101
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1997
3102
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1998
|
-
def
|
|
1999
|
-
command = make_simple_command(:get, 'v1/
|
|
2000
|
-
command.response_representation = Google::Apis::DisplayvideoV1::
|
|
2001
|
-
command.response_class = Google::Apis::DisplayvideoV1::
|
|
2002
|
-
command.params['
|
|
2003
|
-
command.
|
|
2004
|
-
command.
|
|
3103
|
+
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)
|
|
3104
|
+
command = make_simple_command(:get, 'v1/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}', options)
|
|
3105
|
+
command.response_representation = Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudience::Representation
|
|
3106
|
+
command.response_class = Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudience
|
|
3107
|
+
command.params['firstAndThirdPartyAudienceId'] = first_and_third_party_audience_id unless first_and_third_party_audience_id.nil?
|
|
3108
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
3109
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
|
2005
3110
|
command.query['fields'] = fields unless fields.nil?
|
|
2006
3111
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2007
3112
|
execute_or_queue_command(command, &block)
|
|
2008
3113
|
end
|
|
2009
3114
|
|
|
2010
|
-
# Lists
|
|
3115
|
+
# Lists first and third party audiences.
|
|
3116
|
+
# The order is defined by the
|
|
3117
|
+
# order_by parameter.
|
|
2011
3118
|
# @param [Fixnum] advertiser_id
|
|
2012
|
-
#
|
|
2013
|
-
#
|
|
2014
|
-
# Required. Identifies the type of assigned targeting options to list.
|
|
3119
|
+
# The ID of the advertiser that has access to the fetched first and
|
|
3120
|
+
# third party audiences.
|
|
2015
3121
|
# @param [String] filter
|
|
2016
|
-
# Allows filtering by
|
|
3122
|
+
# Allows filtering by first and third party audience fields.
|
|
2017
3123
|
# Supported syntax:
|
|
2018
|
-
# * Filter expressions
|
|
2019
|
-
#
|
|
3124
|
+
# * Filter expressions for first and third party audiences currently can
|
|
3125
|
+
# only contain at most one restriction.
|
|
2020
3126
|
# * A restriction has the form of ``field` `operator` `value``.
|
|
2021
|
-
# * The operator must be `
|
|
3127
|
+
# * The operator must be `CONTAINS (:)`.
|
|
2022
3128
|
# * Supported fields:
|
|
2023
|
-
# - `
|
|
3129
|
+
# - `displayName`
|
|
2024
3130
|
# Examples:
|
|
2025
|
-
# *
|
|
2026
|
-
# `
|
|
3131
|
+
# * All first and third party audiences for which the display name contains
|
|
3132
|
+
# "Google": `displayName : "Google"`.
|
|
2027
3133
|
# The length of this field should be no more than 500 characters.
|
|
2028
3134
|
# @param [String] order_by
|
|
2029
3135
|
# Field by which to sort the list.
|
|
2030
3136
|
# Acceptable values are:
|
|
2031
|
-
# * `
|
|
3137
|
+
# * `firstAndThirdPartyAudienceId` (default)
|
|
3138
|
+
# * `displayName`
|
|
2032
3139
|
# The default sorting order is ascending. To specify descending order for
|
|
2033
3140
|
# a field, a suffix "desc" should be added to the field name. Example:
|
|
2034
|
-
# `
|
|
3141
|
+
# `displayName desc`.
|
|
2035
3142
|
# @param [Fixnum] page_size
|
|
2036
3143
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
2037
3144
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
|
@@ -2040,8 +3147,11 @@ module Google
|
|
|
2040
3147
|
# A token identifying a page of results the server should return.
|
|
2041
3148
|
# Typically, this is the value of
|
|
2042
3149
|
# next_page_token
|
|
2043
|
-
# returned from the previous call to `
|
|
3150
|
+
# returned from the previous call to `ListFirstAndThirdPartyAudiences`
|
|
2044
3151
|
# method. If not specified, the first page of results will be returned.
|
|
3152
|
+
# @param [Fixnum] partner_id
|
|
3153
|
+
# The ID of the partner that has access to the fetched first and
|
|
3154
|
+
# third party audiences.
|
|
2045
3155
|
# @param [String] fields
|
|
2046
3156
|
# Selector specifying which fields to include in a partial response.
|
|
2047
3157
|
# @param [String] quota_user
|
|
@@ -2051,37 +3161,109 @@ module Google
|
|
|
2051
3161
|
# Request-specific options
|
|
2052
3162
|
#
|
|
2053
3163
|
# @yield [result, err] Result & error if block supplied
|
|
2054
|
-
# @yieldparam result [Google::Apis::DisplayvideoV1::
|
|
3164
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListFirstAndThirdPartyAudiencesResponse] parsed result object
|
|
2055
3165
|
# @yieldparam err [StandardError] error object if request failed
|
|
2056
3166
|
#
|
|
2057
|
-
# @return [Google::Apis::DisplayvideoV1::
|
|
3167
|
+
# @return [Google::Apis::DisplayvideoV1::ListFirstAndThirdPartyAudiencesResponse]
|
|
2058
3168
|
#
|
|
2059
3169
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2060
3170
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2061
3171
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2062
|
-
def
|
|
2063
|
-
command = make_simple_command(:get, 'v1/
|
|
2064
|
-
command.response_representation = Google::Apis::DisplayvideoV1::
|
|
2065
|
-
command.response_class = Google::Apis::DisplayvideoV1::
|
|
2066
|
-
command.
|
|
2067
|
-
command.params['targetingType'] = targeting_type unless targeting_type.nil?
|
|
3172
|
+
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)
|
|
3173
|
+
command = make_simple_command(:get, 'v1/firstAndThirdPartyAudiences', options)
|
|
3174
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListFirstAndThirdPartyAudiencesResponse::Representation
|
|
3175
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListFirstAndThirdPartyAudiencesResponse
|
|
3176
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
2068
3177
|
command.query['filter'] = filter unless filter.nil?
|
|
2069
3178
|
command.query['orderBy'] = order_by unless order_by.nil?
|
|
2070
3179
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
2071
3180
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
3181
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
|
2072
3182
|
command.query['fields'] = fields unless fields.nil?
|
|
2073
3183
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2074
3184
|
execute_or_queue_command(command, &block)
|
|
2075
3185
|
end
|
|
2076
3186
|
|
|
2077
|
-
# Gets a
|
|
2078
|
-
# @param [Fixnum]
|
|
2079
|
-
# Required. The ID of the
|
|
3187
|
+
# Gets a Floodlight group.
|
|
3188
|
+
# @param [Fixnum] floodlight_group_id
|
|
3189
|
+
# Required. The ID of the Floodlight group to fetch.
|
|
3190
|
+
# @param [Fixnum] partner_id
|
|
3191
|
+
# Required. The partner context by which the Floodlight group is being accessed.
|
|
3192
|
+
# @param [String] fields
|
|
3193
|
+
# Selector specifying which fields to include in a partial response.
|
|
3194
|
+
# @param [String] quota_user
|
|
3195
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
3196
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
3197
|
+
# @param [Google::Apis::RequestOptions] options
|
|
3198
|
+
# Request-specific options
|
|
3199
|
+
#
|
|
3200
|
+
# @yield [result, err] Result & error if block supplied
|
|
3201
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::FloodlightGroup] parsed result object
|
|
3202
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
3203
|
+
#
|
|
3204
|
+
# @return [Google::Apis::DisplayvideoV1::FloodlightGroup]
|
|
3205
|
+
#
|
|
3206
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
3207
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
3208
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
3209
|
+
def get_floodlight_group(floodlight_group_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
3210
|
+
command = make_simple_command(:get, 'v1/floodlightGroups/{+floodlightGroupId}', options)
|
|
3211
|
+
command.response_representation = Google::Apis::DisplayvideoV1::FloodlightGroup::Representation
|
|
3212
|
+
command.response_class = Google::Apis::DisplayvideoV1::FloodlightGroup
|
|
3213
|
+
command.params['floodlightGroupId'] = floodlight_group_id unless floodlight_group_id.nil?
|
|
3214
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
|
3215
|
+
command.query['fields'] = fields unless fields.nil?
|
|
3216
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
3217
|
+
execute_or_queue_command(command, &block)
|
|
3218
|
+
end
|
|
3219
|
+
|
|
3220
|
+
# Updates an existing Floodlight group.
|
|
3221
|
+
# Returns the updated Floodlight group if successful.
|
|
3222
|
+
# @param [Fixnum] floodlight_group_id
|
|
3223
|
+
# Output only. The unique ID of the Floodlight group. Assigned by the system.
|
|
3224
|
+
# @param [Google::Apis::DisplayvideoV1::FloodlightGroup] floodlight_group_object
|
|
3225
|
+
# @param [Fixnum] partner_id
|
|
3226
|
+
# Required. The partner context by which the Floodlight group is being accessed.
|
|
3227
|
+
# @param [String] update_mask
|
|
3228
|
+
# Required. The mask to control which fields to update.
|
|
3229
|
+
# @param [String] fields
|
|
3230
|
+
# Selector specifying which fields to include in a partial response.
|
|
3231
|
+
# @param [String] quota_user
|
|
3232
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
3233
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
3234
|
+
# @param [Google::Apis::RequestOptions] options
|
|
3235
|
+
# Request-specific options
|
|
3236
|
+
#
|
|
3237
|
+
# @yield [result, err] Result & error if block supplied
|
|
3238
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::FloodlightGroup] parsed result object
|
|
3239
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
3240
|
+
#
|
|
3241
|
+
# @return [Google::Apis::DisplayvideoV1::FloodlightGroup]
|
|
3242
|
+
#
|
|
3243
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
3244
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
3245
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
3246
|
+
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)
|
|
3247
|
+
command = make_simple_command(:patch, 'v1/floodlightGroups/{floodlightGroupId}', options)
|
|
3248
|
+
command.request_representation = Google::Apis::DisplayvideoV1::FloodlightGroup::Representation
|
|
3249
|
+
command.request_object = floodlight_group_object
|
|
3250
|
+
command.response_representation = Google::Apis::DisplayvideoV1::FloodlightGroup::Representation
|
|
3251
|
+
command.response_class = Google::Apis::DisplayvideoV1::FloodlightGroup
|
|
3252
|
+
command.params['floodlightGroupId'] = floodlight_group_id unless floodlight_group_id.nil?
|
|
3253
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
|
3254
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
3255
|
+
command.query['fields'] = fields unless fields.nil?
|
|
3256
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
3257
|
+
execute_or_queue_command(command, &block)
|
|
3258
|
+
end
|
|
3259
|
+
|
|
3260
|
+
# Gets a Google audience.
|
|
3261
|
+
# @param [Fixnum] google_audience_id
|
|
3262
|
+
# Required. The ID of the Google audience to fetch.
|
|
2080
3263
|
# @param [Fixnum] advertiser_id
|
|
2081
|
-
# The ID of the advertiser that has access to the fetched
|
|
2082
|
-
# audience.
|
|
3264
|
+
# The ID of the advertiser that has access to the fetched Google audience.
|
|
2083
3265
|
# @param [Fixnum] partner_id
|
|
2084
|
-
# The ID of the partner that has access to the fetched
|
|
3266
|
+
# The ID of the partner that has access to the fetched Google audience.
|
|
2085
3267
|
# @param [String] fields
|
|
2086
3268
|
# Selector specifying which fields to include in a partial response.
|
|
2087
3269
|
# @param [String] quota_user
|
|
@@ -2091,19 +3273,19 @@ module Google
|
|
|
2091
3273
|
# Request-specific options
|
|
2092
3274
|
#
|
|
2093
3275
|
# @yield [result, err] Result & error if block supplied
|
|
2094
|
-
# @yieldparam result [Google::Apis::DisplayvideoV1::
|
|
3276
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::GoogleAudience] parsed result object
|
|
2095
3277
|
# @yieldparam err [StandardError] error object if request failed
|
|
2096
3278
|
#
|
|
2097
|
-
# @return [Google::Apis::DisplayvideoV1::
|
|
3279
|
+
# @return [Google::Apis::DisplayvideoV1::GoogleAudience]
|
|
2098
3280
|
#
|
|
2099
3281
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2100
3282
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2101
3283
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2102
|
-
def
|
|
2103
|
-
command = make_simple_command(:get, 'v1/
|
|
2104
|
-
command.response_representation = Google::Apis::DisplayvideoV1::
|
|
2105
|
-
command.response_class = Google::Apis::DisplayvideoV1::
|
|
2106
|
-
command.params['
|
|
3284
|
+
def get_google_audience(google_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
3285
|
+
command = make_simple_command(:get, 'v1/googleAudiences/{+googleAudienceId}', options)
|
|
3286
|
+
command.response_representation = Google::Apis::DisplayvideoV1::GoogleAudience::Representation
|
|
3287
|
+
command.response_class = Google::Apis::DisplayvideoV1::GoogleAudience
|
|
3288
|
+
command.params['googleAudienceId'] = google_audience_id unless google_audience_id.nil?
|
|
2107
3289
|
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
2108
3290
|
command.query['partnerId'] = partner_id unless partner_id.nil?
|
|
2109
3291
|
command.query['fields'] = fields unless fields.nil?
|
|
@@ -2111,29 +3293,28 @@ module Google
|
|
|
2111
3293
|
execute_or_queue_command(command, &block)
|
|
2112
3294
|
end
|
|
2113
3295
|
|
|
2114
|
-
# Lists
|
|
2115
|
-
# The order is defined by the
|
|
2116
|
-
#
|
|
3296
|
+
# Lists Google audiences.
|
|
3297
|
+
# The order is defined by the order_by
|
|
3298
|
+
# parameter.
|
|
2117
3299
|
# @param [Fixnum] advertiser_id
|
|
2118
|
-
# The ID of the advertiser that has access to the fetched
|
|
2119
|
-
# audiences.
|
|
3300
|
+
# The ID of the advertiser that has access to the fetched Google audiences.
|
|
2120
3301
|
# @param [String] filter
|
|
2121
|
-
# Allows filtering by
|
|
3302
|
+
# Allows filtering by Google audience fields.
|
|
2122
3303
|
# Supported syntax:
|
|
2123
|
-
# * Filter expressions for
|
|
3304
|
+
# * Filter expressions for Google audiences currently can only contain at
|
|
2124
3305
|
# most one restriction.
|
|
2125
3306
|
# * A restriction has the form of ``field` `operator` `value``.
|
|
2126
3307
|
# * The operator must be `CONTAINS (:)`.
|
|
2127
3308
|
# * Supported fields:
|
|
2128
3309
|
# - `displayName`
|
|
2129
3310
|
# Examples:
|
|
2130
|
-
# * All
|
|
3311
|
+
# * All Google audiences for which the display name contains "Google":
|
|
2131
3312
|
# `displayName : "Google"`.
|
|
2132
3313
|
# The length of this field should be no more than 500 characters.
|
|
2133
3314
|
# @param [String] order_by
|
|
2134
3315
|
# Field by which to sort the list.
|
|
2135
3316
|
# Acceptable values are:
|
|
2136
|
-
# * `
|
|
3317
|
+
# * `googleAudienceId` (default)
|
|
2137
3318
|
# * `displayName`
|
|
2138
3319
|
# The default sorting order is ascending. To specify descending order for
|
|
2139
3320
|
# a field, a suffix "desc" should be added to the field name. Example:
|
|
@@ -2146,10 +3327,10 @@ module Google
|
|
|
2146
3327
|
# A token identifying a page of results the server should return.
|
|
2147
3328
|
# Typically, this is the value of
|
|
2148
3329
|
# next_page_token
|
|
2149
|
-
# returned from the previous call to `
|
|
3330
|
+
# returned from the previous call to `ListGoogleAudiences` method.
|
|
2150
3331
|
# If not specified, the first page of results will be returned.
|
|
2151
3332
|
# @param [Fixnum] partner_id
|
|
2152
|
-
# The ID of the partner that has access to the fetched
|
|
3333
|
+
# The ID of the partner that has access to the fetched Google audiences.
|
|
2153
3334
|
# @param [String] fields
|
|
2154
3335
|
# Selector specifying which fields to include in a partial response.
|
|
2155
3336
|
# @param [String] quota_user
|
|
@@ -2159,18 +3340,18 @@ module Google
|
|
|
2159
3340
|
# Request-specific options
|
|
2160
3341
|
#
|
|
2161
3342
|
# @yield [result, err] Result & error if block supplied
|
|
2162
|
-
# @yieldparam result [Google::Apis::DisplayvideoV1::
|
|
3343
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListGoogleAudiencesResponse] parsed result object
|
|
2163
3344
|
# @yieldparam err [StandardError] error object if request failed
|
|
2164
3345
|
#
|
|
2165
|
-
# @return [Google::Apis::DisplayvideoV1::
|
|
3346
|
+
# @return [Google::Apis::DisplayvideoV1::ListGoogleAudiencesResponse]
|
|
2166
3347
|
#
|
|
2167
3348
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2168
3349
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2169
3350
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2170
|
-
def
|
|
2171
|
-
command = make_simple_command(:get, 'v1/
|
|
2172
|
-
command.response_representation = Google::Apis::DisplayvideoV1::
|
|
2173
|
-
command.response_class = Google::Apis::DisplayvideoV1::
|
|
3351
|
+
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)
|
|
3352
|
+
command = make_simple_command(:get, 'v1/googleAudiences', options)
|
|
3353
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListGoogleAudiencesResponse::Representation
|
|
3354
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListGoogleAudiencesResponse
|
|
2174
3355
|
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
2175
3356
|
command.query['filter'] = filter unless filter.nil?
|
|
2176
3357
|
command.query['orderBy'] = order_by unless order_by.nil?
|
|
@@ -2182,12 +3363,17 @@ module Google
|
|
|
2182
3363
|
execute_or_queue_command(command, &block)
|
|
2183
3364
|
end
|
|
2184
3365
|
|
|
2185
|
-
#
|
|
2186
|
-
#
|
|
2187
|
-
#
|
|
3366
|
+
# Creates a new inventory source group. Returns the newly created inventory
|
|
3367
|
+
# source group if successful.
|
|
3368
|
+
# @param [Google::Apis::DisplayvideoV1::InventorySourceGroup] inventory_source_group_object
|
|
2188
3369
|
# @param [Fixnum] advertiser_id
|
|
2189
|
-
# The ID of the
|
|
2190
|
-
#
|
|
3370
|
+
# The ID of the advertiser that owns the inventory source group.
|
|
3371
|
+
# The parent partner will not have access to this group.
|
|
3372
|
+
# @param [Fixnum] partner_id
|
|
3373
|
+
# The ID of the partner that owns the inventory source group.
|
|
3374
|
+
# Only this partner will have write access to this group. Only advertisers
|
|
3375
|
+
# to which this group is explicitly shared will have read access to this
|
|
3376
|
+
# group.
|
|
2191
3377
|
# @param [String] fields
|
|
2192
3378
|
# Selector specifying which fields to include in a partial response.
|
|
2193
3379
|
# @param [String] quota_user
|
|
@@ -2197,62 +3383,36 @@ module Google
|
|
|
2197
3383
|
# Request-specific options
|
|
2198
3384
|
#
|
|
2199
3385
|
# @yield [result, err] Result & error if block supplied
|
|
2200
|
-
# @yieldparam result [Google::Apis::DisplayvideoV1::
|
|
3386
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::InventorySourceGroup] parsed result object
|
|
2201
3387
|
# @yieldparam err [StandardError] error object if request failed
|
|
2202
3388
|
#
|
|
2203
|
-
# @return [Google::Apis::DisplayvideoV1::
|
|
3389
|
+
# @return [Google::Apis::DisplayvideoV1::InventorySourceGroup]
|
|
2204
3390
|
#
|
|
2205
3391
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2206
3392
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2207
3393
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2208
|
-
def
|
|
2209
|
-
command = make_simple_command(:
|
|
2210
|
-
command.
|
|
2211
|
-
command.
|
|
2212
|
-
command.
|
|
3394
|
+
def create_inventory_source_group(inventory_source_group_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
3395
|
+
command = make_simple_command(:post, 'v1/inventorySourceGroups', options)
|
|
3396
|
+
command.request_representation = Google::Apis::DisplayvideoV1::InventorySourceGroup::Representation
|
|
3397
|
+
command.request_object = inventory_source_group_object
|
|
3398
|
+
command.response_representation = Google::Apis::DisplayvideoV1::InventorySourceGroup::Representation
|
|
3399
|
+
command.response_class = Google::Apis::DisplayvideoV1::InventorySourceGroup
|
|
2213
3400
|
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
3401
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
|
2214
3402
|
command.query['fields'] = fields unless fields.nil?
|
|
2215
3403
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2216
3404
|
execute_or_queue_command(command, &block)
|
|
2217
3405
|
end
|
|
2218
3406
|
|
|
2219
|
-
#
|
|
2220
|
-
#
|
|
2221
|
-
#
|
|
3407
|
+
# Deletes an inventory source group.
|
|
3408
|
+
# @param [Fixnum] inventory_source_group_id
|
|
3409
|
+
# Required. The ID of the inventory source group to delete.
|
|
2222
3410
|
# @param [Fixnum] advertiser_id
|
|
2223
|
-
# The ID of the
|
|
2224
|
-
#
|
|
2225
|
-
# @param [
|
|
2226
|
-
#
|
|
2227
|
-
#
|
|
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.
|
|
3411
|
+
# The ID of the advertiser that owns the inventory source group.
|
|
3412
|
+
# The parent partner does not have access to this group.
|
|
3413
|
+
# @param [Fixnum] partner_id
|
|
3414
|
+
# The ID of the partner that owns the inventory source group.
|
|
3415
|
+
# Only this partner has write access to this group.
|
|
2256
3416
|
# @param [String] fields
|
|
2257
3417
|
# Selector specifying which fields to include in a partial response.
|
|
2258
3418
|
# @param [String] quota_user
|
|
@@ -2262,37 +3422,36 @@ module Google
|
|
|
2262
3422
|
# Request-specific options
|
|
2263
3423
|
#
|
|
2264
3424
|
# @yield [result, err] Result & error if block supplied
|
|
2265
|
-
# @yieldparam result [Google::Apis::DisplayvideoV1::
|
|
3425
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
|
2266
3426
|
# @yieldparam err [StandardError] error object if request failed
|
|
2267
3427
|
#
|
|
2268
|
-
# @return [Google::Apis::DisplayvideoV1::
|
|
3428
|
+
# @return [Google::Apis::DisplayvideoV1::Empty]
|
|
2269
3429
|
#
|
|
2270
3430
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2271
3431
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2272
3432
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2273
|
-
def
|
|
2274
|
-
command = make_simple_command(:
|
|
2275
|
-
command.response_representation = Google::Apis::DisplayvideoV1::
|
|
2276
|
-
command.response_class = Google::Apis::DisplayvideoV1::
|
|
3433
|
+
def delete_inventory_source_group(inventory_source_group_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
3434
|
+
command = make_simple_command(:delete, 'v1/inventorySourceGroups/{+inventorySourceGroupId}', options)
|
|
3435
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
|
3436
|
+
command.response_class = Google::Apis::DisplayvideoV1::Empty
|
|
3437
|
+
command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
|
|
2277
3438
|
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
2278
|
-
command.query['
|
|
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?
|
|
3439
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
|
2282
3440
|
command.query['fields'] = fields unless fields.nil?
|
|
2283
3441
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2284
3442
|
execute_or_queue_command(command, &block)
|
|
2285
3443
|
end
|
|
2286
3444
|
|
|
2287
|
-
# Gets
|
|
2288
|
-
# @param [Fixnum]
|
|
2289
|
-
# Required. The ID of the
|
|
3445
|
+
# Gets an inventory source group.
|
|
3446
|
+
# @param [Fixnum] inventory_source_group_id
|
|
3447
|
+
# Required. The ID of the inventory source group to fetch.
|
|
2290
3448
|
# @param [Fixnum] advertiser_id
|
|
2291
|
-
# The ID of the advertiser that has access to the
|
|
2292
|
-
#
|
|
3449
|
+
# The ID of the advertiser that has access to the inventory source group.
|
|
3450
|
+
# If an inventory source group is partner-owned, only advertisers to which
|
|
3451
|
+
# the group is explicitly shared can access the group.
|
|
2293
3452
|
# @param [Fixnum] partner_id
|
|
2294
|
-
# The ID of the partner that has access to the
|
|
2295
|
-
#
|
|
3453
|
+
# The ID of the partner that has access to the inventory source group.
|
|
3454
|
+
# A partner cannot access an advertiser-owned inventory source group.
|
|
2296
3455
|
# @param [String] fields
|
|
2297
3456
|
# Selector specifying which fields to include in a partial response.
|
|
2298
3457
|
# @param [String] quota_user
|
|
@@ -2302,19 +3461,19 @@ module Google
|
|
|
2302
3461
|
# Request-specific options
|
|
2303
3462
|
#
|
|
2304
3463
|
# @yield [result, err] Result & error if block supplied
|
|
2305
|
-
# @yieldparam result [Google::Apis::DisplayvideoV1::
|
|
3464
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::InventorySourceGroup] parsed result object
|
|
2306
3465
|
# @yieldparam err [StandardError] error object if request failed
|
|
2307
3466
|
#
|
|
2308
|
-
# @return [Google::Apis::DisplayvideoV1::
|
|
3467
|
+
# @return [Google::Apis::DisplayvideoV1::InventorySourceGroup]
|
|
2309
3468
|
#
|
|
2310
3469
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2311
3470
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2312
3471
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2313
|
-
def
|
|
2314
|
-
command = make_simple_command(:get, 'v1/
|
|
2315
|
-
command.response_representation = Google::Apis::DisplayvideoV1::
|
|
2316
|
-
command.response_class = Google::Apis::DisplayvideoV1::
|
|
2317
|
-
command.params['
|
|
3472
|
+
def get_inventory_source_group(inventory_source_group_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
3473
|
+
command = make_simple_command(:get, 'v1/inventorySourceGroups/{+inventorySourceGroupId}', options)
|
|
3474
|
+
command.response_representation = Google::Apis::DisplayvideoV1::InventorySourceGroup::Representation
|
|
3475
|
+
command.response_class = Google::Apis::DisplayvideoV1::InventorySourceGroup
|
|
3476
|
+
command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
|
|
2318
3477
|
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
2319
3478
|
command.query['partnerId'] = partner_id unless partner_id.nil?
|
|
2320
3479
|
command.query['fields'] = fields unless fields.nil?
|
|
@@ -2322,46 +3481,43 @@ module Google
|
|
|
2322
3481
|
execute_or_queue_command(command, &block)
|
|
2323
3482
|
end
|
|
2324
3483
|
|
|
2325
|
-
# Lists
|
|
3484
|
+
# Lists inventory source groups that are accessible to the current user.
|
|
2326
3485
|
# The order is defined by the
|
|
2327
3486
|
# order_by parameter.
|
|
2328
3487
|
# @param [Fixnum] advertiser_id
|
|
2329
|
-
# The ID of the advertiser that has access to the
|
|
2330
|
-
#
|
|
3488
|
+
# The ID of the advertiser that has access to the inventory source group.
|
|
3489
|
+
# If an inventory source group is partner-owned, only advertisers to which
|
|
3490
|
+
# the group is explicitly shared can access the group.
|
|
2331
3491
|
# @param [String] filter
|
|
2332
|
-
# Allows filtering by
|
|
3492
|
+
# Allows filtering by inventory source group properties.
|
|
2333
3493
|
# Supported syntax:
|
|
2334
|
-
# * Filter expressions
|
|
2335
|
-
#
|
|
3494
|
+
# * Filter expressions are made up of one or more restrictions.
|
|
3495
|
+
# * Restrictions can be combined by the logical operator `OR`.
|
|
2336
3496
|
# * A restriction has the form of ``field` `operator` `value``.
|
|
2337
|
-
# * The operator must be `
|
|
3497
|
+
# * The operator must be `EQUALS (=)`.
|
|
2338
3498
|
# * Supported fields:
|
|
2339
|
-
# - `
|
|
2340
|
-
# Examples:
|
|
2341
|
-
# * All first and third party audiences for which the display name contains
|
|
2342
|
-
# "Google": `displayName : "Google"`.
|
|
3499
|
+
# - `inventorySourceGroupId`
|
|
2343
3500
|
# The length of this field should be no more than 500 characters.
|
|
2344
3501
|
# @param [String] order_by
|
|
2345
3502
|
# Field by which to sort the list.
|
|
2346
3503
|
# Acceptable values are:
|
|
2347
|
-
# * `
|
|
2348
|
-
# * `
|
|
3504
|
+
# * `displayName` (default)
|
|
3505
|
+
# * `inventorySourceGroupId`
|
|
2349
3506
|
# The default sorting order is ascending. To specify descending order for
|
|
2350
|
-
# a field, a suffix "desc" should be added to the field name.
|
|
3507
|
+
# a field, a suffix "desc" should be added to the field name. For example,
|
|
2351
3508
|
# `displayName desc`.
|
|
2352
3509
|
# @param [Fixnum] page_size
|
|
2353
3510
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
2354
|
-
# default to `100`.
|
|
2355
|
-
# is specified.
|
|
3511
|
+
# default to `100`.
|
|
2356
3512
|
# @param [String] page_token
|
|
2357
3513
|
# A token identifying a page of results the server should return.
|
|
2358
3514
|
# Typically, this is the value of
|
|
2359
3515
|
# next_page_token
|
|
2360
|
-
# returned from the previous call to `
|
|
2361
|
-
#
|
|
3516
|
+
# returned from the previous call to `ListInventorySources` method.
|
|
3517
|
+
# If not specified, the first page of results will be returned.
|
|
2362
3518
|
# @param [Fixnum] partner_id
|
|
2363
|
-
# The ID of the partner that has access to the
|
|
2364
|
-
#
|
|
3519
|
+
# The ID of the partner that has access to the inventory source group.
|
|
3520
|
+
# A partner cannot access advertiser-owned inventory source groups.
|
|
2365
3521
|
# @param [String] fields
|
|
2366
3522
|
# Selector specifying which fields to include in a partial response.
|
|
2367
3523
|
# @param [String] quota_user
|
|
@@ -2371,18 +3527,18 @@ module Google
|
|
|
2371
3527
|
# Request-specific options
|
|
2372
3528
|
#
|
|
2373
3529
|
# @yield [result, err] Result & error if block supplied
|
|
2374
|
-
# @yieldparam result [Google::Apis::DisplayvideoV1::
|
|
3530
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListInventorySourceGroupsResponse] parsed result object
|
|
2375
3531
|
# @yieldparam err [StandardError] error object if request failed
|
|
2376
3532
|
#
|
|
2377
|
-
# @return [Google::Apis::DisplayvideoV1::
|
|
3533
|
+
# @return [Google::Apis::DisplayvideoV1::ListInventorySourceGroupsResponse]
|
|
2378
3534
|
#
|
|
2379
3535
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2380
3536
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2381
3537
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2382
|
-
def
|
|
2383
|
-
command = make_simple_command(:get, 'v1/
|
|
2384
|
-
command.response_representation = Google::Apis::DisplayvideoV1::
|
|
2385
|
-
command.response_class = Google::Apis::DisplayvideoV1::
|
|
3538
|
+
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)
|
|
3539
|
+
command = make_simple_command(:get, 'v1/inventorySourceGroups', options)
|
|
3540
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListInventorySourceGroupsResponse::Representation
|
|
3541
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListInventorySourceGroupsResponse
|
|
2386
3542
|
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
2387
3543
|
command.query['filter'] = filter unless filter.nil?
|
|
2388
3544
|
command.query['orderBy'] = order_by unless order_by.nil?
|
|
@@ -2394,46 +3550,18 @@ module Google
|
|
|
2394
3550
|
execute_or_queue_command(command, &block)
|
|
2395
3551
|
end
|
|
2396
3552
|
|
|
2397
|
-
#
|
|
2398
|
-
#
|
|
2399
|
-
#
|
|
2400
|
-
#
|
|
2401
|
-
#
|
|
2402
|
-
# @param [
|
|
2403
|
-
#
|
|
2404
|
-
#
|
|
2405
|
-
#
|
|
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
|
|
3553
|
+
# Updates an inventory source group. Returns the updated inventory source
|
|
3554
|
+
# group if successful.
|
|
3555
|
+
# @param [Fixnum] inventory_source_group_id
|
|
3556
|
+
# Output only. The unique ID of the inventory source group. Assigned by the
|
|
3557
|
+
# system.
|
|
3558
|
+
# @param [Google::Apis::DisplayvideoV1::InventorySourceGroup] inventory_source_group_object
|
|
3559
|
+
# @param [Fixnum] advertiser_id
|
|
3560
|
+
# The ID of the advertiser that owns the inventory source group.
|
|
3561
|
+
# The parent partner does not have access to this group.
|
|
2435
3562
|
# @param [Fixnum] partner_id
|
|
2436
|
-
#
|
|
3563
|
+
# The ID of the partner that owns the inventory source group.
|
|
3564
|
+
# Only this partner has write access to this group.
|
|
2437
3565
|
# @param [String] update_mask
|
|
2438
3566
|
# Required. The mask to control which fields to update.
|
|
2439
3567
|
# @param [String] fields
|
|
@@ -2445,21 +3573,22 @@ module Google
|
|
|
2445
3573
|
# Request-specific options
|
|
2446
3574
|
#
|
|
2447
3575
|
# @yield [result, err] Result & error if block supplied
|
|
2448
|
-
# @yieldparam result [Google::Apis::DisplayvideoV1::
|
|
3576
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::InventorySourceGroup] parsed result object
|
|
2449
3577
|
# @yieldparam err [StandardError] error object if request failed
|
|
2450
3578
|
#
|
|
2451
|
-
# @return [Google::Apis::DisplayvideoV1::
|
|
3579
|
+
# @return [Google::Apis::DisplayvideoV1::InventorySourceGroup]
|
|
2452
3580
|
#
|
|
2453
3581
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2454
3582
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2455
3583
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2456
|
-
def
|
|
2457
|
-
command = make_simple_command(:patch, 'v1/
|
|
2458
|
-
command.request_representation = Google::Apis::DisplayvideoV1::
|
|
2459
|
-
command.request_object =
|
|
2460
|
-
command.response_representation = Google::Apis::DisplayvideoV1::
|
|
2461
|
-
command.response_class = Google::Apis::DisplayvideoV1::
|
|
2462
|
-
command.params['
|
|
3584
|
+
def patch_inventory_source_group(inventory_source_group_id, inventory_source_group_object = nil, advertiser_id: nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
3585
|
+
command = make_simple_command(:patch, 'v1/inventorySourceGroups/{inventorySourceGroupId}', options)
|
|
3586
|
+
command.request_representation = Google::Apis::DisplayvideoV1::InventorySourceGroup::Representation
|
|
3587
|
+
command.request_object = inventory_source_group_object
|
|
3588
|
+
command.response_representation = Google::Apis::DisplayvideoV1::InventorySourceGroup::Representation
|
|
3589
|
+
command.response_class = Google::Apis::DisplayvideoV1::InventorySourceGroup
|
|
3590
|
+
command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
|
|
3591
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
2463
3592
|
command.query['partnerId'] = partner_id unless partner_id.nil?
|
|
2464
3593
|
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
2465
3594
|
command.query['fields'] = fields unless fields.nil?
|
|
@@ -2467,13 +3596,16 @@ module Google
|
|
|
2467
3596
|
execute_or_queue_command(command, &block)
|
|
2468
3597
|
end
|
|
2469
3598
|
|
|
2470
|
-
#
|
|
2471
|
-
#
|
|
2472
|
-
#
|
|
2473
|
-
#
|
|
2474
|
-
#
|
|
2475
|
-
#
|
|
2476
|
-
#
|
|
3599
|
+
# Bulk edits multiple assignments between inventory sources and a single
|
|
3600
|
+
# inventory source group.
|
|
3601
|
+
# The operation will delete the assigned inventory sources provided in
|
|
3602
|
+
# BulkEditAssignedInventorySourcesRequest.deleted_assigned_inventory_sources
|
|
3603
|
+
# and then create the assigned inventory sources provided in
|
|
3604
|
+
# BulkEditAssignedInventorySourcesRequest.created_assigned_inventory_sources.
|
|
3605
|
+
# @param [Fixnum] inventory_source_group_id
|
|
3606
|
+
# Required. The ID of the inventory source group to which the assignments are
|
|
3607
|
+
# assigned.
|
|
3608
|
+
# @param [Google::Apis::DisplayvideoV1::BulkEditAssignedInventorySourcesRequest] bulk_edit_assigned_inventory_sources_request_object
|
|
2477
3609
|
# @param [String] fields
|
|
2478
3610
|
# Selector specifying which fields to include in a partial response.
|
|
2479
3611
|
# @param [String] quota_user
|
|
@@ -2483,64 +3615,40 @@ module Google
|
|
|
2483
3615
|
# Request-specific options
|
|
2484
3616
|
#
|
|
2485
3617
|
# @yield [result, err] Result & error if block supplied
|
|
2486
|
-
# @yieldparam result [Google::Apis::DisplayvideoV1::
|
|
3618
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::BulkEditAssignedInventorySourcesResponse] parsed result object
|
|
2487
3619
|
# @yieldparam err [StandardError] error object if request failed
|
|
2488
3620
|
#
|
|
2489
|
-
# @return [Google::Apis::DisplayvideoV1::
|
|
3621
|
+
# @return [Google::Apis::DisplayvideoV1::BulkEditAssignedInventorySourcesResponse]
|
|
2490
3622
|
#
|
|
2491
3623
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2492
3624
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2493
3625
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2494
|
-
def
|
|
2495
|
-
command = make_simple_command(:
|
|
2496
|
-
command.
|
|
2497
|
-
command.
|
|
2498
|
-
command.
|
|
2499
|
-
command.
|
|
2500
|
-
command.
|
|
3626
|
+
def bulk_edit_assigned_inventory_sources(inventory_source_group_id, bulk_edit_assigned_inventory_sources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
3627
|
+
command = make_simple_command(:post, 'v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources:bulkEdit', options)
|
|
3628
|
+
command.request_representation = Google::Apis::DisplayvideoV1::BulkEditAssignedInventorySourcesRequest::Representation
|
|
3629
|
+
command.request_object = bulk_edit_assigned_inventory_sources_request_object
|
|
3630
|
+
command.response_representation = Google::Apis::DisplayvideoV1::BulkEditAssignedInventorySourcesResponse::Representation
|
|
3631
|
+
command.response_class = Google::Apis::DisplayvideoV1::BulkEditAssignedInventorySourcesResponse
|
|
3632
|
+
command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
|
|
2501
3633
|
command.query['fields'] = fields unless fields.nil?
|
|
2502
3634
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2503
3635
|
execute_or_queue_command(command, &block)
|
|
2504
3636
|
end
|
|
2505
3637
|
|
|
2506
|
-
#
|
|
2507
|
-
#
|
|
2508
|
-
#
|
|
3638
|
+
# Creates an assignment between an inventory source and an inventory source
|
|
3639
|
+
# group.
|
|
3640
|
+
# @param [Fixnum] inventory_source_group_id
|
|
3641
|
+
# Required. The ID of the inventory source group to which the assignment will be
|
|
3642
|
+
# assigned.
|
|
3643
|
+
# @param [Google::Apis::DisplayvideoV1::AssignedInventorySource] assigned_inventory_source_object
|
|
2509
3644
|
# @param [Fixnum] advertiser_id
|
|
2510
|
-
# The ID of the advertiser that
|
|
2511
|
-
#
|
|
2512
|
-
#
|
|
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.
|
|
3645
|
+
# The ID of the advertiser that owns the parent inventory source group.
|
|
3646
|
+
# The parent partner will not have access to this assigned inventory
|
|
3647
|
+
# source.
|
|
2542
3648
|
# @param [Fixnum] partner_id
|
|
2543
|
-
# The ID of the partner that
|
|
3649
|
+
# The ID of the partner that owns the parent inventory source group.
|
|
3650
|
+
# Only this partner will have write access to this assigned inventory
|
|
3651
|
+
# source.
|
|
2544
3652
|
# @param [String] fields
|
|
2545
3653
|
# Selector specifying which fields to include in a partial response.
|
|
2546
3654
|
# @param [String] quota_user
|
|
@@ -2550,39 +3658,42 @@ module Google
|
|
|
2550
3658
|
# Request-specific options
|
|
2551
3659
|
#
|
|
2552
3660
|
# @yield [result, err] Result & error if block supplied
|
|
2553
|
-
# @yieldparam result [Google::Apis::DisplayvideoV1::
|
|
3661
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::AssignedInventorySource] parsed result object
|
|
2554
3662
|
# @yieldparam err [StandardError] error object if request failed
|
|
2555
3663
|
#
|
|
2556
|
-
# @return [Google::Apis::DisplayvideoV1::
|
|
3664
|
+
# @return [Google::Apis::DisplayvideoV1::AssignedInventorySource]
|
|
2557
3665
|
#
|
|
2558
3666
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2559
3667
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2560
3668
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2561
|
-
def
|
|
2562
|
-
command = make_simple_command(:
|
|
2563
|
-
command.
|
|
2564
|
-
command.
|
|
3669
|
+
def create_inventory_source_group_assigned_inventory_source(inventory_source_group_id, assigned_inventory_source_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
3670
|
+
command = make_simple_command(:post, 'v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources', options)
|
|
3671
|
+
command.request_representation = Google::Apis::DisplayvideoV1::AssignedInventorySource::Representation
|
|
3672
|
+
command.request_object = assigned_inventory_source_object
|
|
3673
|
+
command.response_representation = Google::Apis::DisplayvideoV1::AssignedInventorySource::Representation
|
|
3674
|
+
command.response_class = Google::Apis::DisplayvideoV1::AssignedInventorySource
|
|
3675
|
+
command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
|
|
2565
3676
|
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
3677
|
command.query['partnerId'] = partner_id unless partner_id.nil?
|
|
2571
3678
|
command.query['fields'] = fields unless fields.nil?
|
|
2572
3679
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2573
3680
|
execute_or_queue_command(command, &block)
|
|
2574
3681
|
end
|
|
2575
3682
|
|
|
2576
|
-
#
|
|
3683
|
+
# Deletes the assignment between an inventory source and an inventory source
|
|
3684
|
+
# group.
|
|
2577
3685
|
# @param [Fixnum] inventory_source_group_id
|
|
2578
|
-
# Required. The ID of the inventory source group to
|
|
3686
|
+
# Required. The ID of the inventory source group to which this assignment is
|
|
3687
|
+
# assigned.
|
|
3688
|
+
# @param [Fixnum] assigned_inventory_source_id
|
|
3689
|
+
# Required. The ID of the assigned inventory source to delete.
|
|
2579
3690
|
# @param [Fixnum] advertiser_id
|
|
2580
|
-
# The ID of the advertiser that
|
|
2581
|
-
#
|
|
2582
|
-
#
|
|
3691
|
+
# The ID of the advertiser that owns the parent inventory source group.
|
|
3692
|
+
# The parent partner does not have access to this assigned inventory
|
|
3693
|
+
# source.
|
|
2583
3694
|
# @param [Fixnum] partner_id
|
|
2584
|
-
# The ID of the partner that
|
|
2585
|
-
#
|
|
3695
|
+
# The ID of the partner that owns the parent inventory source group.
|
|
3696
|
+
# Only this partner has write access to this assigned inventory source.
|
|
2586
3697
|
# @param [String] fields
|
|
2587
3698
|
# Selector specifying which fields to include in a partial response.
|
|
2588
3699
|
# @param [String] quota_user
|
|
@@ -2592,19 +3703,20 @@ module Google
|
|
|
2592
3703
|
# Request-specific options
|
|
2593
3704
|
#
|
|
2594
3705
|
# @yield [result, err] Result & error if block supplied
|
|
2595
|
-
# @yieldparam result [Google::Apis::DisplayvideoV1::
|
|
3706
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
|
2596
3707
|
# @yieldparam err [StandardError] error object if request failed
|
|
2597
3708
|
#
|
|
2598
|
-
# @return [Google::Apis::DisplayvideoV1::
|
|
3709
|
+
# @return [Google::Apis::DisplayvideoV1::Empty]
|
|
2599
3710
|
#
|
|
2600
3711
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2601
3712
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2602
3713
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2603
|
-
def
|
|
2604
|
-
command = make_simple_command(:
|
|
2605
|
-
command.response_representation = Google::Apis::DisplayvideoV1::
|
|
2606
|
-
command.response_class = Google::Apis::DisplayvideoV1::
|
|
3714
|
+
def delete_inventory_source_group_assigned_inventory_source(inventory_source_group_id, assigned_inventory_source_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
3715
|
+
command = make_simple_command(:delete, 'v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources/{+assignedInventorySourceId}', options)
|
|
3716
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
|
3717
|
+
command.response_class = Google::Apis::DisplayvideoV1::Empty
|
|
2607
3718
|
command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
|
|
3719
|
+
command.params['assignedInventorySourceId'] = assigned_inventory_source_id unless assigned_inventory_source_id.nil?
|
|
2608
3720
|
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
2609
3721
|
command.query['partnerId'] = partner_id unless partner_id.nil?
|
|
2610
3722
|
command.query['fields'] = fields unless fields.nil?
|
|
@@ -2612,43 +3724,46 @@ module Google
|
|
|
2612
3724
|
execute_or_queue_command(command, &block)
|
|
2613
3725
|
end
|
|
2614
3726
|
|
|
2615
|
-
# Lists inventory
|
|
2616
|
-
#
|
|
2617
|
-
#
|
|
3727
|
+
# Lists inventory sources assigned to an inventory source group.
|
|
3728
|
+
# @param [Fixnum] inventory_source_group_id
|
|
3729
|
+
# Required. The ID of the inventory source group to which these assignments are
|
|
3730
|
+
# assigned.
|
|
2618
3731
|
# @param [Fixnum] advertiser_id
|
|
2619
|
-
# The ID of the advertiser that has access to the
|
|
2620
|
-
# If
|
|
2621
|
-
# the group is explicitly shared can access the
|
|
3732
|
+
# The ID of the advertiser that has access to the assignment.
|
|
3733
|
+
# If the parent inventory source group is partner-owned, only advertisers
|
|
3734
|
+
# to which the parent group is explicitly shared can access the assigned
|
|
3735
|
+
# inventory source.
|
|
2622
3736
|
# @param [String] filter
|
|
2623
|
-
# Allows filtering by inventory source
|
|
3737
|
+
# Allows filtering by assigned inventory source fields.
|
|
2624
3738
|
# Supported syntax:
|
|
2625
3739
|
# * Filter expressions are made up of one or more restrictions.
|
|
2626
3740
|
# * Restrictions can be combined by the logical operator `OR`.
|
|
2627
3741
|
# * A restriction has the form of ``field` `operator` `value``.
|
|
2628
3742
|
# * The operator must be `EQUALS (=)`.
|
|
2629
3743
|
# * Supported fields:
|
|
2630
|
-
# - `
|
|
3744
|
+
# - `assignedInventorySourceId`
|
|
2631
3745
|
# The length of this field should be no more than 500 characters.
|
|
2632
3746
|
# @param [String] order_by
|
|
2633
3747
|
# Field by which to sort the list.
|
|
2634
3748
|
# Acceptable values are:
|
|
2635
|
-
# * `
|
|
2636
|
-
#
|
|
2637
|
-
#
|
|
2638
|
-
#
|
|
2639
|
-
# `displayName desc`.
|
|
3749
|
+
# * `assignedInventorySourceId` (default)
|
|
3750
|
+
# The default sorting order is ascending. To specify descending order for a
|
|
3751
|
+
# field, a suffix " desc" should be added to the field name. Example:
|
|
3752
|
+
# `assignedInventorySourceId desc`.
|
|
2640
3753
|
# @param [Fixnum] page_size
|
|
2641
3754
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
2642
|
-
# default to `100`.
|
|
3755
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
|
3756
|
+
# is specified.
|
|
2643
3757
|
# @param [String] page_token
|
|
2644
3758
|
# A token identifying a page of results the server should return.
|
|
2645
3759
|
# Typically, this is the value of
|
|
2646
3760
|
# next_page_token
|
|
2647
|
-
# returned from the previous call to `
|
|
2648
|
-
# If not specified, the first page of results will be returned.
|
|
3761
|
+
# returned from the previous call to `ListAssignedInventorySources`
|
|
3762
|
+
# method. If not specified, the first page of results will be returned.
|
|
2649
3763
|
# @param [Fixnum] partner_id
|
|
2650
|
-
# The ID of the partner that has access to the
|
|
2651
|
-
#
|
|
3764
|
+
# The ID of the partner that has access to the assignment.
|
|
3765
|
+
# If the parent inventory source group is advertiser-owned, the assignment
|
|
3766
|
+
# cannot be accessed via a partner.
|
|
2652
3767
|
# @param [String] fields
|
|
2653
3768
|
# Selector specifying which fields to include in a partial response.
|
|
2654
3769
|
# @param [String] quota_user
|
|
@@ -2658,18 +3773,19 @@ module Google
|
|
|
2658
3773
|
# Request-specific options
|
|
2659
3774
|
#
|
|
2660
3775
|
# @yield [result, err] Result & error if block supplied
|
|
2661
|
-
# @yieldparam result [Google::Apis::DisplayvideoV1::
|
|
3776
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListAssignedInventorySourcesResponse] parsed result object
|
|
2662
3777
|
# @yieldparam err [StandardError] error object if request failed
|
|
2663
3778
|
#
|
|
2664
|
-
# @return [Google::Apis::DisplayvideoV1::
|
|
3779
|
+
# @return [Google::Apis::DisplayvideoV1::ListAssignedInventorySourcesResponse]
|
|
2665
3780
|
#
|
|
2666
3781
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2667
3782
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2668
3783
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2669
|
-
def
|
|
2670
|
-
command = make_simple_command(:get, 'v1/inventorySourceGroups', options)
|
|
2671
|
-
command.response_representation = Google::Apis::DisplayvideoV1::
|
|
2672
|
-
command.response_class = Google::Apis::DisplayvideoV1::
|
|
3784
|
+
def list_inventory_source_group_assigned_inventory_sources(inventory_source_group_id, 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)
|
|
3785
|
+
command = make_simple_command(:get, 'v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources', options)
|
|
3786
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListAssignedInventorySourcesResponse::Representation
|
|
3787
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListAssignedInventorySourcesResponse
|
|
3788
|
+
command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
|
|
2673
3789
|
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
2674
3790
|
command.query['filter'] = filter unless filter.nil?
|
|
2675
3791
|
command.query['orderBy'] = order_by unless order_by.nil?
|
|
@@ -2835,6 +3951,8 @@ module Google
|
|
|
2835
3951
|
execute_or_queue_command(command, &block)
|
|
2836
3952
|
end
|
|
2837
3953
|
|
|
3954
|
+
# Updates an existing inventory source.
|
|
3955
|
+
# Returns the updated inventory source if successful.
|
|
2838
3956
|
# Gets a channel for a partner or advertiser.
|
|
2839
3957
|
# @param [Fixnum] partner_id
|
|
2840
3958
|
# The ID of the partner that owns the fetched channel.
|
|
@@ -2939,6 +4057,234 @@ module Google
|
|
|
2939
4057
|
execute_or_queue_command(command, &block)
|
|
2940
4058
|
end
|
|
2941
4059
|
|
|
4060
|
+
# Updates a channel. Returns the updated channel if successful.
|
|
4061
|
+
# @param [Fixnum] partner_id
|
|
4062
|
+
# The ID of the partner that owns the created channel.
|
|
4063
|
+
# @param [Fixnum] channel_id
|
|
4064
|
+
# Output only. The unique ID of the channel. Assigned by the system.
|
|
4065
|
+
# @param [Google::Apis::DisplayvideoV1::Channel] channel_object
|
|
4066
|
+
# @param [Fixnum] advertiser_id
|
|
4067
|
+
# The ID of the advertiser that owns the created channel.
|
|
4068
|
+
# @param [String] update_mask
|
|
4069
|
+
# Required. The mask to control which fields to update.
|
|
4070
|
+
# @param [String] fields
|
|
4071
|
+
# Selector specifying which fields to include in a partial response.
|
|
4072
|
+
# @param [String] quota_user
|
|
4073
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
4074
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
4075
|
+
# @param [Google::Apis::RequestOptions] options
|
|
4076
|
+
# Request-specific options
|
|
4077
|
+
#
|
|
4078
|
+
# @yield [result, err] Result & error if block supplied
|
|
4079
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Channel] parsed result object
|
|
4080
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
4081
|
+
#
|
|
4082
|
+
# @return [Google::Apis::DisplayvideoV1::Channel]
|
|
4083
|
+
#
|
|
4084
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
4085
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
4086
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
4087
|
+
def patch_partner_channel(partner_id, channel_id, channel_object = nil, advertiser_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
4088
|
+
command = make_simple_command(:patch, 'v1/partners/{+partnerId}/channels/{channelId}', options)
|
|
4089
|
+
command.request_representation = Google::Apis::DisplayvideoV1::Channel::Representation
|
|
4090
|
+
command.request_object = channel_object
|
|
4091
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Channel::Representation
|
|
4092
|
+
command.response_class = Google::Apis::DisplayvideoV1::Channel
|
|
4093
|
+
command.params['partnerId'] = partner_id unless partner_id.nil?
|
|
4094
|
+
command.params['channelId'] = channel_id unless channel_id.nil?
|
|
4095
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
4096
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
4097
|
+
command.query['fields'] = fields unless fields.nil?
|
|
4098
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
4099
|
+
execute_or_queue_command(command, &block)
|
|
4100
|
+
end
|
|
4101
|
+
|
|
4102
|
+
# Bulk edits sites under a single channel.
|
|
4103
|
+
# The operation will delete the sites provided in
|
|
4104
|
+
# BulkEditSitesRequest.deleted_sites and then create the sites
|
|
4105
|
+
# provided in BulkEditSitesRequest.created_sites.
|
|
4106
|
+
# @param [Fixnum] partner_id
|
|
4107
|
+
# The ID of the partner that owns the parent channel.
|
|
4108
|
+
# @param [Fixnum] channel_id
|
|
4109
|
+
# Required. The ID of the parent channel to which the sites belong.
|
|
4110
|
+
# @param [Google::Apis::DisplayvideoV1::BulkEditSitesRequest] bulk_edit_sites_request_object
|
|
4111
|
+
# @param [String] fields
|
|
4112
|
+
# Selector specifying which fields to include in a partial response.
|
|
4113
|
+
# @param [String] quota_user
|
|
4114
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
4115
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
4116
|
+
# @param [Google::Apis::RequestOptions] options
|
|
4117
|
+
# Request-specific options
|
|
4118
|
+
#
|
|
4119
|
+
# @yield [result, err] Result & error if block supplied
|
|
4120
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::BulkEditSitesResponse] parsed result object
|
|
4121
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
4122
|
+
#
|
|
4123
|
+
# @return [Google::Apis::DisplayvideoV1::BulkEditSitesResponse]
|
|
4124
|
+
#
|
|
4125
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
4126
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
4127
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
4128
|
+
def bulk_partner_channel_site_edit(partner_id, channel_id, bulk_edit_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
4129
|
+
command = make_simple_command(:post, 'v1/partners/{partnerId}/channels/{+channelId}/sites:bulkEdit', options)
|
|
4130
|
+
command.request_representation = Google::Apis::DisplayvideoV1::BulkEditSitesRequest::Representation
|
|
4131
|
+
command.request_object = bulk_edit_sites_request_object
|
|
4132
|
+
command.response_representation = Google::Apis::DisplayvideoV1::BulkEditSitesResponse::Representation
|
|
4133
|
+
command.response_class = Google::Apis::DisplayvideoV1::BulkEditSitesResponse
|
|
4134
|
+
command.params['partnerId'] = partner_id unless partner_id.nil?
|
|
4135
|
+
command.params['channelId'] = channel_id unless channel_id.nil?
|
|
4136
|
+
command.query['fields'] = fields unless fields.nil?
|
|
4137
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
4138
|
+
execute_or_queue_command(command, &block)
|
|
4139
|
+
end
|
|
4140
|
+
|
|
4141
|
+
# Creates a site in a channel.
|
|
4142
|
+
# @param [Fixnum] partner_id
|
|
4143
|
+
# The ID of the partner that owns the parent channel.
|
|
4144
|
+
# @param [Fixnum] channel_id
|
|
4145
|
+
# Required. The ID of the parent channel in which the site will be created.
|
|
4146
|
+
# @param [Google::Apis::DisplayvideoV1::Site] site_object
|
|
4147
|
+
# @param [Fixnum] advertiser_id
|
|
4148
|
+
# The ID of the advertiser that owns the parent channel.
|
|
4149
|
+
# @param [String] fields
|
|
4150
|
+
# Selector specifying which fields to include in a partial response.
|
|
4151
|
+
# @param [String] quota_user
|
|
4152
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
4153
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
4154
|
+
# @param [Google::Apis::RequestOptions] options
|
|
4155
|
+
# Request-specific options
|
|
4156
|
+
#
|
|
4157
|
+
# @yield [result, err] Result & error if block supplied
|
|
4158
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Site] parsed result object
|
|
4159
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
4160
|
+
#
|
|
4161
|
+
# @return [Google::Apis::DisplayvideoV1::Site]
|
|
4162
|
+
#
|
|
4163
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
4164
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
4165
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
4166
|
+
def create_partner_channel_site(partner_id, channel_id, site_object = nil, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
4167
|
+
command = make_simple_command(:post, 'v1/partners/{partnerId}/channels/{+channelId}/sites', options)
|
|
4168
|
+
command.request_representation = Google::Apis::DisplayvideoV1::Site::Representation
|
|
4169
|
+
command.request_object = site_object
|
|
4170
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Site::Representation
|
|
4171
|
+
command.response_class = Google::Apis::DisplayvideoV1::Site
|
|
4172
|
+
command.params['partnerId'] = partner_id unless partner_id.nil?
|
|
4173
|
+
command.params['channelId'] = channel_id unless channel_id.nil?
|
|
4174
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
4175
|
+
command.query['fields'] = fields unless fields.nil?
|
|
4176
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
4177
|
+
execute_or_queue_command(command, &block)
|
|
4178
|
+
end
|
|
4179
|
+
|
|
4180
|
+
# Deletes a site from a channel.
|
|
4181
|
+
# @param [Fixnum] partner_id
|
|
4182
|
+
# The ID of the partner that owns the parent channel.
|
|
4183
|
+
# @param [Fixnum] channel_id
|
|
4184
|
+
# Required. The ID of the parent channel to which the site belongs.
|
|
4185
|
+
# @param [String] url_or_app_id
|
|
4186
|
+
# Required. The URL or app ID of the site to delete.
|
|
4187
|
+
# @param [Fixnum] advertiser_id
|
|
4188
|
+
# The ID of the advertiser that owns the parent channel.
|
|
4189
|
+
# @param [String] fields
|
|
4190
|
+
# Selector specifying which fields to include in a partial response.
|
|
4191
|
+
# @param [String] quota_user
|
|
4192
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
4193
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
4194
|
+
# @param [Google::Apis::RequestOptions] options
|
|
4195
|
+
# Request-specific options
|
|
4196
|
+
#
|
|
4197
|
+
# @yield [result, err] Result & error if block supplied
|
|
4198
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
|
4199
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
4200
|
+
#
|
|
4201
|
+
# @return [Google::Apis::DisplayvideoV1::Empty]
|
|
4202
|
+
#
|
|
4203
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
4204
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
4205
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
4206
|
+
def delete_partner_channel_site(partner_id, channel_id, url_or_app_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
4207
|
+
command = make_simple_command(:delete, 'v1/partners/{partnerId}/channels/{+channelId}/sites/{+urlOrAppId}', options)
|
|
4208
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
|
4209
|
+
command.response_class = Google::Apis::DisplayvideoV1::Empty
|
|
4210
|
+
command.params['partnerId'] = partner_id unless partner_id.nil?
|
|
4211
|
+
command.params['channelId'] = channel_id unless channel_id.nil?
|
|
4212
|
+
command.params['urlOrAppId'] = url_or_app_id unless url_or_app_id.nil?
|
|
4213
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
4214
|
+
command.query['fields'] = fields unless fields.nil?
|
|
4215
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
4216
|
+
execute_or_queue_command(command, &block)
|
|
4217
|
+
end
|
|
4218
|
+
|
|
4219
|
+
# Lists sites in a channel.
|
|
4220
|
+
# @param [Fixnum] partner_id
|
|
4221
|
+
# The ID of the partner that owns the parent channel.
|
|
4222
|
+
# @param [Fixnum] channel_id
|
|
4223
|
+
# Required. The ID of the parent channel to which the requested sites belong.
|
|
4224
|
+
# @param [Fixnum] advertiser_id
|
|
4225
|
+
# The ID of the advertiser that owns the parent channel.
|
|
4226
|
+
# @param [String] filter
|
|
4227
|
+
# Allows filtering by site fields.
|
|
4228
|
+
# Supported syntax:
|
|
4229
|
+
# * Filter expressions for site currently can only contain at most one
|
|
4230
|
+
# * restriction.
|
|
4231
|
+
# * A restriction has the form of ``field` `operator` `value``.
|
|
4232
|
+
# * The operator must be `CONTAINS (:)`.
|
|
4233
|
+
# * Supported fields:
|
|
4234
|
+
# - `urlOrAppId`
|
|
4235
|
+
# Examples:
|
|
4236
|
+
# * All sites for which the URL or app ID contains "google":
|
|
4237
|
+
# `urlOrAppId : "google"`
|
|
4238
|
+
# @param [String] order_by
|
|
4239
|
+
# Field by which to sort the list.
|
|
4240
|
+
# Acceptable values are:
|
|
4241
|
+
# * `urlOrAppId` (default)
|
|
4242
|
+
# The default sorting order is ascending. To specify descending order for a
|
|
4243
|
+
# field, a suffix " desc" should be added to the field name. Example:
|
|
4244
|
+
# `urlOrAppId desc`.
|
|
4245
|
+
# @param [Fixnum] page_size
|
|
4246
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
4247
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
|
4248
|
+
# is specified.
|
|
4249
|
+
# @param [String] page_token
|
|
4250
|
+
# A token identifying a page of results the server should return.
|
|
4251
|
+
# Typically, this is the value of
|
|
4252
|
+
# next_page_token returned from the
|
|
4253
|
+
# previous call to `ListSites` method. If not specified, the first page
|
|
4254
|
+
# of results will be returned.
|
|
4255
|
+
# @param [String] fields
|
|
4256
|
+
# Selector specifying which fields to include in a partial response.
|
|
4257
|
+
# @param [String] quota_user
|
|
4258
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
4259
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
4260
|
+
# @param [Google::Apis::RequestOptions] options
|
|
4261
|
+
# Request-specific options
|
|
4262
|
+
#
|
|
4263
|
+
# @yield [result, err] Result & error if block supplied
|
|
4264
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListSitesResponse] parsed result object
|
|
4265
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
4266
|
+
#
|
|
4267
|
+
# @return [Google::Apis::DisplayvideoV1::ListSitesResponse]
|
|
4268
|
+
#
|
|
4269
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
4270
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
4271
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
4272
|
+
def list_partner_channel_sites(partner_id, channel_id, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
4273
|
+
command = make_simple_command(:get, 'v1/partners/{+partnerId}/channels/{+channelId}/sites', options)
|
|
4274
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListSitesResponse::Representation
|
|
4275
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListSitesResponse
|
|
4276
|
+
command.params['partnerId'] = partner_id unless partner_id.nil?
|
|
4277
|
+
command.params['channelId'] = channel_id unless channel_id.nil?
|
|
4278
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
4279
|
+
command.query['filter'] = filter unless filter.nil?
|
|
4280
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
|
4281
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
4282
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
4283
|
+
command.query['fields'] = fields unless fields.nil?
|
|
4284
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
4285
|
+
execute_or_queue_command(command, &block)
|
|
4286
|
+
end
|
|
4287
|
+
|
|
2942
4288
|
# Creates an SDF Download Task. Returns an
|
|
2943
4289
|
# Operation.
|
|
2944
4290
|
# An SDF Download Task is a long-running, asynchronous operation. The
|