google-api-client 0.42.1 → 0.42.2
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 +76 -0
- data/generated/google/apis/admob_v1.rb +1 -1
- data/generated/google/apis/admob_v1/classes.rb +3 -1
- data/generated/google/apis/apigee_v1.rb +1 -1
- data/generated/google/apis/apigee_v1/classes.rb +6 -12
- data/generated/google/apis/apigee_v1/representations.rb +1 -2
- data/generated/google/apis/apigee_v1/service.rb +18 -5
- data/generated/google/apis/appengine_v1.rb +1 -1
- data/generated/google/apis/appengine_v1/service.rb +6 -3
- data/generated/google/apis/appengine_v1beta.rb +1 -1
- data/generated/google/apis/appengine_v1beta/service.rb +6 -2
- data/generated/google/apis/appsmarket_v2.rb +1 -1
- data/generated/google/apis/bigquery_v2.rb +1 -1
- data/generated/google/apis/bigquery_v2/classes.rb +198 -3
- data/generated/google/apis/bigquery_v2/representations.rb +70 -0
- data/generated/google/apis/bigtableadmin_v1.rb +1 -1
- data/generated/google/apis/bigtableadmin_v1/classes.rb +267 -0
- data/generated/google/apis/bigtableadmin_v1/representations.rb +100 -0
- data/generated/google/apis/bigtableadmin_v2.rb +1 -1
- data/generated/google/apis/bigtableadmin_v2/classes.rb +355 -0
- data/generated/google/apis/bigtableadmin_v2/representations.rb +146 -0
- data/generated/google/apis/bigtableadmin_v2/service.rb +298 -0
- data/generated/google/apis/books_v1.rb +1 -1
- data/generated/google/apis/books_v1/classes.rb +140 -159
- data/generated/google/apis/books_v1/service.rb +47 -49
- data/generated/google/apis/chat_v1.rb +1 -1
- data/generated/google/apis/chat_v1/classes.rb +19 -0
- data/generated/google/apis/chat_v1/representations.rb +13 -0
- data/generated/google/apis/chat_v1/service.rb +39 -0
- data/generated/google/apis/chromeuxreport_v1.rb +1 -1
- data/generated/google/apis/chromeuxreport_v1/classes.rb +22 -0
- data/generated/google/apis/chromeuxreport_v1/representations.rb +2 -0
- data/generated/google/apis/{cloudfunctions_v1beta2.rb → cloudasset_v1p5beta1.rb} +9 -9
- data/generated/google/apis/cloudasset_v1p5beta1/classes.rb +1537 -0
- data/generated/google/apis/cloudasset_v1p5beta1/representations.rb +399 -0
- data/generated/google/apis/cloudasset_v1p5beta1/service.rb +129 -0
- data/generated/google/apis/cloudbuild_v1.rb +1 -1
- data/generated/google/apis/cloudbuild_v1alpha1.rb +1 -1
- data/generated/google/apis/cloudbuild_v1alpha2.rb +1 -1
- data/generated/google/apis/cloudfunctions_v1.rb +1 -1
- data/generated/google/apis/cloudfunctions_v1/classes.rb +0 -45
- data/generated/google/apis/cloudfunctions_v1/representations.rb +0 -17
- data/generated/google/apis/cloudresourcemanager_v1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v1/classes.rb +503 -754
- data/generated/google/apis/cloudresourcemanager_v1/service.rb +198 -249
- data/generated/google/apis/cloudresourcemanager_v1beta1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +258 -429
- data/generated/google/apis/cloudresourcemanager_v1beta1/service.rb +136 -178
- data/generated/google/apis/cloudresourcemanager_v2.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v2/classes.rb +258 -414
- data/generated/google/apis/cloudresourcemanager_v2/service.rb +96 -129
- data/generated/google/apis/cloudresourcemanager_v2beta1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v2beta1/classes.rb +258 -414
- data/generated/google/apis/cloudresourcemanager_v2beta1/service.rb +96 -129
- data/generated/google/apis/cloudscheduler_v1.rb +1 -1
- data/generated/google/apis/cloudscheduler_v1/classes.rb +11 -0
- data/generated/google/apis/cloudscheduler_v1/representations.rb +1 -0
- data/generated/google/apis/cloudscheduler_v1beta1.rb +1 -1
- data/generated/google/apis/cloudscheduler_v1beta1/classes.rb +11 -0
- data/generated/google/apis/cloudscheduler_v1beta1/representations.rb +1 -0
- data/generated/google/apis/cloudshell_v1.rb +1 -1
- data/generated/google/apis/cloudshell_v1/classes.rb +2 -2
- data/generated/google/apis/cloudshell_v1alpha1.rb +1 -1
- data/generated/google/apis/cloudshell_v1alpha1/classes.rb +8 -5
- data/generated/google/apis/content_v2.rb +1 -1
- data/generated/google/apis/content_v2/classes.rb +6 -0
- data/generated/google/apis/content_v2/representations.rb +1 -0
- data/generated/google/apis/content_v2_1.rb +1 -1
- data/generated/google/apis/content_v2_1/classes.rb +6 -0
- data/generated/google/apis/content_v2_1/representations.rb +1 -0
- data/generated/google/apis/customsearch_v1.rb +1 -1
- data/generated/google/apis/customsearch_v1/classes.rb +14 -10
- data/generated/google/apis/customsearch_v1/service.rb +6 -6
- data/generated/google/apis/datacatalog_v1beta1.rb +1 -1
- data/generated/google/apis/datacatalog_v1beta1/classes.rb +380 -569
- data/generated/google/apis/datacatalog_v1beta1/service.rb +319 -440
- data/generated/google/apis/dataflow_v1b3.rb +1 -1
- data/generated/google/apis/dataflow_v1b3/classes.rb +2 -1
- data/generated/google/apis/deploymentmanager_v2.rb +1 -1
- data/generated/google/apis/dfareporting_v3_4.rb +1 -1
- data/generated/google/apis/dfareporting_v3_4/classes.rb +421 -0
- data/generated/google/apis/dfareporting_v3_4/representations.rb +182 -0
- data/generated/google/apis/dialogflow_v2.rb +1 -1
- data/generated/google/apis/dialogflow_v2/classes.rb +148 -35
- data/generated/google/apis/dialogflow_v2/representations.rb +15 -0
- data/generated/google/apis/dialogflow_v2/service.rb +4 -0
- data/generated/google/apis/dialogflow_v2beta1.rb +1 -1
- data/generated/google/apis/dialogflow_v2beta1/classes.rb +164 -36
- data/generated/google/apis/dialogflow_v2beta1/representations.rb +15 -0
- data/generated/google/apis/dialogflow_v2beta1/service.rb +8 -0
- data/generated/google/apis/displayvideo_v1.rb +7 -1
- data/generated/google/apis/displayvideo_v1/classes.rb +1666 -1726
- data/generated/google/apis/displayvideo_v1/representations.rb +264 -0
- data/generated/google/apis/displayvideo_v1/service.rb +1173 -926
- data/generated/google/apis/doubleclicksearch_v2.rb +1 -1
- data/generated/google/apis/doubleclicksearch_v2/classes.rb +109 -126
- data/generated/google/apis/doubleclicksearch_v2/service.rb +3 -4
- data/generated/google/apis/fcm_v1.rb +1 -1
- data/generated/google/apis/fcm_v1/classes.rb +245 -393
- data/generated/google/apis/fcm_v1/service.rb +5 -6
- data/generated/google/apis/firebase_v1beta1.rb +1 -1
- data/generated/google/apis/firebase_v1beta1/classes.rb +10 -16
- data/generated/google/apis/firebaseml_v1beta2.rb +1 -1
- data/generated/google/apis/firebaseml_v1beta2/classes.rb +9 -0
- data/generated/google/apis/firebaseml_v1beta2/representations.rb +1 -0
- data/generated/google/apis/games_configuration_v1configuration.rb +1 -1
- data/generated/google/apis/games_configuration_v1configuration/service.rb +2 -2
- data/generated/google/apis/games_management_v1management.rb +1 -1
- data/generated/google/apis/games_management_v1management/service.rb +2 -2
- data/generated/google/apis/games_v1.rb +1 -1
- data/generated/google/apis/games_v1/classes.rb +1 -1
- data/generated/google/apis/games_v1/service.rb +2 -2
- data/generated/google/apis/gmail_v1.rb +1 -1
- data/generated/google/apis/gmail_v1/classes.rb +2 -2
- data/generated/google/apis/gmail_v1/service.rb +2 -1
- data/generated/google/apis/gmailpostmastertools_v1beta1.rb +4 -1
- data/generated/google/apis/monitoring_v1.rb +1 -1
- data/generated/google/apis/monitoring_v1/classes.rb +2 -1
- data/generated/google/apis/monitoring_v3.rb +1 -1
- data/generated/google/apis/monitoring_v3/classes.rb +5 -4
- data/generated/google/apis/monitoring_v3/service.rb +5 -4
- data/generated/google/apis/osconfig_v1.rb +1 -1
- data/generated/google/apis/osconfig_v1/classes.rb +75 -0
- data/generated/google/apis/osconfig_v1/representations.rb +35 -0
- data/generated/google/apis/osconfig_v1beta.rb +1 -1
- data/generated/google/apis/osconfig_v1beta/classes.rb +75 -0
- data/generated/google/apis/osconfig_v1beta/representations.rb +35 -0
- data/generated/google/apis/pagespeedonline_v5.rb +1 -1
- data/generated/google/apis/people_v1.rb +1 -1
- data/generated/google/apis/people_v1/classes.rb +243 -397
- data/generated/google/apis/people_v1/service.rb +156 -384
- data/generated/google/apis/prod_tt_sasportal_v1alpha1.rb +1 -1
- data/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb +0 -73
- data/generated/google/apis/prod_tt_sasportal_v1alpha1/representations.rb +0 -32
- data/generated/google/apis/prod_tt_sasportal_v1alpha1/service.rb +0 -477
- data/generated/google/apis/pubsub_v1.rb +1 -1
- data/generated/google/apis/pubsub_v1/classes.rb +21 -0
- data/generated/google/apis/pubsub_v1/representations.rb +2 -0
- data/generated/google/apis/realtimebidding_v1.rb +1 -1
- data/generated/google/apis/redis_v1.rb +1 -1
- data/generated/google/apis/redis_v1/classes.rb +397 -0
- data/generated/google/apis/redis_v1/representations.rb +139 -0
- data/generated/google/apis/redis_v1beta1.rb +1 -1
- data/generated/google/apis/redis_v1beta1/classes.rb +397 -0
- data/generated/google/apis/redis_v1beta1/representations.rb +139 -0
- data/generated/google/apis/remotebuildexecution_v1.rb +1 -1
- data/generated/google/apis/remotebuildexecution_v1alpha.rb +1 -1
- data/generated/google/apis/remotebuildexecution_v2.rb +1 -1
- data/generated/google/apis/run_v1.rb +1 -1
- data/generated/google/apis/run_v1/classes.rb +835 -1248
- data/generated/google/apis/run_v1/service.rb +195 -245
- data/generated/google/apis/run_v1alpha1.rb +1 -1
- data/generated/google/apis/run_v1alpha1/classes.rb +934 -1331
- data/generated/google/apis/run_v1alpha1/service.rb +321 -377
- data/generated/google/apis/run_v1beta1.rb +1 -1
- data/generated/google/apis/run_v1beta1/classes.rb +209 -276
- data/generated/google/apis/run_v1beta1/service.rb +16 -18
- data/generated/google/apis/sasportal_v1alpha1.rb +1 -1
- data/generated/google/apis/sasportal_v1alpha1/classes.rb +0 -73
- data/generated/google/apis/sasportal_v1alpha1/representations.rb +0 -32
- data/generated/google/apis/sasportal_v1alpha1/service.rb +0 -477
- data/generated/google/apis/serviceconsumermanagement_v1.rb +1 -1
- data/generated/google/apis/serviceconsumermanagement_v1/classes.rb +2 -2
- data/generated/google/apis/serviceconsumermanagement_v1/service.rb +7 -7
- data/generated/google/apis/serviceconsumermanagement_v1beta1.rb +1 -1
- data/generated/google/apis/serviceconsumermanagement_v1beta1/classes.rb +1 -1
- data/generated/google/apis/servicenetworking_v1.rb +1 -1
- data/generated/google/apis/servicenetworking_v1/classes.rb +1 -1
- data/generated/google/apis/servicenetworking_v1beta.rb +1 -1
- data/generated/google/apis/servicenetworking_v1beta/classes.rb +1 -1
- data/generated/google/apis/serviceusage_v1.rb +1 -1
- data/generated/google/apis/serviceusage_v1/classes.rb +1 -1
- data/generated/google/apis/serviceusage_v1beta1.rb +1 -1
- data/generated/google/apis/serviceusage_v1beta1/classes.rb +1 -1
- data/generated/google/apis/spanner_v1.rb +1 -1
- data/generated/google/apis/sql_v1beta4.rb +1 -1
- data/generated/google/apis/sql_v1beta4/classes.rb +207 -200
- data/generated/google/apis/sql_v1beta4/representations.rb +2 -1
- data/generated/google/apis/sql_v1beta4/service.rb +2 -2
- data/generated/google/apis/testing_v1.rb +1 -1
- data/generated/google/apis/testing_v1/classes.rb +63 -0
- data/generated/google/apis/testing_v1/representations.rb +32 -0
- data/generated/google/apis/toolresults_v1beta3.rb +1 -1
- data/generated/google/apis/toolresults_v1beta3/classes.rb +9 -0
- data/generated/google/apis/toolresults_v1beta3/representations.rb +1 -0
- data/generated/google/apis/toolresults_v1beta3/service.rb +498 -498
- data/generated/google/apis/webfonts_v1.rb +1 -1
- data/generated/google/apis/webfonts_v1/service.rb +2 -2
- data/generated/google/apis/youtube_partner_v1.rb +1 -1
- data/generated/google/apis/youtube_partner_v1/classes.rb +637 -761
- data/generated/google/apis/youtube_partner_v1/service.rb +511 -651
- data/generated/google/apis/youtube_v3.rb +1 -1
- data/generated/google/apis/youtube_v3/classes.rb +6 -0
- data/generated/google/apis/youtube_v3/representations.rb +1 -0
- data/generated/google/apis/youtube_v3/service.rb +32 -32
- data/lib/google/apis/version.rb +1 -1
- metadata +7 -7
- data/generated/google/apis/cloudfunctions_v1beta2/classes.rb +0 -848
- data/generated/google/apis/cloudfunctions_v1beta2/representations.rb +0 -346
- data/generated/google/apis/cloudfunctions_v1beta2/service.rb +0 -486
|
@@ -136,6 +136,12 @@ module Google
|
|
|
136
136
|
include Google::Apis::Core::JsonObjectSupport
|
|
137
137
|
end
|
|
138
138
|
|
|
139
|
+
class AssignedUserRole
|
|
140
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
141
|
+
|
|
142
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
143
|
+
end
|
|
144
|
+
|
|
139
145
|
class AudienceGroupAssignedTargetingOptionDetails
|
|
140
146
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
141
147
|
|
|
@@ -148,6 +154,12 @@ module Google
|
|
|
148
154
|
include Google::Apis::Core::JsonObjectSupport
|
|
149
155
|
end
|
|
150
156
|
|
|
157
|
+
class AuditAdvertiserResponse
|
|
158
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
159
|
+
|
|
160
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
161
|
+
end
|
|
162
|
+
|
|
151
163
|
class AuthorizedSellerStatusAssignedTargetingOptionDetails
|
|
152
164
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
153
165
|
|
|
@@ -214,6 +226,18 @@ module Google
|
|
|
214
226
|
include Google::Apis::Core::JsonObjectSupport
|
|
215
227
|
end
|
|
216
228
|
|
|
229
|
+
class BulkEditAssignedUserRolesRequest
|
|
230
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
231
|
+
|
|
232
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
233
|
+
end
|
|
234
|
+
|
|
235
|
+
class BulkEditAssignedUserRolesResponse
|
|
236
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
237
|
+
|
|
238
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
239
|
+
end
|
|
240
|
+
|
|
217
241
|
class BulkEditLineItemAssignedTargetingOptionsRequest
|
|
218
242
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
219
243
|
|
|
@@ -238,6 +262,18 @@ module Google
|
|
|
238
262
|
include Google::Apis::Core::JsonObjectSupport
|
|
239
263
|
end
|
|
240
264
|
|
|
265
|
+
class BulkEditPartnerAssignedTargetingOptionsRequest
|
|
266
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
267
|
+
|
|
268
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
269
|
+
end
|
|
270
|
+
|
|
271
|
+
class BulkEditPartnerAssignedTargetingOptionsResponse
|
|
272
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
273
|
+
|
|
274
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
275
|
+
end
|
|
276
|
+
|
|
241
277
|
class BulkEditSitesRequest
|
|
242
278
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
243
279
|
|
|
@@ -562,6 +598,18 @@ module Google
|
|
|
562
598
|
include Google::Apis::Core::JsonObjectSupport
|
|
563
599
|
end
|
|
564
600
|
|
|
601
|
+
class ExchangeConfig
|
|
602
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
603
|
+
|
|
604
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
605
|
+
end
|
|
606
|
+
|
|
607
|
+
class ExchangeConfigEnabledExchange
|
|
608
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
609
|
+
|
|
610
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
611
|
+
end
|
|
612
|
+
|
|
565
613
|
class ExchangeReviewStatus
|
|
566
614
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
567
615
|
|
|
@@ -910,6 +958,18 @@ module Google
|
|
|
910
958
|
include Google::Apis::Core::JsonObjectSupport
|
|
911
959
|
end
|
|
912
960
|
|
|
961
|
+
class ListPartnerAssignedTargetingOptionsResponse
|
|
962
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
963
|
+
|
|
964
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
965
|
+
end
|
|
966
|
+
|
|
967
|
+
class ListPartnersResponse
|
|
968
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
969
|
+
|
|
970
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
971
|
+
end
|
|
972
|
+
|
|
913
973
|
class ListSitesResponse
|
|
914
974
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
915
975
|
|
|
@@ -922,6 +982,12 @@ module Google
|
|
|
922
982
|
include Google::Apis::Core::JsonObjectSupport
|
|
923
983
|
end
|
|
924
984
|
|
|
985
|
+
class ListUsersResponse
|
|
986
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
987
|
+
|
|
988
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
989
|
+
end
|
|
990
|
+
|
|
925
991
|
class LocationList
|
|
926
992
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
927
993
|
|
|
@@ -940,6 +1006,12 @@ module Google
|
|
|
940
1006
|
include Google::Apis::Core::JsonObjectSupport
|
|
941
1007
|
end
|
|
942
1008
|
|
|
1009
|
+
class MeasurementConfig
|
|
1010
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
1011
|
+
|
|
1012
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
1013
|
+
end
|
|
1014
|
+
|
|
943
1015
|
class Money
|
|
944
1016
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
945
1017
|
|
|
@@ -1024,12 +1096,36 @@ module Google
|
|
|
1024
1096
|
include Google::Apis::Core::JsonObjectSupport
|
|
1025
1097
|
end
|
|
1026
1098
|
|
|
1099
|
+
class Partner
|
|
1100
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
1101
|
+
|
|
1102
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
1103
|
+
end
|
|
1104
|
+
|
|
1105
|
+
class PartnerAdServerConfig
|
|
1106
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
1107
|
+
|
|
1108
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
1109
|
+
end
|
|
1110
|
+
|
|
1027
1111
|
class PartnerCost
|
|
1028
1112
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
1029
1113
|
|
|
1030
1114
|
include Google::Apis::Core::JsonObjectSupport
|
|
1031
1115
|
end
|
|
1032
1116
|
|
|
1117
|
+
class PartnerDataAccessConfig
|
|
1118
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
1119
|
+
|
|
1120
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
1121
|
+
end
|
|
1122
|
+
|
|
1123
|
+
class PartnerGeneralConfig
|
|
1124
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
1125
|
+
|
|
1126
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
1127
|
+
end
|
|
1128
|
+
|
|
1033
1129
|
class PartnerRevenueModel
|
|
1034
1130
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
1035
1131
|
|
|
@@ -1192,6 +1288,12 @@ module Google
|
|
|
1192
1288
|
include Google::Apis::Core::JsonObjectSupport
|
|
1193
1289
|
end
|
|
1194
1290
|
|
|
1291
|
+
class User
|
|
1292
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
1293
|
+
|
|
1294
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
1295
|
+
end
|
|
1296
|
+
|
|
1195
1297
|
class UserRewardedContentAssignedTargetingOptionDetails
|
|
1196
1298
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
1197
1299
|
|
|
@@ -1482,6 +1584,16 @@ module Google
|
|
|
1482
1584
|
end
|
|
1483
1585
|
end
|
|
1484
1586
|
|
|
1587
|
+
class AssignedUserRole
|
|
1588
|
+
# @private
|
|
1589
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1590
|
+
property :advertiser_id, :numeric_string => true, as: 'advertiserId'
|
|
1591
|
+
property :assigned_user_role_id, as: 'assignedUserRoleId'
|
|
1592
|
+
property :partner_id, :numeric_string => true, as: 'partnerId'
|
|
1593
|
+
property :user_role, as: 'userRole'
|
|
1594
|
+
end
|
|
1595
|
+
end
|
|
1596
|
+
|
|
1485
1597
|
class AudienceGroupAssignedTargetingOptionDetails
|
|
1486
1598
|
# @private
|
|
1487
1599
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -1508,6 +1620,15 @@ module Google
|
|
|
1508
1620
|
end
|
|
1509
1621
|
end
|
|
1510
1622
|
|
|
1623
|
+
class AuditAdvertiserResponse
|
|
1624
|
+
# @private
|
|
1625
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1626
|
+
property :used_campaigns_count, :numeric_string => true, as: 'usedCampaignsCount'
|
|
1627
|
+
property :used_insertion_orders_count, :numeric_string => true, as: 'usedInsertionOrdersCount'
|
|
1628
|
+
property :used_line_items_count, :numeric_string => true, as: 'usedLineItemsCount'
|
|
1629
|
+
end
|
|
1630
|
+
end
|
|
1631
|
+
|
|
1511
1632
|
class AuthorizedSellerStatusAssignedTargetingOptionDetails
|
|
1512
1633
|
# @private
|
|
1513
1634
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -1605,6 +1726,23 @@ module Google
|
|
|
1605
1726
|
end
|
|
1606
1727
|
end
|
|
1607
1728
|
|
|
1729
|
+
class BulkEditAssignedUserRolesRequest
|
|
1730
|
+
# @private
|
|
1731
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1732
|
+
collection :created_assigned_user_roles, as: 'createdAssignedUserRoles', class: Google::Apis::DisplayvideoV1::AssignedUserRole, decorator: Google::Apis::DisplayvideoV1::AssignedUserRole::Representation
|
|
1733
|
+
|
|
1734
|
+
collection :deleted_assigned_user_roles, as: 'deletedAssignedUserRoles'
|
|
1735
|
+
end
|
|
1736
|
+
end
|
|
1737
|
+
|
|
1738
|
+
class BulkEditAssignedUserRolesResponse
|
|
1739
|
+
# @private
|
|
1740
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1741
|
+
collection :created_assigned_user_roles, as: 'createdAssignedUserRoles', class: Google::Apis::DisplayvideoV1::AssignedUserRole, decorator: Google::Apis::DisplayvideoV1::AssignedUserRole::Representation
|
|
1742
|
+
|
|
1743
|
+
end
|
|
1744
|
+
end
|
|
1745
|
+
|
|
1608
1746
|
class BulkEditLineItemAssignedTargetingOptionsRequest
|
|
1609
1747
|
# @private
|
|
1610
1748
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -1640,6 +1778,24 @@ module Google
|
|
|
1640
1778
|
end
|
|
1641
1779
|
end
|
|
1642
1780
|
|
|
1781
|
+
class BulkEditPartnerAssignedTargetingOptionsRequest
|
|
1782
|
+
# @private
|
|
1783
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1784
|
+
collection :create_requests, as: 'createRequests', class: Google::Apis::DisplayvideoV1::CreateAssignedTargetingOptionsRequest, decorator: Google::Apis::DisplayvideoV1::CreateAssignedTargetingOptionsRequest::Representation
|
|
1785
|
+
|
|
1786
|
+
collection :delete_requests, as: 'deleteRequests', class: Google::Apis::DisplayvideoV1::DeleteAssignedTargetingOptionsRequest, decorator: Google::Apis::DisplayvideoV1::DeleteAssignedTargetingOptionsRequest::Representation
|
|
1787
|
+
|
|
1788
|
+
end
|
|
1789
|
+
end
|
|
1790
|
+
|
|
1791
|
+
class BulkEditPartnerAssignedTargetingOptionsResponse
|
|
1792
|
+
# @private
|
|
1793
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1794
|
+
collection :created_assigned_targeting_options, as: 'createdAssignedTargetingOptions', class: Google::Apis::DisplayvideoV1::AssignedTargetingOption, decorator: Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
|
1795
|
+
|
|
1796
|
+
end
|
|
1797
|
+
end
|
|
1798
|
+
|
|
1643
1799
|
class BulkEditSitesRequest
|
|
1644
1800
|
# @private
|
|
1645
1801
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -2174,6 +2330,24 @@ module Google
|
|
|
2174
2330
|
end
|
|
2175
2331
|
end
|
|
2176
2332
|
|
|
2333
|
+
class ExchangeConfig
|
|
2334
|
+
# @private
|
|
2335
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
2336
|
+
collection :enabled_exchanges, as: 'enabledExchanges', class: Google::Apis::DisplayvideoV1::ExchangeConfigEnabledExchange, decorator: Google::Apis::DisplayvideoV1::ExchangeConfigEnabledExchange::Representation
|
|
2337
|
+
|
|
2338
|
+
end
|
|
2339
|
+
end
|
|
2340
|
+
|
|
2341
|
+
class ExchangeConfigEnabledExchange
|
|
2342
|
+
# @private
|
|
2343
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
2344
|
+
property :exchange, as: 'exchange'
|
|
2345
|
+
property :google_ad_manager_agency_id, as: 'googleAdManagerAgencyId'
|
|
2346
|
+
property :google_ad_manager_buyer_network_id, as: 'googleAdManagerBuyerNetworkId'
|
|
2347
|
+
property :seat_id, as: 'seatId'
|
|
2348
|
+
end
|
|
2349
|
+
end
|
|
2350
|
+
|
|
2177
2351
|
class ExchangeReviewStatus
|
|
2178
2352
|
# @private
|
|
2179
2353
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -2763,6 +2937,24 @@ module Google
|
|
|
2763
2937
|
end
|
|
2764
2938
|
end
|
|
2765
2939
|
|
|
2940
|
+
class ListPartnerAssignedTargetingOptionsResponse
|
|
2941
|
+
# @private
|
|
2942
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
2943
|
+
collection :assigned_targeting_options, as: 'assignedTargetingOptions', class: Google::Apis::DisplayvideoV1::AssignedTargetingOption, decorator: Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
|
2944
|
+
|
|
2945
|
+
property :next_page_token, as: 'nextPageToken'
|
|
2946
|
+
end
|
|
2947
|
+
end
|
|
2948
|
+
|
|
2949
|
+
class ListPartnersResponse
|
|
2950
|
+
# @private
|
|
2951
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
2952
|
+
property :next_page_token, as: 'nextPageToken'
|
|
2953
|
+
collection :partners, as: 'partners', class: Google::Apis::DisplayvideoV1::Partner, decorator: Google::Apis::DisplayvideoV1::Partner::Representation
|
|
2954
|
+
|
|
2955
|
+
end
|
|
2956
|
+
end
|
|
2957
|
+
|
|
2766
2958
|
class ListSitesResponse
|
|
2767
2959
|
# @private
|
|
2768
2960
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -2781,6 +2973,15 @@ module Google
|
|
|
2781
2973
|
end
|
|
2782
2974
|
end
|
|
2783
2975
|
|
|
2976
|
+
class ListUsersResponse
|
|
2977
|
+
# @private
|
|
2978
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
2979
|
+
property :next_page_token, as: 'nextPageToken'
|
|
2980
|
+
collection :users, as: 'users', class: Google::Apis::DisplayvideoV1::User, decorator: Google::Apis::DisplayvideoV1::User::Representation
|
|
2981
|
+
|
|
2982
|
+
end
|
|
2983
|
+
end
|
|
2984
|
+
|
|
2784
2985
|
class LocationList
|
|
2785
2986
|
# @private
|
|
2786
2987
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -2808,6 +3009,14 @@ module Google
|
|
|
2808
3009
|
end
|
|
2809
3010
|
end
|
|
2810
3011
|
|
|
3012
|
+
class MeasurementConfig
|
|
3013
|
+
# @private
|
|
3014
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
3015
|
+
property :dv360_to_cm_cost_reporting_enabled, as: 'dv360ToCmCostReportingEnabled'
|
|
3016
|
+
property :dv360_to_cm_data_sharing_enabled, as: 'dv360ToCmDataSharingEnabled'
|
|
3017
|
+
end
|
|
3018
|
+
end
|
|
3019
|
+
|
|
2811
3020
|
class Money
|
|
2812
3021
|
# @private
|
|
2813
3022
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -2934,6 +3143,33 @@ module Google
|
|
|
2934
3143
|
end
|
|
2935
3144
|
end
|
|
2936
3145
|
|
|
3146
|
+
class Partner
|
|
3147
|
+
# @private
|
|
3148
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
3149
|
+
property :ad_server_config, as: 'adServerConfig', class: Google::Apis::DisplayvideoV1::PartnerAdServerConfig, decorator: Google::Apis::DisplayvideoV1::PartnerAdServerConfig::Representation
|
|
3150
|
+
|
|
3151
|
+
property :data_access_config, as: 'dataAccessConfig', class: Google::Apis::DisplayvideoV1::PartnerDataAccessConfig, decorator: Google::Apis::DisplayvideoV1::PartnerDataAccessConfig::Representation
|
|
3152
|
+
|
|
3153
|
+
property :display_name, as: 'displayName'
|
|
3154
|
+
property :entity_status, as: 'entityStatus'
|
|
3155
|
+
property :exchange_config, as: 'exchangeConfig', class: Google::Apis::DisplayvideoV1::ExchangeConfig, decorator: Google::Apis::DisplayvideoV1::ExchangeConfig::Representation
|
|
3156
|
+
|
|
3157
|
+
property :general_config, as: 'generalConfig', class: Google::Apis::DisplayvideoV1::PartnerGeneralConfig, decorator: Google::Apis::DisplayvideoV1::PartnerGeneralConfig::Representation
|
|
3158
|
+
|
|
3159
|
+
property :name, as: 'name'
|
|
3160
|
+
property :partner_id, :numeric_string => true, as: 'partnerId'
|
|
3161
|
+
property :update_time, as: 'updateTime'
|
|
3162
|
+
end
|
|
3163
|
+
end
|
|
3164
|
+
|
|
3165
|
+
class PartnerAdServerConfig
|
|
3166
|
+
# @private
|
|
3167
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
3168
|
+
property :measurement_config, as: 'measurementConfig', class: Google::Apis::DisplayvideoV1::MeasurementConfig, decorator: Google::Apis::DisplayvideoV1::MeasurementConfig::Representation
|
|
3169
|
+
|
|
3170
|
+
end
|
|
3171
|
+
end
|
|
3172
|
+
|
|
2937
3173
|
class PartnerCost
|
|
2938
3174
|
# @private
|
|
2939
3175
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -2945,6 +3181,22 @@ module Google
|
|
|
2945
3181
|
end
|
|
2946
3182
|
end
|
|
2947
3183
|
|
|
3184
|
+
class PartnerDataAccessConfig
|
|
3185
|
+
# @private
|
|
3186
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
3187
|
+
property :sdf_config, as: 'sdfConfig', class: Google::Apis::DisplayvideoV1::SdfConfig, decorator: Google::Apis::DisplayvideoV1::SdfConfig::Representation
|
|
3188
|
+
|
|
3189
|
+
end
|
|
3190
|
+
end
|
|
3191
|
+
|
|
3192
|
+
class PartnerGeneralConfig
|
|
3193
|
+
# @private
|
|
3194
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
3195
|
+
property :currency_code, as: 'currencyCode'
|
|
3196
|
+
property :time_zone, as: 'timeZone'
|
|
3197
|
+
end
|
|
3198
|
+
end
|
|
3199
|
+
|
|
2948
3200
|
class PartnerRevenueModel
|
|
2949
3201
|
# @private
|
|
2950
3202
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -3234,6 +3486,18 @@ module Google
|
|
|
3234
3486
|
end
|
|
3235
3487
|
end
|
|
3236
3488
|
|
|
3489
|
+
class User
|
|
3490
|
+
# @private
|
|
3491
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
3492
|
+
collection :assigned_user_roles, as: 'assignedUserRoles', class: Google::Apis::DisplayvideoV1::AssignedUserRole, decorator: Google::Apis::DisplayvideoV1::AssignedUserRole::Representation
|
|
3493
|
+
|
|
3494
|
+
property :display_name, as: 'displayName'
|
|
3495
|
+
property :email, as: 'email'
|
|
3496
|
+
property :name, as: 'name'
|
|
3497
|
+
property :user_id, :numeric_string => true, as: 'userId'
|
|
3498
|
+
end
|
|
3499
|
+
end
|
|
3500
|
+
|
|
3237
3501
|
class UserRewardedContentAssignedTargetingOptionDetails
|
|
3238
3502
|
# @private
|
|
3239
3503
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -48,10 +48,47 @@ module Google
|
|
|
48
48
|
@batch_path = 'batch'
|
|
49
49
|
end
|
|
50
50
|
|
|
51
|
-
#
|
|
52
|
-
#
|
|
53
|
-
#
|
|
54
|
-
#
|
|
51
|
+
# Audits an advertiser. Returns the counts of used entities per resource type
|
|
52
|
+
# under the advertiser provided. Used entities count towards their [respective
|
|
53
|
+
# resource limit]: (https://support.google.com/displayvideo/answer/6071450?hl=en)
|
|
54
|
+
# @param [Fixnum] advertiser_id
|
|
55
|
+
# Required. The ID of the advertiser to audit.
|
|
56
|
+
# @param [String] read_mask
|
|
57
|
+
# Optional. The specific fields to return. If no mask is specified, all fields
|
|
58
|
+
# in the response proto will be filled. Valid values are: * usedLineItemsCount *
|
|
59
|
+
# usedInsertionOrdersCount * usedCampaignsCount
|
|
60
|
+
# @param [String] fields
|
|
61
|
+
# Selector specifying which fields to include in a partial response.
|
|
62
|
+
# @param [String] quota_user
|
|
63
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
64
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
65
|
+
# @param [Google::Apis::RequestOptions] options
|
|
66
|
+
# Request-specific options
|
|
67
|
+
#
|
|
68
|
+
# @yield [result, err] Result & error if block supplied
|
|
69
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::AuditAdvertiserResponse] parsed result object
|
|
70
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
71
|
+
#
|
|
72
|
+
# @return [Google::Apis::DisplayvideoV1::AuditAdvertiserResponse]
|
|
73
|
+
#
|
|
74
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
75
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
76
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
77
|
+
def audit_advertiser(advertiser_id, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
78
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}:audit', options)
|
|
79
|
+
command.response_representation = Google::Apis::DisplayvideoV1::AuditAdvertiserResponse::Representation
|
|
80
|
+
command.response_class = Google::Apis::DisplayvideoV1::AuditAdvertiserResponse
|
|
81
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
82
|
+
command.query['readMask'] = read_mask unless read_mask.nil?
|
|
83
|
+
command.query['fields'] = fields unless fields.nil?
|
|
84
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
85
|
+
execute_or_queue_command(command, &block)
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
# Bulk edits targeting options under a single advertiser. The operation will
|
|
89
|
+
# delete the assigned targeting options provided in
|
|
90
|
+
# BulkEditAdvertiserAssignedTargetingOptionsRequest.delete_requests and then
|
|
91
|
+
# create the assigned targeting options provided in
|
|
55
92
|
# BulkEditAdvertiserAssignedTargetingOptionsRequest.create_requests .
|
|
56
93
|
# @param [Fixnum] advertiser_id
|
|
57
94
|
# Required. The ID of the advertiser.
|
|
@@ -89,37 +126,27 @@ module Google
|
|
|
89
126
|
# @param [Fixnum] advertiser_id
|
|
90
127
|
# Required. The ID of the advertiser the line item belongs to.
|
|
91
128
|
# @param [String] filter
|
|
92
|
-
# Allows filtering by assigned targeting option properties.
|
|
93
|
-
#
|
|
94
|
-
#
|
|
95
|
-
# *
|
|
96
|
-
#
|
|
97
|
-
#
|
|
98
|
-
#
|
|
99
|
-
# - `targetingType`
|
|
100
|
-
# Examples:
|
|
101
|
-
# * targetingType with value TARGETING_TYPE_CHANNEL
|
|
102
|
-
# `targetingType="TARGETING_TYPE_CHANNEL"`
|
|
103
|
-
# The length of this field should be no more than 500 characters.
|
|
129
|
+
# Allows filtering by assigned targeting option properties. Supported syntax: *
|
|
130
|
+
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
131
|
+
# be combined by the logical operator `OR`.. * A restriction has the form of ``
|
|
132
|
+
# field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported
|
|
133
|
+
# fields: - `targetingType` Examples: * targetingType with value
|
|
134
|
+
# TARGETING_TYPE_CHANNEL `targetingType="TARGETING_TYPE_CHANNEL"` The length of
|
|
135
|
+
# this field should be no more than 500 characters.
|
|
104
136
|
# @param [String] order_by
|
|
105
|
-
# Field by which to sort the list.
|
|
106
|
-
#
|
|
107
|
-
#
|
|
108
|
-
#
|
|
109
|
-
# a field, a suffix "desc" should be added to the field name. Example:
|
|
110
|
-
# `targetingType desc`.
|
|
137
|
+
# Field by which to sort the list. Acceptable values are: * `targetingType` (
|
|
138
|
+
# default) The default sorting order is ascending. To specify descending order
|
|
139
|
+
# for a field, a suffix "desc" should be added to the field name. Example: `
|
|
140
|
+
# targetingType desc`.
|
|
111
141
|
# @param [Fixnum] page_size
|
|
112
|
-
# Requested page size.
|
|
113
|
-
#
|
|
114
|
-
#
|
|
115
|
-
# value is specified.
|
|
142
|
+
# Requested page size. The size must be an integer between `1` and `5000`. If
|
|
143
|
+
# unspecified, the default is '5000'. Returns error code `INVALID_ARGUMENT` if
|
|
144
|
+
# an invalid value is specified.
|
|
116
145
|
# @param [String] page_token
|
|
117
|
-
# A token that lets the client fetch the next page of results.
|
|
118
|
-
#
|
|
119
|
-
#
|
|
120
|
-
#
|
|
121
|
-
# `BulkListAdvertiserAssignedTargetingOptions` method.
|
|
122
|
-
# If not specified, the first page of results will be returned.
|
|
146
|
+
# A token that lets the client fetch the next page of results. Typically, this
|
|
147
|
+
# is the value of next_page_token returned from the previous call to `
|
|
148
|
+
# BulkListAdvertiserAssignedTargetingOptions` method. If not specified, the
|
|
149
|
+
# first page of results will be returned.
|
|
123
150
|
# @param [String] fields
|
|
124
151
|
# Selector specifying which fields to include in a partial response.
|
|
125
152
|
# @param [String] quota_user
|
|
@@ -151,8 +178,7 @@ module Google
|
|
|
151
178
|
execute_or_queue_command(command, &block)
|
|
152
179
|
end
|
|
153
180
|
|
|
154
|
-
# Creates a new advertiser.
|
|
155
|
-
# Returns the newly created advertiser if successful.
|
|
181
|
+
# Creates a new advertiser. Returns the newly created advertiser if successful.
|
|
156
182
|
# This method can take up to 180 seconds to complete.
|
|
157
183
|
# @param [Google::Apis::DisplayvideoV1::Advertiser] advertiser_object
|
|
158
184
|
# @param [String] fields
|
|
@@ -183,10 +209,9 @@ module Google
|
|
|
183
209
|
execute_or_queue_command(command, &block)
|
|
184
210
|
end
|
|
185
211
|
|
|
186
|
-
# Deletes an advertiser.
|
|
187
|
-
#
|
|
188
|
-
#
|
|
189
|
-
# A deleted advertiser cannot be recovered.
|
|
212
|
+
# Deletes an advertiser. Deleting an advertiser will delete all of its child
|
|
213
|
+
# resources, for example, campaigns, insertion orders and line items. A deleted
|
|
214
|
+
# advertiser cannot be recovered.
|
|
190
215
|
# @param [Fixnum] advertiser_id
|
|
191
216
|
# The ID of the advertiser we need to delete.
|
|
192
217
|
# @param [String] fields
|
|
@@ -246,46 +271,34 @@ module Google
|
|
|
246
271
|
execute_or_queue_command(command, &block)
|
|
247
272
|
end
|
|
248
273
|
|
|
249
|
-
# Lists advertisers that are accessible to the current user.
|
|
250
|
-
#
|
|
251
|
-
#
|
|
252
|
-
# A single partner_id is required.
|
|
253
|
-
# Cross-partner listing is not supported.
|
|
274
|
+
# Lists advertisers that are accessible to the current user. The order is
|
|
275
|
+
# defined by the order_by parameter. A single partner_id is required. Cross-
|
|
276
|
+
# partner listing is not supported.
|
|
254
277
|
# @param [String] filter
|
|
255
|
-
# Allows filtering by advertiser properties.
|
|
256
|
-
#
|
|
257
|
-
#
|
|
258
|
-
# *
|
|
259
|
-
#
|
|
260
|
-
#
|
|
261
|
-
#
|
|
262
|
-
#
|
|
263
|
-
# - `entityStatus`
|
|
264
|
-
# Examples:
|
|
265
|
-
# * All active advertisers under a partner:
|
|
266
|
-
# `entityStatus="ENTITY_STATUS_ACTIVE"`
|
|
267
|
-
# The length of this field should be no more than 500 characters.
|
|
278
|
+
# Allows filtering by advertiser properties. Supported syntax: * Filter
|
|
279
|
+
# expressions are made up of one or more restrictions. * Restrictions can be
|
|
280
|
+
# combined by `AND` or `OR` logical operators. A sequence of restrictions
|
|
281
|
+
# implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
|
|
282
|
+
# value``. * The operator must be `EQUALS (=)`. * Supported fields: - `
|
|
283
|
+
# entityStatus` Examples: * All active advertisers under a partner: `
|
|
284
|
+
# entityStatus="ENTITY_STATUS_ACTIVE"` The length of this field should be no
|
|
285
|
+
# more than 500 characters.
|
|
268
286
|
# @param [String] order_by
|
|
269
|
-
# Field by which to sort the list.
|
|
270
|
-
#
|
|
271
|
-
#
|
|
272
|
-
#
|
|
273
|
-
# The default sorting order is ascending. To specify descending order for
|
|
274
|
-
# a field, a suffix "desc" should be added to the field name. For example,
|
|
275
|
-
# `displayName desc`.
|
|
287
|
+
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
288
|
+
# default) * `entityStatus` The default sorting order is ascending. To specify
|
|
289
|
+
# descending order for a field, a suffix "desc" should be added to the field
|
|
290
|
+
# name. For example, `displayName desc`.
|
|
276
291
|
# @param [Fixnum] page_size
|
|
277
292
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
278
293
|
# default to `100`.
|
|
279
294
|
# @param [String] page_token
|
|
280
|
-
# A token identifying a page of results the server should return.
|
|
281
|
-
#
|
|
282
|
-
#
|
|
283
|
-
# returned
|
|
284
|
-
# If not specified, the first page of results will be returned.
|
|
295
|
+
# A token identifying a page of results the server should return. Typically,
|
|
296
|
+
# this is the value of next_page_token returned from the previous call to `
|
|
297
|
+
# ListAdvertisers` method. If not specified, the first page of results will be
|
|
298
|
+
# returned.
|
|
285
299
|
# @param [Fixnum] partner_id
|
|
286
300
|
# Required. The ID of the partner that the fetched advertisers should all belong
|
|
287
|
-
# to.
|
|
288
|
-
# The system only supports listing advertisers for one partner at a time.
|
|
301
|
+
# to. The system only supports listing advertisers for one partner at a time.
|
|
289
302
|
# @param [String] fields
|
|
290
303
|
# Selector specifying which fields to include in a partial response.
|
|
291
304
|
# @param [String] quota_user
|
|
@@ -317,8 +330,7 @@ module Google
|
|
|
317
330
|
execute_or_queue_command(command, &block)
|
|
318
331
|
end
|
|
319
332
|
|
|
320
|
-
# Updates an existing advertiser.
|
|
321
|
-
# Returns the updated advertiser if successful.
|
|
333
|
+
# Updates an existing advertiser. Returns the updated advertiser if successful.
|
|
322
334
|
# @param [Fixnum] advertiser_id
|
|
323
335
|
# Output only. The unique ID of the advertiser. Assigned by the system.
|
|
324
336
|
# @param [Google::Apis::DisplayvideoV1::Advertiser] advertiser_object
|
|
@@ -354,10 +366,9 @@ module Google
|
|
|
354
366
|
execute_or_queue_command(command, &block)
|
|
355
367
|
end
|
|
356
368
|
|
|
357
|
-
# Uploads an asset.
|
|
358
|
-
#
|
|
359
|
-
#
|
|
360
|
-
# ZIP files, and 1 GB for videos.
|
|
369
|
+
# Uploads an asset. Returns the ID of the newly uploaded asset if successful.
|
|
370
|
+
# The asset file size should be no more than 10 MB for images, 200 MB for ZIP
|
|
371
|
+
# files, and 1 GB for videos.
|
|
361
372
|
# @param [Fixnum] advertiser_id
|
|
362
373
|
# Required. The ID of the advertiser this asset belongs to.
|
|
363
374
|
# @param [Google::Apis::DisplayvideoV1::CreateAssetRequest] create_asset_request_object
|
|
@@ -400,8 +411,7 @@ module Google
|
|
|
400
411
|
execute_or_queue_command(command, &block)
|
|
401
412
|
end
|
|
402
413
|
|
|
403
|
-
# Creates a new campaign.
|
|
404
|
-
# Returns the newly created campaign if successful.
|
|
414
|
+
# Creates a new campaign. Returns the newly created campaign if successful.
|
|
405
415
|
# @param [Fixnum] advertiser_id
|
|
406
416
|
# Output only. The unique ID of the advertiser the campaign belongs to.
|
|
407
417
|
# @param [Google::Apis::DisplayvideoV1::Campaign] campaign_object
|
|
@@ -434,10 +444,9 @@ module Google
|
|
|
434
444
|
execute_or_queue_command(command, &block)
|
|
435
445
|
end
|
|
436
446
|
|
|
437
|
-
# Permanently deletes a campaign. A deleted campaign cannot be recovered.
|
|
438
|
-
#
|
|
439
|
-
#
|
|
440
|
-
# able to delete it.
|
|
447
|
+
# Permanently deletes a campaign. A deleted campaign cannot be recovered. The
|
|
448
|
+
# campaign should be archived first, i.e. set entity_status to `
|
|
449
|
+
# ENTITY_STATUS_ARCHIVED`, to be able to delete it.
|
|
441
450
|
# @param [Fixnum] advertiser_id
|
|
442
451
|
# The ID of the advertiser this campaign belongs to.
|
|
443
452
|
# @param [Fixnum] campaign_id
|
|
@@ -503,47 +512,34 @@ module Google
|
|
|
503
512
|
execute_or_queue_command(command, &block)
|
|
504
513
|
end
|
|
505
514
|
|
|
506
|
-
# Lists campaigns in an advertiser.
|
|
507
|
-
#
|
|
508
|
-
#
|
|
509
|
-
# If a filter by
|
|
510
|
-
# entity_status is not specified, campaigns with
|
|
511
|
-
# `ENTITY_STATUS_ARCHIVED` will not be included in the results.
|
|
515
|
+
# Lists campaigns in an advertiser. The order is defined by the order_by
|
|
516
|
+
# parameter. If a filter by entity_status is not specified, campaigns with `
|
|
517
|
+
# ENTITY_STATUS_ARCHIVED` will not be included in the results.
|
|
512
518
|
# @param [Fixnum] advertiser_id
|
|
513
519
|
# The ID of the advertiser to list campaigns for.
|
|
514
520
|
# @param [String] filter
|
|
515
|
-
# Allows filtering by campaign properties.
|
|
516
|
-
#
|
|
517
|
-
#
|
|
518
|
-
# *
|
|
519
|
-
#
|
|
520
|
-
#
|
|
521
|
-
#
|
|
522
|
-
#
|
|
523
|
-
#
|
|
524
|
-
# Examples:
|
|
525
|
-
# * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an
|
|
526
|
-
# advertiser:
|
|
527
|
-
# `(entityStatus="ENTITY_STATUS_ACTIVE" OR
|
|
528
|
-
# entityStatus="ENTITY_STATUS_PAUSED")`
|
|
529
|
-
# The length of this field should be no more than 500 characters.
|
|
521
|
+
# Allows filtering by campaign properties. Supported syntax: * Filter
|
|
522
|
+
# expressions are made up of one or more restrictions. * Restrictions can be
|
|
523
|
+
# combined by `AND` or `OR` logical operators. A sequence of restrictions
|
|
524
|
+
# implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
|
|
525
|
+
# value``. * The operator must be `EQUALS (=)`. * Supported fields: - `
|
|
526
|
+
# entityStatus` Examples: * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`
|
|
527
|
+
# campaigns under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR
|
|
528
|
+
# entityStatus="ENTITY_STATUS_PAUSED")` The length of this field should be no
|
|
529
|
+
# more than 500 characters.
|
|
530
530
|
# @param [String] order_by
|
|
531
|
-
# Field by which to sort the list.
|
|
532
|
-
#
|
|
533
|
-
#
|
|
534
|
-
#
|
|
535
|
-
# The default sorting order is ascending. To specify descending order for
|
|
536
|
-
# a field, a suffix "desc" should be added to the field name. Example:
|
|
537
|
-
# `displayName desc`.
|
|
531
|
+
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
532
|
+
# default) * `entityStatus` The default sorting order is ascending. To specify
|
|
533
|
+
# descending order for a field, a suffix "desc" should be added to the field
|
|
534
|
+
# name. Example: `displayName desc`.
|
|
538
535
|
# @param [Fixnum] page_size
|
|
539
536
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
540
537
|
# default to `100`.
|
|
541
538
|
# @param [String] page_token
|
|
542
|
-
# A token identifying a page of results the server should return.
|
|
543
|
-
#
|
|
544
|
-
#
|
|
545
|
-
#
|
|
546
|
-
# of results will be returned.
|
|
539
|
+
# A token identifying a page of results the server should return. Typically,
|
|
540
|
+
# this is the value of next_page_token returned from the previous call to `
|
|
541
|
+
# ListCampaigns` method. If not specified, the first page of results will be
|
|
542
|
+
# returned.
|
|
547
543
|
# @param [String] fields
|
|
548
544
|
# Selector specifying which fields to include in a partial response.
|
|
549
545
|
# @param [String] quota_user
|
|
@@ -575,8 +571,7 @@ module Google
|
|
|
575
571
|
execute_or_queue_command(command, &block)
|
|
576
572
|
end
|
|
577
573
|
|
|
578
|
-
# Updates an existing campaign.
|
|
579
|
-
# Returns the updated campaign if successful.
|
|
574
|
+
# Updates an existing campaign. Returns the updated campaign if successful.
|
|
580
575
|
# @param [Fixnum] advertiser_id
|
|
581
576
|
# Output only. The unique ID of the advertiser the campaign belongs to.
|
|
582
577
|
# @param [Fixnum] campaign_id
|
|
@@ -691,36 +686,26 @@ module Google
|
|
|
691
686
|
# @param [Fixnum] advertiser_id
|
|
692
687
|
# The ID of the advertiser that owns the channels.
|
|
693
688
|
# @param [String] filter
|
|
694
|
-
# Allows filtering by channel fields.
|
|
695
|
-
#
|
|
696
|
-
#
|
|
697
|
-
# *
|
|
698
|
-
#
|
|
699
|
-
#
|
|
700
|
-
# * Supported fields:
|
|
701
|
-
# - `displayName`
|
|
702
|
-
# Examples:
|
|
703
|
-
# * All channels for which the display name contains "google":
|
|
704
|
-
# `displayName : "google"`.
|
|
705
|
-
# The length of this field should be no more than 500 characters.
|
|
689
|
+
# Allows filtering by channel fields. Supported syntax: * Filter expressions for
|
|
690
|
+
# channel currently can only contain at most one * restriction. * A restriction
|
|
691
|
+
# has the form of ``field` `operator` `value``. * The operator must be `CONTAINS
|
|
692
|
+
# (:)`. * Supported fields: - `displayName` Examples: * All channels for which
|
|
693
|
+
# the display name contains "google": `displayName : "google"`. The length of
|
|
694
|
+
# this field should be no more than 500 characters.
|
|
706
695
|
# @param [String] order_by
|
|
707
|
-
# Field by which to sort the list.
|
|
708
|
-
#
|
|
709
|
-
#
|
|
710
|
-
#
|
|
711
|
-
# The default sorting order is ascending. To specify descending order for a
|
|
712
|
-
# field, a suffix " desc" should be added to the field name. Example:
|
|
713
|
-
# `displayName desc`.
|
|
696
|
+
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
697
|
+
# default) * `channelId` The default sorting order is ascending. To specify
|
|
698
|
+
# descending order for a field, a suffix " desc" should be added to the field
|
|
699
|
+
# name. Example: `displayName desc`.
|
|
714
700
|
# @param [Fixnum] page_size
|
|
715
701
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
716
|
-
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
|
717
|
-
#
|
|
702
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
703
|
+
# specified.
|
|
718
704
|
# @param [String] page_token
|
|
719
|
-
# A token identifying a page of results the server should return.
|
|
720
|
-
#
|
|
721
|
-
#
|
|
722
|
-
#
|
|
723
|
-
# of results will be returned.
|
|
705
|
+
# A token identifying a page of results the server should return. Typically,
|
|
706
|
+
# this is the value of next_page_token returned from the previous call to `
|
|
707
|
+
# ListChannels` method. If not specified, the first page of results will be
|
|
708
|
+
# returned.
|
|
724
709
|
# @param [Fixnum] partner_id
|
|
725
710
|
# The ID of the partner that owns the channels.
|
|
726
711
|
# @param [String] fields
|
|
@@ -797,9 +782,8 @@ module Google
|
|
|
797
782
|
execute_or_queue_command(command, &block)
|
|
798
783
|
end
|
|
799
784
|
|
|
800
|
-
# Bulk edits sites under a single channel.
|
|
801
|
-
#
|
|
802
|
-
# BulkEditSitesRequest.deleted_sites and then create the sites
|
|
785
|
+
# Bulk edits sites under a single channel. The operation will delete the sites
|
|
786
|
+
# provided in BulkEditSitesRequest.deleted_sites and then create the sites
|
|
803
787
|
# provided in BulkEditSitesRequest.created_sites.
|
|
804
788
|
# @param [Fixnum] advertiser_id
|
|
805
789
|
# The ID of the advertiser that owns the parent channel.
|
|
@@ -920,34 +904,25 @@ module Google
|
|
|
920
904
|
# @param [Fixnum] channel_id
|
|
921
905
|
# Required. The ID of the parent channel to which the requested sites belong.
|
|
922
906
|
# @param [String] filter
|
|
923
|
-
# Allows filtering by site fields.
|
|
924
|
-
#
|
|
925
|
-
#
|
|
926
|
-
# *
|
|
927
|
-
#
|
|
928
|
-
# * The operator must be `CONTAINS (:)`.
|
|
929
|
-
# * Supported fields:
|
|
930
|
-
# - `urlOrAppId`
|
|
931
|
-
# Examples:
|
|
932
|
-
# * All sites for which the URL or app ID contains "google":
|
|
933
|
-
# `urlOrAppId : "google"`
|
|
907
|
+
# Allows filtering by site fields. Supported syntax: * Filter expressions for
|
|
908
|
+
# site currently can only contain at most one * restriction. * A restriction has
|
|
909
|
+
# the form of ``field` `operator` `value``. * The operator must be `CONTAINS (:)`
|
|
910
|
+
# . * Supported fields: - `urlOrAppId` Examples: * All sites for which the URL
|
|
911
|
+
# or app ID contains "google": `urlOrAppId : "google"`
|
|
934
912
|
# @param [String] order_by
|
|
935
|
-
# Field by which to sort the list.
|
|
936
|
-
#
|
|
937
|
-
#
|
|
938
|
-
#
|
|
939
|
-
# field, a suffix " desc" should be added to the field name. Example:
|
|
940
|
-
# `urlOrAppId desc`.
|
|
913
|
+
# Field by which to sort the list. Acceptable values are: * `urlOrAppId` (
|
|
914
|
+
# default) The default sorting order is ascending. To specify descending order
|
|
915
|
+
# for a field, a suffix " desc" should be added to the field name. Example: `
|
|
916
|
+
# urlOrAppId desc`.
|
|
941
917
|
# @param [Fixnum] page_size
|
|
942
918
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
943
|
-
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
|
944
|
-
#
|
|
919
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
920
|
+
# specified.
|
|
945
921
|
# @param [String] page_token
|
|
946
|
-
# A token identifying a page of results the server should return.
|
|
947
|
-
#
|
|
948
|
-
#
|
|
949
|
-
#
|
|
950
|
-
# of results will be returned.
|
|
922
|
+
# A token identifying a page of results the server should return. Typically,
|
|
923
|
+
# this is the value of next_page_token returned from the previous call to `
|
|
924
|
+
# ListSites` method. If not specified, the first page of results will be
|
|
925
|
+
# returned.
|
|
951
926
|
# @param [Fixnum] partner_id
|
|
952
927
|
# The ID of the partner that owns the parent channel.
|
|
953
928
|
# @param [String] fields
|
|
@@ -983,8 +958,7 @@ module Google
|
|
|
983
958
|
execute_or_queue_command(command, &block)
|
|
984
959
|
end
|
|
985
960
|
|
|
986
|
-
# Creates a new creative.
|
|
987
|
-
# Returns the newly created creative if successful.
|
|
961
|
+
# Creates a new creative. Returns the newly created creative if successful.
|
|
988
962
|
# @param [Fixnum] advertiser_id
|
|
989
963
|
# Output only. The unique ID of the advertiser the creative belongs to.
|
|
990
964
|
# @param [Google::Apis::DisplayvideoV1::Creative] creative_object
|
|
@@ -1017,11 +991,9 @@ module Google
|
|
|
1017
991
|
execute_or_queue_command(command, &block)
|
|
1018
992
|
end
|
|
1019
993
|
|
|
1020
|
-
# Deletes a creative.
|
|
1021
|
-
#
|
|
1022
|
-
#
|
|
1023
|
-
# entity_status to `ENTITY_STATUS_ARCHIVED`, before
|
|
1024
|
-
# it can be deleted.
|
|
994
|
+
# Deletes a creative. Returns error code `NOT_FOUND` if the creative does not
|
|
995
|
+
# exist. The creative should be archived first, i.e. set entity_status to `
|
|
996
|
+
# ENTITY_STATUS_ARCHIVED`, before it can be deleted.
|
|
1025
997
|
# @param [Fixnum] advertiser_id
|
|
1026
998
|
# The ID of the advertiser this creative belongs to.
|
|
1027
999
|
# @param [Fixnum] creative_id
|
|
@@ -1087,81 +1059,55 @@ module Google
|
|
|
1087
1059
|
execute_or_queue_command(command, &block)
|
|
1088
1060
|
end
|
|
1089
1061
|
|
|
1090
|
-
# Lists creatives in an advertiser.
|
|
1091
|
-
#
|
|
1092
|
-
#
|
|
1093
|
-
# If a filter by
|
|
1094
|
-
# entity_status is not specified, creatives with
|
|
1095
|
-
# `ENTITY_STATUS_ARCHIVED` will not be included in the results.
|
|
1062
|
+
# Lists creatives in an advertiser. The order is defined by the order_by
|
|
1063
|
+
# parameter. If a filter by entity_status is not specified, creatives with `
|
|
1064
|
+
# ENTITY_STATUS_ARCHIVED` will not be included in the results.
|
|
1096
1065
|
# @param [Fixnum] advertiser_id
|
|
1097
1066
|
# Required. The ID of the advertiser to list creatives for.
|
|
1098
1067
|
# @param [String] filter
|
|
1099
|
-
# Allows filtering by creative properties.
|
|
1100
|
-
#
|
|
1101
|
-
#
|
|
1102
|
-
# *
|
|
1103
|
-
#
|
|
1104
|
-
#
|
|
1105
|
-
#
|
|
1106
|
-
#
|
|
1107
|
-
# * The operator must be `
|
|
1108
|
-
#
|
|
1109
|
-
#
|
|
1110
|
-
#
|
|
1111
|
-
#
|
|
1112
|
-
#
|
|
1113
|
-
#
|
|
1114
|
-
#
|
|
1115
|
-
#
|
|
1116
|
-
#
|
|
1117
|
-
# *
|
|
1118
|
-
#
|
|
1119
|
-
# *
|
|
1120
|
-
#
|
|
1121
|
-
#
|
|
1122
|
-
#
|
|
1123
|
-
#
|
|
1124
|
-
#
|
|
1125
|
-
# `
|
|
1126
|
-
#
|
|
1127
|
-
# against multiple possible line item IDs.
|
|
1128
|
-
# * There may be multiple `creativeId` restrictions in order to search
|
|
1129
|
-
# against multiple possible creative IDs.
|
|
1130
|
-
# Examples:
|
|
1131
|
-
# * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"`
|
|
1132
|
-
# * All active creatives with 300x400 or 50x100 dimensions:
|
|
1133
|
-
# `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400"
|
|
1134
|
-
# OR dimensions="50x100")`
|
|
1135
|
-
# * All dynamic creatives that are approved by AdX or
|
|
1136
|
-
# AppNexus, with a minimum duration of 5 seconds and 200ms.
|
|
1137
|
-
# `dynamic="true" AND minDuration="5.2s" AND
|
|
1138
|
-
# (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED"
|
|
1139
|
-
# OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")`
|
|
1140
|
-
# * All video creatives that are associated with line item ID 1 or 2:
|
|
1141
|
-
# `creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)`
|
|
1142
|
-
# * Find creatives by multiple creative IDs:
|
|
1143
|
-
# `creativeId=1 OR creativeId=2`
|
|
1144
|
-
# The length of this field should be no more than 500 characters.
|
|
1068
|
+
# Allows filtering by creative properties. Supported syntax: * Filter
|
|
1069
|
+
# expressions are made up of one or more restrictions. * Restriction for the
|
|
1070
|
+
# same field must be combined by `OR`. * Restriction for different fields must
|
|
1071
|
+
# be combined by `AND`. * Between `(` and `)` there can only be restrictions
|
|
1072
|
+
# combined by `OR` for the same field. * A restriction has the form of ``field` `
|
|
1073
|
+
# operator` `value``. * The operator must be `EQUALS (=)` for the following
|
|
1074
|
+
# fields: - `entityStatus` - `creativeType`. - `dimensions` - `minDuration` - `
|
|
1075
|
+
# maxDuration` - `approvalStatus` - `exchangeReviewStatus` - `dynamic` - `
|
|
1076
|
+
# creativeId` * The operator must be `HAS (:)` for the following fields: - `
|
|
1077
|
+
# lineItemIds` * For `entityStatus`, `minDuration`, `maxDuration`, and `dynamic`
|
|
1078
|
+
# there may be at most one restriction. * For `dimensions`, the value is in the
|
|
1079
|
+
# form of `"`width`x`height`"`. * For `exchangeReviewStatus`, the value is in
|
|
1080
|
+
# the form of ``exchange`-`reviewStatus``. * For `minDuration` and `maxDuration`,
|
|
1081
|
+
# the value is in the form of `"`duration`s"`. Only seconds are supported with
|
|
1082
|
+
# millisecond granularity. * There may be multiple `lineItemIds` restrictions in
|
|
1083
|
+
# order to search against multiple possible line item IDs. * There may be
|
|
1084
|
+
# multiple `creativeId` restrictions in order to search against multiple
|
|
1085
|
+
# possible creative IDs. Examples: * All native creatives: `creativeType="
|
|
1086
|
+
# CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or 50x100
|
|
1087
|
+
# dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR
|
|
1088
|
+
# dimensions="50x100")` * All dynamic creatives that are approved by AdX or
|
|
1089
|
+
# AppNexus, with a minimum duration of 5 seconds and 200ms. `dynamic="true" AND
|
|
1090
|
+
# minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-
|
|
1091
|
+
# REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-
|
|
1092
|
+
# REVIEW_STATUS_APPROVED")` * All video creatives that are associated with line
|
|
1093
|
+
# item ID 1 or 2: `creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR
|
|
1094
|
+
# lineItemIds:2)` * Find creatives by multiple creative IDs: `creativeId=1 OR
|
|
1095
|
+
# creativeId=2` The length of this field should be no more than 500 characters.
|
|
1145
1096
|
# @param [String] order_by
|
|
1146
|
-
# Field by which to sort the list.
|
|
1147
|
-
#
|
|
1148
|
-
#
|
|
1149
|
-
#
|
|
1150
|
-
#
|
|
1151
|
-
# * `dimensions` (sorts by width first, then by height)
|
|
1152
|
-
# The default sorting order is ascending. To specify descending order for
|
|
1153
|
-
# a field, a suffix "desc" should be added to the field name.
|
|
1154
|
-
# Example: `createTime desc`.
|
|
1097
|
+
# Field by which to sort the list. Acceptable values are: * `creativeId` (
|
|
1098
|
+
# default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first,
|
|
1099
|
+
# then by height) The default sorting order is ascending. To specify descending
|
|
1100
|
+
# order for a field, a suffix "desc" should be added to the field name. Example:
|
|
1101
|
+
# `createTime desc`.
|
|
1155
1102
|
# @param [Fixnum] page_size
|
|
1156
1103
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
1157
|
-
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
|
1158
|
-
#
|
|
1104
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
1105
|
+
# specified.
|
|
1159
1106
|
# @param [String] page_token
|
|
1160
|
-
# A token identifying a page of results the server should return.
|
|
1161
|
-
#
|
|
1162
|
-
#
|
|
1163
|
-
# returned
|
|
1164
|
-
# If not specified, the first page of results will be returned.
|
|
1107
|
+
# A token identifying a page of results the server should return. Typically,
|
|
1108
|
+
# this is the value of next_page_token returned from the previous call to `
|
|
1109
|
+
# ListCreatives` method. If not specified, the first page of results will be
|
|
1110
|
+
# returned.
|
|
1165
1111
|
# @param [String] fields
|
|
1166
1112
|
# Selector specifying which fields to include in a partial response.
|
|
1167
1113
|
# @param [String] quota_user
|
|
@@ -1193,8 +1139,7 @@ module Google
|
|
|
1193
1139
|
execute_or_queue_command(command, &block)
|
|
1194
1140
|
end
|
|
1195
1141
|
|
|
1196
|
-
# Updates an existing creative.
|
|
1197
|
-
# Returns the updated creative if successful.
|
|
1142
|
+
# Updates an existing creative. Returns the updated creative if successful.
|
|
1198
1143
|
# @param [Fixnum] advertiser_id
|
|
1199
1144
|
# Output only. The unique ID of the advertiser the creative belongs to.
|
|
1200
1145
|
# @param [Fixnum] creative_id
|
|
@@ -1233,8 +1178,8 @@ module Google
|
|
|
1233
1178
|
execute_or_queue_command(command, &block)
|
|
1234
1179
|
end
|
|
1235
1180
|
|
|
1236
|
-
# Creates a new insertion order.
|
|
1237
|
-
#
|
|
1181
|
+
# Creates a new insertion order. Returns the newly created insertion order if
|
|
1182
|
+
# successful.
|
|
1238
1183
|
# @param [Fixnum] advertiser_id
|
|
1239
1184
|
# Output only. The unique ID of the advertiser the insertion order belongs to.
|
|
1240
1185
|
# @param [Google::Apis::DisplayvideoV1::InsertionOrder] insertion_order_object
|
|
@@ -1267,11 +1212,9 @@ module Google
|
|
|
1267
1212
|
execute_or_queue_command(command, &block)
|
|
1268
1213
|
end
|
|
1269
1214
|
|
|
1270
|
-
# Deletes an insertion order.
|
|
1271
|
-
#
|
|
1272
|
-
#
|
|
1273
|
-
# entity_status to `ENTITY_STATUS_ARCHIVED`,
|
|
1274
|
-
# to be able to delete it.
|
|
1215
|
+
# Deletes an insertion order. Returns error code `NOT_FOUND` if the insertion
|
|
1216
|
+
# order does not exist. The insertion order should be archived first, i.e. set
|
|
1217
|
+
# entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it.
|
|
1275
1218
|
# @param [Fixnum] advertiser_id
|
|
1276
1219
|
# The ID of the advertiser this insertion order belongs to.
|
|
1277
1220
|
# @param [Fixnum] insertion_order_id
|
|
@@ -1304,8 +1247,8 @@ module Google
|
|
|
1304
1247
|
execute_or_queue_command(command, &block)
|
|
1305
1248
|
end
|
|
1306
1249
|
|
|
1307
|
-
# Gets an insertion order.
|
|
1308
|
-
#
|
|
1250
|
+
# Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order
|
|
1251
|
+
# does not exist.
|
|
1309
1252
|
# @param [Fixnum] advertiser_id
|
|
1310
1253
|
# Required. The ID of the advertiser this insertion order belongs to.
|
|
1311
1254
|
# @param [Fixnum] insertion_order_id
|
|
@@ -1338,50 +1281,36 @@ module Google
|
|
|
1338
1281
|
execute_or_queue_command(command, &block)
|
|
1339
1282
|
end
|
|
1340
1283
|
|
|
1341
|
-
# Lists insertion orders in an advertiser.
|
|
1342
|
-
#
|
|
1343
|
-
#
|
|
1344
|
-
# If a filter by
|
|
1345
|
-
# entity_status is not specified, insertion
|
|
1346
|
-
# orders with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
|
|
1284
|
+
# Lists insertion orders in an advertiser. The order is defined by the order_by
|
|
1285
|
+
# parameter. If a filter by entity_status is not specified, insertion orders
|
|
1286
|
+
# with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
|
|
1347
1287
|
# @param [Fixnum] advertiser_id
|
|
1348
1288
|
# Required. The ID of the advertiser to list insertion orders for.
|
|
1349
1289
|
# @param [String] filter
|
|
1350
|
-
# Allows filtering by insertion order properties.
|
|
1351
|
-
#
|
|
1352
|
-
#
|
|
1353
|
-
# *
|
|
1354
|
-
#
|
|
1355
|
-
#
|
|
1356
|
-
# *
|
|
1357
|
-
#
|
|
1358
|
-
#
|
|
1359
|
-
#
|
|
1360
|
-
# Examples:
|
|
1361
|
-
# * All insertion orders under a campaign: `campaignId="1234"`
|
|
1362
|
-
# * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders
|
|
1363
|
-
# under an advertiser:
|
|
1364
|
-
# `(entityStatus="ENTITY_STATUS_ACTIVE" OR
|
|
1365
|
-
# entityStatus="ENTITY_STATUS_PAUSED")`
|
|
1366
|
-
# The length of this field should be no more than 500 characters.
|
|
1290
|
+
# Allows filtering by insertion order properties. Supported syntax: * Filter
|
|
1291
|
+
# expressions are made up of one or more restrictions. * Restrictions can be
|
|
1292
|
+
# combined by `AND` or `OR` logical operators. A sequence of restrictions
|
|
1293
|
+
# implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
|
|
1294
|
+
# value``. * The operator must be `EQUALS (=)`. * Supported fields: - `
|
|
1295
|
+
# campaignId` - `entityStatus` Examples: * All insertion orders under a campaign:
|
|
1296
|
+
# `campaignId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`
|
|
1297
|
+
# insertion orders under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR
|
|
1298
|
+
# entityStatus="ENTITY_STATUS_PAUSED")` The length of this field should be no
|
|
1299
|
+
# more than 500 characters.
|
|
1367
1300
|
# @param [String] order_by
|
|
1368
|
-
# Field by which to sort the list.
|
|
1369
|
-
#
|
|
1370
|
-
#
|
|
1371
|
-
#
|
|
1372
|
-
# The default sorting order is ascending. To specify descending order for
|
|
1373
|
-
# a field, a suffix "desc" should be added to the field name. Example:
|
|
1374
|
-
# `displayName desc`.
|
|
1301
|
+
# Field by which to sort the list. Acceptable values are: * "displayName" (
|
|
1302
|
+
# default) * "entityStatus" The default sorting order is ascending. To specify
|
|
1303
|
+
# descending order for a field, a suffix "desc" should be added to the field
|
|
1304
|
+
# name. Example: `displayName desc`.
|
|
1375
1305
|
# @param [Fixnum] page_size
|
|
1376
1306
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
1377
|
-
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
|
1378
|
-
#
|
|
1307
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
1308
|
+
# specified.
|
|
1379
1309
|
# @param [String] page_token
|
|
1380
|
-
# A token identifying a page of results the server should return.
|
|
1381
|
-
#
|
|
1382
|
-
#
|
|
1383
|
-
#
|
|
1384
|
-
# the first page of results will be returned.
|
|
1310
|
+
# A token identifying a page of results the server should return. Typically,
|
|
1311
|
+
# this is the value of next_page_token returned from the previous call to `
|
|
1312
|
+
# ListInsertionOrders` method. If not specified, the first page of results will
|
|
1313
|
+
# be returned.
|
|
1385
1314
|
# @param [String] fields
|
|
1386
1315
|
# Selector specifying which fields to include in a partial response.
|
|
1387
1316
|
# @param [String] quota_user
|
|
@@ -1413,8 +1342,8 @@ module Google
|
|
|
1413
1342
|
execute_or_queue_command(command, &block)
|
|
1414
1343
|
end
|
|
1415
1344
|
|
|
1416
|
-
# Updates an existing insertion order.
|
|
1417
|
-
#
|
|
1345
|
+
# Updates an existing insertion order. Returns the updated insertion order if
|
|
1346
|
+
# successful.
|
|
1418
1347
|
# @param [Fixnum] advertiser_id
|
|
1419
1348
|
# Output only. The unique ID of the advertiser the insertion order belongs to.
|
|
1420
1349
|
# @param [Fixnum] insertion_order_id
|
|
@@ -1453,10 +1382,10 @@ module Google
|
|
|
1453
1382
|
execute_or_queue_command(command, &block)
|
|
1454
1383
|
end
|
|
1455
1384
|
|
|
1456
|
-
# Bulk edits targeting options under a single line item.
|
|
1457
|
-
#
|
|
1458
|
-
# BulkEditLineItemAssignedTargetingOptionsRequest.delete_requests and
|
|
1459
|
-
#
|
|
1385
|
+
# Bulk edits targeting options under a single line item. The operation will
|
|
1386
|
+
# delete the assigned targeting options provided in
|
|
1387
|
+
# BulkEditLineItemAssignedTargetingOptionsRequest.delete_requests and then
|
|
1388
|
+
# create the assigned targeting options provided in
|
|
1460
1389
|
# BulkEditLineItemAssignedTargetingOptionsRequest.create_requests .
|
|
1461
1390
|
# @param [Fixnum] advertiser_id
|
|
1462
1391
|
# Required. The ID of the advertiser the line item belongs to.
|
|
@@ -1499,44 +1428,32 @@ module Google
|
|
|
1499
1428
|
# @param [Fixnum] line_item_id
|
|
1500
1429
|
# Required. The ID of the line item to list assigned targeting options for.
|
|
1501
1430
|
# @param [String] filter
|
|
1502
|
-
# Allows filtering by assigned targeting option properties.
|
|
1503
|
-
#
|
|
1504
|
-
#
|
|
1505
|
-
#
|
|
1506
|
-
#
|
|
1507
|
-
#
|
|
1508
|
-
#
|
|
1509
|
-
#
|
|
1510
|
-
#
|
|
1511
|
-
#
|
|
1512
|
-
#
|
|
1513
|
-
#
|
|
1514
|
-
# TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL
|
|
1515
|
-
# `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR
|
|
1516
|
-
# targetingType="TARGETING_TYPE_CHANNEL"`
|
|
1517
|
-
# * AssignedTargetingOptions with inheritance status of NOT_INHERITED or
|
|
1518
|
-
# INHERITED_FROM_PARTNER
|
|
1519
|
-
# `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"`
|
|
1520
|
-
# The length of this field should be no more than 500 characters.
|
|
1431
|
+
# Allows filtering by assigned targeting option properties. Supported syntax: *
|
|
1432
|
+
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
1433
|
+
# be combined by the logical operator `OR` on the same field. * A restriction
|
|
1434
|
+
# has the form of ``field` `operator` `value``. * The operator must be `EQUALS (=
|
|
1435
|
+
# )`. * Supported fields: - `targetingType` - `inheritance` Examples: *
|
|
1436
|
+
# AssignedTargetingOptions of targeting type
|
|
1437
|
+
# TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL `
|
|
1438
|
+
# targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="
|
|
1439
|
+
# TARGETING_TYPE_CHANNEL"` * AssignedTargetingOptions with inheritance status of
|
|
1440
|
+
# NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED" OR
|
|
1441
|
+
# inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no
|
|
1442
|
+
# more than 500 characters.
|
|
1521
1443
|
# @param [String] order_by
|
|
1522
|
-
# Field by which to sort the list.
|
|
1523
|
-
#
|
|
1524
|
-
#
|
|
1525
|
-
#
|
|
1526
|
-
# a field, a suffix "desc" should be added to the field name. Example:
|
|
1527
|
-
# `targetingType desc`.
|
|
1444
|
+
# Field by which to sort the list. Acceptable values are: * `targetingType` (
|
|
1445
|
+
# default) The default sorting order is ascending. To specify descending order
|
|
1446
|
+
# for a field, a suffix "desc" should be added to the field name. Example: `
|
|
1447
|
+
# targetingType desc`.
|
|
1528
1448
|
# @param [Fixnum] page_size
|
|
1529
|
-
# Requested page size.
|
|
1530
|
-
#
|
|
1531
|
-
#
|
|
1532
|
-
# value is specified.
|
|
1449
|
+
# Requested page size. The size must be an integer between `1` and `5000`. If
|
|
1450
|
+
# unspecified, the default is '5000'. Returns error code `INVALID_ARGUMENT` if
|
|
1451
|
+
# an invalid value is specified.
|
|
1533
1452
|
# @param [String] page_token
|
|
1534
|
-
# A token that lets the client fetch the next page of results.
|
|
1535
|
-
#
|
|
1536
|
-
#
|
|
1537
|
-
#
|
|
1538
|
-
# `BulkListLineItemAssignedTargetingOptions` method.
|
|
1539
|
-
# If not specified, the first page of results will be returned.
|
|
1453
|
+
# A token that lets the client fetch the next page of results. Typically, this
|
|
1454
|
+
# is the value of next_page_token returned from the previous call to `
|
|
1455
|
+
# BulkListLineItemAssignedTargetingOptions` method. If not specified, the first
|
|
1456
|
+
# page of results will be returned.
|
|
1540
1457
|
# @param [String] fields
|
|
1541
1458
|
# Selector specifying which fields to include in a partial response.
|
|
1542
1459
|
# @param [String] quota_user
|
|
@@ -1569,8 +1486,7 @@ module Google
|
|
|
1569
1486
|
execute_or_queue_command(command, &block)
|
|
1570
1487
|
end
|
|
1571
1488
|
|
|
1572
|
-
# Creates a new line item.
|
|
1573
|
-
# Returns the newly created line item if successful.
|
|
1489
|
+
# Creates a new line item. Returns the newly created line item if successful.
|
|
1574
1490
|
# @param [Fixnum] advertiser_id
|
|
1575
1491
|
# Output only. The unique ID of the advertiser the line item belongs to.
|
|
1576
1492
|
# @param [Google::Apis::DisplayvideoV1::LineItem] line_item_object
|
|
@@ -1603,11 +1519,9 @@ module Google
|
|
|
1603
1519
|
execute_or_queue_command(command, &block)
|
|
1604
1520
|
end
|
|
1605
1521
|
|
|
1606
|
-
# Deletes a line item.
|
|
1607
|
-
#
|
|
1608
|
-
#
|
|
1609
|
-
# entity_status to `ENTITY_STATUS_ARCHIVED`, to be
|
|
1610
|
-
# able to delete it.
|
|
1522
|
+
# Deletes a line item. Returns error code `NOT_FOUND` if the line item does not
|
|
1523
|
+
# exist. The line item should be archived first, i.e. set entity_status to `
|
|
1524
|
+
# ENTITY_STATUS_ARCHIVED`, to be able to delete it.
|
|
1611
1525
|
# @param [Fixnum] advertiser_id
|
|
1612
1526
|
# The ID of the advertiser this line item belongs to.
|
|
1613
1527
|
# @param [Fixnum] line_item_id
|
|
@@ -1673,54 +1587,41 @@ module Google
|
|
|
1673
1587
|
execute_or_queue_command(command, &block)
|
|
1674
1588
|
end
|
|
1675
1589
|
|
|
1676
|
-
# Lists line items in an advertiser.
|
|
1677
|
-
#
|
|
1678
|
-
#
|
|
1679
|
-
# If a filter by
|
|
1680
|
-
# entity_status is not specified, line items with
|
|
1681
|
-
# `ENTITY_STATUS_ARCHIVED` will not be included in the results.
|
|
1590
|
+
# Lists line items in an advertiser. The order is defined by the order_by
|
|
1591
|
+
# parameter. If a filter by entity_status is not specified, line items with `
|
|
1592
|
+
# ENTITY_STATUS_ARCHIVED` will not be included in the results.
|
|
1682
1593
|
# @param [Fixnum] advertiser_id
|
|
1683
1594
|
# Required. The ID of the advertiser to list line items for.
|
|
1684
1595
|
# @param [String] filter
|
|
1685
|
-
# Allows filtering by line item properties.
|
|
1686
|
-
#
|
|
1687
|
-
#
|
|
1688
|
-
# *
|
|
1689
|
-
#
|
|
1690
|
-
# *
|
|
1691
|
-
#
|
|
1692
|
-
#
|
|
1693
|
-
#
|
|
1694
|
-
#
|
|
1695
|
-
#
|
|
1696
|
-
#
|
|
1697
|
-
#
|
|
1698
|
-
#
|
|
1699
|
-
#
|
|
1700
|
-
# and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser:
|
|
1701
|
-
# `(entityStatus="ENTITY_STATUS_ACTIVE" OR
|
|
1702
|
-
# entityStatus="ENTITY_STATUS_PAUSED") AND
|
|
1703
|
-
# lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"`
|
|
1704
|
-
# The length of this field should be no more than 500 characters.
|
|
1596
|
+
# Allows filtering by line item properties. Supported syntax: * Filter
|
|
1597
|
+
# expressions are made up of one or more restrictions. * Restrictions can be
|
|
1598
|
+
# combined by `AND` or `OR` logical operators. A sequence of restrictions
|
|
1599
|
+
# implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
|
|
1600
|
+
# value``. * The operator used on `flight.dateRange.endDate` must be LESS THAN (<
|
|
1601
|
+
# ). * The operators used on all other fields must be `EQUALS (=)`. * Supported
|
|
1602
|
+
# fields: - `campaignId` - `insertionOrderId` - `entityStatus` - `lineItemType` -
|
|
1603
|
+
# `flight.dateRange.endDate` (input formatted as YYYY-MM-DD) Examples: * All
|
|
1604
|
+
# line items under an insertion order: `insertionOrderId="1234"` * All `
|
|
1605
|
+
# ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `
|
|
1606
|
+
# LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus=
|
|
1607
|
+
# "ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND
|
|
1608
|
+
# lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` * All line items whose flight
|
|
1609
|
+
# dates end before March 28, 2019: `flight.dateRange.endDate<"2019-03-28"` The
|
|
1610
|
+
# length of this field should be no more than 500 characters.
|
|
1705
1611
|
# @param [String] order_by
|
|
1706
|
-
# Field by which to sort the list.
|
|
1707
|
-
#
|
|
1708
|
-
#
|
|
1709
|
-
#
|
|
1710
|
-
# * “flight.dateRange.endDate”
|
|
1711
|
-
# The default sorting order is ascending. To specify descending order for
|
|
1712
|
-
# a field, a suffix "desc" should be added to the field name. Example:
|
|
1713
|
-
# `displayName desc`.
|
|
1612
|
+
# Field by which to sort the list. Acceptable values are: * "displayName" (
|
|
1613
|
+
# default) * "entityStatus" * “flight.dateRange.endDate” The default sorting
|
|
1614
|
+
# order is ascending. To specify descending order for a field, a suffix "desc"
|
|
1615
|
+
# should be added to the field name. Example: `displayName desc`.
|
|
1714
1616
|
# @param [Fixnum] page_size
|
|
1715
1617
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
1716
|
-
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
|
1717
|
-
#
|
|
1618
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
1619
|
+
# specified.
|
|
1718
1620
|
# @param [String] page_token
|
|
1719
|
-
# A token identifying a page of results the server should return.
|
|
1720
|
-
#
|
|
1721
|
-
#
|
|
1722
|
-
# returned
|
|
1723
|
-
# If not specified, the first page of results will be returned.
|
|
1621
|
+
# A token identifying a page of results the server should return. Typically,
|
|
1622
|
+
# this is the value of next_page_token returned from the previous call to `
|
|
1623
|
+
# ListLineItems` method. If not specified, the first page of results will be
|
|
1624
|
+
# returned.
|
|
1724
1625
|
# @param [String] fields
|
|
1725
1626
|
# Selector specifying which fields to include in a partial response.
|
|
1726
1627
|
# @param [String] quota_user
|
|
@@ -1752,8 +1653,7 @@ module Google
|
|
|
1752
1653
|
execute_or_queue_command(command, &block)
|
|
1753
1654
|
end
|
|
1754
1655
|
|
|
1755
|
-
# Updates an existing line item.
|
|
1756
|
-
# Returns the updated line item if successful.
|
|
1656
|
+
# Updates an existing line item. Returns the updated line item if successful.
|
|
1757
1657
|
# @param [Fixnum] advertiser_id
|
|
1758
1658
|
# Output only. The unique ID of the advertiser the line item belongs to.
|
|
1759
1659
|
# @param [Fixnum] line_item_id
|
|
@@ -1792,8 +1692,8 @@ module Google
|
|
|
1792
1692
|
execute_or_queue_command(command, &block)
|
|
1793
1693
|
end
|
|
1794
1694
|
|
|
1795
|
-
# Assigns a targeting option to a line item.
|
|
1796
|
-
#
|
|
1695
|
+
# Assigns a targeting option to a line item. Returns the assigned targeting
|
|
1696
|
+
# option if successful.
|
|
1797
1697
|
# @param [Fixnum] advertiser_id
|
|
1798
1698
|
# Required. The ID of the advertiser the line item belongs to.
|
|
1799
1699
|
# @param [Fixnum] line_item_id
|
|
@@ -1919,39 +1819,30 @@ module Google
|
|
|
1919
1819
|
# @param [String] targeting_type
|
|
1920
1820
|
# Required. Identifies the type of assigned targeting options to list.
|
|
1921
1821
|
# @param [String] filter
|
|
1922
|
-
# Allows filtering by assigned targeting option properties.
|
|
1923
|
-
#
|
|
1924
|
-
#
|
|
1925
|
-
#
|
|
1926
|
-
#
|
|
1927
|
-
#
|
|
1928
|
-
# *
|
|
1929
|
-
#
|
|
1930
|
-
#
|
|
1931
|
-
#
|
|
1932
|
-
# * AssignedTargetingOptions with ID 1 or 2
|
|
1933
|
-
# `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"`
|
|
1934
|
-
# * AssignedTargetingOptions with inheritance status of NOT_INHERITED or
|
|
1935
|
-
# INHERITED_FROM_PARTNER
|
|
1936
|
-
# `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"`
|
|
1937
|
-
# The length of this field should be no more than 500 characters.
|
|
1822
|
+
# Allows filtering by assigned targeting option properties. Supported syntax: *
|
|
1823
|
+
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
1824
|
+
# be combined by the logical operator `OR`. * A restriction has the form of ``
|
|
1825
|
+
# field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported
|
|
1826
|
+
# fields: - `assignedTargetingOptionId` - `inheritance` Examples: *
|
|
1827
|
+
# AssignedTargetingOptions with ID 1 or 2 `assignedTargetingOptionId="1" OR
|
|
1828
|
+
# assignedTargetingOptionId="2"` * AssignedTargetingOptions with inheritance
|
|
1829
|
+
# status of NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED"
|
|
1830
|
+
# OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no
|
|
1831
|
+
# more than 500 characters.
|
|
1938
1832
|
# @param [String] order_by
|
|
1939
|
-
# Field by which to sort the list.
|
|
1940
|
-
#
|
|
1941
|
-
#
|
|
1942
|
-
#
|
|
1943
|
-
# a field, a suffix "desc" should be added to the field name. Example:
|
|
1944
|
-
# `assignedTargetingOptionId desc`.
|
|
1833
|
+
# Field by which to sort the list. Acceptable values are: * `
|
|
1834
|
+
# assignedTargetingOptionId` (default) The default sorting order is ascending.
|
|
1835
|
+
# To specify descending order for a field, a suffix "desc" should be added to
|
|
1836
|
+
# the field name. Example: `assignedTargetingOptionId desc`.
|
|
1945
1837
|
# @param [Fixnum] page_size
|
|
1946
1838
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
1947
|
-
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
|
1948
|
-
#
|
|
1839
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
1840
|
+
# specified.
|
|
1949
1841
|
# @param [String] page_token
|
|
1950
|
-
# A token identifying a page of results the server should return.
|
|
1951
|
-
#
|
|
1952
|
-
#
|
|
1953
|
-
#
|
|
1954
|
-
# method. If not specified, the first page of results will be returned.
|
|
1842
|
+
# A token identifying a page of results the server should return. Typically,
|
|
1843
|
+
# this is the value of next_page_token returned from the previous call to `
|
|
1844
|
+
# ListLineItemAssignedTargetingOptions` method. If not specified, the first page
|
|
1845
|
+
# of results will be returned.
|
|
1955
1846
|
# @param [String] fields
|
|
1956
1847
|
# Selector specifying which fields to include in a partial response.
|
|
1957
1848
|
# @param [String] quota_user
|
|
@@ -2058,38 +1949,27 @@ module Google
|
|
|
2058
1949
|
# Required. The ID of the DV360 advertiser to which the fetched location lists
|
|
2059
1950
|
# belong.
|
|
2060
1951
|
# @param [String] filter
|
|
2061
|
-
# Allows filtering by location list fields.
|
|
2062
|
-
#
|
|
2063
|
-
#
|
|
2064
|
-
# *
|
|
2065
|
-
#
|
|
2066
|
-
#
|
|
2067
|
-
# *
|
|
2068
|
-
#
|
|
2069
|
-
# - `locationType`
|
|
2070
|
-
# Examples:
|
|
2071
|
-
# * All regional location list:
|
|
2072
|
-
# `locationType="TARGETING_LOCATION_TYPE_REGIONAL"`
|
|
2073
|
-
# * All proximity location list:
|
|
2074
|
-
# `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"`
|
|
1952
|
+
# Allows filtering by location list fields. Supported syntax: * Filter
|
|
1953
|
+
# expressions are made up of one or more restrictions. * Restrictions can be
|
|
1954
|
+
# combined by `AND` or `OR` logical operators. A sequence of restrictions
|
|
1955
|
+
# implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
|
|
1956
|
+
# value``. * The operator must be `EQUALS (=)`. * Supported fields: - `
|
|
1957
|
+
# locationType` Examples: * All regional location list: `locationType="
|
|
1958
|
+
# TARGETING_LOCATION_TYPE_REGIONAL"` * All proximity location list: `
|
|
1959
|
+
# locationType="TARGETING_LOCATION_TYPE_PROXIMITY"`
|
|
2075
1960
|
# @param [String] order_by
|
|
2076
|
-
# Field by which to sort the list.
|
|
2077
|
-
#
|
|
2078
|
-
#
|
|
2079
|
-
#
|
|
2080
|
-
# The default sorting order is ascending. To specify descending order for
|
|
2081
|
-
# a field, a suffix "desc" should be added to the field name. Example:
|
|
2082
|
-
# `displayName desc`.
|
|
1961
|
+
# Field by which to sort the list. Acceptable values are: * `locationListId` (
|
|
1962
|
+
# default) * `displayName` The default sorting order is ascending. To specify
|
|
1963
|
+
# descending order for a field, a suffix "desc" should be added to the field
|
|
1964
|
+
# name. Example: `displayName desc`.
|
|
2083
1965
|
# @param [Fixnum] page_size
|
|
2084
|
-
# Requested page size. Must be between `1` and `100`.
|
|
2085
|
-
#
|
|
2086
|
-
# invalid value is specified.
|
|
1966
|
+
# Requested page size. Must be between `1` and `100`. Defaults to `100` if not
|
|
1967
|
+
# set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
|
|
2087
1968
|
# @param [String] page_token
|
|
2088
|
-
# A token identifying a page of results the server should return.
|
|
2089
|
-
#
|
|
2090
|
-
#
|
|
2091
|
-
# returned
|
|
2092
|
-
# If not specified, the first page of results will be returned.
|
|
1969
|
+
# A token identifying a page of results the server should return. Typically,
|
|
1970
|
+
# this is the value of next_page_token returned from the previous call to `
|
|
1971
|
+
# ListLocationLists` method. If not specified, the first page of results will be
|
|
1972
|
+
# returned.
|
|
2093
1973
|
# @param [String] fields
|
|
2094
1974
|
# Selector specifying which fields to include in a partial response.
|
|
2095
1975
|
# @param [String] quota_user
|
|
@@ -2160,12 +2040,11 @@ module Google
|
|
|
2160
2040
|
execute_or_queue_command(command, &block)
|
|
2161
2041
|
end
|
|
2162
2042
|
|
|
2163
|
-
# Bulk edits multiple assignments between locations and a single location
|
|
2164
|
-
# list.
|
|
2043
|
+
# Bulk edits multiple assignments between locations and a single location list.
|
|
2165
2044
|
# The operation will delete the assigned locations provided in
|
|
2166
|
-
# BulkEditAssignedLocationsRequest.deleted_assigned_locations and then
|
|
2167
|
-
#
|
|
2168
|
-
#
|
|
2045
|
+
# BulkEditAssignedLocationsRequest.deleted_assigned_locations and then create
|
|
2046
|
+
# the assigned locations provided in BulkEditAssignedLocationsRequest.
|
|
2047
|
+
# created_assigned_locations.
|
|
2169
2048
|
# @param [Fixnum] advertiser_id
|
|
2170
2049
|
# Required. The ID of the DV360 advertiser to which the location list belongs.
|
|
2171
2050
|
# @param [Fixnum] location_list_id
|
|
@@ -2279,32 +2158,26 @@ module Google
|
|
|
2279
2158
|
# @param [Fixnum] location_list_id
|
|
2280
2159
|
# Required. The ID of the location list to which these assignments are assigned.
|
|
2281
2160
|
# @param [String] filter
|
|
2282
|
-
# Allows filtering by location list assignment fields.
|
|
2283
|
-
#
|
|
2284
|
-
#
|
|
2285
|
-
#
|
|
2286
|
-
#
|
|
2287
|
-
#
|
|
2288
|
-
# * Supported fields:
|
|
2289
|
-
# - `assignedLocationId`
|
|
2290
|
-
# The length of this field should be no more than 500 characters.
|
|
2161
|
+
# Allows filtering by location list assignment fields. Supported syntax: *
|
|
2162
|
+
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
2163
|
+
# be combined by the logical operator `OR`. * A restriction has the form of ``
|
|
2164
|
+
# field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported
|
|
2165
|
+
# fields: - `assignedLocationId` The length of this field should be no more than
|
|
2166
|
+
# 500 characters.
|
|
2291
2167
|
# @param [String] order_by
|
|
2292
|
-
# Field by which to sort the list.
|
|
2293
|
-
#
|
|
2294
|
-
#
|
|
2295
|
-
#
|
|
2296
|
-
# field, a suffix " desc" should be added to the field name. Example:
|
|
2297
|
-
# `assignedLocationId desc`.
|
|
2168
|
+
# Field by which to sort the list. Acceptable values are: * `assignedLocationId`
|
|
2169
|
+
# (default) The default sorting order is ascending. To specify descending order
|
|
2170
|
+
# for a field, a suffix " desc" should be added to the field name. Example: `
|
|
2171
|
+
# assignedLocationId desc`.
|
|
2298
2172
|
# @param [Fixnum] page_size
|
|
2299
2173
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
2300
|
-
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
|
2301
|
-
#
|
|
2174
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
2175
|
+
# specified.
|
|
2302
2176
|
# @param [String] page_token
|
|
2303
|
-
# A token identifying a page of results the server should return.
|
|
2304
|
-
#
|
|
2305
|
-
#
|
|
2306
|
-
#
|
|
2307
|
-
# method. If not specified, the first page of results will be returned.
|
|
2177
|
+
# A token identifying a page of results the server should return. Typically,
|
|
2178
|
+
# this is the value of next_page_token returned from the previous call to `
|
|
2179
|
+
# ListAssignedLocations` method. If not specified, the first page of results
|
|
2180
|
+
# will be returned.
|
|
2308
2181
|
# @param [String] fields
|
|
2309
2182
|
# Selector specifying which fields to include in a partial response.
|
|
2310
2183
|
# @param [String] quota_user
|
|
@@ -2341,8 +2214,7 @@ module Google
|
|
|
2341
2214
|
# keyword list if successful.
|
|
2342
2215
|
# @param [Fixnum] advertiser_id
|
|
2343
2216
|
# Required. The ID of the DV360 advertiser to which the negative keyword list
|
|
2344
|
-
# will
|
|
2345
|
-
# belong.
|
|
2217
|
+
# will belong.
|
|
2346
2218
|
# @param [Google::Apis::DisplayvideoV1::NegativeKeywordList] negative_keyword_list_object
|
|
2347
2219
|
# @param [String] fields
|
|
2348
2220
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -2373,8 +2245,8 @@ module Google
|
|
|
2373
2245
|
execute_or_queue_command(command, &block)
|
|
2374
2246
|
end
|
|
2375
2247
|
|
|
2376
|
-
# Deletes a negative keyword list given an advertiser ID and a negative
|
|
2377
|
-
#
|
|
2248
|
+
# Deletes a negative keyword list given an advertiser ID and a negative keyword
|
|
2249
|
+
# list ID.
|
|
2378
2250
|
# @param [Fixnum] advertiser_id
|
|
2379
2251
|
# Required. The ID of the DV360 advertiser to which the negative keyword list
|
|
2380
2252
|
# belongs.
|
|
@@ -2412,8 +2284,7 @@ module Google
|
|
|
2412
2284
|
# list ID.
|
|
2413
2285
|
# @param [Fixnum] advertiser_id
|
|
2414
2286
|
# Required. The ID of the DV360 advertiser to which the fetched negative keyword
|
|
2415
|
-
# list
|
|
2416
|
-
# belongs.
|
|
2287
|
+
# list belongs.
|
|
2417
2288
|
# @param [Fixnum] negative_keyword_list_id
|
|
2418
2289
|
# Required. The ID of the negative keyword list to fetch.
|
|
2419
2290
|
# @param [String] fields
|
|
@@ -2447,18 +2318,15 @@ module Google
|
|
|
2447
2318
|
# Lists negative keyword lists based on a given advertiser id.
|
|
2448
2319
|
# @param [Fixnum] advertiser_id
|
|
2449
2320
|
# Required. The ID of the DV360 advertiser to which the fetched negative keyword
|
|
2450
|
-
# lists
|
|
2451
|
-
# belong.
|
|
2321
|
+
# lists belong.
|
|
2452
2322
|
# @param [Fixnum] page_size
|
|
2453
|
-
# Requested page size. Must be between `1` and `100`.
|
|
2454
|
-
#
|
|
2455
|
-
# invalid value is specified.
|
|
2323
|
+
# Requested page size. Must be between `1` and `100`. Defaults to `100` if not
|
|
2324
|
+
# set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
|
|
2456
2325
|
# @param [String] page_token
|
|
2457
|
-
# A token identifying a page of results the server should return.
|
|
2458
|
-
#
|
|
2459
|
-
#
|
|
2460
|
-
#
|
|
2461
|
-
# If not specified, the first page of results will be returned.
|
|
2326
|
+
# A token identifying a page of results the server should return. Typically,
|
|
2327
|
+
# this is the value of next_page_token returned from the previous call to `
|
|
2328
|
+
# ListNegativeKeywordLists` method. If not specified, the first page of results
|
|
2329
|
+
# will be returned.
|
|
2462
2330
|
# @param [String] fields
|
|
2463
2331
|
# Selector specifying which fields to include in a partial response.
|
|
2464
2332
|
# @param [String] quota_user
|
|
@@ -2488,8 +2356,8 @@ module Google
|
|
|
2488
2356
|
execute_or_queue_command(command, &block)
|
|
2489
2357
|
end
|
|
2490
2358
|
|
|
2491
|
-
# Updates a negative keyword list. Returns the updated negative keyword list
|
|
2492
|
-
#
|
|
2359
|
+
# Updates a negative keyword list. Returns the updated negative keyword list if
|
|
2360
|
+
# successful.
|
|
2493
2361
|
# @param [Fixnum] advertiser_id
|
|
2494
2362
|
# Required. The ID of the DV360 advertiser to which the negative keyword list
|
|
2495
2363
|
# belongs.
|
|
@@ -2530,21 +2398,18 @@ module Google
|
|
|
2530
2398
|
execute_or_queue_command(command, &block)
|
|
2531
2399
|
end
|
|
2532
2400
|
|
|
2533
|
-
# Bulk edits negative keywords in a single negative keyword list.
|
|
2534
|
-
#
|
|
2535
|
-
#
|
|
2536
|
-
#
|
|
2537
|
-
#
|
|
2538
|
-
#
|
|
2539
|
-
# partial success or partial failure.
|
|
2401
|
+
# Bulk edits negative keywords in a single negative keyword list. The operation
|
|
2402
|
+
# will delete the negative keywords provided in BulkEditNegativeKeywordsRequest.
|
|
2403
|
+
# deleted_negative_keywords and then create the negative keywords provided in
|
|
2404
|
+
# BulkEditNegativeKeywordsRequest.created_negative_keywords. This operation is
|
|
2405
|
+
# guaranteed to be atomic and will never result in a partial success or partial
|
|
2406
|
+
# failure.
|
|
2540
2407
|
# @param [Fixnum] advertiser_id
|
|
2541
2408
|
# Required. The ID of the DV360 advertiser to which the parent negative keyword
|
|
2542
|
-
# list
|
|
2543
|
-
# belongs.
|
|
2409
|
+
# list belongs.
|
|
2544
2410
|
# @param [Fixnum] negative_keyword_list_id
|
|
2545
2411
|
# Required. The ID of the parent negative keyword list to which the negative
|
|
2546
|
-
# keywords
|
|
2547
|
-
# belong.
|
|
2412
|
+
# keywords belong.
|
|
2548
2413
|
# @param [Google::Apis::DisplayvideoV1::BulkEditNegativeKeywordsRequest] bulk_edit_negative_keywords_request_object
|
|
2549
2414
|
# @param [String] fields
|
|
2550
2415
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -2579,12 +2444,10 @@ module Google
|
|
|
2579
2444
|
# Creates a negative keyword in a negative keyword list.
|
|
2580
2445
|
# @param [Fixnum] advertiser_id
|
|
2581
2446
|
# Required. The ID of the DV360 advertiser to which the parent negative keyword
|
|
2582
|
-
# list
|
|
2583
|
-
# belongs.
|
|
2447
|
+
# list belongs.
|
|
2584
2448
|
# @param [Fixnum] negative_keyword_list_id
|
|
2585
2449
|
# Required. The ID of the parent negative keyword list in which the negative
|
|
2586
|
-
# keyword
|
|
2587
|
-
# will be created.
|
|
2450
|
+
# keyword will be created.
|
|
2588
2451
|
# @param [Google::Apis::DisplayvideoV1::NegativeKeyword] negative_keyword_object
|
|
2589
2452
|
# @param [String] fields
|
|
2590
2453
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -2619,12 +2482,10 @@ module Google
|
|
|
2619
2482
|
# Deletes a negative keyword from a negative keyword list.
|
|
2620
2483
|
# @param [Fixnum] advertiser_id
|
|
2621
2484
|
# Required. The ID of the DV360 advertiser to which the parent negative keyword
|
|
2622
|
-
# list
|
|
2623
|
-
# belongs.
|
|
2485
|
+
# list belongs.
|
|
2624
2486
|
# @param [Fixnum] negative_keyword_list_id
|
|
2625
2487
|
# Required. The ID of the parent negative keyword list to which the negative
|
|
2626
|
-
# keyword
|
|
2627
|
-
# belongs.
|
|
2488
|
+
# keyword belongs.
|
|
2628
2489
|
# @param [String] keyword_value
|
|
2629
2490
|
# Required. The keyword value of the negative keyword to delete.
|
|
2630
2491
|
# @param [String] fields
|
|
@@ -2659,42 +2520,31 @@ module Google
|
|
|
2659
2520
|
# Lists negative keywords in a negative keyword list.
|
|
2660
2521
|
# @param [Fixnum] advertiser_id
|
|
2661
2522
|
# Required. The ID of the DV360 advertiser to which the parent negative keyword
|
|
2662
|
-
# list
|
|
2663
|
-
# belongs.
|
|
2523
|
+
# list belongs.
|
|
2664
2524
|
# @param [Fixnum] negative_keyword_list_id
|
|
2665
2525
|
# Required. The ID of the parent negative keyword list to which the requested
|
|
2666
|
-
# negative
|
|
2667
|
-
# keywords belong.
|
|
2526
|
+
# negative keywords belong.
|
|
2668
2527
|
# @param [String] filter
|
|
2669
|
-
# Allows filtering by negative keyword fields.
|
|
2670
|
-
#
|
|
2671
|
-
# *
|
|
2672
|
-
#
|
|
2673
|
-
# *
|
|
2674
|
-
#
|
|
2675
|
-
# * The operator must be `CONTAINS (:)`.
|
|
2676
|
-
# * Supported fields:
|
|
2677
|
-
# - `keywordValue`
|
|
2678
|
-
# Examples:
|
|
2679
|
-
# * All negative keywords for which the keyword value contains "google":
|
|
2680
|
-
# `keywordValue : "google"`
|
|
2528
|
+
# Allows filtering by negative keyword fields. Supported syntax: * Filter
|
|
2529
|
+
# expressions for negative keyword currently can only contain at most one *
|
|
2530
|
+
# restriction. * A restriction has the form of ``field` `operator` `value``. *
|
|
2531
|
+
# The operator must be `CONTAINS (:)`. * Supported fields: - `keywordValue`
|
|
2532
|
+
# Examples: * All negative keywords for which the keyword value contains "google"
|
|
2533
|
+
# : `keywordValue : "google"`
|
|
2681
2534
|
# @param [String] order_by
|
|
2682
|
-
# Field by which to sort the list.
|
|
2683
|
-
#
|
|
2684
|
-
#
|
|
2685
|
-
#
|
|
2686
|
-
# field, a suffix " desc" should be added to the field name. Example:
|
|
2687
|
-
# `keywordValue desc`.
|
|
2535
|
+
# Field by which to sort the list. Acceptable values are: * `keywordValue` (
|
|
2536
|
+
# default) The default sorting order is ascending. To specify descending order
|
|
2537
|
+
# for a field, a suffix " desc" should be added to the field name. Example: `
|
|
2538
|
+
# keywordValue desc`.
|
|
2688
2539
|
# @param [Fixnum] page_size
|
|
2689
2540
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
2690
|
-
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
|
2691
|
-
#
|
|
2541
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
2542
|
+
# specified.
|
|
2692
2543
|
# @param [String] page_token
|
|
2693
|
-
# A token identifying a page of results the server should return.
|
|
2694
|
-
#
|
|
2695
|
-
#
|
|
2696
|
-
#
|
|
2697
|
-
# the first page of results will be returned.
|
|
2544
|
+
# A token identifying a page of results the server should return. Typically,
|
|
2545
|
+
# this is the value of next_page_token returned from the previous call to `
|
|
2546
|
+
# ListNegativeKeywords` method. If not specified, the first page of results will
|
|
2547
|
+
# be returned.
|
|
2698
2548
|
# @param [String] fields
|
|
2699
2549
|
# Selector specifying which fields to include in a partial response.
|
|
2700
2550
|
# @param [String] quota_user
|
|
@@ -2727,8 +2577,8 @@ module Google
|
|
|
2727
2577
|
execute_or_queue_command(command, &block)
|
|
2728
2578
|
end
|
|
2729
2579
|
|
|
2730
|
-
# Assigns a targeting option to an advertiser.
|
|
2731
|
-
#
|
|
2580
|
+
# Assigns a targeting option to an advertiser. Returns the assigned targeting
|
|
2581
|
+
# option if successful.
|
|
2732
2582
|
# @param [Fixnum] advertiser_id
|
|
2733
2583
|
# Required. The ID of the advertiser.
|
|
2734
2584
|
# @param [String] targeting_type
|
|
@@ -2843,35 +2693,27 @@ module Google
|
|
|
2843
2693
|
# @param [String] targeting_type
|
|
2844
2694
|
# Required. Identifies the type of assigned targeting options to list.
|
|
2845
2695
|
# @param [String] filter
|
|
2846
|
-
# Allows filtering by assigned targeting option properties.
|
|
2847
|
-
#
|
|
2848
|
-
#
|
|
2849
|
-
#
|
|
2850
|
-
#
|
|
2851
|
-
#
|
|
2852
|
-
#
|
|
2853
|
-
# - `assignedTargetingOptionId`
|
|
2854
|
-
# Examples:
|
|
2855
|
-
# * AssignedTargetingOption with ID 123456
|
|
2856
|
-
# `assignedTargetingOptionId="123456"`
|
|
2857
|
-
# The length of this field should be no more than 500 characters.
|
|
2696
|
+
# Allows filtering by assigned targeting option properties. Supported syntax: *
|
|
2697
|
+
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
2698
|
+
# be combined by the logical operator `OR`. * A restriction has the form of ``
|
|
2699
|
+
# field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported
|
|
2700
|
+
# fields: - `assignedTargetingOptionId` Examples: * AssignedTargetingOption with
|
|
2701
|
+
# ID 123456 `assignedTargetingOptionId="123456"` The length of this field should
|
|
2702
|
+
# be no more than 500 characters.
|
|
2858
2703
|
# @param [String] order_by
|
|
2859
|
-
# Field by which to sort the list.
|
|
2860
|
-
#
|
|
2861
|
-
#
|
|
2862
|
-
#
|
|
2863
|
-
# a field, a suffix "desc" should be added to the field name. Example:
|
|
2864
|
-
# `assignedTargetingOptionId desc`.
|
|
2704
|
+
# Field by which to sort the list. Acceptable values are: * `
|
|
2705
|
+
# assignedTargetingOptionId` (default) The default sorting order is ascending.
|
|
2706
|
+
# To specify descending order for a field, a suffix "desc" should be added to
|
|
2707
|
+
# the field name. Example: `assignedTargetingOptionId desc`.
|
|
2865
2708
|
# @param [Fixnum] page_size
|
|
2866
2709
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
2867
|
-
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
|
2868
|
-
#
|
|
2710
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
2711
|
+
# specified.
|
|
2869
2712
|
# @param [String] page_token
|
|
2870
|
-
# A token identifying a page of results the server should return.
|
|
2871
|
-
#
|
|
2872
|
-
#
|
|
2873
|
-
#
|
|
2874
|
-
# method. If not specified, the first page of results will be returned.
|
|
2713
|
+
# A token identifying a page of results the server should return. Typically,
|
|
2714
|
+
# this is the value of next_page_token returned from the previous call to `
|
|
2715
|
+
# ListAdvertiserAssignedTargetingOptions` method. If not specified, the first
|
|
2716
|
+
# page of results will be returned.
|
|
2875
2717
|
# @param [String] fields
|
|
2876
2718
|
# Selector specifying which fields to include in a partial response.
|
|
2877
2719
|
# @param [String] quota_user
|
|
@@ -2908,8 +2750,7 @@ module Google
|
|
|
2908
2750
|
# @param [Fixnum] combined_audience_id
|
|
2909
2751
|
# Required. The ID of the combined audience to fetch.
|
|
2910
2752
|
# @param [Fixnum] advertiser_id
|
|
2911
|
-
# The ID of the advertiser that has access to the fetched combined
|
|
2912
|
-
# audience.
|
|
2753
|
+
# The ID of the advertiser that has access to the fetched combined audience.
|
|
2913
2754
|
# @param [Fixnum] partner_id
|
|
2914
2755
|
# The ID of the partner that has access to the fetched combined audience.
|
|
2915
2756
|
# @param [String] fields
|
|
@@ -2941,43 +2782,31 @@ module Google
|
|
|
2941
2782
|
execute_or_queue_command(command, &block)
|
|
2942
2783
|
end
|
|
2943
2784
|
|
|
2944
|
-
# Lists combined audiences.
|
|
2945
|
-
# The order is defined by the
|
|
2946
|
-
# order_by parameter.
|
|
2785
|
+
# Lists combined audiences. The order is defined by the order_by parameter.
|
|
2947
2786
|
# @param [Fixnum] advertiser_id
|
|
2948
|
-
# The ID of the advertiser that has access to the fetched combined
|
|
2949
|
-
# audiences.
|
|
2787
|
+
# The ID of the advertiser that has access to the fetched combined audiences.
|
|
2950
2788
|
# @param [String] filter
|
|
2951
|
-
# Allows filtering by combined audience fields.
|
|
2952
|
-
#
|
|
2953
|
-
# *
|
|
2954
|
-
#
|
|
2955
|
-
# *
|
|
2956
|
-
#
|
|
2957
|
-
#
|
|
2958
|
-
# - `displayName`
|
|
2959
|
-
# Examples:
|
|
2960
|
-
# * All combined audiences for which the display name contains "Google":
|
|
2961
|
-
# `displayName : "Google"`.
|
|
2962
|
-
# The length of this field should be no more than 500 characters.
|
|
2789
|
+
# Allows filtering by combined audience fields. Supported syntax: * Filter
|
|
2790
|
+
# expressions for combined audiences currently can only contain at most one
|
|
2791
|
+
# restriction. * A restriction has the form of ``field` `operator` `value``. *
|
|
2792
|
+
# The operator must be `CONTAINS (:)`. * Supported fields: - `displayName`
|
|
2793
|
+
# Examples: * All combined audiences for which the display name contains "Google"
|
|
2794
|
+
# : `displayName : "Google"`. The length of this field should be no more than
|
|
2795
|
+
# 500 characters.
|
|
2963
2796
|
# @param [String] order_by
|
|
2964
|
-
# Field by which to sort the list.
|
|
2965
|
-
#
|
|
2966
|
-
#
|
|
2967
|
-
#
|
|
2968
|
-
# The default sorting order is ascending. To specify descending order for
|
|
2969
|
-
# a field, a suffix "desc" should be added to the field name. Example:
|
|
2970
|
-
# `displayName desc`.
|
|
2797
|
+
# Field by which to sort the list. Acceptable values are: * `combinedAudienceId`
|
|
2798
|
+
# (default) * `displayName` The default sorting order is ascending. To specify
|
|
2799
|
+
# descending order for a field, a suffix "desc" should be added to the field
|
|
2800
|
+
# name. Example: `displayName desc`.
|
|
2971
2801
|
# @param [Fixnum] page_size
|
|
2972
2802
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
2973
|
-
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
|
2974
|
-
#
|
|
2803
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
2804
|
+
# specified.
|
|
2975
2805
|
# @param [String] page_token
|
|
2976
|
-
# A token identifying a page of results the server should return.
|
|
2977
|
-
#
|
|
2978
|
-
#
|
|
2979
|
-
#
|
|
2980
|
-
# If not specified, the first page of results will be returned.
|
|
2806
|
+
# A token identifying a page of results the server should return. Typically,
|
|
2807
|
+
# this is the value of next_page_token returned from the previous call to `
|
|
2808
|
+
# ListCombinedAudiences` method. If not specified, the first page of results
|
|
2809
|
+
# will be returned.
|
|
2981
2810
|
# @param [Fixnum] partner_id
|
|
2982
2811
|
# The ID of the partner that has access to the fetched combined audiences.
|
|
2983
2812
|
# @param [String] fields
|
|
@@ -3016,8 +2845,7 @@ module Google
|
|
|
3016
2845
|
# @param [Fixnum] custom_list_id
|
|
3017
2846
|
# Required. The ID of the custom list to fetch.
|
|
3018
2847
|
# @param [Fixnum] advertiser_id
|
|
3019
|
-
# The ID of the DV360 advertiser that has access to the fetched custom
|
|
3020
|
-
# lists.
|
|
2848
|
+
# The ID of the DV360 advertiser that has access to the fetched custom lists.
|
|
3021
2849
|
# @param [String] fields
|
|
3022
2850
|
# Selector specifying which fields to include in a partial response.
|
|
3023
2851
|
# @param [String] quota_user
|
|
@@ -3046,43 +2874,30 @@ module Google
|
|
|
3046
2874
|
execute_or_queue_command(command, &block)
|
|
3047
2875
|
end
|
|
3048
2876
|
|
|
3049
|
-
# Lists custom lists.
|
|
3050
|
-
# The order is defined by the order_by
|
|
3051
|
-
# parameter.
|
|
2877
|
+
# Lists custom lists. The order is defined by the order_by parameter.
|
|
3052
2878
|
# @param [Fixnum] advertiser_id
|
|
3053
|
-
# The ID of the DV360 advertiser that has access to the fetched custom
|
|
3054
|
-
# lists.
|
|
2879
|
+
# The ID of the DV360 advertiser that has access to the fetched custom lists.
|
|
3055
2880
|
# @param [String] filter
|
|
3056
|
-
# Allows filtering by custom list fields.
|
|
3057
|
-
#
|
|
3058
|
-
#
|
|
3059
|
-
#
|
|
3060
|
-
#
|
|
3061
|
-
# * The operator must be `CONTAINS (:)`.
|
|
3062
|
-
# * Supported fields:
|
|
3063
|
-
# - `displayName`
|
|
3064
|
-
# Examples:
|
|
3065
|
-
# * All custom lists for which the display name contains "Google":
|
|
3066
|
-
# `displayName : "Google"`.
|
|
2881
|
+
# Allows filtering by custom list fields. Supported syntax: * Filter expressions
|
|
2882
|
+
# for custom lists currently can only contain at most one restriction. * A
|
|
2883
|
+
# restriction has the form of ``field` `operator` `value``. * The operator must
|
|
2884
|
+
# be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All custom
|
|
2885
|
+
# lists for which the display name contains "Google": `displayName : "Google"`.
|
|
3067
2886
|
# The length of this field should be no more than 500 characters.
|
|
3068
2887
|
# @param [String] order_by
|
|
3069
|
-
# Field by which to sort the list.
|
|
3070
|
-
#
|
|
3071
|
-
#
|
|
3072
|
-
#
|
|
3073
|
-
# The default sorting order is ascending. To specify descending order for
|
|
3074
|
-
# a field, a suffix "desc" should be added to the field name. Example:
|
|
3075
|
-
# `displayName desc`.
|
|
2888
|
+
# Field by which to sort the list. Acceptable values are: * `customListId` (
|
|
2889
|
+
# default) * `displayName` The default sorting order is ascending. To specify
|
|
2890
|
+
# descending order for a field, a suffix "desc" should be added to the field
|
|
2891
|
+
# name. Example: `displayName desc`.
|
|
3076
2892
|
# @param [Fixnum] page_size
|
|
3077
2893
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
3078
|
-
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
|
3079
|
-
#
|
|
2894
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
2895
|
+
# specified.
|
|
3080
2896
|
# @param [String] page_token
|
|
3081
|
-
# A token identifying a page of results the server should return.
|
|
3082
|
-
#
|
|
3083
|
-
#
|
|
3084
|
-
# returned
|
|
3085
|
-
# If not specified, the first page of results will be returned.
|
|
2897
|
+
# A token identifying a page of results the server should return. Typically,
|
|
2898
|
+
# this is the value of next_page_token returned from the previous call to `
|
|
2899
|
+
# ListCustomLists` method. If not specified, the first page of results will be
|
|
2900
|
+
# returned.
|
|
3086
2901
|
# @param [String] fields
|
|
3087
2902
|
# Selector specifying which fields to include in a partial response.
|
|
3088
2903
|
# @param [String] quota_user
|
|
@@ -3118,11 +2933,11 @@ module Google
|
|
|
3118
2933
|
# @param [Fixnum] first_and_third_party_audience_id
|
|
3119
2934
|
# Required. The ID of the first and third party audience to fetch.
|
|
3120
2935
|
# @param [Fixnum] advertiser_id
|
|
3121
|
-
# The ID of the advertiser that has access to the fetched first and
|
|
3122
|
-
#
|
|
2936
|
+
# The ID of the advertiser that has access to the fetched first and third party
|
|
2937
|
+
# audience.
|
|
3123
2938
|
# @param [Fixnum] partner_id
|
|
3124
|
-
# The ID of the partner that has access to the fetched first and
|
|
3125
|
-
#
|
|
2939
|
+
# The ID of the partner that has access to the fetched first and third party
|
|
2940
|
+
# audience.
|
|
3126
2941
|
# @param [String] fields
|
|
3127
2942
|
# Selector specifying which fields to include in a partial response.
|
|
3128
2943
|
# @param [String] quota_user
|
|
@@ -3152,46 +2967,36 @@ module Google
|
|
|
3152
2967
|
execute_or_queue_command(command, &block)
|
|
3153
2968
|
end
|
|
3154
2969
|
|
|
3155
|
-
# Lists first and third party audiences.
|
|
3156
|
-
#
|
|
3157
|
-
# order_by parameter.
|
|
2970
|
+
# Lists first and third party audiences. The order is defined by the order_by
|
|
2971
|
+
# parameter.
|
|
3158
2972
|
# @param [Fixnum] advertiser_id
|
|
3159
|
-
# The ID of the advertiser that has access to the fetched first and
|
|
3160
|
-
#
|
|
2973
|
+
# The ID of the advertiser that has access to the fetched first and third party
|
|
2974
|
+
# audiences.
|
|
3161
2975
|
# @param [String] filter
|
|
3162
|
-
# Allows filtering by first and third party audience fields.
|
|
3163
|
-
#
|
|
3164
|
-
#
|
|
3165
|
-
#
|
|
3166
|
-
# *
|
|
3167
|
-
#
|
|
3168
|
-
#
|
|
3169
|
-
# - `displayName`
|
|
3170
|
-
# Examples:
|
|
3171
|
-
# * All first and third party audiences for which the display name contains
|
|
3172
|
-
# "Google": `displayName : "Google"`.
|
|
3173
|
-
# The length of this field should be no more than 500 characters.
|
|
2976
|
+
# Allows filtering by first and third party audience fields. Supported syntax: *
|
|
2977
|
+
# Filter expressions for first and third party audiences currently can only
|
|
2978
|
+
# contain at most one restriction. * A restriction has the form of ``field` `
|
|
2979
|
+
# operator` `value``. * The operator must be `CONTAINS (:)`. * Supported fields:
|
|
2980
|
+
# - `displayName` Examples: * All first and third party audiences for which the
|
|
2981
|
+
# display name contains "Google": `displayName : "Google"`. The length of this
|
|
2982
|
+
# field should be no more than 500 characters.
|
|
3174
2983
|
# @param [String] order_by
|
|
3175
|
-
# Field by which to sort the list.
|
|
3176
|
-
#
|
|
3177
|
-
#
|
|
3178
|
-
#
|
|
3179
|
-
# The default sorting order is ascending. To specify descending order for
|
|
3180
|
-
# a field, a suffix "desc" should be added to the field name. Example:
|
|
3181
|
-
# `displayName desc`.
|
|
2984
|
+
# Field by which to sort the list. Acceptable values are: * `
|
|
2985
|
+
# firstAndThirdPartyAudienceId` (default) * `displayName` The default sorting
|
|
2986
|
+
# order is ascending. To specify descending order for a field, a suffix "desc"
|
|
2987
|
+
# should be added to the field name. Example: `displayName desc`.
|
|
3182
2988
|
# @param [Fixnum] page_size
|
|
3183
2989
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
3184
|
-
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
|
3185
|
-
#
|
|
2990
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
2991
|
+
# specified.
|
|
3186
2992
|
# @param [String] page_token
|
|
3187
|
-
# A token identifying a page of results the server should return.
|
|
3188
|
-
#
|
|
3189
|
-
#
|
|
3190
|
-
#
|
|
3191
|
-
# method. If not specified, the first page of results will be returned.
|
|
2993
|
+
# A token identifying a page of results the server should return. Typically,
|
|
2994
|
+
# this is the value of next_page_token returned from the previous call to `
|
|
2995
|
+
# ListFirstAndThirdPartyAudiences` method. If not specified, the first page of
|
|
2996
|
+
# results will be returned.
|
|
3192
2997
|
# @param [Fixnum] partner_id
|
|
3193
|
-
# The ID of the partner that has access to the fetched first and
|
|
3194
|
-
#
|
|
2998
|
+
# The ID of the partner that has access to the fetched first and third party
|
|
2999
|
+
# audiences.
|
|
3195
3000
|
# @param [String] fields
|
|
3196
3001
|
# Selector specifying which fields to include in a partial response.
|
|
3197
3002
|
# @param [String] quota_user
|
|
@@ -3257,8 +3062,8 @@ module Google
|
|
|
3257
3062
|
execute_or_queue_command(command, &block)
|
|
3258
3063
|
end
|
|
3259
3064
|
|
|
3260
|
-
# Updates an existing Floodlight group.
|
|
3261
|
-
#
|
|
3065
|
+
# Updates an existing Floodlight group. Returns the updated Floodlight group if
|
|
3066
|
+
# successful.
|
|
3262
3067
|
# @param [Fixnum] floodlight_group_id
|
|
3263
3068
|
# Output only. The unique ID of the Floodlight group. Assigned by the system.
|
|
3264
3069
|
# @param [Google::Apis::DisplayvideoV1::FloodlightGroup] floodlight_group_object
|
|
@@ -3333,42 +3138,31 @@ module Google
|
|
|
3333
3138
|
execute_or_queue_command(command, &block)
|
|
3334
3139
|
end
|
|
3335
3140
|
|
|
3336
|
-
# Lists Google audiences.
|
|
3337
|
-
# The order is defined by the order_by
|
|
3338
|
-
# parameter.
|
|
3141
|
+
# Lists Google audiences. The order is defined by the order_by parameter.
|
|
3339
3142
|
# @param [Fixnum] advertiser_id
|
|
3340
3143
|
# The ID of the advertiser that has access to the fetched Google audiences.
|
|
3341
3144
|
# @param [String] filter
|
|
3342
|
-
# Allows filtering by Google audience fields.
|
|
3343
|
-
#
|
|
3344
|
-
# *
|
|
3345
|
-
#
|
|
3346
|
-
# *
|
|
3347
|
-
#
|
|
3348
|
-
#
|
|
3349
|
-
# - `displayName`
|
|
3350
|
-
# Examples:
|
|
3351
|
-
# * All Google audiences for which the display name contains "Google":
|
|
3352
|
-
# `displayName : "Google"`.
|
|
3353
|
-
# The length of this field should be no more than 500 characters.
|
|
3145
|
+
# Allows filtering by Google audience fields. Supported syntax: * Filter
|
|
3146
|
+
# expressions for Google audiences currently can only contain at most one
|
|
3147
|
+
# restriction. * A restriction has the form of ``field` `operator` `value``. *
|
|
3148
|
+
# The operator must be `CONTAINS (:)`. * Supported fields: - `displayName`
|
|
3149
|
+
# Examples: * All Google audiences for which the display name contains "Google":
|
|
3150
|
+
# `displayName : "Google"`. The length of this field should be no more than 500
|
|
3151
|
+
# characters.
|
|
3354
3152
|
# @param [String] order_by
|
|
3355
|
-
# Field by which to sort the list.
|
|
3356
|
-
#
|
|
3357
|
-
#
|
|
3358
|
-
#
|
|
3359
|
-
# The default sorting order is ascending. To specify descending order for
|
|
3360
|
-
# a field, a suffix "desc" should be added to the field name. Example:
|
|
3361
|
-
# `displayName desc`.
|
|
3153
|
+
# Field by which to sort the list. Acceptable values are: * `googleAudienceId` (
|
|
3154
|
+
# default) * `displayName` The default sorting order is ascending. To specify
|
|
3155
|
+
# descending order for a field, a suffix "desc" should be added to the field
|
|
3156
|
+
# name. Example: `displayName desc`.
|
|
3362
3157
|
# @param [Fixnum] page_size
|
|
3363
3158
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
3364
|
-
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
|
3365
|
-
#
|
|
3159
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
3160
|
+
# specified.
|
|
3366
3161
|
# @param [String] page_token
|
|
3367
|
-
# A token identifying a page of results the server should return.
|
|
3368
|
-
#
|
|
3369
|
-
#
|
|
3370
|
-
# returned
|
|
3371
|
-
# If not specified, the first page of results will be returned.
|
|
3162
|
+
# A token identifying a page of results the server should return. Typically,
|
|
3163
|
+
# this is the value of next_page_token returned from the previous call to `
|
|
3164
|
+
# ListGoogleAudiences` method. If not specified, the first page of results will
|
|
3165
|
+
# be returned.
|
|
3372
3166
|
# @param [Fixnum] partner_id
|
|
3373
3167
|
# The ID of the partner that has access to the fetched Google audiences.
|
|
3374
3168
|
# @param [String] fields
|
|
@@ -3407,13 +3201,12 @@ module Google
|
|
|
3407
3201
|
# source group if successful.
|
|
3408
3202
|
# @param [Google::Apis::DisplayvideoV1::InventorySourceGroup] inventory_source_group_object
|
|
3409
3203
|
# @param [Fixnum] advertiser_id
|
|
3410
|
-
# The ID of the advertiser that owns the inventory source group.
|
|
3411
|
-
#
|
|
3204
|
+
# The ID of the advertiser that owns the inventory source group. The parent
|
|
3205
|
+
# partner will not have access to this group.
|
|
3412
3206
|
# @param [Fixnum] partner_id
|
|
3413
|
-
# The ID of the partner that owns the inventory source group.
|
|
3414
|
-
#
|
|
3415
|
-
#
|
|
3416
|
-
# group.
|
|
3207
|
+
# The ID of the partner that owns the inventory source group. Only this partner
|
|
3208
|
+
# will have write access to this group. Only advertisers to which this group is
|
|
3209
|
+
# explicitly shared will have read access to this group.
|
|
3417
3210
|
# @param [String] fields
|
|
3418
3211
|
# Selector specifying which fields to include in a partial response.
|
|
3419
3212
|
# @param [String] quota_user
|
|
@@ -3448,11 +3241,11 @@ module Google
|
|
|
3448
3241
|
# @param [Fixnum] inventory_source_group_id
|
|
3449
3242
|
# Required. The ID of the inventory source group to delete.
|
|
3450
3243
|
# @param [Fixnum] advertiser_id
|
|
3451
|
-
# The ID of the advertiser that owns the inventory source group.
|
|
3452
|
-
#
|
|
3244
|
+
# The ID of the advertiser that owns the inventory source group. The parent
|
|
3245
|
+
# partner does not have access to this group.
|
|
3453
3246
|
# @param [Fixnum] partner_id
|
|
3454
|
-
# The ID of the partner that owns the inventory source group.
|
|
3455
|
-
#
|
|
3247
|
+
# The ID of the partner that owns the inventory source group. Only this partner
|
|
3248
|
+
# has write access to this group.
|
|
3456
3249
|
# @param [String] fields
|
|
3457
3250
|
# Selector specifying which fields to include in a partial response.
|
|
3458
3251
|
# @param [String] quota_user
|
|
@@ -3486,12 +3279,12 @@ module Google
|
|
|
3486
3279
|
# @param [Fixnum] inventory_source_group_id
|
|
3487
3280
|
# Required. The ID of the inventory source group to fetch.
|
|
3488
3281
|
# @param [Fixnum] advertiser_id
|
|
3489
|
-
# The ID of the advertiser that has access to the inventory source group.
|
|
3490
|
-
#
|
|
3491
|
-
#
|
|
3282
|
+
# The ID of the advertiser that has access to the inventory source group. If an
|
|
3283
|
+
# inventory source group is partner-owned, only advertisers to which the group
|
|
3284
|
+
# is explicitly shared can access the group.
|
|
3492
3285
|
# @param [Fixnum] partner_id
|
|
3493
|
-
# The ID of the partner that has access to the inventory source group.
|
|
3494
|
-
#
|
|
3286
|
+
# The ID of the partner that has access to the inventory source group. A partner
|
|
3287
|
+
# cannot access an advertiser-owned inventory source group.
|
|
3495
3288
|
# @param [String] fields
|
|
3496
3289
|
# Selector specifying which fields to include in a partial response.
|
|
3497
3290
|
# @param [String] quota_user
|
|
@@ -3521,43 +3314,35 @@ module Google
|
|
|
3521
3314
|
execute_or_queue_command(command, &block)
|
|
3522
3315
|
end
|
|
3523
3316
|
|
|
3524
|
-
# Lists inventory source groups that are accessible to the current user.
|
|
3525
|
-
#
|
|
3526
|
-
# order_by parameter.
|
|
3317
|
+
# Lists inventory source groups that are accessible to the current user. The
|
|
3318
|
+
# order is defined by the order_by parameter.
|
|
3527
3319
|
# @param [Fixnum] advertiser_id
|
|
3528
|
-
# The ID of the advertiser that has access to the inventory source group.
|
|
3529
|
-
#
|
|
3530
|
-
#
|
|
3320
|
+
# The ID of the advertiser that has access to the inventory source group. If an
|
|
3321
|
+
# inventory source group is partner-owned, only advertisers to which the group
|
|
3322
|
+
# is explicitly shared can access the group.
|
|
3531
3323
|
# @param [String] filter
|
|
3532
|
-
# Allows filtering by inventory source group properties.
|
|
3533
|
-
#
|
|
3534
|
-
#
|
|
3535
|
-
#
|
|
3536
|
-
#
|
|
3537
|
-
#
|
|
3538
|
-
# * Supported fields:
|
|
3539
|
-
# - `inventorySourceGroupId`
|
|
3540
|
-
# The length of this field should be no more than 500 characters.
|
|
3324
|
+
# Allows filtering by inventory source group properties. Supported syntax: *
|
|
3325
|
+
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
3326
|
+
# be combined by the logical operator `OR`. * A restriction has the form of ``
|
|
3327
|
+
# field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported
|
|
3328
|
+
# fields: - `inventorySourceGroupId` The length of this field should be no more
|
|
3329
|
+
# than 500 characters.
|
|
3541
3330
|
# @param [String] order_by
|
|
3542
|
-
# Field by which to sort the list.
|
|
3543
|
-
#
|
|
3544
|
-
#
|
|
3545
|
-
#
|
|
3546
|
-
# The default sorting order is ascending. To specify descending order for
|
|
3547
|
-
# a field, a suffix "desc" should be added to the field name. For example,
|
|
3548
|
-
# `displayName desc`.
|
|
3331
|
+
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
3332
|
+
# default) * `inventorySourceGroupId` The default sorting order is ascending. To
|
|
3333
|
+
# specify descending order for a field, a suffix "desc" should be added to the
|
|
3334
|
+
# field name. For example, `displayName desc`.
|
|
3549
3335
|
# @param [Fixnum] page_size
|
|
3550
3336
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
3551
3337
|
# default to `100`.
|
|
3552
3338
|
# @param [String] page_token
|
|
3553
|
-
# A token identifying a page of results the server should return.
|
|
3554
|
-
#
|
|
3555
|
-
#
|
|
3556
|
-
# returned
|
|
3557
|
-
# If not specified, the first page of results will be returned.
|
|
3339
|
+
# A token identifying a page of results the server should return. Typically,
|
|
3340
|
+
# this is the value of next_page_token returned from the previous call to `
|
|
3341
|
+
# ListInventorySources` method. If not specified, the first page of results will
|
|
3342
|
+
# be returned.
|
|
3558
3343
|
# @param [Fixnum] partner_id
|
|
3559
|
-
# The ID of the partner that has access to the inventory source group.
|
|
3560
|
-
#
|
|
3344
|
+
# The ID of the partner that has access to the inventory source group. A partner
|
|
3345
|
+
# cannot access advertiser-owned inventory source groups.
|
|
3561
3346
|
# @param [String] fields
|
|
3562
3347
|
# Selector specifying which fields to include in a partial response.
|
|
3563
3348
|
# @param [String] quota_user
|
|
@@ -3590,18 +3375,18 @@ module Google
|
|
|
3590
3375
|
execute_or_queue_command(command, &block)
|
|
3591
3376
|
end
|
|
3592
3377
|
|
|
3593
|
-
# Updates an inventory source group. Returns the updated inventory source
|
|
3594
|
-
#
|
|
3378
|
+
# Updates an inventory source group. Returns the updated inventory source group
|
|
3379
|
+
# if successful.
|
|
3595
3380
|
# @param [Fixnum] inventory_source_group_id
|
|
3596
3381
|
# Output only. The unique ID of the inventory source group. Assigned by the
|
|
3597
3382
|
# system.
|
|
3598
3383
|
# @param [Google::Apis::DisplayvideoV1::InventorySourceGroup] inventory_source_group_object
|
|
3599
3384
|
# @param [Fixnum] advertiser_id
|
|
3600
|
-
# The ID of the advertiser that owns the inventory source group.
|
|
3601
|
-
#
|
|
3385
|
+
# The ID of the advertiser that owns the inventory source group. The parent
|
|
3386
|
+
# partner does not have access to this group.
|
|
3602
3387
|
# @param [Fixnum] partner_id
|
|
3603
|
-
# The ID of the partner that owns the inventory source group.
|
|
3604
|
-
#
|
|
3388
|
+
# The ID of the partner that owns the inventory source group. Only this partner
|
|
3389
|
+
# has write access to this group.
|
|
3605
3390
|
# @param [String] update_mask
|
|
3606
3391
|
# Required. The mask to control which fields to update.
|
|
3607
3392
|
# @param [String] fields
|
|
@@ -3637,11 +3422,11 @@ module Google
|
|
|
3637
3422
|
end
|
|
3638
3423
|
|
|
3639
3424
|
# Bulk edits multiple assignments between inventory sources and a single
|
|
3640
|
-
# inventory source group.
|
|
3641
|
-
#
|
|
3642
|
-
#
|
|
3643
|
-
#
|
|
3644
|
-
#
|
|
3425
|
+
# inventory source group. The operation will delete the assigned inventory
|
|
3426
|
+
# sources provided in BulkEditAssignedInventorySourcesRequest.
|
|
3427
|
+
# deleted_assigned_inventory_sources and then create the assigned inventory
|
|
3428
|
+
# sources provided in BulkEditAssignedInventorySourcesRequest.
|
|
3429
|
+
# created_assigned_inventory_sources.
|
|
3645
3430
|
# @param [Fixnum] inventory_source_group_id
|
|
3646
3431
|
# Required. The ID of the inventory source group to which the assignments are
|
|
3647
3432
|
# assigned.
|
|
@@ -3682,13 +3467,11 @@ module Google
|
|
|
3682
3467
|
# assigned.
|
|
3683
3468
|
# @param [Google::Apis::DisplayvideoV1::AssignedInventorySource] assigned_inventory_source_object
|
|
3684
3469
|
# @param [Fixnum] advertiser_id
|
|
3685
|
-
# The ID of the advertiser that owns the parent inventory source group.
|
|
3686
|
-
#
|
|
3687
|
-
# source.
|
|
3470
|
+
# The ID of the advertiser that owns the parent inventory source group. The
|
|
3471
|
+
# parent partner will not have access to this assigned inventory source.
|
|
3688
3472
|
# @param [Fixnum] partner_id
|
|
3689
|
-
# The ID of the partner that owns the parent inventory source group.
|
|
3690
|
-
#
|
|
3691
|
-
# source.
|
|
3473
|
+
# The ID of the partner that owns the parent inventory source group. Only this
|
|
3474
|
+
# partner will have write access to this assigned inventory source.
|
|
3692
3475
|
# @param [String] fields
|
|
3693
3476
|
# Selector specifying which fields to include in a partial response.
|
|
3694
3477
|
# @param [String] quota_user
|
|
@@ -3728,12 +3511,11 @@ module Google
|
|
|
3728
3511
|
# @param [Fixnum] assigned_inventory_source_id
|
|
3729
3512
|
# Required. The ID of the assigned inventory source to delete.
|
|
3730
3513
|
# @param [Fixnum] advertiser_id
|
|
3731
|
-
# The ID of the advertiser that owns the parent inventory source group.
|
|
3732
|
-
#
|
|
3733
|
-
# source.
|
|
3514
|
+
# The ID of the advertiser that owns the parent inventory source group. The
|
|
3515
|
+
# parent partner does not have access to this assigned inventory source.
|
|
3734
3516
|
# @param [Fixnum] partner_id
|
|
3735
|
-
# The ID of the partner that owns the parent inventory source group.
|
|
3736
|
-
#
|
|
3517
|
+
# The ID of the partner that owns the parent inventory source group. Only this
|
|
3518
|
+
# partner has write access to this assigned inventory source.
|
|
3737
3519
|
# @param [String] fields
|
|
3738
3520
|
# Selector specifying which fields to include in a partial response.
|
|
3739
3521
|
# @param [String] quota_user
|
|
@@ -3769,41 +3551,34 @@ module Google
|
|
|
3769
3551
|
# Required. The ID of the inventory source group to which these assignments are
|
|
3770
3552
|
# assigned.
|
|
3771
3553
|
# @param [Fixnum] advertiser_id
|
|
3772
|
-
# The ID of the advertiser that has access to the assignment.
|
|
3773
|
-
#
|
|
3774
|
-
#
|
|
3775
|
-
# inventory source.
|
|
3554
|
+
# The ID of the advertiser that has access to the assignment. If the parent
|
|
3555
|
+
# inventory source group is partner-owned, only advertisers to which the parent
|
|
3556
|
+
# group is explicitly shared can access the assigned inventory source.
|
|
3776
3557
|
# @param [String] filter
|
|
3777
|
-
# Allows filtering by assigned inventory source fields.
|
|
3778
|
-
#
|
|
3779
|
-
#
|
|
3780
|
-
#
|
|
3781
|
-
#
|
|
3782
|
-
#
|
|
3783
|
-
# * Supported fields:
|
|
3784
|
-
# - `assignedInventorySourceId`
|
|
3785
|
-
# The length of this field should be no more than 500 characters.
|
|
3558
|
+
# Allows filtering by assigned inventory source fields. Supported syntax: *
|
|
3559
|
+
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
3560
|
+
# be combined by the logical operator `OR`. * A restriction has the form of ``
|
|
3561
|
+
# field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported
|
|
3562
|
+
# fields: - `assignedInventorySourceId` The length of this field should be no
|
|
3563
|
+
# more than 500 characters.
|
|
3786
3564
|
# @param [String] order_by
|
|
3787
|
-
# Field by which to sort the list.
|
|
3788
|
-
#
|
|
3789
|
-
#
|
|
3790
|
-
#
|
|
3791
|
-
# field, a suffix " desc" should be added to the field name. Example:
|
|
3792
|
-
# `assignedInventorySourceId desc`.
|
|
3565
|
+
# Field by which to sort the list. Acceptable values are: * `
|
|
3566
|
+
# assignedInventorySourceId` (default) The default sorting order is ascending.
|
|
3567
|
+
# To specify descending order for a field, a suffix " desc" should be added to
|
|
3568
|
+
# the field name. Example: `assignedInventorySourceId desc`.
|
|
3793
3569
|
# @param [Fixnum] page_size
|
|
3794
3570
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
3795
|
-
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
|
3796
|
-
#
|
|
3571
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
3572
|
+
# specified.
|
|
3797
3573
|
# @param [String] page_token
|
|
3798
|
-
# A token identifying a page of results the server should return.
|
|
3799
|
-
#
|
|
3800
|
-
#
|
|
3801
|
-
#
|
|
3802
|
-
# method. If not specified, the first page of results will be returned.
|
|
3574
|
+
# A token identifying a page of results the server should return. Typically,
|
|
3575
|
+
# this is the value of next_page_token returned from the previous call to `
|
|
3576
|
+
# ListAssignedInventorySources` method. If not specified, the first page of
|
|
3577
|
+
# results will be returned.
|
|
3803
3578
|
# @param [Fixnum] partner_id
|
|
3804
|
-
# The ID of the partner that has access to the assignment.
|
|
3805
|
-
#
|
|
3806
|
-
#
|
|
3579
|
+
# The ID of the partner that has access to the assignment. If the parent
|
|
3580
|
+
# inventory source group is advertiser-owned, the assignment cannot be accessed
|
|
3581
|
+
# via a partner.
|
|
3807
3582
|
# @param [String] fields
|
|
3808
3583
|
# Selector specifying which fields to include in a partial response.
|
|
3809
3584
|
# @param [String] quota_user
|
|
@@ -3841,8 +3616,8 @@ module Google
|
|
|
3841
3616
|
# @param [Fixnum] inventory_source_id
|
|
3842
3617
|
# Required. The ID of the inventory source to fetch.
|
|
3843
3618
|
# @param [Fixnum] partner_id
|
|
3844
|
-
# Required. The ID of the DV360 partner to which the fetched inventory source
|
|
3845
|
-
#
|
|
3619
|
+
# Required. The ID of the DV360 partner to which the fetched inventory source is
|
|
3620
|
+
# permissioned.
|
|
3846
3621
|
# @param [String] fields
|
|
3847
3622
|
# Selector specifying which fields to include in a partial response.
|
|
3848
3623
|
# @param [String] quota_user
|
|
@@ -3871,51 +3646,37 @@ module Google
|
|
|
3871
3646
|
execute_or_queue_command(command, &block)
|
|
3872
3647
|
end
|
|
3873
3648
|
|
|
3874
|
-
# Lists inventory sources that are accessible to the current user.
|
|
3875
|
-
#
|
|
3876
|
-
#
|
|
3877
|
-
#
|
|
3878
|
-
# entity_status is not
|
|
3879
|
-
# specified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED`
|
|
3880
|
-
# will not be included in the results.
|
|
3649
|
+
# Lists inventory sources that are accessible to the current user. The order is
|
|
3650
|
+
# defined by the order_by parameter. If a filter by entity_status is not
|
|
3651
|
+
# specified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED` will
|
|
3652
|
+
# not be included in the results.
|
|
3881
3653
|
# @param [Fixnum] advertiser_id
|
|
3882
3654
|
# The ID of the advertiser that has access to the inventory source.
|
|
3883
3655
|
# @param [String] filter
|
|
3884
|
-
# Allows filtering by inventory source properties.
|
|
3885
|
-
#
|
|
3886
|
-
#
|
|
3887
|
-
# *
|
|
3888
|
-
#
|
|
3889
|
-
#
|
|
3890
|
-
# *
|
|
3891
|
-
# *
|
|
3892
|
-
#
|
|
3893
|
-
#
|
|
3894
|
-
#
|
|
3895
|
-
# - `rateDetails.rateType`
|
|
3896
|
-
# - `exchange`
|
|
3897
|
-
# Examples:
|
|
3898
|
-
# * All active inventory sources:
|
|
3899
|
-
# `status.entityStatus="ENTITY_STATUS_ACTIVE"`
|
|
3900
|
-
# * Inventory sources belonging to Google Ad Manager or Rubicon exchanges:
|
|
3901
|
-
# `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"`
|
|
3902
|
-
# The length of this field should be no more than 500 characters.
|
|
3656
|
+
# Allows filtering by inventory source properties. Supported syntax: * Filter
|
|
3657
|
+
# expressions are made up of one or more restrictions. * Restrictions can be
|
|
3658
|
+
# combined by `AND` or `OR` logical operators. A sequence of restrictions
|
|
3659
|
+
# implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
|
|
3660
|
+
# value``. * The operator must be `EQUALS (=)`. * Supported fields: - `status.
|
|
3661
|
+
# entityStatus` - `commitment` - `deliveryMethod` - `rateDetails.rateType` - `
|
|
3662
|
+
# exchange` Examples: * All active inventory sources: `status.entityStatus="
|
|
3663
|
+
# ENTITY_STATUS_ACTIVE"` * Inventory sources belonging to Google Ad Manager or
|
|
3664
|
+
# Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="
|
|
3665
|
+
# EXCHANGE_RUBICON"` The length of this field should be no more than 500
|
|
3666
|
+
# characters.
|
|
3903
3667
|
# @param [String] order_by
|
|
3904
|
-
# Field by which to sort the list.
|
|
3905
|
-
#
|
|
3906
|
-
#
|
|
3907
|
-
#
|
|
3908
|
-
# a field, a suffix "desc" should be added to the field name. For example,
|
|
3909
|
-
# `displayName desc`.
|
|
3668
|
+
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
3669
|
+
# default) The default sorting order is ascending. To specify descending order
|
|
3670
|
+
# for a field, a suffix "desc" should be added to the field name. For example, `
|
|
3671
|
+
# displayName desc`.
|
|
3910
3672
|
# @param [Fixnum] page_size
|
|
3911
3673
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
3912
3674
|
# default to `100`.
|
|
3913
3675
|
# @param [String] page_token
|
|
3914
|
-
# A token identifying a page of results the server should return.
|
|
3915
|
-
#
|
|
3916
|
-
#
|
|
3917
|
-
# returned
|
|
3918
|
-
# If not specified, the first page of results will be returned.
|
|
3676
|
+
# A token identifying a page of results the server should return. Typically,
|
|
3677
|
+
# this is the value of next_page_token returned from the previous call to `
|
|
3678
|
+
# ListInventorySources` method. If not specified, the first page of results will
|
|
3679
|
+
# be returned.
|
|
3919
3680
|
# @param [Fixnum] partner_id
|
|
3920
3681
|
# The ID of the partner that has access to the inventory source.
|
|
3921
3682
|
# @param [String] fields
|
|
@@ -3951,12 +3712,10 @@ module Google
|
|
|
3951
3712
|
end
|
|
3952
3713
|
|
|
3953
3714
|
# Downloads media. Download is supported on the URI `/download/`resource_name=**`
|
|
3954
|
-
# ?alt=media.`
|
|
3955
|
-
#
|
|
3956
|
-
# media` query string.
|
|
3715
|
+
# ?alt=media.` **Note**: Download requests will not be successful without
|
|
3716
|
+
# including `alt=media` query string.
|
|
3957
3717
|
# @param [String] resource_name
|
|
3958
|
-
# Name of the media that is being downloaded.
|
|
3959
|
-
# ReadRequest.resource_name.
|
|
3718
|
+
# Name of the media that is being downloaded. See ReadRequest.resource_name.
|
|
3960
3719
|
# @param [String] fields
|
|
3961
3720
|
# Selector specifying which fields to include in a partial response.
|
|
3962
3721
|
# @param [String] quota_user
|
|
@@ -3991,6 +3750,126 @@ module Google
|
|
|
3991
3750
|
execute_or_queue_command(command, &block)
|
|
3992
3751
|
end
|
|
3993
3752
|
|
|
3753
|
+
# Bulk edits targeting options under a single partner. The operation will delete
|
|
3754
|
+
# the assigned targeting options provided in
|
|
3755
|
+
# BulkEditPartnerAssignedTargetingOptionsRequest.delete_requests and then create
|
|
3756
|
+
# the assigned targeting options provided in
|
|
3757
|
+
# BulkEditPartnerAssignedTargetingOptionsRequest.create_requests .
|
|
3758
|
+
# @param [Fixnum] partner_id
|
|
3759
|
+
# Required. The ID of the partner.
|
|
3760
|
+
# @param [Google::Apis::DisplayvideoV1::BulkEditPartnerAssignedTargetingOptionsRequest] bulk_edit_partner_assigned_targeting_options_request_object
|
|
3761
|
+
# @param [String] fields
|
|
3762
|
+
# Selector specifying which fields to include in a partial response.
|
|
3763
|
+
# @param [String] quota_user
|
|
3764
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
3765
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
3766
|
+
# @param [Google::Apis::RequestOptions] options
|
|
3767
|
+
# Request-specific options
|
|
3768
|
+
#
|
|
3769
|
+
# @yield [result, err] Result & error if block supplied
|
|
3770
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::BulkEditPartnerAssignedTargetingOptionsResponse] parsed result object
|
|
3771
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
3772
|
+
#
|
|
3773
|
+
# @return [Google::Apis::DisplayvideoV1::BulkEditPartnerAssignedTargetingOptionsResponse]
|
|
3774
|
+
#
|
|
3775
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
3776
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
3777
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
3778
|
+
def bulk_edit_partner_assigned_targeting_options(partner_id, bulk_edit_partner_assigned_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
3779
|
+
command = make_simple_command(:post, 'v1/partners/{+partnerId}:bulkEditPartnerAssignedTargetingOptions', options)
|
|
3780
|
+
command.request_representation = Google::Apis::DisplayvideoV1::BulkEditPartnerAssignedTargetingOptionsRequest::Representation
|
|
3781
|
+
command.request_object = bulk_edit_partner_assigned_targeting_options_request_object
|
|
3782
|
+
command.response_representation = Google::Apis::DisplayvideoV1::BulkEditPartnerAssignedTargetingOptionsResponse::Representation
|
|
3783
|
+
command.response_class = Google::Apis::DisplayvideoV1::BulkEditPartnerAssignedTargetingOptionsResponse
|
|
3784
|
+
command.params['partnerId'] = partner_id unless partner_id.nil?
|
|
3785
|
+
command.query['fields'] = fields unless fields.nil?
|
|
3786
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
3787
|
+
execute_or_queue_command(command, &block)
|
|
3788
|
+
end
|
|
3789
|
+
|
|
3790
|
+
# Gets a partner.
|
|
3791
|
+
# @param [Fixnum] partner_id
|
|
3792
|
+
# Required. The ID of the partner to fetch.
|
|
3793
|
+
# @param [String] fields
|
|
3794
|
+
# Selector specifying which fields to include in a partial response.
|
|
3795
|
+
# @param [String] quota_user
|
|
3796
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
3797
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
3798
|
+
# @param [Google::Apis::RequestOptions] options
|
|
3799
|
+
# Request-specific options
|
|
3800
|
+
#
|
|
3801
|
+
# @yield [result, err] Result & error if block supplied
|
|
3802
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Partner] parsed result object
|
|
3803
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
3804
|
+
#
|
|
3805
|
+
# @return [Google::Apis::DisplayvideoV1::Partner]
|
|
3806
|
+
#
|
|
3807
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
3808
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
3809
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
3810
|
+
def get_partner(partner_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
3811
|
+
command = make_simple_command(:get, 'v1/partners/{+partnerId}', options)
|
|
3812
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Partner::Representation
|
|
3813
|
+
command.response_class = Google::Apis::DisplayvideoV1::Partner
|
|
3814
|
+
command.params['partnerId'] = partner_id unless partner_id.nil?
|
|
3815
|
+
command.query['fields'] = fields unless fields.nil?
|
|
3816
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
3817
|
+
execute_or_queue_command(command, &block)
|
|
3818
|
+
end
|
|
3819
|
+
|
|
3820
|
+
# Lists partners that are accessible to the current user. The order is defined
|
|
3821
|
+
# by the order_by parameter.
|
|
3822
|
+
# @param [String] filter
|
|
3823
|
+
# Allows filtering by partner properties. Supported syntax: * Filter expressions
|
|
3824
|
+
# are made up of one or more restrictions. * Restrictions can be combined by `
|
|
3825
|
+
# AND` or `OR` logical operators. A sequence of restrictions implicitly uses `
|
|
3826
|
+
# AND`. * A restriction has the form of ``field` `operator` `value``. * The
|
|
3827
|
+
# operator must be `EQUALS (=)`. * Supported fields: - `entityStatus` Examples: *
|
|
3828
|
+
# All active partners: `entityStatus="ENTITY_STATUS_ACTIVE"` The length of this
|
|
3829
|
+
# field should be no more than 500 characters.
|
|
3830
|
+
# @param [String] order_by
|
|
3831
|
+
# Field by which to sort the list. Acceptable values are: * `displayName` The
|
|
3832
|
+
# default sorting order is ascending. To specify descending order for a field, a
|
|
3833
|
+
# suffix "desc" should be added to the field name. For example, `displayName
|
|
3834
|
+
# desc`.
|
|
3835
|
+
# @param [Fixnum] page_size
|
|
3836
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
3837
|
+
# default to `100`.
|
|
3838
|
+
# @param [String] page_token
|
|
3839
|
+
# A token identifying a page of results the server should return. Typically,
|
|
3840
|
+
# this is the value of next_page_token returned from the previous call to `
|
|
3841
|
+
# ListPartners` method. If not specified, the first page of results will be
|
|
3842
|
+
# returned.
|
|
3843
|
+
# @param [String] fields
|
|
3844
|
+
# Selector specifying which fields to include in a partial response.
|
|
3845
|
+
# @param [String] quota_user
|
|
3846
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
3847
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
3848
|
+
# @param [Google::Apis::RequestOptions] options
|
|
3849
|
+
# Request-specific options
|
|
3850
|
+
#
|
|
3851
|
+
# @yield [result, err] Result & error if block supplied
|
|
3852
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListPartnersResponse] parsed result object
|
|
3853
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
3854
|
+
#
|
|
3855
|
+
# @return [Google::Apis::DisplayvideoV1::ListPartnersResponse]
|
|
3856
|
+
#
|
|
3857
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
3858
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
3859
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
3860
|
+
def list_partners(filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
3861
|
+
command = make_simple_command(:get, 'v1/partners', options)
|
|
3862
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListPartnersResponse::Representation
|
|
3863
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListPartnersResponse
|
|
3864
|
+
command.query['filter'] = filter unless filter.nil?
|
|
3865
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
|
3866
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
3867
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
3868
|
+
command.query['fields'] = fields unless fields.nil?
|
|
3869
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
3870
|
+
execute_or_queue_command(command, &block)
|
|
3871
|
+
end
|
|
3872
|
+
|
|
3994
3873
|
# Creates a new channel. Returns the newly created channel if successful.
|
|
3995
3874
|
# @param [Fixnum] partner_id
|
|
3996
3875
|
# The ID of the partner that owns the created channel.
|
|
@@ -4069,36 +3948,26 @@ module Google
|
|
|
4069
3948
|
# @param [Fixnum] advertiser_id
|
|
4070
3949
|
# The ID of the advertiser that owns the channels.
|
|
4071
3950
|
# @param [String] filter
|
|
4072
|
-
# Allows filtering by channel fields.
|
|
4073
|
-
#
|
|
4074
|
-
#
|
|
4075
|
-
# *
|
|
4076
|
-
#
|
|
4077
|
-
#
|
|
4078
|
-
# * Supported fields:
|
|
4079
|
-
# - `displayName`
|
|
4080
|
-
# Examples:
|
|
4081
|
-
# * All channels for which the display name contains "google":
|
|
4082
|
-
# `displayName : "google"`.
|
|
4083
|
-
# The length of this field should be no more than 500 characters.
|
|
3951
|
+
# Allows filtering by channel fields. Supported syntax: * Filter expressions for
|
|
3952
|
+
# channel currently can only contain at most one * restriction. * A restriction
|
|
3953
|
+
# has the form of ``field` `operator` `value``. * The operator must be `CONTAINS
|
|
3954
|
+
# (:)`. * Supported fields: - `displayName` Examples: * All channels for which
|
|
3955
|
+
# the display name contains "google": `displayName : "google"`. The length of
|
|
3956
|
+
# this field should be no more than 500 characters.
|
|
4084
3957
|
# @param [String] order_by
|
|
4085
|
-
# Field by which to sort the list.
|
|
4086
|
-
#
|
|
4087
|
-
#
|
|
4088
|
-
#
|
|
4089
|
-
# The default sorting order is ascending. To specify descending order for a
|
|
4090
|
-
# field, a suffix " desc" should be added to the field name. Example:
|
|
4091
|
-
# `displayName desc`.
|
|
3958
|
+
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
3959
|
+
# default) * `channelId` The default sorting order is ascending. To specify
|
|
3960
|
+
# descending order for a field, a suffix " desc" should be added to the field
|
|
3961
|
+
# name. Example: `displayName desc`.
|
|
4092
3962
|
# @param [Fixnum] page_size
|
|
4093
3963
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
4094
|
-
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
|
4095
|
-
#
|
|
3964
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
3965
|
+
# specified.
|
|
4096
3966
|
# @param [String] page_token
|
|
4097
|
-
# A token identifying a page of results the server should return.
|
|
4098
|
-
#
|
|
4099
|
-
#
|
|
4100
|
-
#
|
|
4101
|
-
# of results will be returned.
|
|
3967
|
+
# A token identifying a page of results the server should return. Typically,
|
|
3968
|
+
# this is the value of next_page_token returned from the previous call to `
|
|
3969
|
+
# ListChannels` method. If not specified, the first page of results will be
|
|
3970
|
+
# returned.
|
|
4102
3971
|
# @param [String] fields
|
|
4103
3972
|
# Selector specifying which fields to include in a partial response.
|
|
4104
3973
|
# @param [String] quota_user
|
|
@@ -4173,9 +4042,8 @@ module Google
|
|
|
4173
4042
|
execute_or_queue_command(command, &block)
|
|
4174
4043
|
end
|
|
4175
4044
|
|
|
4176
|
-
# Bulk edits sites under a single channel.
|
|
4177
|
-
#
|
|
4178
|
-
# BulkEditSitesRequest.deleted_sites and then create the sites
|
|
4045
|
+
# Bulk edits sites under a single channel. The operation will delete the sites
|
|
4046
|
+
# provided in BulkEditSitesRequest.deleted_sites and then create the sites
|
|
4179
4047
|
# provided in BulkEditSitesRequest.created_sites.
|
|
4180
4048
|
# @param [Fixnum] partner_id
|
|
4181
4049
|
# The ID of the partner that owns the parent channel.
|
|
@@ -4298,34 +4166,25 @@ module Google
|
|
|
4298
4166
|
# @param [Fixnum] advertiser_id
|
|
4299
4167
|
# The ID of the advertiser that owns the parent channel.
|
|
4300
4168
|
# @param [String] filter
|
|
4301
|
-
# Allows filtering by site fields.
|
|
4302
|
-
#
|
|
4303
|
-
#
|
|
4304
|
-
# *
|
|
4305
|
-
#
|
|
4306
|
-
# * The operator must be `CONTAINS (:)`.
|
|
4307
|
-
# * Supported fields:
|
|
4308
|
-
# - `urlOrAppId`
|
|
4309
|
-
# Examples:
|
|
4310
|
-
# * All sites for which the URL or app ID contains "google":
|
|
4311
|
-
# `urlOrAppId : "google"`
|
|
4169
|
+
# Allows filtering by site fields. Supported syntax: * Filter expressions for
|
|
4170
|
+
# site currently can only contain at most one * restriction. * A restriction has
|
|
4171
|
+
# the form of ``field` `operator` `value``. * The operator must be `CONTAINS (:)`
|
|
4172
|
+
# . * Supported fields: - `urlOrAppId` Examples: * All sites for which the URL
|
|
4173
|
+
# or app ID contains "google": `urlOrAppId : "google"`
|
|
4312
4174
|
# @param [String] order_by
|
|
4313
|
-
# Field by which to sort the list.
|
|
4314
|
-
#
|
|
4315
|
-
#
|
|
4316
|
-
#
|
|
4317
|
-
# field, a suffix " desc" should be added to the field name. Example:
|
|
4318
|
-
# `urlOrAppId desc`.
|
|
4175
|
+
# Field by which to sort the list. Acceptable values are: * `urlOrAppId` (
|
|
4176
|
+
# default) The default sorting order is ascending. To specify descending order
|
|
4177
|
+
# for a field, a suffix " desc" should be added to the field name. Example: `
|
|
4178
|
+
# urlOrAppId desc`.
|
|
4319
4179
|
# @param [Fixnum] page_size
|
|
4320
4180
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
4321
|
-
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
|
4322
|
-
#
|
|
4181
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
4182
|
+
# specified.
|
|
4323
4183
|
# @param [String] page_token
|
|
4324
|
-
# A token identifying a page of results the server should return.
|
|
4325
|
-
#
|
|
4326
|
-
#
|
|
4327
|
-
#
|
|
4328
|
-
# of results will be returned.
|
|
4184
|
+
# A token identifying a page of results the server should return. Typically,
|
|
4185
|
+
# this is the value of next_page_token returned from the previous call to `
|
|
4186
|
+
# ListSites` method. If not specified, the first page of results will be
|
|
4187
|
+
# returned.
|
|
4329
4188
|
# @param [String] fields
|
|
4330
4189
|
# Selector specifying which fields to include in a partial response.
|
|
4331
4190
|
# @param [String] quota_user
|
|
@@ -4359,21 +4218,186 @@ module Google
|
|
|
4359
4218
|
execute_or_queue_command(command, &block)
|
|
4360
4219
|
end
|
|
4361
4220
|
|
|
4362
|
-
#
|
|
4363
|
-
#
|
|
4364
|
-
#
|
|
4365
|
-
#
|
|
4366
|
-
#
|
|
4367
|
-
#
|
|
4368
|
-
#
|
|
4369
|
-
#
|
|
4370
|
-
#
|
|
4371
|
-
#
|
|
4372
|
-
#
|
|
4373
|
-
#
|
|
4374
|
-
#
|
|
4375
|
-
#
|
|
4376
|
-
#
|
|
4221
|
+
# Assigns a targeting option to a partner. Returns the assigned targeting option
|
|
4222
|
+
# if successful.
|
|
4223
|
+
# @param [Fixnum] partner_id
|
|
4224
|
+
# Required. The ID of the partner.
|
|
4225
|
+
# @param [String] targeting_type
|
|
4226
|
+
# Required. Identifies the type of this assigned targeting option. Supported
|
|
4227
|
+
# targeting types: * `TARGETING_TYPE_CHANNEL`
|
|
4228
|
+
# @param [Google::Apis::DisplayvideoV1::AssignedTargetingOption] assigned_targeting_option_object
|
|
4229
|
+
# @param [String] fields
|
|
4230
|
+
# Selector specifying which fields to include in a partial response.
|
|
4231
|
+
# @param [String] quota_user
|
|
4232
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
4233
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
4234
|
+
# @param [Google::Apis::RequestOptions] options
|
|
4235
|
+
# Request-specific options
|
|
4236
|
+
#
|
|
4237
|
+
# @yield [result, err] Result & error if block supplied
|
|
4238
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::AssignedTargetingOption] parsed result object
|
|
4239
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
4240
|
+
#
|
|
4241
|
+
# @return [Google::Apis::DisplayvideoV1::AssignedTargetingOption]
|
|
4242
|
+
#
|
|
4243
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
4244
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
4245
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
4246
|
+
def create_partner_targeting_type_assigned_targeting_option(partner_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
4247
|
+
command = make_simple_command(:post, 'v1/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
|
|
4248
|
+
command.request_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
|
4249
|
+
command.request_object = assigned_targeting_option_object
|
|
4250
|
+
command.response_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
|
4251
|
+
command.response_class = Google::Apis::DisplayvideoV1::AssignedTargetingOption
|
|
4252
|
+
command.params['partnerId'] = partner_id unless partner_id.nil?
|
|
4253
|
+
command.params['targetingType'] = targeting_type unless targeting_type.nil?
|
|
4254
|
+
command.query['fields'] = fields unless fields.nil?
|
|
4255
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
4256
|
+
execute_or_queue_command(command, &block)
|
|
4257
|
+
end
|
|
4258
|
+
|
|
4259
|
+
# Deletes an assigned targeting option from a partner.
|
|
4260
|
+
# @param [Fixnum] partner_id
|
|
4261
|
+
# Required. The ID of the partner.
|
|
4262
|
+
# @param [String] targeting_type
|
|
4263
|
+
# Required. Identifies the type of this assigned targeting option. Supported
|
|
4264
|
+
# targeting types: * `TARGETING_TYPE_CHANNEL`
|
|
4265
|
+
# @param [String] assigned_targeting_option_id
|
|
4266
|
+
# Required. The ID of the assigned targeting option to delete.
|
|
4267
|
+
# @param [String] fields
|
|
4268
|
+
# Selector specifying which fields to include in a partial response.
|
|
4269
|
+
# @param [String] quota_user
|
|
4270
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
4271
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
4272
|
+
# @param [Google::Apis::RequestOptions] options
|
|
4273
|
+
# Request-specific options
|
|
4274
|
+
#
|
|
4275
|
+
# @yield [result, err] Result & error if block supplied
|
|
4276
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
|
4277
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
4278
|
+
#
|
|
4279
|
+
# @return [Google::Apis::DisplayvideoV1::Empty]
|
|
4280
|
+
#
|
|
4281
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
4282
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
4283
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
4284
|
+
def delete_partner_targeting_type_assigned_targeting_option(partner_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
4285
|
+
command = make_simple_command(:delete, 'v1/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
|
|
4286
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
|
4287
|
+
command.response_class = Google::Apis::DisplayvideoV1::Empty
|
|
4288
|
+
command.params['partnerId'] = partner_id unless partner_id.nil?
|
|
4289
|
+
command.params['targetingType'] = targeting_type unless targeting_type.nil?
|
|
4290
|
+
command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
|
|
4291
|
+
command.query['fields'] = fields unless fields.nil?
|
|
4292
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
4293
|
+
execute_or_queue_command(command, &block)
|
|
4294
|
+
end
|
|
4295
|
+
|
|
4296
|
+
# Gets a single targeting option assigned to a partner.
|
|
4297
|
+
# @param [Fixnum] partner_id
|
|
4298
|
+
# Required. The ID of the partner.
|
|
4299
|
+
# @param [String] targeting_type
|
|
4300
|
+
# Required. Identifies the type of this assigned targeting option. Supported
|
|
4301
|
+
# targeting types: * `TARGETING_TYPE_CHANNEL`
|
|
4302
|
+
# @param [String] assigned_targeting_option_id
|
|
4303
|
+
# Required. An identifier unique to the targeting type in this partner that
|
|
4304
|
+
# identifies the assigned targeting option being requested.
|
|
4305
|
+
# @param [String] fields
|
|
4306
|
+
# Selector specifying which fields to include in a partial response.
|
|
4307
|
+
# @param [String] quota_user
|
|
4308
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
4309
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
4310
|
+
# @param [Google::Apis::RequestOptions] options
|
|
4311
|
+
# Request-specific options
|
|
4312
|
+
#
|
|
4313
|
+
# @yield [result, err] Result & error if block supplied
|
|
4314
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::AssignedTargetingOption] parsed result object
|
|
4315
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
4316
|
+
#
|
|
4317
|
+
# @return [Google::Apis::DisplayvideoV1::AssignedTargetingOption]
|
|
4318
|
+
#
|
|
4319
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
4320
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
4321
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
4322
|
+
def get_partner_targeting_type_assigned_targeting_option(partner_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
4323
|
+
command = make_simple_command(:get, 'v1/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
|
|
4324
|
+
command.response_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
|
4325
|
+
command.response_class = Google::Apis::DisplayvideoV1::AssignedTargetingOption
|
|
4326
|
+
command.params['partnerId'] = partner_id unless partner_id.nil?
|
|
4327
|
+
command.params['targetingType'] = targeting_type unless targeting_type.nil?
|
|
4328
|
+
command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
|
|
4329
|
+
command.query['fields'] = fields unless fields.nil?
|
|
4330
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
4331
|
+
execute_or_queue_command(command, &block)
|
|
4332
|
+
end
|
|
4333
|
+
|
|
4334
|
+
# Lists the targeting options assigned to a partner.
|
|
4335
|
+
# @param [Fixnum] partner_id
|
|
4336
|
+
# Required. The ID of the partner.
|
|
4337
|
+
# @param [String] targeting_type
|
|
4338
|
+
# Required. Identifies the type of assigned targeting options to list. Supported
|
|
4339
|
+
# targeting types: * `TARGETING_TYPE_CHANNEL`
|
|
4340
|
+
# @param [String] filter
|
|
4341
|
+
# Allows filtering by assigned targeting option properties. Supported syntax: *
|
|
4342
|
+
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
4343
|
+
# be combined by the logical operator `OR`. * A restriction has the form of ``
|
|
4344
|
+
# field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported
|
|
4345
|
+
# fields: - `assignedTargetingOptionId` Examples: * AssignedTargetingOption with
|
|
4346
|
+
# ID 123456 `assignedTargetingOptionId="123456"` The length of this field should
|
|
4347
|
+
# be no more than 500 characters.
|
|
4348
|
+
# @param [String] order_by
|
|
4349
|
+
# Field by which to sort the list. Acceptable values are: * `
|
|
4350
|
+
# assignedTargetingOptionId` (default) The default sorting order is ascending.
|
|
4351
|
+
# To specify descending order for a field, a suffix "desc" should be added to
|
|
4352
|
+
# the field name. Example: `assignedTargetingOptionId desc`.
|
|
4353
|
+
# @param [Fixnum] page_size
|
|
4354
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
4355
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
4356
|
+
# specified.
|
|
4357
|
+
# @param [String] page_token
|
|
4358
|
+
# A token identifying a page of results the server should return. Typically,
|
|
4359
|
+
# this is the value of next_page_token returned from the previous call to `
|
|
4360
|
+
# ListPartnerAssignedTargetingOptions` method. If not specified, the first page
|
|
4361
|
+
# of results will be returned.
|
|
4362
|
+
# @param [String] fields
|
|
4363
|
+
# Selector specifying which fields to include in a partial response.
|
|
4364
|
+
# @param [String] quota_user
|
|
4365
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
4366
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
4367
|
+
# @param [Google::Apis::RequestOptions] options
|
|
4368
|
+
# Request-specific options
|
|
4369
|
+
#
|
|
4370
|
+
# @yield [result, err] Result & error if block supplied
|
|
4371
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListPartnerAssignedTargetingOptionsResponse] parsed result object
|
|
4372
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
4373
|
+
#
|
|
4374
|
+
# @return [Google::Apis::DisplayvideoV1::ListPartnerAssignedTargetingOptionsResponse]
|
|
4375
|
+
#
|
|
4376
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
4377
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
4378
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
4379
|
+
def list_partner_targeting_type_assigned_targeting_options(partner_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
4380
|
+
command = make_simple_command(:get, 'v1/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
|
|
4381
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListPartnerAssignedTargetingOptionsResponse::Representation
|
|
4382
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListPartnerAssignedTargetingOptionsResponse
|
|
4383
|
+
command.params['partnerId'] = partner_id unless partner_id.nil?
|
|
4384
|
+
command.params['targetingType'] = targeting_type unless targeting_type.nil?
|
|
4385
|
+
command.query['filter'] = filter unless filter.nil?
|
|
4386
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
|
4387
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
4388
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
4389
|
+
command.query['fields'] = fields unless fields.nil?
|
|
4390
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
4391
|
+
execute_or_queue_command(command, &block)
|
|
4392
|
+
end
|
|
4393
|
+
|
|
4394
|
+
# Creates an SDF Download Task. Returns an Operation. An SDF Download Task is a
|
|
4395
|
+
# long-running, asynchronous operation. The metadata type of this operation is
|
|
4396
|
+
# SdfDownloadTaskMetadata. If the request is successful, the response type of
|
|
4397
|
+
# the operation is SdfDownloadTask. The response will not include the download
|
|
4398
|
+
# files, which must be retrieved with media.download. The state of operation can
|
|
4399
|
+
# be retrieved with sdfdownloadtask.operations.get. Any errors can be found in
|
|
4400
|
+
# the error.message. Note that error.details is expected to be empty.
|
|
4377
4401
|
# @param [Google::Apis::DisplayvideoV1::CreateSdfDownloadTaskRequest] create_sdf_download_task_request_object
|
|
4378
4402
|
# @param [String] fields
|
|
4379
4403
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -4476,32 +4500,26 @@ module Google
|
|
|
4476
4500
|
# @param [Fixnum] advertiser_id
|
|
4477
4501
|
# Required. The Advertiser this request is being made in the context of.
|
|
4478
4502
|
# @param [String] filter
|
|
4479
|
-
# Allows filtering by targeting option properties.
|
|
4480
|
-
#
|
|
4481
|
-
# *
|
|
4482
|
-
# *
|
|
4483
|
-
#
|
|
4484
|
-
#
|
|
4485
|
-
# * Supported fields:
|
|
4486
|
-
# - `targetingOptionId`
|
|
4487
|
-
# The length of this field should be no more than 500 characters.
|
|
4503
|
+
# Allows filtering by targeting option properties. Supported syntax: * Filter
|
|
4504
|
+
# expressions are made up of one or more restrictions. * Restrictions can be
|
|
4505
|
+
# combined by `OR` logical operators. * A restriction has the form of ``field` `
|
|
4506
|
+
# operator` `value``. * The operator must be "=" (equal sign). * Supported
|
|
4507
|
+
# fields: - `targetingOptionId` The length of this field should be no more than
|
|
4508
|
+
# 500 characters.
|
|
4488
4509
|
# @param [String] order_by
|
|
4489
|
-
# Field by which to sort the list.
|
|
4490
|
-
#
|
|
4491
|
-
#
|
|
4492
|
-
#
|
|
4493
|
-
# a field, a suffix "desc" should be added to the field name.
|
|
4494
|
-
# Example: `targetingOptionId desc`.
|
|
4510
|
+
# Field by which to sort the list. Acceptable values are: * `targetingOptionId` (
|
|
4511
|
+
# default) The default sorting order is ascending. To specify descending order
|
|
4512
|
+
# for a field, a suffix "desc" should be added to the field name. Example: `
|
|
4513
|
+
# targetingOptionId desc`.
|
|
4495
4514
|
# @param [Fixnum] page_size
|
|
4496
4515
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
4497
|
-
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
|
|
4498
|
-
#
|
|
4516
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
4517
|
+
# specified.
|
|
4499
4518
|
# @param [String] page_token
|
|
4500
|
-
# A token identifying a page of results the server should return.
|
|
4501
|
-
#
|
|
4502
|
-
#
|
|
4503
|
-
# returned
|
|
4504
|
-
# If not specified, the first page of results will be returned.
|
|
4519
|
+
# A token identifying a page of results the server should return. Typically,
|
|
4520
|
+
# this is the value of next_page_token returned from the previous call to `
|
|
4521
|
+
# ListTargetingOptions` method. If not specified, the first page of results will
|
|
4522
|
+
# be returned.
|
|
4505
4523
|
# @param [String] fields
|
|
4506
4524
|
# Selector specifying which fields to include in a partial response.
|
|
4507
4525
|
# @param [String] quota_user
|
|
@@ -4533,6 +4551,235 @@ module Google
|
|
|
4533
4551
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
4534
4552
|
execute_or_queue_command(command, &block)
|
|
4535
4553
|
end
|
|
4554
|
+
|
|
4555
|
+
# Bulk edits user roles for a user. The operation will delete the assigned user
|
|
4556
|
+
# roles provided in BulkEditAssignedUserRolesRequest.deleted_assigned_user_roles
|
|
4557
|
+
# and then assign the user roles provided in BulkEditAssignedUserRolesRequest.
|
|
4558
|
+
# created_assigned_user_roles.
|
|
4559
|
+
# @param [Fixnum] user_id
|
|
4560
|
+
# Required. The ID of the user to which the assigned user roles belong.
|
|
4561
|
+
# @param [Google::Apis::DisplayvideoV1::BulkEditAssignedUserRolesRequest] bulk_edit_assigned_user_roles_request_object
|
|
4562
|
+
# @param [String] fields
|
|
4563
|
+
# Selector specifying which fields to include in a partial response.
|
|
4564
|
+
# @param [String] quota_user
|
|
4565
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
4566
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
4567
|
+
# @param [Google::Apis::RequestOptions] options
|
|
4568
|
+
# Request-specific options
|
|
4569
|
+
#
|
|
4570
|
+
# @yield [result, err] Result & error if block supplied
|
|
4571
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::BulkEditAssignedUserRolesResponse] parsed result object
|
|
4572
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
4573
|
+
#
|
|
4574
|
+
# @return [Google::Apis::DisplayvideoV1::BulkEditAssignedUserRolesResponse]
|
|
4575
|
+
#
|
|
4576
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
4577
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
4578
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
4579
|
+
def bulk_edit_assigned_user_roles(user_id, bulk_edit_assigned_user_roles_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
4580
|
+
command = make_simple_command(:post, 'v1/users/{+userId}:bulkEditAssignedUserRoles', options)
|
|
4581
|
+
command.request_representation = Google::Apis::DisplayvideoV1::BulkEditAssignedUserRolesRequest::Representation
|
|
4582
|
+
command.request_object = bulk_edit_assigned_user_roles_request_object
|
|
4583
|
+
command.response_representation = Google::Apis::DisplayvideoV1::BulkEditAssignedUserRolesResponse::Representation
|
|
4584
|
+
command.response_class = Google::Apis::DisplayvideoV1::BulkEditAssignedUserRolesResponse
|
|
4585
|
+
command.params['userId'] = user_id unless user_id.nil?
|
|
4586
|
+
command.query['fields'] = fields unless fields.nil?
|
|
4587
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
4588
|
+
execute_or_queue_command(command, &block)
|
|
4589
|
+
end
|
|
4590
|
+
|
|
4591
|
+
# Creates a new user. Returns the newly created user if successful.
|
|
4592
|
+
# @param [Google::Apis::DisplayvideoV1::User] user_object
|
|
4593
|
+
# @param [String] fields
|
|
4594
|
+
# Selector specifying which fields to include in a partial response.
|
|
4595
|
+
# @param [String] quota_user
|
|
4596
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
4597
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
4598
|
+
# @param [Google::Apis::RequestOptions] options
|
|
4599
|
+
# Request-specific options
|
|
4600
|
+
#
|
|
4601
|
+
# @yield [result, err] Result & error if block supplied
|
|
4602
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::User] parsed result object
|
|
4603
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
4604
|
+
#
|
|
4605
|
+
# @return [Google::Apis::DisplayvideoV1::User]
|
|
4606
|
+
#
|
|
4607
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
4608
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
4609
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
4610
|
+
def create_user(user_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
4611
|
+
command = make_simple_command(:post, 'v1/users', options)
|
|
4612
|
+
command.request_representation = Google::Apis::DisplayvideoV1::User::Representation
|
|
4613
|
+
command.request_object = user_object
|
|
4614
|
+
command.response_representation = Google::Apis::DisplayvideoV1::User::Representation
|
|
4615
|
+
command.response_class = Google::Apis::DisplayvideoV1::User
|
|
4616
|
+
command.query['fields'] = fields unless fields.nil?
|
|
4617
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
4618
|
+
execute_or_queue_command(command, &block)
|
|
4619
|
+
end
|
|
4620
|
+
|
|
4621
|
+
# Deletes a user.
|
|
4622
|
+
# @param [Fixnum] user_id
|
|
4623
|
+
# Required. The ID of the user to delete.
|
|
4624
|
+
# @param [String] fields
|
|
4625
|
+
# Selector specifying which fields to include in a partial response.
|
|
4626
|
+
# @param [String] quota_user
|
|
4627
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
4628
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
4629
|
+
# @param [Google::Apis::RequestOptions] options
|
|
4630
|
+
# Request-specific options
|
|
4631
|
+
#
|
|
4632
|
+
# @yield [result, err] Result & error if block supplied
|
|
4633
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
|
4634
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
4635
|
+
#
|
|
4636
|
+
# @return [Google::Apis::DisplayvideoV1::Empty]
|
|
4637
|
+
#
|
|
4638
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
4639
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
4640
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
4641
|
+
def delete_user(user_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
4642
|
+
command = make_simple_command(:delete, 'v1/users/{+userId}', options)
|
|
4643
|
+
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
|
4644
|
+
command.response_class = Google::Apis::DisplayvideoV1::Empty
|
|
4645
|
+
command.params['userId'] = user_id unless user_id.nil?
|
|
4646
|
+
command.query['fields'] = fields unless fields.nil?
|
|
4647
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
4648
|
+
execute_or_queue_command(command, &block)
|
|
4649
|
+
end
|
|
4650
|
+
|
|
4651
|
+
# Gets a user.
|
|
4652
|
+
# @param [Fixnum] user_id
|
|
4653
|
+
# Required. The ID of the user to fetch.
|
|
4654
|
+
# @param [String] fields
|
|
4655
|
+
# Selector specifying which fields to include in a partial response.
|
|
4656
|
+
# @param [String] quota_user
|
|
4657
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
4658
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
4659
|
+
# @param [Google::Apis::RequestOptions] options
|
|
4660
|
+
# Request-specific options
|
|
4661
|
+
#
|
|
4662
|
+
# @yield [result, err] Result & error if block supplied
|
|
4663
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::User] parsed result object
|
|
4664
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
4665
|
+
#
|
|
4666
|
+
# @return [Google::Apis::DisplayvideoV1::User]
|
|
4667
|
+
#
|
|
4668
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
4669
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
4670
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
4671
|
+
def get_user(user_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
4672
|
+
command = make_simple_command(:get, 'v1/users/{+userId}', options)
|
|
4673
|
+
command.response_representation = Google::Apis::DisplayvideoV1::User::Representation
|
|
4674
|
+
command.response_class = Google::Apis::DisplayvideoV1::User
|
|
4675
|
+
command.params['userId'] = user_id unless user_id.nil?
|
|
4676
|
+
command.query['fields'] = fields unless fields.nil?
|
|
4677
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
4678
|
+
execute_or_queue_command(command, &block)
|
|
4679
|
+
end
|
|
4680
|
+
|
|
4681
|
+
# Lists users that are accessible to the current user. If two users have user
|
|
4682
|
+
# roles on the same partner or advertiser, they can access each other.
|
|
4683
|
+
# @param [String] filter
|
|
4684
|
+
# Allows filtering by user properties. Supported syntax: * Filter expressions
|
|
4685
|
+
# are made up of one or more restrictions. * Restrictions can be combined by the
|
|
4686
|
+
# logical operator `AND`. * A restriction has the form of ``field` `operator` `
|
|
4687
|
+
# value``. * The operator must be `CONTAINS (:)` or `EQUALS (=)`. * The operator
|
|
4688
|
+
# must be `CONTAINS (:)` for the following fields: - `displayName` - `email` *
|
|
4689
|
+
# The operator must be `EQUALS (=)` for the following fields: - `
|
|
4690
|
+
# assignedUserRole.userRole` - `assignedUserRole.partnerId` - `assignedUserRole.
|
|
4691
|
+
# advertiserId` - `assignedUserRole.entityType`: A synthetic field of
|
|
4692
|
+
# AssignedUserRole used for filtering. Identifies the type of entity to which
|
|
4693
|
+
# the user role is assigned. Valid values are `Partner` and `Advertiser`. - `
|
|
4694
|
+
# assignedUserRole.parentPartnerId`: A synthetic field of AssignedUserRole used
|
|
4695
|
+
# for filtering. Identifies the parent partner of the entity to which the user
|
|
4696
|
+
# role is assigned." Examples: * The user with displayName containing `foo`: `
|
|
4697
|
+
# displayName:"foo"` * The user with email containing `bar`: `email:"bar"` * All
|
|
4698
|
+
# users with standard user roles: `assignedUserRole.userRole="STANDARD"` * All
|
|
4699
|
+
# users with user roles for partner 123: `assignedUserRole.partnerId="123"` *
|
|
4700
|
+
# All users with user roles for advertiser 123: `assignedUserRole.advertiserId="
|
|
4701
|
+
# 123"` * All users with partner level user roles: `entityType="PARTNER"` * All
|
|
4702
|
+
# users with user roles for partner 123 and advertisers under partner 123: `
|
|
4703
|
+
# parentPartnerId="123"` The length of this field should be no more than 500
|
|
4704
|
+
# characters.
|
|
4705
|
+
# @param [String] order_by
|
|
4706
|
+
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
4707
|
+
# default) The default sorting order is ascending. To specify descending order
|
|
4708
|
+
# for a field, a suffix "desc" should be added to the field name. For example, `
|
|
4709
|
+
# displayName desc`.
|
|
4710
|
+
# @param [Fixnum] page_size
|
|
4711
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
4712
|
+
# default to `100`.
|
|
4713
|
+
# @param [String] page_token
|
|
4714
|
+
# A token identifying a page of results the server should return. Typically,
|
|
4715
|
+
# this is the value of next_page_token returned from the previous call to `
|
|
4716
|
+
# ListUsers` method. If not specified, the first page of results will be
|
|
4717
|
+
# returned.
|
|
4718
|
+
# @param [String] fields
|
|
4719
|
+
# Selector specifying which fields to include in a partial response.
|
|
4720
|
+
# @param [String] quota_user
|
|
4721
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
4722
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
4723
|
+
# @param [Google::Apis::RequestOptions] options
|
|
4724
|
+
# Request-specific options
|
|
4725
|
+
#
|
|
4726
|
+
# @yield [result, err] Result & error if block supplied
|
|
4727
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListUsersResponse] parsed result object
|
|
4728
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
4729
|
+
#
|
|
4730
|
+
# @return [Google::Apis::DisplayvideoV1::ListUsersResponse]
|
|
4731
|
+
#
|
|
4732
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
4733
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
4734
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
4735
|
+
def list_users(filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
4736
|
+
command = make_simple_command(:get, 'v1/users', options)
|
|
4737
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListUsersResponse::Representation
|
|
4738
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListUsersResponse
|
|
4739
|
+
command.query['filter'] = filter unless filter.nil?
|
|
4740
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
|
4741
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
4742
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
4743
|
+
command.query['fields'] = fields unless fields.nil?
|
|
4744
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
4745
|
+
execute_or_queue_command(command, &block)
|
|
4746
|
+
end
|
|
4747
|
+
|
|
4748
|
+
# Updates an existing user. Returns the updated user if successful.
|
|
4749
|
+
# @param [Fixnum] user_id
|
|
4750
|
+
# Output only. The unique ID of the user. Assigned by the system.
|
|
4751
|
+
# @param [Google::Apis::DisplayvideoV1::User] user_object
|
|
4752
|
+
# @param [String] update_mask
|
|
4753
|
+
# Required. The mask to control which fields to update.
|
|
4754
|
+
# @param [String] fields
|
|
4755
|
+
# Selector specifying which fields to include in a partial response.
|
|
4756
|
+
# @param [String] quota_user
|
|
4757
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
4758
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
4759
|
+
# @param [Google::Apis::RequestOptions] options
|
|
4760
|
+
# Request-specific options
|
|
4761
|
+
#
|
|
4762
|
+
# @yield [result, err] Result & error if block supplied
|
|
4763
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::User] parsed result object
|
|
4764
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
4765
|
+
#
|
|
4766
|
+
# @return [Google::Apis::DisplayvideoV1::User]
|
|
4767
|
+
#
|
|
4768
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
4769
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
4770
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
4771
|
+
def patch_user(user_id, user_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
4772
|
+
command = make_simple_command(:patch, 'v1/users/{+userId}', options)
|
|
4773
|
+
command.request_representation = Google::Apis::DisplayvideoV1::User::Representation
|
|
4774
|
+
command.request_object = user_object
|
|
4775
|
+
command.response_representation = Google::Apis::DisplayvideoV1::User::Representation
|
|
4776
|
+
command.response_class = Google::Apis::DisplayvideoV1::User
|
|
4777
|
+
command.params['userId'] = user_id unless user_id.nil?
|
|
4778
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
4779
|
+
command.query['fields'] = fields unless fields.nil?
|
|
4780
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
4781
|
+
execute_or_queue_command(command, &block)
|
|
4782
|
+
end
|
|
4536
4783
|
|
|
4537
4784
|
protected
|
|
4538
4785
|
|