google-apis-realtimebidding_v1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,1079 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/core/base_service'
16
+ require 'google/apis/core/json_representation'
17
+ require 'google/apis/core/hashable'
18
+ require 'google/apis/errors'
19
+
20
+ module Google
21
+ module Apis
22
+ module RealtimebiddingV1
23
+ # Real-time Bidding API
24
+ #
25
+ # Allows external bidders to manage their RTB integration with Google. This
26
+ # includes managing bidder endpoints, QPS quotas, configuring what ad inventory
27
+ # to receive via pretargeting, submitting creatives for verification, and
28
+ # accessing creative metadata such as approval status.
29
+ #
30
+ # @example
31
+ # require 'google/apis/realtimebidding_v1'
32
+ #
33
+ # Realtimebidding = Google::Apis::RealtimebiddingV1 # Alias the module
34
+ # service = Realtimebidding::RealtimeBiddingService.new
35
+ #
36
+ # @see https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/
37
+ class RealtimeBiddingService < Google::Apis::Core::BaseService
38
+ # @return [String]
39
+ # API key. Your API key identifies your project and provides you with API access,
40
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
41
+ attr_accessor :key
42
+
43
+ # @return [String]
44
+ # Available to use for quota purposes for server-side applications. Can be any
45
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
46
+ attr_accessor :quota_user
47
+
48
+ def initialize
49
+ super('https://realtimebidding.googleapis.com/', '',
50
+ client_name: 'google-apis-realtimebidding_v1',
51
+ client_version: Google::Apis::RealtimebiddingV1::GEM_VERSION)
52
+ @batch_path = 'batch'
53
+ end
54
+
55
+ # Lists creatives.
56
+ # @param [String] parent
57
+ # Required. Name of the parent buyer that owns the creatives. The pattern for
58
+ # this resource is either `buyers/`buyerAccountId`` or `bidders/`bidderAccountId`
59
+ # `. For `buyers/`buyerAccountId``, the `buyerAccountId` can be one of the
60
+ # following: 1. The ID of the buyer that is accessing their own creatives. 2.
61
+ # The ID of the child seat buyer under a bidder account. So for listing
62
+ # creatives pertaining to the child seat buyer (`456`) under bidder account (`
63
+ # 123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself.
64
+ # So for listing creatives pertaining to bidder (`123`), you would use `buyers/
65
+ # 123`. If you want to access all creatives pertaining to both the bidder and
66
+ # all of its child seat accounts, you would use `bidders/`bidderAccountId``, e.g.
67
+ # , for all creatives pertaining to bidder (`123`), use `bidders/123`.
68
+ # @param [String] filter
69
+ # Query string to filter creatives. If no filter is specified, all active
70
+ # creatives will be returned. Example: 'accountId=12345 AND (dealsStatus:
71
+ # DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes:
72
+ # IS_COOKIE_TARGETED'
73
+ # @param [Fixnum] page_size
74
+ # Requested page size. The server may return fewer creatives than requested (due
75
+ # to timeout constraint) even if more are available via another call. If
76
+ # unspecified, server will pick an appropriate default. Acceptable values are 1
77
+ # to 1000, inclusive.
78
+ # @param [String] page_token
79
+ # A token identifying a page of results the server should return. Typically,
80
+ # this is the value of ListCreativesResponse.nextPageToken returned from the
81
+ # previous call to the 'ListCreatives' method.
82
+ # @param [String] view
83
+ # Controls the amount of information included in the response. By default only
84
+ # creativeServingDecision is included. To retrieve the entire creative resource (
85
+ # including the declared fields and the creative content) specify the view as "
86
+ # FULL".
87
+ # @param [String] fields
88
+ # Selector specifying which fields to include in a partial response.
89
+ # @param [String] quota_user
90
+ # Available to use for quota purposes for server-side applications. Can be any
91
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
92
+ # @param [Google::Apis::RequestOptions] options
93
+ # Request-specific options
94
+ #
95
+ # @yield [result, err] Result & error if block supplied
96
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::ListCreativesResponse] parsed result object
97
+ # @yieldparam err [StandardError] error object if request failed
98
+ #
99
+ # @return [Google::Apis::RealtimebiddingV1::ListCreativesResponse]
100
+ #
101
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
102
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
103
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
104
+ def list_bidder_creatives(parent, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
105
+ command = make_simple_command(:get, 'v1/{+parent}/creatives', options)
106
+ command.response_representation = Google::Apis::RealtimebiddingV1::ListCreativesResponse::Representation
107
+ command.response_class = Google::Apis::RealtimebiddingV1::ListCreativesResponse
108
+ command.params['parent'] = parent unless parent.nil?
109
+ command.query['filter'] = filter unless filter.nil?
110
+ command.query['pageSize'] = page_size unless page_size.nil?
111
+ command.query['pageToken'] = page_token unless page_token.nil?
112
+ command.query['view'] = view unless view.nil?
113
+ command.query['fields'] = fields unless fields.nil?
114
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
115
+ execute_or_queue_command(command, &block)
116
+ end
117
+
118
+ # Watches all creatives pertaining to a bidder. It is sufficient to invoke this
119
+ # endpoint once per bidder. A Pub/Sub topic will be created and notifications
120
+ # will be pushed to the topic when any of the bidder's creatives change status.
121
+ # All of the bidder's service accounts will have access to read from the topic.
122
+ # Subsequent invocations of this method will return the existing Pub/Sub
123
+ # configuration.
124
+ # @param [String] parent
125
+ # Required. To watch all creatives pertaining to the bidder and all its child
126
+ # seat accounts, the bidder must follow the pattern `bidders/`bidderAccountId``.
127
+ # @param [Google::Apis::RealtimebiddingV1::WatchCreativesRequest] watch_creatives_request_object
128
+ # @param [String] fields
129
+ # Selector specifying which fields to include in a partial response.
130
+ # @param [String] quota_user
131
+ # Available to use for quota purposes for server-side applications. Can be any
132
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
133
+ # @param [Google::Apis::RequestOptions] options
134
+ # Request-specific options
135
+ #
136
+ # @yield [result, err] Result & error if block supplied
137
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::WatchCreativesResponse] parsed result object
138
+ # @yieldparam err [StandardError] error object if request failed
139
+ #
140
+ # @return [Google::Apis::RealtimebiddingV1::WatchCreativesResponse]
141
+ #
142
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
143
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
144
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
145
+ def watch_creatives(parent, watch_creatives_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
146
+ command = make_simple_command(:post, 'v1/{+parent}/creatives:watch', options)
147
+ command.request_representation = Google::Apis::RealtimebiddingV1::WatchCreativesRequest::Representation
148
+ command.request_object = watch_creatives_request_object
149
+ command.response_representation = Google::Apis::RealtimebiddingV1::WatchCreativesResponse::Representation
150
+ command.response_class = Google::Apis::RealtimebiddingV1::WatchCreativesResponse
151
+ command.params['parent'] = parent unless parent.nil?
152
+ command.query['fields'] = fields unless fields.nil?
153
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
154
+ execute_or_queue_command(command, &block)
155
+ end
156
+
157
+ # Activates a pretargeting configuration.
158
+ # @param [String] name
159
+ # Required. The name of the pretargeting configuration. Format: bidders/`
160
+ # bidderAccountId`/pretargetingConfig/`configId`
161
+ # @param [Google::Apis::RealtimebiddingV1::ActivatePretargetingConfigRequest] activate_pretargeting_config_request_object
162
+ # @param [String] fields
163
+ # Selector specifying which fields to include in a partial response.
164
+ # @param [String] quota_user
165
+ # Available to use for quota purposes for server-side applications. Can be any
166
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
167
+ # @param [Google::Apis::RequestOptions] options
168
+ # Request-specific options
169
+ #
170
+ # @yield [result, err] Result & error if block supplied
171
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::PretargetingConfig] parsed result object
172
+ # @yieldparam err [StandardError] error object if request failed
173
+ #
174
+ # @return [Google::Apis::RealtimebiddingV1::PretargetingConfig]
175
+ #
176
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
177
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
178
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
179
+ def activate_pretargeting_config(name, activate_pretargeting_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
180
+ command = make_simple_command(:post, 'v1/{+name}:activate', options)
181
+ command.request_representation = Google::Apis::RealtimebiddingV1::ActivatePretargetingConfigRequest::Representation
182
+ command.request_object = activate_pretargeting_config_request_object
183
+ command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation
184
+ command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig
185
+ command.params['name'] = name unless name.nil?
186
+ command.query['fields'] = fields unless fields.nil?
187
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
188
+ execute_or_queue_command(command, &block)
189
+ end
190
+
191
+ # Adds targeted apps to the pretargeting configuration.
192
+ # @param [String] pretargeting_config
193
+ # Required. The name of the pretargeting configuration. Format: bidders/`
194
+ # bidderAccountId`/pretargetingConfig/`configId`
195
+ # @param [Google::Apis::RealtimebiddingV1::AddTargetedAppsRequest] add_targeted_apps_request_object
196
+ # @param [String] fields
197
+ # Selector specifying which fields to include in a partial response.
198
+ # @param [String] quota_user
199
+ # Available to use for quota purposes for server-side applications. Can be any
200
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
201
+ # @param [Google::Apis::RequestOptions] options
202
+ # Request-specific options
203
+ #
204
+ # @yield [result, err] Result & error if block supplied
205
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::PretargetingConfig] parsed result object
206
+ # @yieldparam err [StandardError] error object if request failed
207
+ #
208
+ # @return [Google::Apis::RealtimebiddingV1::PretargetingConfig]
209
+ #
210
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
211
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
212
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
213
+ def add_pretargeting_config_targeted_apps(pretargeting_config, add_targeted_apps_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
214
+ command = make_simple_command(:post, 'v1/{+pretargetingConfig}:addTargetedApps', options)
215
+ command.request_representation = Google::Apis::RealtimebiddingV1::AddTargetedAppsRequest::Representation
216
+ command.request_object = add_targeted_apps_request_object
217
+ command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation
218
+ command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig
219
+ command.params['pretargetingConfig'] = pretargeting_config unless pretargeting_config.nil?
220
+ command.query['fields'] = fields unless fields.nil?
221
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
222
+ execute_or_queue_command(command, &block)
223
+ end
224
+
225
+ # Adds targeted publishers to the pretargeting config.
226
+ # @param [String] pretargeting_config
227
+ # Required. The name of the pretargeting configuration. Format: bidders/`
228
+ # bidderAccountId`/pretargetingConfig/`configId`
229
+ # @param [Google::Apis::RealtimebiddingV1::AddTargetedPublishersRequest] add_targeted_publishers_request_object
230
+ # @param [String] fields
231
+ # Selector specifying which fields to include in a partial response.
232
+ # @param [String] quota_user
233
+ # Available to use for quota purposes for server-side applications. Can be any
234
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
235
+ # @param [Google::Apis::RequestOptions] options
236
+ # Request-specific options
237
+ #
238
+ # @yield [result, err] Result & error if block supplied
239
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::PretargetingConfig] parsed result object
240
+ # @yieldparam err [StandardError] error object if request failed
241
+ #
242
+ # @return [Google::Apis::RealtimebiddingV1::PretargetingConfig]
243
+ #
244
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
245
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
246
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
247
+ def add_pretargeting_config_targeted_publishers(pretargeting_config, add_targeted_publishers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
248
+ command = make_simple_command(:post, 'v1/{+pretargetingConfig}:addTargetedPublishers', options)
249
+ command.request_representation = Google::Apis::RealtimebiddingV1::AddTargetedPublishersRequest::Representation
250
+ command.request_object = add_targeted_publishers_request_object
251
+ command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation
252
+ command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig
253
+ command.params['pretargetingConfig'] = pretargeting_config unless pretargeting_config.nil?
254
+ command.query['fields'] = fields unless fields.nil?
255
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
256
+ execute_or_queue_command(command, &block)
257
+ end
258
+
259
+ # Adds targeted sites to the pretargeting configuration.
260
+ # @param [String] pretargeting_config
261
+ # Required. The name of the pretargeting configuration. Format: bidders/`
262
+ # bidderAccountId`/pretargetingConfig/`configId`
263
+ # @param [Google::Apis::RealtimebiddingV1::AddTargetedSitesRequest] add_targeted_sites_request_object
264
+ # @param [String] fields
265
+ # Selector specifying which fields to include in a partial response.
266
+ # @param [String] quota_user
267
+ # Available to use for quota purposes for server-side applications. Can be any
268
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
269
+ # @param [Google::Apis::RequestOptions] options
270
+ # Request-specific options
271
+ #
272
+ # @yield [result, err] Result & error if block supplied
273
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::PretargetingConfig] parsed result object
274
+ # @yieldparam err [StandardError] error object if request failed
275
+ #
276
+ # @return [Google::Apis::RealtimebiddingV1::PretargetingConfig]
277
+ #
278
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
279
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
280
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
281
+ def add_pretargeting_config_targeted_sites(pretargeting_config, add_targeted_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
282
+ command = make_simple_command(:post, 'v1/{+pretargetingConfig}:addTargetedSites', options)
283
+ command.request_representation = Google::Apis::RealtimebiddingV1::AddTargetedSitesRequest::Representation
284
+ command.request_object = add_targeted_sites_request_object
285
+ command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation
286
+ command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig
287
+ command.params['pretargetingConfig'] = pretargeting_config unless pretargeting_config.nil?
288
+ command.query['fields'] = fields unless fields.nil?
289
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
290
+ execute_or_queue_command(command, &block)
291
+ end
292
+
293
+ # Creates a pretargeting configuration. A pretargeting configuration's state (
294
+ # PretargetingConfig.state) is active upon creation, and it will start to affect
295
+ # traffic shortly after. A bidder may create a maximum of 10 pretargeting
296
+ # configurations. Attempts to exceed this maximum results in a 400 bad request
297
+ # error.
298
+ # @param [String] parent
299
+ # Required. Name of the bidder to create the pretargeting configuration for.
300
+ # Format: bidders/`bidderAccountId`
301
+ # @param [Google::Apis::RealtimebiddingV1::PretargetingConfig] pretargeting_config_object
302
+ # @param [String] fields
303
+ # Selector specifying which fields to include in a partial response.
304
+ # @param [String] quota_user
305
+ # Available to use for quota purposes for server-side applications. Can be any
306
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
307
+ # @param [Google::Apis::RequestOptions] options
308
+ # Request-specific options
309
+ #
310
+ # @yield [result, err] Result & error if block supplied
311
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::PretargetingConfig] parsed result object
312
+ # @yieldparam err [StandardError] error object if request failed
313
+ #
314
+ # @return [Google::Apis::RealtimebiddingV1::PretargetingConfig]
315
+ #
316
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
317
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
318
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
319
+ def create_bidder_pretargeting_config(parent, pretargeting_config_object = nil, fields: nil, quota_user: nil, options: nil, &block)
320
+ command = make_simple_command(:post, 'v1/{+parent}/pretargetingConfigs', options)
321
+ command.request_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation
322
+ command.request_object = pretargeting_config_object
323
+ command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation
324
+ command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig
325
+ command.params['parent'] = parent unless parent.nil?
326
+ command.query['fields'] = fields unless fields.nil?
327
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
328
+ execute_or_queue_command(command, &block)
329
+ end
330
+
331
+ # Deletes a pretargeting configuration.
332
+ # @param [String] name
333
+ # Required. The name of the pretargeting configuration to delete. Format:
334
+ # bidders/`bidderAccountId`/pretargetingConfig/`configId`
335
+ # @param [String] fields
336
+ # Selector specifying which fields to include in a partial response.
337
+ # @param [String] quota_user
338
+ # Available to use for quota purposes for server-side applications. Can be any
339
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
340
+ # @param [Google::Apis::RequestOptions] options
341
+ # Request-specific options
342
+ #
343
+ # @yield [result, err] Result & error if block supplied
344
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::Empty] parsed result object
345
+ # @yieldparam err [StandardError] error object if request failed
346
+ #
347
+ # @return [Google::Apis::RealtimebiddingV1::Empty]
348
+ #
349
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
350
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
351
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
352
+ def delete_bidder_pretargeting_config(name, fields: nil, quota_user: nil, options: nil, &block)
353
+ command = make_simple_command(:delete, 'v1/{+name}', options)
354
+ command.response_representation = Google::Apis::RealtimebiddingV1::Empty::Representation
355
+ command.response_class = Google::Apis::RealtimebiddingV1::Empty
356
+ command.params['name'] = name unless name.nil?
357
+ command.query['fields'] = fields unless fields.nil?
358
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
359
+ execute_or_queue_command(command, &block)
360
+ end
361
+
362
+ # Gets a pretargeting configuration.
363
+ # @param [String] name
364
+ # Required. Name of the pretargeting configuration to get. Format: bidders/`
365
+ # bidderAccountId`/pretargetingConfig/`configId`
366
+ # @param [String] fields
367
+ # Selector specifying which fields to include in a partial response.
368
+ # @param [String] quota_user
369
+ # Available to use for quota purposes for server-side applications. Can be any
370
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
371
+ # @param [Google::Apis::RequestOptions] options
372
+ # Request-specific options
373
+ #
374
+ # @yield [result, err] Result & error if block supplied
375
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::PretargetingConfig] parsed result object
376
+ # @yieldparam err [StandardError] error object if request failed
377
+ #
378
+ # @return [Google::Apis::RealtimebiddingV1::PretargetingConfig]
379
+ #
380
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
381
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
382
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
383
+ def get_bidder_pretargeting_config(name, fields: nil, quota_user: nil, options: nil, &block)
384
+ command = make_simple_command(:get, 'v1/{+name}', options)
385
+ command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation
386
+ command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig
387
+ command.params['name'] = name unless name.nil?
388
+ command.query['fields'] = fields unless fields.nil?
389
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
390
+ execute_or_queue_command(command, &block)
391
+ end
392
+
393
+ # Lists all pretargeting configurations for a single bidder.
394
+ # @param [String] parent
395
+ # Required. Name of the bidder whose pretargeting configurations will be listed.
396
+ # Format: bidders/`bidderAccountId`
397
+ # @param [Fixnum] page_size
398
+ # The maximum number of pretargeting configurations to return. If unspecified,
399
+ # at most 10 pretargeting configurations will be returned. The maximum value is
400
+ # 100; values above 100 will be coerced to 100.
401
+ # @param [String] page_token
402
+ # A token identifying a page of results the server should return. This value is
403
+ # received from a previous `ListPretargetingConfigs` call in
404
+ # ListPretargetingConfigsResponse.nextPageToken.
405
+ # @param [String] fields
406
+ # Selector specifying which fields to include in a partial response.
407
+ # @param [String] quota_user
408
+ # Available to use for quota purposes for server-side applications. Can be any
409
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
410
+ # @param [Google::Apis::RequestOptions] options
411
+ # Request-specific options
412
+ #
413
+ # @yield [result, err] Result & error if block supplied
414
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::ListPretargetingConfigsResponse] parsed result object
415
+ # @yieldparam err [StandardError] error object if request failed
416
+ #
417
+ # @return [Google::Apis::RealtimebiddingV1::ListPretargetingConfigsResponse]
418
+ #
419
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
420
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
421
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
422
+ def list_bidder_pretargeting_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
423
+ command = make_simple_command(:get, 'v1/{+parent}/pretargetingConfigs', options)
424
+ command.response_representation = Google::Apis::RealtimebiddingV1::ListPretargetingConfigsResponse::Representation
425
+ command.response_class = Google::Apis::RealtimebiddingV1::ListPretargetingConfigsResponse
426
+ command.params['parent'] = parent unless parent.nil?
427
+ command.query['pageSize'] = page_size unless page_size.nil?
428
+ command.query['pageToken'] = page_token unless page_token.nil?
429
+ command.query['fields'] = fields unless fields.nil?
430
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
431
+ execute_or_queue_command(command, &block)
432
+ end
433
+
434
+ # Updates a pretargeting configuration.
435
+ # @param [String] name
436
+ # Output only. Name of the pretargeting configuration that must follow the
437
+ # pattern `bidders/`bidder_account_id`/pretargetingConfigs/`config_id``
438
+ # @param [Google::Apis::RealtimebiddingV1::PretargetingConfig] pretargeting_config_object
439
+ # @param [String] update_mask
440
+ # Field mask to use for partial in-place updates.
441
+ # @param [String] fields
442
+ # Selector specifying which fields to include in a partial response.
443
+ # @param [String] quota_user
444
+ # Available to use for quota purposes for server-side applications. Can be any
445
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
446
+ # @param [Google::Apis::RequestOptions] options
447
+ # Request-specific options
448
+ #
449
+ # @yield [result, err] Result & error if block supplied
450
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::PretargetingConfig] parsed result object
451
+ # @yieldparam err [StandardError] error object if request failed
452
+ #
453
+ # @return [Google::Apis::RealtimebiddingV1::PretargetingConfig]
454
+ #
455
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
456
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
457
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
458
+ def patch_bidder_pretargeting_config(name, pretargeting_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
459
+ command = make_simple_command(:patch, 'v1/{+name}', options)
460
+ command.request_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation
461
+ command.request_object = pretargeting_config_object
462
+ command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation
463
+ command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig
464
+ command.params['name'] = name unless name.nil?
465
+ command.query['updateMask'] = update_mask unless update_mask.nil?
466
+ command.query['fields'] = fields unless fields.nil?
467
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
468
+ execute_or_queue_command(command, &block)
469
+ end
470
+
471
+ # Removes targeted apps from the pretargeting configuration.
472
+ # @param [String] pretargeting_config
473
+ # Required. The name of the pretargeting configuration. Format: bidders/`
474
+ # bidderAccountId`/pretargetingConfig/`configId`
475
+ # @param [Google::Apis::RealtimebiddingV1::RemoveTargetedAppsRequest] remove_targeted_apps_request_object
476
+ # @param [String] fields
477
+ # Selector specifying which fields to include in a partial response.
478
+ # @param [String] quota_user
479
+ # Available to use for quota purposes for server-side applications. Can be any
480
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
481
+ # @param [Google::Apis::RequestOptions] options
482
+ # Request-specific options
483
+ #
484
+ # @yield [result, err] Result & error if block supplied
485
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::PretargetingConfig] parsed result object
486
+ # @yieldparam err [StandardError] error object if request failed
487
+ #
488
+ # @return [Google::Apis::RealtimebiddingV1::PretargetingConfig]
489
+ #
490
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
491
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
492
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
493
+ def remove_pretargeting_config_targeted_apps(pretargeting_config, remove_targeted_apps_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
494
+ command = make_simple_command(:post, 'v1/{+pretargetingConfig}:removeTargetedApps', options)
495
+ command.request_representation = Google::Apis::RealtimebiddingV1::RemoveTargetedAppsRequest::Representation
496
+ command.request_object = remove_targeted_apps_request_object
497
+ command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation
498
+ command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig
499
+ command.params['pretargetingConfig'] = pretargeting_config unless pretargeting_config.nil?
500
+ command.query['fields'] = fields unless fields.nil?
501
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
502
+ execute_or_queue_command(command, &block)
503
+ end
504
+
505
+ # Removes targeted publishers from the pretargeting config.
506
+ # @param [String] pretargeting_config
507
+ # Required. The name of the pretargeting configuration. Format: bidders/`
508
+ # bidderAccountId`/pretargetingConfig/`configId`
509
+ # @param [Google::Apis::RealtimebiddingV1::RemoveTargetedPublishersRequest] remove_targeted_publishers_request_object
510
+ # @param [String] fields
511
+ # Selector specifying which fields to include in a partial response.
512
+ # @param [String] quota_user
513
+ # Available to use for quota purposes for server-side applications. Can be any
514
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
515
+ # @param [Google::Apis::RequestOptions] options
516
+ # Request-specific options
517
+ #
518
+ # @yield [result, err] Result & error if block supplied
519
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::PretargetingConfig] parsed result object
520
+ # @yieldparam err [StandardError] error object if request failed
521
+ #
522
+ # @return [Google::Apis::RealtimebiddingV1::PretargetingConfig]
523
+ #
524
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
525
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
526
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
527
+ def remove_pretargeting_config_targeted_publishers(pretargeting_config, remove_targeted_publishers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
528
+ command = make_simple_command(:post, 'v1/{+pretargetingConfig}:removeTargetedPublishers', options)
529
+ command.request_representation = Google::Apis::RealtimebiddingV1::RemoveTargetedPublishersRequest::Representation
530
+ command.request_object = remove_targeted_publishers_request_object
531
+ command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation
532
+ command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig
533
+ command.params['pretargetingConfig'] = pretargeting_config unless pretargeting_config.nil?
534
+ command.query['fields'] = fields unless fields.nil?
535
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
536
+ execute_or_queue_command(command, &block)
537
+ end
538
+
539
+ # Removes targeted sites from the pretargeting configuration.
540
+ # @param [String] pretargeting_config
541
+ # Required. The name of the pretargeting configuration. Format: bidders/`
542
+ # bidderAccountId`/pretargetingConfig/`configId`
543
+ # @param [Google::Apis::RealtimebiddingV1::RemoveTargetedSitesRequest] remove_targeted_sites_request_object
544
+ # @param [String] fields
545
+ # Selector specifying which fields to include in a partial response.
546
+ # @param [String] quota_user
547
+ # Available to use for quota purposes for server-side applications. Can be any
548
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
549
+ # @param [Google::Apis::RequestOptions] options
550
+ # Request-specific options
551
+ #
552
+ # @yield [result, err] Result & error if block supplied
553
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::PretargetingConfig] parsed result object
554
+ # @yieldparam err [StandardError] error object if request failed
555
+ #
556
+ # @return [Google::Apis::RealtimebiddingV1::PretargetingConfig]
557
+ #
558
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
559
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
560
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
561
+ def remove_pretargeting_config_targeted_sites(pretargeting_config, remove_targeted_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
562
+ command = make_simple_command(:post, 'v1/{+pretargetingConfig}:removeTargetedSites', options)
563
+ command.request_representation = Google::Apis::RealtimebiddingV1::RemoveTargetedSitesRequest::Representation
564
+ command.request_object = remove_targeted_sites_request_object
565
+ command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation
566
+ command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig
567
+ command.params['pretargetingConfig'] = pretargeting_config unless pretargeting_config.nil?
568
+ command.query['fields'] = fields unless fields.nil?
569
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
570
+ execute_or_queue_command(command, &block)
571
+ end
572
+
573
+ # Suspends a pretargeting configuration.
574
+ # @param [String] name
575
+ # Required. The name of the pretargeting configuration. Format: bidders/`
576
+ # bidderAccountId`/pretargetingConfig/`configId`
577
+ # @param [Google::Apis::RealtimebiddingV1::SuspendPretargetingConfigRequest] suspend_pretargeting_config_request_object
578
+ # @param [String] fields
579
+ # Selector specifying which fields to include in a partial response.
580
+ # @param [String] quota_user
581
+ # Available to use for quota purposes for server-side applications. Can be any
582
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
583
+ # @param [Google::Apis::RequestOptions] options
584
+ # Request-specific options
585
+ #
586
+ # @yield [result, err] Result & error if block supplied
587
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::PretargetingConfig] parsed result object
588
+ # @yieldparam err [StandardError] error object if request failed
589
+ #
590
+ # @return [Google::Apis::RealtimebiddingV1::PretargetingConfig]
591
+ #
592
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
593
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
594
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
595
+ def suspend_pretargeting_config(name, suspend_pretargeting_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
596
+ command = make_simple_command(:post, 'v1/{+name}:suspend', options)
597
+ command.request_representation = Google::Apis::RealtimebiddingV1::SuspendPretargetingConfigRequest::Representation
598
+ command.request_object = suspend_pretargeting_config_request_object
599
+ command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation
600
+ command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig
601
+ command.params['name'] = name unless name.nil?
602
+ command.query['fields'] = fields unless fields.nil?
603
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
604
+ execute_or_queue_command(command, &block)
605
+ end
606
+
607
+ # Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript
608
+ # code that can be placed on a web page. When a user visits a page containing a
609
+ # remarketing tag, Google adds the user to a user list.
610
+ # @param [String] name
611
+ # Required. To fetch remarketing tag for an account, name must follow the
612
+ # pattern `buyers/`accountId`` where ``accountId`` represents ID of a buyer that
613
+ # owns the remarketing tag. For a bidder accessing remarketing tag on behalf of
614
+ # a child seat buyer, ``accountId`` should represent the ID of the child seat
615
+ # buyer. To fetch remarketing tag for a specific user list, name must follow the
616
+ # pattern `buyers/`accountId`/userLists/`userListId``. See UserList.name.
617
+ # @param [String] fields
618
+ # Selector specifying which fields to include in a partial response.
619
+ # @param [String] quota_user
620
+ # Available to use for quota purposes for server-side applications. Can be any
621
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
622
+ # @param [Google::Apis::RequestOptions] options
623
+ # Request-specific options
624
+ #
625
+ # @yield [result, err] Result & error if block supplied
626
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::GetRemarketingTagResponse] parsed result object
627
+ # @yieldparam err [StandardError] error object if request failed
628
+ #
629
+ # @return [Google::Apis::RealtimebiddingV1::GetRemarketingTagResponse]
630
+ #
631
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
632
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
633
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
634
+ def get_buyer_remarketing_tag(name, fields: nil, quota_user: nil, options: nil, &block)
635
+ command = make_simple_command(:get, 'v1/{+name}:getRemarketingTag', options)
636
+ command.response_representation = Google::Apis::RealtimebiddingV1::GetRemarketingTagResponse::Representation
637
+ command.response_class = Google::Apis::RealtimebiddingV1::GetRemarketingTagResponse
638
+ command.params['name'] = name unless name.nil?
639
+ command.query['fields'] = fields unless fields.nil?
640
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
641
+ execute_or_queue_command(command, &block)
642
+ end
643
+
644
+ # Creates a creative.
645
+ # @param [String] parent
646
+ # Required. The name of the parent buyer that the new creative belongs to that
647
+ # must follow the pattern `buyers/`buyerAccountId``, where ``buyerAccountId``
648
+ # represents the account ID of the buyer who owns a creative. For a bidder
649
+ # accessing creatives on behalf of a child seat buyer, ``buyerAccountId`` should
650
+ # represent the account ID of the child seat buyer.
651
+ # @param [Google::Apis::RealtimebiddingV1::Creative] creative_object
652
+ # @param [String] fields
653
+ # Selector specifying which fields to include in a partial response.
654
+ # @param [String] quota_user
655
+ # Available to use for quota purposes for server-side applications. Can be any
656
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
657
+ # @param [Google::Apis::RequestOptions] options
658
+ # Request-specific options
659
+ #
660
+ # @yield [result, err] Result & error if block supplied
661
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::Creative] parsed result object
662
+ # @yieldparam err [StandardError] error object if request failed
663
+ #
664
+ # @return [Google::Apis::RealtimebiddingV1::Creative]
665
+ #
666
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
667
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
668
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
669
+ def create_buyer_creative(parent, creative_object = nil, fields: nil, quota_user: nil, options: nil, &block)
670
+ command = make_simple_command(:post, 'v1/{+parent}/creatives', options)
671
+ command.request_representation = Google::Apis::RealtimebiddingV1::Creative::Representation
672
+ command.request_object = creative_object
673
+ command.response_representation = Google::Apis::RealtimebiddingV1::Creative::Representation
674
+ command.response_class = Google::Apis::RealtimebiddingV1::Creative
675
+ command.params['parent'] = parent unless parent.nil?
676
+ command.query['fields'] = fields unless fields.nil?
677
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
678
+ execute_or_queue_command(command, &block)
679
+ end
680
+
681
+ # Gets a creative.
682
+ # @param [String] name
683
+ # Required. Name of the creative to retrieve. See creative.name.
684
+ # @param [String] view
685
+ # Controls the amount of information included in the response. By default only
686
+ # creativeServingDecision is included. To retrieve the entire creative resource (
687
+ # including the declared fields and the creative content) specify the view as "
688
+ # FULL".
689
+ # @param [String] fields
690
+ # Selector specifying which fields to include in a partial response.
691
+ # @param [String] quota_user
692
+ # Available to use for quota purposes for server-side applications. Can be any
693
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
694
+ # @param [Google::Apis::RequestOptions] options
695
+ # Request-specific options
696
+ #
697
+ # @yield [result, err] Result & error if block supplied
698
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::Creative] parsed result object
699
+ # @yieldparam err [StandardError] error object if request failed
700
+ #
701
+ # @return [Google::Apis::RealtimebiddingV1::Creative]
702
+ #
703
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
704
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
705
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
706
+ def get_buyer_creative(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
707
+ command = make_simple_command(:get, 'v1/{+name}', options)
708
+ command.response_representation = Google::Apis::RealtimebiddingV1::Creative::Representation
709
+ command.response_class = Google::Apis::RealtimebiddingV1::Creative
710
+ command.params['name'] = name unless name.nil?
711
+ command.query['view'] = view unless view.nil?
712
+ command.query['fields'] = fields unless fields.nil?
713
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
714
+ execute_or_queue_command(command, &block)
715
+ end
716
+
717
+ # Lists creatives.
718
+ # @param [String] parent
719
+ # Required. Name of the parent buyer that owns the creatives. The pattern for
720
+ # this resource is either `buyers/`buyerAccountId`` or `bidders/`bidderAccountId`
721
+ # `. For `buyers/`buyerAccountId``, the `buyerAccountId` can be one of the
722
+ # following: 1. The ID of the buyer that is accessing their own creatives. 2.
723
+ # The ID of the child seat buyer under a bidder account. So for listing
724
+ # creatives pertaining to the child seat buyer (`456`) under bidder account (`
725
+ # 123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself.
726
+ # So for listing creatives pertaining to bidder (`123`), you would use `buyers/
727
+ # 123`. If you want to access all creatives pertaining to both the bidder and
728
+ # all of its child seat accounts, you would use `bidders/`bidderAccountId``, e.g.
729
+ # , for all creatives pertaining to bidder (`123`), use `bidders/123`.
730
+ # @param [String] filter
731
+ # Query string to filter creatives. If no filter is specified, all active
732
+ # creatives will be returned. Example: 'accountId=12345 AND (dealsStatus:
733
+ # DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes:
734
+ # IS_COOKIE_TARGETED'
735
+ # @param [Fixnum] page_size
736
+ # Requested page size. The server may return fewer creatives than requested (due
737
+ # to timeout constraint) even if more are available via another call. If
738
+ # unspecified, server will pick an appropriate default. Acceptable values are 1
739
+ # to 1000, inclusive.
740
+ # @param [String] page_token
741
+ # A token identifying a page of results the server should return. Typically,
742
+ # this is the value of ListCreativesResponse.nextPageToken returned from the
743
+ # previous call to the 'ListCreatives' method.
744
+ # @param [String] view
745
+ # Controls the amount of information included in the response. By default only
746
+ # creativeServingDecision is included. To retrieve the entire creative resource (
747
+ # including the declared fields and the creative content) specify the view as "
748
+ # FULL".
749
+ # @param [String] fields
750
+ # Selector specifying which fields to include in a partial response.
751
+ # @param [String] quota_user
752
+ # Available to use for quota purposes for server-side applications. Can be any
753
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
754
+ # @param [Google::Apis::RequestOptions] options
755
+ # Request-specific options
756
+ #
757
+ # @yield [result, err] Result & error if block supplied
758
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::ListCreativesResponse] parsed result object
759
+ # @yieldparam err [StandardError] error object if request failed
760
+ #
761
+ # @return [Google::Apis::RealtimebiddingV1::ListCreativesResponse]
762
+ #
763
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
764
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
765
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
766
+ def list_buyer_creatives(parent, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
767
+ command = make_simple_command(:get, 'v1/{+parent}/creatives', options)
768
+ command.response_representation = Google::Apis::RealtimebiddingV1::ListCreativesResponse::Representation
769
+ command.response_class = Google::Apis::RealtimebiddingV1::ListCreativesResponse
770
+ command.params['parent'] = parent unless parent.nil?
771
+ command.query['filter'] = filter unless filter.nil?
772
+ command.query['pageSize'] = page_size unless page_size.nil?
773
+ command.query['pageToken'] = page_token unless page_token.nil?
774
+ command.query['view'] = view unless view.nil?
775
+ command.query['fields'] = fields unless fields.nil?
776
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
777
+ execute_or_queue_command(command, &block)
778
+ end
779
+
780
+ # Updates a creative.
781
+ # @param [String] name
782
+ # Output only. Name of the creative. Follows the pattern `buyers/`buyer`/
783
+ # creatives/`creative``, where ``buyer`` represents the account ID of the buyer
784
+ # who owns the creative, and ``creative`` is the buyer-specific creative ID that
785
+ # references this creative in the bid response.
786
+ # @param [Google::Apis::RealtimebiddingV1::Creative] creative_object
787
+ # @param [String] update_mask
788
+ # Field mask to use for partial in-place updates.
789
+ # @param [String] fields
790
+ # Selector specifying which fields to include in a partial response.
791
+ # @param [String] quota_user
792
+ # Available to use for quota purposes for server-side applications. Can be any
793
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
794
+ # @param [Google::Apis::RequestOptions] options
795
+ # Request-specific options
796
+ #
797
+ # @yield [result, err] Result & error if block supplied
798
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::Creative] parsed result object
799
+ # @yieldparam err [StandardError] error object if request failed
800
+ #
801
+ # @return [Google::Apis::RealtimebiddingV1::Creative]
802
+ #
803
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
804
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
805
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
806
+ def patch_buyer_creative(name, creative_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
807
+ command = make_simple_command(:patch, 'v1/{+name}', options)
808
+ command.request_representation = Google::Apis::RealtimebiddingV1::Creative::Representation
809
+ command.request_object = creative_object
810
+ command.response_representation = Google::Apis::RealtimebiddingV1::Creative::Representation
811
+ command.response_class = Google::Apis::RealtimebiddingV1::Creative
812
+ command.params['name'] = name unless name.nil?
813
+ command.query['updateMask'] = update_mask unless update_mask.nil?
814
+ command.query['fields'] = fields unless fields.nil?
815
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
816
+ execute_or_queue_command(command, &block)
817
+ end
818
+
819
+ # Change the status of a user list to CLOSED. This prevents new users from being
820
+ # added to the user list.
821
+ # @param [String] name
822
+ # Required. The name of the user list to close. See UserList.name
823
+ # @param [Google::Apis::RealtimebiddingV1::CloseUserListRequest] close_user_list_request_object
824
+ # @param [String] fields
825
+ # Selector specifying which fields to include in a partial response.
826
+ # @param [String] quota_user
827
+ # Available to use for quota purposes for server-side applications. Can be any
828
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
829
+ # @param [Google::Apis::RequestOptions] options
830
+ # Request-specific options
831
+ #
832
+ # @yield [result, err] Result & error if block supplied
833
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::UserList] parsed result object
834
+ # @yieldparam err [StandardError] error object if request failed
835
+ #
836
+ # @return [Google::Apis::RealtimebiddingV1::UserList]
837
+ #
838
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
839
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
840
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
841
+ def close_user_list(name, close_user_list_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
842
+ command = make_simple_command(:post, 'v1/{+name}:close', options)
843
+ command.request_representation = Google::Apis::RealtimebiddingV1::CloseUserListRequest::Representation
844
+ command.request_object = close_user_list_request_object
845
+ command.response_representation = Google::Apis::RealtimebiddingV1::UserList::Representation
846
+ command.response_class = Google::Apis::RealtimebiddingV1::UserList
847
+ command.params['name'] = name unless name.nil?
848
+ command.query['fields'] = fields unless fields.nil?
849
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
850
+ execute_or_queue_command(command, &block)
851
+ end
852
+
853
+ # Create a new user list.
854
+ # @param [String] parent
855
+ # Required. The name of the parent buyer of the user list to be retrieved that
856
+ # must follow the pattern `buyers/`buyerAccountId``, where ``buyerAccountId``
857
+ # represents the account ID of the buyer who owns user lists. For a bidder
858
+ # accessing user lists on behalf of a child seat buyer , ``buyerAccountId``
859
+ # should represent the account ID of the child seat buyer.
860
+ # @param [Google::Apis::RealtimebiddingV1::UserList] user_list_object
861
+ # @param [String] fields
862
+ # Selector specifying which fields to include in a partial response.
863
+ # @param [String] quota_user
864
+ # Available to use for quota purposes for server-side applications. Can be any
865
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
866
+ # @param [Google::Apis::RequestOptions] options
867
+ # Request-specific options
868
+ #
869
+ # @yield [result, err] Result & error if block supplied
870
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::UserList] parsed result object
871
+ # @yieldparam err [StandardError] error object if request failed
872
+ #
873
+ # @return [Google::Apis::RealtimebiddingV1::UserList]
874
+ #
875
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
876
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
877
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
878
+ def create_buyer_user_list(parent, user_list_object = nil, fields: nil, quota_user: nil, options: nil, &block)
879
+ command = make_simple_command(:post, 'v1/{+parent}/userLists', options)
880
+ command.request_representation = Google::Apis::RealtimebiddingV1::UserList::Representation
881
+ command.request_object = user_list_object
882
+ command.response_representation = Google::Apis::RealtimebiddingV1::UserList::Representation
883
+ command.response_class = Google::Apis::RealtimebiddingV1::UserList
884
+ command.params['parent'] = parent unless parent.nil?
885
+ command.query['fields'] = fields unless fields.nil?
886
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
887
+ execute_or_queue_command(command, &block)
888
+ end
889
+
890
+ # Gets a user list by its name.
891
+ # @param [String] name
892
+ # Required. The name of the user list to be retrieved. See UserList.name.
893
+ # @param [String] fields
894
+ # Selector specifying which fields to include in a partial response.
895
+ # @param [String] quota_user
896
+ # Available to use for quota purposes for server-side applications. Can be any
897
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
898
+ # @param [Google::Apis::RequestOptions] options
899
+ # Request-specific options
900
+ #
901
+ # @yield [result, err] Result & error if block supplied
902
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::UserList] parsed result object
903
+ # @yieldparam err [StandardError] error object if request failed
904
+ #
905
+ # @return [Google::Apis::RealtimebiddingV1::UserList]
906
+ #
907
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
908
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
909
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
910
+ def get_buyer_user_list(name, fields: nil, quota_user: nil, options: nil, &block)
911
+ command = make_simple_command(:get, 'v1/{+name}', options)
912
+ command.response_representation = Google::Apis::RealtimebiddingV1::UserList::Representation
913
+ command.response_class = Google::Apis::RealtimebiddingV1::UserList
914
+ command.params['name'] = name unless name.nil?
915
+ command.query['fields'] = fields unless fields.nil?
916
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
917
+ execute_or_queue_command(command, &block)
918
+ end
919
+
920
+ # Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript
921
+ # code that can be placed on a web page. When a user visits a page containing a
922
+ # remarketing tag, Google adds the user to a user list.
923
+ # @param [String] name
924
+ # Required. To fetch remarketing tag for an account, name must follow the
925
+ # pattern `buyers/`accountId`` where ``accountId`` represents ID of a buyer that
926
+ # owns the remarketing tag. For a bidder accessing remarketing tag on behalf of
927
+ # a child seat buyer, ``accountId`` should represent the ID of the child seat
928
+ # buyer. To fetch remarketing tag for a specific user list, name must follow the
929
+ # pattern `buyers/`accountId`/userLists/`userListId``. See UserList.name.
930
+ # @param [String] fields
931
+ # Selector specifying which fields to include in a partial response.
932
+ # @param [String] quota_user
933
+ # Available to use for quota purposes for server-side applications. Can be any
934
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
935
+ # @param [Google::Apis::RequestOptions] options
936
+ # Request-specific options
937
+ #
938
+ # @yield [result, err] Result & error if block supplied
939
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::GetRemarketingTagResponse] parsed result object
940
+ # @yieldparam err [StandardError] error object if request failed
941
+ #
942
+ # @return [Google::Apis::RealtimebiddingV1::GetRemarketingTagResponse]
943
+ #
944
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
945
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
946
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
947
+ def get_buyer_user_list_remarketing_tag(name, fields: nil, quota_user: nil, options: nil, &block)
948
+ command = make_simple_command(:get, 'v1/{+name}:getRemarketingTag', options)
949
+ command.response_representation = Google::Apis::RealtimebiddingV1::GetRemarketingTagResponse::Representation
950
+ command.response_class = Google::Apis::RealtimebiddingV1::GetRemarketingTagResponse
951
+ command.params['name'] = name unless name.nil?
952
+ command.query['fields'] = fields unless fields.nil?
953
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
954
+ execute_or_queue_command(command, &block)
955
+ end
956
+
957
+ # Lists the user lists visible to the current user.
958
+ # @param [String] parent
959
+ # Required. The name of the parent buyer for the user lists to be returned that
960
+ # must follow the pattern `buyers/`buyerAccountId``, where ``buyerAccountId``
961
+ # represents the account ID of the buyer who owns user lists. For a bidder
962
+ # accessing user lists on behalf of a child seat buyer , ``buyerAccountId``
963
+ # should represent the account ID of the child seat buyer.
964
+ # @param [Fixnum] page_size
965
+ # The number of results to return per page.
966
+ # @param [String] page_token
967
+ # Continuation page token (as received from a previous response).
968
+ # @param [String] fields
969
+ # Selector specifying which fields to include in a partial response.
970
+ # @param [String] quota_user
971
+ # Available to use for quota purposes for server-side applications. Can be any
972
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
973
+ # @param [Google::Apis::RequestOptions] options
974
+ # Request-specific options
975
+ #
976
+ # @yield [result, err] Result & error if block supplied
977
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::ListUserListsResponse] parsed result object
978
+ # @yieldparam err [StandardError] error object if request failed
979
+ #
980
+ # @return [Google::Apis::RealtimebiddingV1::ListUserListsResponse]
981
+ #
982
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
983
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
984
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
985
+ def list_buyer_user_lists(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
986
+ command = make_simple_command(:get, 'v1/{+parent}/userLists', options)
987
+ command.response_representation = Google::Apis::RealtimebiddingV1::ListUserListsResponse::Representation
988
+ command.response_class = Google::Apis::RealtimebiddingV1::ListUserListsResponse
989
+ command.params['parent'] = parent unless parent.nil?
990
+ command.query['pageSize'] = page_size unless page_size.nil?
991
+ command.query['pageToken'] = page_token unless page_token.nil?
992
+ command.query['fields'] = fields unless fields.nil?
993
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
994
+ execute_or_queue_command(command, &block)
995
+ end
996
+
997
+ # Change the status of a user list to OPEN. This allows new users to be added to
998
+ # the user list.
999
+ # @param [String] name
1000
+ # Required. The name of the user list to open. See UserList.name
1001
+ # @param [Google::Apis::RealtimebiddingV1::OpenUserListRequest] open_user_list_request_object
1002
+ # @param [String] fields
1003
+ # Selector specifying which fields to include in a partial response.
1004
+ # @param [String] quota_user
1005
+ # Available to use for quota purposes for server-side applications. Can be any
1006
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1007
+ # @param [Google::Apis::RequestOptions] options
1008
+ # Request-specific options
1009
+ #
1010
+ # @yield [result, err] Result & error if block supplied
1011
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::UserList] parsed result object
1012
+ # @yieldparam err [StandardError] error object if request failed
1013
+ #
1014
+ # @return [Google::Apis::RealtimebiddingV1::UserList]
1015
+ #
1016
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1017
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1018
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1019
+ def open_user_list(name, open_user_list_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1020
+ command = make_simple_command(:post, 'v1/{+name}:open', options)
1021
+ command.request_representation = Google::Apis::RealtimebiddingV1::OpenUserListRequest::Representation
1022
+ command.request_object = open_user_list_request_object
1023
+ command.response_representation = Google::Apis::RealtimebiddingV1::UserList::Representation
1024
+ command.response_class = Google::Apis::RealtimebiddingV1::UserList
1025
+ command.params['name'] = name unless name.nil?
1026
+ command.query['fields'] = fields unless fields.nil?
1027
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1028
+ execute_or_queue_command(command, &block)
1029
+ end
1030
+
1031
+ # Update the given user list. Only user lists with URLRestrictions can be
1032
+ # updated.
1033
+ # @param [String] name
1034
+ # Output only. Name of the user list that must follow the pattern `buyers/`buyer`
1035
+ # /userLists/`user_list``, where ``buyer`` represents the account ID of the
1036
+ # buyer who owns the user list. For a bidder accessing user lists on behalf of a
1037
+ # child seat buyer, ``buyer`` represents the account ID of the child seat buyer.
1038
+ # ``user_list`` is an int64 identifier assigned by Google to uniquely identify a
1039
+ # user list.
1040
+ # @param [Google::Apis::RealtimebiddingV1::UserList] user_list_object
1041
+ # @param [String] fields
1042
+ # Selector specifying which fields to include in a partial response.
1043
+ # @param [String] quota_user
1044
+ # Available to use for quota purposes for server-side applications. Can be any
1045
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1046
+ # @param [Google::Apis::RequestOptions] options
1047
+ # Request-specific options
1048
+ #
1049
+ # @yield [result, err] Result & error if block supplied
1050
+ # @yieldparam result [Google::Apis::RealtimebiddingV1::UserList] parsed result object
1051
+ # @yieldparam err [StandardError] error object if request failed
1052
+ #
1053
+ # @return [Google::Apis::RealtimebiddingV1::UserList]
1054
+ #
1055
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1056
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1057
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1058
+ def update_buyer_user_list(name, user_list_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1059
+ command = make_simple_command(:put, 'v1/{+name}', options)
1060
+ command.request_representation = Google::Apis::RealtimebiddingV1::UserList::Representation
1061
+ command.request_object = user_list_object
1062
+ command.response_representation = Google::Apis::RealtimebiddingV1::UserList::Representation
1063
+ command.response_class = Google::Apis::RealtimebiddingV1::UserList
1064
+ command.params['name'] = name unless name.nil?
1065
+ command.query['fields'] = fields unless fields.nil?
1066
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1067
+ execute_or_queue_command(command, &block)
1068
+ end
1069
+
1070
+ protected
1071
+
1072
+ def apply_command_defaults(command)
1073
+ command.query['key'] = key unless key.nil?
1074
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1075
+ end
1076
+ end
1077
+ end
1078
+ end
1079
+ end