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