google-apis-admob_v1beta 0.22.0 → 0.23.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -158,6 +158,116 @@ module Google
158
158
  execute_or_queue_command(command, &block)
159
159
  end
160
160
 
161
+ # List the adapters of the ad source.
162
+ # @param [String] parent
163
+ # Required. The parent which owns this collection of adapters. Format: accounts/`
164
+ # publisher_id`/adSources/`ad_source_id`
165
+ # @param [Fixnum] page_size
166
+ # The maximum number of adapters to return. If unspecified or 0, at most 10,000
167
+ # adapters will be returned. The maximum value is 20,000; values above 20,000
168
+ # will be coerced to 20,000.
169
+ # @param [String] page_token
170
+ # A page token, received from a previous `ListAdapters` call. Provide this to
171
+ # retrieve the subsequent page.
172
+ # @param [String] fields
173
+ # Selector specifying which fields to include in a partial response.
174
+ # @param [String] quota_user
175
+ # Available to use for quota purposes for server-side applications. Can be any
176
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
177
+ # @param [Google::Apis::RequestOptions] options
178
+ # Request-specific options
179
+ #
180
+ # @yield [result, err] Result & error if block supplied
181
+ # @yieldparam result [Google::Apis::AdmobV1beta::ListAdaptersResponse] parsed result object
182
+ # @yieldparam err [StandardError] error object if request failed
183
+ #
184
+ # @return [Google::Apis::AdmobV1beta::ListAdaptersResponse]
185
+ #
186
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
187
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
188
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
189
+ def list_account_ad_source_adapters(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
190
+ command = make_simple_command(:get, 'v1beta/{+parent}/adapters', options)
191
+ command.response_representation = Google::Apis::AdmobV1beta::ListAdaptersResponse::Representation
192
+ command.response_class = Google::Apis::AdmobV1beta::ListAdaptersResponse
193
+ command.params['parent'] = parent unless parent.nil?
194
+ command.query['pageSize'] = page_size unless page_size.nil?
195
+ command.query['pageToken'] = page_token unless page_token.nil?
196
+ command.query['fields'] = fields unless fields.nil?
197
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
198
+ execute_or_queue_command(command, &block)
199
+ end
200
+
201
+ # Batch create the ad unit mappings under the specific AdMob account. The
202
+ # maximum allowed batch size is 100.
203
+ # @param [String] parent
204
+ # Required. The AdMob account which owns this collection of ad unit mappings.
205
+ # Format: accounts/`publisher_id` See https://support.google.com/admob/answer/
206
+ # 2784578 for instructions on how to find your AdMob publisher ID.
207
+ # @param [Google::Apis::AdmobV1beta::BatchCreateAdUnitMappingsRequest] batch_create_ad_unit_mappings_request_object
208
+ # @param [String] fields
209
+ # Selector specifying which fields to include in a partial response.
210
+ # @param [String] quota_user
211
+ # Available to use for quota purposes for server-side applications. Can be any
212
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
213
+ # @param [Google::Apis::RequestOptions] options
214
+ # Request-specific options
215
+ #
216
+ # @yield [result, err] Result & error if block supplied
217
+ # @yieldparam result [Google::Apis::AdmobV1beta::BatchCreateAdUnitMappingsResponse] parsed result object
218
+ # @yieldparam err [StandardError] error object if request failed
219
+ #
220
+ # @return [Google::Apis::AdmobV1beta::BatchCreateAdUnitMappingsResponse]
221
+ #
222
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
223
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
224
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
225
+ def batch_create_ad_unit_mappings(parent, batch_create_ad_unit_mappings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
226
+ command = make_simple_command(:post, 'v1beta/{+parent}/adUnitMappings:batchCreate', options)
227
+ command.request_representation = Google::Apis::AdmobV1beta::BatchCreateAdUnitMappingsRequest::Representation
228
+ command.request_object = batch_create_ad_unit_mappings_request_object
229
+ command.response_representation = Google::Apis::AdmobV1beta::BatchCreateAdUnitMappingsResponse::Representation
230
+ command.response_class = Google::Apis::AdmobV1beta::BatchCreateAdUnitMappingsResponse
231
+ command.params['parent'] = parent unless parent.nil?
232
+ command.query['fields'] = fields unless fields.nil?
233
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
234
+ execute_or_queue_command(command, &block)
235
+ end
236
+
237
+ # Creates an ad unit under the specified AdMob account.
238
+ # @param [String] parent
239
+ # Required. Resource name of the account to create the specified ad unit for.
240
+ # Example: accounts/pub-9876543210987654
241
+ # @param [Google::Apis::AdmobV1beta::AdUnit] ad_unit_object
242
+ # @param [String] fields
243
+ # Selector specifying which fields to include in a partial response.
244
+ # @param [String] quota_user
245
+ # Available to use for quota purposes for server-side applications. Can be any
246
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
247
+ # @param [Google::Apis::RequestOptions] options
248
+ # Request-specific options
249
+ #
250
+ # @yield [result, err] Result & error if block supplied
251
+ # @yieldparam result [Google::Apis::AdmobV1beta::AdUnit] parsed result object
252
+ # @yieldparam err [StandardError] error object if request failed
253
+ #
254
+ # @return [Google::Apis::AdmobV1beta::AdUnit]
255
+ #
256
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
257
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
258
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
259
+ def create_account_ad_unit(parent, ad_unit_object = nil, fields: nil, quota_user: nil, options: nil, &block)
260
+ command = make_simple_command(:post, 'v1beta/{+parent}/adUnits', options)
261
+ command.request_representation = Google::Apis::AdmobV1beta::AdUnit::Representation
262
+ command.request_object = ad_unit_object
263
+ command.response_representation = Google::Apis::AdmobV1beta::AdUnit::Representation
264
+ command.response_class = Google::Apis::AdmobV1beta::AdUnit
265
+ command.params['parent'] = parent unless parent.nil?
266
+ command.query['fields'] = fields unless fields.nil?
267
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
268
+ execute_or_queue_command(command, &block)
269
+ end
270
+
161
271
  # List the ad units under the specified AdMob account.
162
272
  # @param [String] parent
163
273
  # Required. Resource name of the account to list ad units for. Example: accounts/
@@ -199,6 +309,122 @@ module Google
199
309
  execute_or_queue_command(command, &block)
200
310
  end
201
311
 
312
+ # Create an ad unit mapping under the specific AdMob account and ad unit.
313
+ # @param [String] parent
314
+ # Required. The parent which owns the ad unit mapping. Format: accounts/`
315
+ # publisher_id`/adUnits/`ad_unit_id`
316
+ # @param [Google::Apis::AdmobV1beta::AdUnitMapping] ad_unit_mapping_object
317
+ # @param [String] fields
318
+ # Selector specifying which fields to include in a partial response.
319
+ # @param [String] quota_user
320
+ # Available to use for quota purposes for server-side applications. Can be any
321
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
322
+ # @param [Google::Apis::RequestOptions] options
323
+ # Request-specific options
324
+ #
325
+ # @yield [result, err] Result & error if block supplied
326
+ # @yieldparam result [Google::Apis::AdmobV1beta::AdUnitMapping] parsed result object
327
+ # @yieldparam err [StandardError] error object if request failed
328
+ #
329
+ # @return [Google::Apis::AdmobV1beta::AdUnitMapping]
330
+ #
331
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
332
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
333
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
334
+ def create_account_ad_unit_ad_unit_mapping(parent, ad_unit_mapping_object = nil, fields: nil, quota_user: nil, options: nil, &block)
335
+ command = make_simple_command(:post, 'v1beta/{+parent}/adUnitMappings', options)
336
+ command.request_representation = Google::Apis::AdmobV1beta::AdUnitMapping::Representation
337
+ command.request_object = ad_unit_mapping_object
338
+ command.response_representation = Google::Apis::AdmobV1beta::AdUnitMapping::Representation
339
+ command.response_class = Google::Apis::AdmobV1beta::AdUnitMapping
340
+ command.params['parent'] = parent unless parent.nil?
341
+ command.query['fields'] = fields unless fields.nil?
342
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
343
+ execute_or_queue_command(command, &block)
344
+ end
345
+
346
+ # List ad unit mappings under the specified AdMob account and ad unit.
347
+ # @param [String] parent
348
+ # Required. The parent which owns this collection of ad unit mappings. Format:
349
+ # accounts/`publisher_id`/adUnits/`ad_unit_id`
350
+ # @param [String] filter
351
+ # The filter string that uses [EBNF grammar syntax](https://google.aip.dev/
352
+ # assets/misc/ebnf-filtering.txt). Possible field to filter by is: - "
353
+ # DISPLAY_NAME" Possible filter function is: - `IN`: Used to filter fields that
354
+ # represent a singleton including "DISPLAY_NAME". The filter functions can be
355
+ # added together using `AND`. `OR` functionality is not supported. Example:
356
+ # filter: IN(DISPLAY_NAME, "Test Ad Unit Mapping 1", "Test Ad Unit Mapping 2")
357
+ # @param [Fixnum] page_size
358
+ # The maximum number of ad unit mappings to return. If unspecified or 0, at most
359
+ # 10,000 ad unit mappings will be returned. The maximum value is 20,000; values
360
+ # above 20,000 will be coerced to 20,000.
361
+ # @param [String] page_token
362
+ # A page token, received from a previous `ListAdUnitMappings` call. Provide this
363
+ # to retrieve the subsequent page.
364
+ # @param [String] fields
365
+ # Selector specifying which fields to include in a partial response.
366
+ # @param [String] quota_user
367
+ # Available to use for quota purposes for server-side applications. Can be any
368
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
369
+ # @param [Google::Apis::RequestOptions] options
370
+ # Request-specific options
371
+ #
372
+ # @yield [result, err] Result & error if block supplied
373
+ # @yieldparam result [Google::Apis::AdmobV1beta::ListAdUnitMappingsResponse] parsed result object
374
+ # @yieldparam err [StandardError] error object if request failed
375
+ #
376
+ # @return [Google::Apis::AdmobV1beta::ListAdUnitMappingsResponse]
377
+ #
378
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
379
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
380
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
381
+ def list_account_ad_unit_ad_unit_mappings(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
382
+ command = make_simple_command(:get, 'v1beta/{+parent}/adUnitMappings', options)
383
+ command.response_representation = Google::Apis::AdmobV1beta::ListAdUnitMappingsResponse::Representation
384
+ command.response_class = Google::Apis::AdmobV1beta::ListAdUnitMappingsResponse
385
+ command.params['parent'] = parent unless parent.nil?
386
+ command.query['filter'] = filter unless filter.nil?
387
+ command.query['pageSize'] = page_size unless page_size.nil?
388
+ command.query['pageToken'] = page_token unless page_token.nil?
389
+ command.query['fields'] = fields unless fields.nil?
390
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
391
+ execute_or_queue_command(command, &block)
392
+ end
393
+
394
+ # Creates an app under the specified AdMob account.
395
+ # @param [String] parent
396
+ # Required. Resource name of the account for which the app is being created.
397
+ # Example: accounts/pub-9876543210987654
398
+ # @param [Google::Apis::AdmobV1beta::App] app_object
399
+ # @param [String] fields
400
+ # Selector specifying which fields to include in a partial response.
401
+ # @param [String] quota_user
402
+ # Available to use for quota purposes for server-side applications. Can be any
403
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
404
+ # @param [Google::Apis::RequestOptions] options
405
+ # Request-specific options
406
+ #
407
+ # @yield [result, err] Result & error if block supplied
408
+ # @yieldparam result [Google::Apis::AdmobV1beta::App] parsed result object
409
+ # @yieldparam err [StandardError] error object if request failed
410
+ #
411
+ # @return [Google::Apis::AdmobV1beta::App]
412
+ #
413
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
414
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
415
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
416
+ def create_account_app(parent, app_object = nil, fields: nil, quota_user: nil, options: nil, &block)
417
+ command = make_simple_command(:post, 'v1beta/{+parent}/apps', options)
418
+ command.request_representation = Google::Apis::AdmobV1beta::App::Representation
419
+ command.request_object = app_object
420
+ command.response_representation = Google::Apis::AdmobV1beta::App::Representation
421
+ command.response_class = Google::Apis::AdmobV1beta::App
422
+ command.params['parent'] = parent unless parent.nil?
423
+ command.query['fields'] = fields unless fields.nil?
424
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
425
+ execute_or_queue_command(command, &block)
426
+ end
427
+
202
428
  # List the apps under the specified AdMob account.
203
429
  # @param [String] parent
204
430
  # Required. Resource name of the account to list apps for. Example: accounts/pub-
@@ -240,6 +466,333 @@ module Google
240
466
  execute_or_queue_command(command, &block)
241
467
  end
242
468
 
469
+ # Generates Campaign Report based on provided specifications.
470
+ # @param [String] parent
471
+ # Resource name of the account to generate the report for. Example: accounts/pub-
472
+ # 9876543210987654
473
+ # @param [Google::Apis::AdmobV1beta::GenerateCampaignReportRequest] generate_campaign_report_request_object
474
+ # @param [String] fields
475
+ # Selector specifying which fields to include in a partial response.
476
+ # @param [String] quota_user
477
+ # Available to use for quota purposes for server-side applications. Can be any
478
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
479
+ # @param [Google::Apis::RequestOptions] options
480
+ # Request-specific options
481
+ #
482
+ # @yield [result, err] Result & error if block supplied
483
+ # @yieldparam result [Google::Apis::AdmobV1beta::GenerateCampaignReportResponse] parsed result object
484
+ # @yieldparam err [StandardError] error object if request failed
485
+ #
486
+ # @return [Google::Apis::AdmobV1beta::GenerateCampaignReportResponse]
487
+ #
488
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
489
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
490
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
491
+ def generate_campaign_report(parent, generate_campaign_report_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
492
+ command = make_simple_command(:post, 'v1beta/{+parent}/campaignReport:generate', options)
493
+ command.request_representation = Google::Apis::AdmobV1beta::GenerateCampaignReportRequest::Representation
494
+ command.request_object = generate_campaign_report_request_object
495
+ command.response_representation = Google::Apis::AdmobV1beta::GenerateCampaignReportResponse::Representation
496
+ command.response_class = Google::Apis::AdmobV1beta::GenerateCampaignReportResponse
497
+ command.params['parent'] = parent unless parent.nil?
498
+ command.query['fields'] = fields unless fields.nil?
499
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
500
+ execute_or_queue_command(command, &block)
501
+ end
502
+
503
+ # Batch update operation for campaigns under the specified AdMob publisher.
504
+ # @param [String] parent
505
+ # Required. Resource name of the account to list campaigns for. The `parent`
506
+ # field in the individual UpdateCampaignRequest messages should match the value
507
+ # set here. Example: accounts/pub-9876543210987654
508
+ # @param [Google::Apis::AdmobV1beta::BatchUpdateCampaignsRequest] batch_update_campaigns_request_object
509
+ # @param [String] fields
510
+ # Selector specifying which fields to include in a partial response.
511
+ # @param [String] quota_user
512
+ # Available to use for quota purposes for server-side applications. Can be any
513
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
514
+ # @param [Google::Apis::RequestOptions] options
515
+ # Request-specific options
516
+ #
517
+ # @yield [result, err] Result & error if block supplied
518
+ # @yieldparam result [Google::Apis::AdmobV1beta::BatchUpdateCampaignsResponse] parsed result object
519
+ # @yieldparam err [StandardError] error object if request failed
520
+ #
521
+ # @return [Google::Apis::AdmobV1beta::BatchUpdateCampaignsResponse]
522
+ #
523
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
524
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
525
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
526
+ def batch_update_campaigns(parent, batch_update_campaigns_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
527
+ command = make_simple_command(:post, 'v1beta/{+parent}/campaigns:batchUpdate', options)
528
+ command.request_representation = Google::Apis::AdmobV1beta::BatchUpdateCampaignsRequest::Representation
529
+ command.request_object = batch_update_campaigns_request_object
530
+ command.response_representation = Google::Apis::AdmobV1beta::BatchUpdateCampaignsResponse::Representation
531
+ command.response_class = Google::Apis::AdmobV1beta::BatchUpdateCampaignsResponse
532
+ command.params['parent'] = parent unless parent.nil?
533
+ command.query['fields'] = fields unless fields.nil?
534
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
535
+ execute_or_queue_command(command, &block)
536
+ end
537
+
538
+ # List the campaigns under the specified AdMob account.
539
+ # @param [String] parent
540
+ # Required. Resource name of the account to list campaigns for. Example:
541
+ # accounts/pub-9876543210987654
542
+ # @param [String] filter
543
+ # The filter string that uses [EBNF grammar syntax](https://google.aip.dev/
544
+ # assets/misc/ebnf-filtering.txt). Possible field to filter by is: - "
545
+ # CAMPAIGN_GOAL_TYPE" Possible filter function is: - `IN`: Used to filter fields
546
+ # that represent a singleton including "CAMPAIGN_GOAL_TYPE". The filter
547
+ # functions can be added together using `AND`. `OR` functionality is not
548
+ # supported. Example: filter: IN(CAMPAIGN_GOAL_TYPE, "NUMBER_OF_CLICKS", "
549
+ # MEDIATED_ADS")
550
+ # @param [Fixnum] page_size
551
+ # The maximum number of campaigns to return.
552
+ # @param [String] page_token
553
+ # The value returned by the last `ListCampaignsResponse`; indicates that this is
554
+ # a continuation of a prior `ListGoogleBiddingAdUnits` call, and that the system
555
+ # should return the next page of data.
556
+ # @param [String] fields
557
+ # Selector specifying which fields to include in a partial response.
558
+ # @param [String] quota_user
559
+ # Available to use for quota purposes for server-side applications. Can be any
560
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
561
+ # @param [Google::Apis::RequestOptions] options
562
+ # Request-specific options
563
+ #
564
+ # @yield [result, err] Result & error if block supplied
565
+ # @yieldparam result [Google::Apis::AdmobV1beta::ListCampaignsResponse] parsed result object
566
+ # @yieldparam err [StandardError] error object if request failed
567
+ #
568
+ # @return [Google::Apis::AdmobV1beta::ListCampaignsResponse]
569
+ #
570
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
571
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
572
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
573
+ def list_account_campaigns(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
574
+ command = make_simple_command(:get, 'v1beta/{+parent}/campaigns', options)
575
+ command.response_representation = Google::Apis::AdmobV1beta::ListCampaignsResponse::Representation
576
+ command.response_class = Google::Apis::AdmobV1beta::ListCampaignsResponse
577
+ command.params['parent'] = parent unless parent.nil?
578
+ command.query['filter'] = filter unless filter.nil?
579
+ command.query['pageSize'] = page_size unless page_size.nil?
580
+ command.query['pageToken'] = page_token unless page_token.nil?
581
+ command.query['fields'] = fields unless fields.nil?
582
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
583
+ execute_or_queue_command(command, &block)
584
+ end
585
+
586
+ # Create a mediation group under the specific AdMob account.
587
+ # @param [String] parent
588
+ # Required. The parent which owns the mediation group. Format: accounts/`
589
+ # publisher_id`
590
+ # @param [Google::Apis::AdmobV1beta::MediationGroup] mediation_group_object
591
+ # @param [String] fields
592
+ # Selector specifying which fields to include in a partial response.
593
+ # @param [String] quota_user
594
+ # Available to use for quota purposes for server-side applications. Can be any
595
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
596
+ # @param [Google::Apis::RequestOptions] options
597
+ # Request-specific options
598
+ #
599
+ # @yield [result, err] Result & error if block supplied
600
+ # @yieldparam result [Google::Apis::AdmobV1beta::MediationGroup] parsed result object
601
+ # @yieldparam err [StandardError] error object if request failed
602
+ #
603
+ # @return [Google::Apis::AdmobV1beta::MediationGroup]
604
+ #
605
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
606
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
607
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
608
+ def create_account_mediation_group(parent, mediation_group_object = nil, fields: nil, quota_user: nil, options: nil, &block)
609
+ command = make_simple_command(:post, 'v1beta/{+parent}/mediationGroups', options)
610
+ command.request_representation = Google::Apis::AdmobV1beta::MediationGroup::Representation
611
+ command.request_object = mediation_group_object
612
+ command.response_representation = Google::Apis::AdmobV1beta::MediationGroup::Representation
613
+ command.response_class = Google::Apis::AdmobV1beta::MediationGroup
614
+ command.params['parent'] = parent unless parent.nil?
615
+ command.query['fields'] = fields unless fields.nil?
616
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
617
+ execute_or_queue_command(command, &block)
618
+ end
619
+
620
+ # List mediation groups under the specified AdMob account.
621
+ # @param [String] parent
622
+ # Required. Resource name of the account to list mediation groups for. Example:
623
+ # accounts/pub-9876543210987654
624
+ # @param [String] filter
625
+ # The filter string that uses [EBNF grammar syntax](https://google.aip.dev/
626
+ # assets/misc/ebnf-filtering.txt). Possible fields to filter by are: - "
627
+ # AD_SOURCE_IDS" - "AD_UNIT_IDS" - "APP_IDS" - "DISPLAY_NAME" - "FORMAT" - "
628
+ # MEDIATION_GROUP_ID" - "PLATFORM" - "STATE" - "TARGETED_REGION_CODES" Possible
629
+ # filter functions are: - `IN`: Used to filter fields that represent a singleton
630
+ # including "MEDIATION_GROUP_ID", "DISPLAY_NAME", "STATE", "PLATFORM", and "
631
+ # FORMAT". - `CONTAINS_ANY`: Used to filter fields that represent a collection
632
+ # including "AD_SOURCE_IDS", "AD_UNIT_IDS", "APP_IDS", and "
633
+ # TARGETED_REGION_CODES". The filter functions can be added together using `AND`.
634
+ # `OR` functionality is not supported. Example: filter: IN(DISPLAY_NAME, "Test
635
+ # Group 1", "Test Group 2") AND IN(PLATFORM, "ANDROID") AND CONTAINS_ANY(
636
+ # AD_SOURCE_IDS, "5450213213286189855")
637
+ # @param [Fixnum] page_size
638
+ # The maximum number of mediation groups to return. If unspecified or 0, at most
639
+ # 10,000 mediation groups will be returned. The maximum value is 20,000; values
640
+ # above 20,000 will be coerced to 20,000.
641
+ # @param [String] page_token
642
+ # The value returned by the last `ListMediationGroupsResponse`; indicates that
643
+ # this is a continuation of a prior `ListMediationGroups` call, and that the
644
+ # system should return the next page of data.
645
+ # @param [String] fields
646
+ # Selector specifying which fields to include in a partial response.
647
+ # @param [String] quota_user
648
+ # Available to use for quota purposes for server-side applications. Can be any
649
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
650
+ # @param [Google::Apis::RequestOptions] options
651
+ # Request-specific options
652
+ #
653
+ # @yield [result, err] Result & error if block supplied
654
+ # @yieldparam result [Google::Apis::AdmobV1beta::ListMediationGroupsResponse] parsed result object
655
+ # @yieldparam err [StandardError] error object if request failed
656
+ #
657
+ # @return [Google::Apis::AdmobV1beta::ListMediationGroupsResponse]
658
+ #
659
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
660
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
661
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
662
+ def list_account_mediation_groups(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
663
+ command = make_simple_command(:get, 'v1beta/{+parent}/mediationGroups', options)
664
+ command.response_representation = Google::Apis::AdmobV1beta::ListMediationGroupsResponse::Representation
665
+ command.response_class = Google::Apis::AdmobV1beta::ListMediationGroupsResponse
666
+ command.params['parent'] = parent unless parent.nil?
667
+ command.query['filter'] = filter unless filter.nil?
668
+ command.query['pageSize'] = page_size unless page_size.nil?
669
+ command.query['pageToken'] = page_token unless page_token.nil?
670
+ command.query['fields'] = fields unless fields.nil?
671
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
672
+ execute_or_queue_command(command, &block)
673
+ end
674
+
675
+ # Update the specified mediation group under the specified AdMob account.
676
+ # @param [String] name
677
+ # Resource name for this mediation group. Format is: accounts/`publisher_id`/
678
+ # mediationGroups/`mediation_group_id` Example: accounts/pub-9876543210987654/
679
+ # mediationGroups/0123456789
680
+ # @param [Google::Apis::AdmobV1beta::MediationGroup] mediation_group_object
681
+ # @param [String] update_mask
682
+ # List of mediation group fields to be updated. Updates to repeated fields such
683
+ # as items in a list will fully replace the existing value(s) with the new value(
684
+ # s). Updates to individual values in a map can be done by indexing by the key.
685
+ # The following field masks are supported for mediation group updates: - "
686
+ # mediation_group_lines[\"`mediation_group_line_id`\"]" clang-format off - "
687
+ # mediation_group_lines[\"`mediation_group_line_id`\"].ad_unit_mappings[\"`
688
+ # ad_unit_id`\"]" clang-format on - "mediation_group_lines[\"`
689
+ # mediation_group_line_id`\"].cpm_micros" - "mediation_group_lines[\"`
690
+ # mediation_group_line_id`\"].cpm_mode" - "mediation_group_lines[\"`
691
+ # mediation_group_line_id`\"].state" - "mediation_group_lines[\"`
692
+ # mediation_group_line_id`\"].display_name" - "targeting.ad_unit_ids" To update
693
+ # a mediation group with a new mediation group line, use a distinct negative
694
+ # number for the "mediation_group_line_id". For Example: update_mask ` paths: "
695
+ # mediation_group_lines[\"123456789012345\"].cpm_micros" `
696
+ # @param [String] fields
697
+ # Selector specifying which fields to include in a partial response.
698
+ # @param [String] quota_user
699
+ # Available to use for quota purposes for server-side applications. Can be any
700
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
701
+ # @param [Google::Apis::RequestOptions] options
702
+ # Request-specific options
703
+ #
704
+ # @yield [result, err] Result & error if block supplied
705
+ # @yieldparam result [Google::Apis::AdmobV1beta::MediationGroup] parsed result object
706
+ # @yieldparam err [StandardError] error object if request failed
707
+ #
708
+ # @return [Google::Apis::AdmobV1beta::MediationGroup]
709
+ #
710
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
711
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
712
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
713
+ def patch_account_mediation_group(name, mediation_group_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
714
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
715
+ command.request_representation = Google::Apis::AdmobV1beta::MediationGroup::Representation
716
+ command.request_object = mediation_group_object
717
+ command.response_representation = Google::Apis::AdmobV1beta::MediationGroup::Representation
718
+ command.response_class = Google::Apis::AdmobV1beta::MediationGroup
719
+ command.params['name'] = name unless name.nil?
720
+ command.query['updateMask'] = update_mask unless update_mask.nil?
721
+ command.query['fields'] = fields unless fields.nil?
722
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
723
+ execute_or_queue_command(command, &block)
724
+ end
725
+
726
+ # Create an A/B testing experiment for a specified AdMob account and a mediation
727
+ # group.
728
+ # @param [String] parent
729
+ # Required. The parent which owns the mediation group. Format: accounts/`
730
+ # publisher_id`/mediationGroups/`mediation_group_id`
731
+ # @param [Google::Apis::AdmobV1beta::MediationAbExperiment] mediation_ab_experiment_object
732
+ # @param [String] fields
733
+ # Selector specifying which fields to include in a partial response.
734
+ # @param [String] quota_user
735
+ # Available to use for quota purposes for server-side applications. Can be any
736
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
737
+ # @param [Google::Apis::RequestOptions] options
738
+ # Request-specific options
739
+ #
740
+ # @yield [result, err] Result & error if block supplied
741
+ # @yieldparam result [Google::Apis::AdmobV1beta::MediationAbExperiment] parsed result object
742
+ # @yieldparam err [StandardError] error object if request failed
743
+ #
744
+ # @return [Google::Apis::AdmobV1beta::MediationAbExperiment]
745
+ #
746
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
747
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
748
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
749
+ def create_account_mediation_group_mediation_ab_experiment(parent, mediation_ab_experiment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
750
+ command = make_simple_command(:post, 'v1beta/{+parent}/mediationAbExperiments', options)
751
+ command.request_representation = Google::Apis::AdmobV1beta::MediationAbExperiment::Representation
752
+ command.request_object = mediation_ab_experiment_object
753
+ command.response_representation = Google::Apis::AdmobV1beta::MediationAbExperiment::Representation
754
+ command.response_class = Google::Apis::AdmobV1beta::MediationAbExperiment
755
+ command.params['parent'] = parent unless parent.nil?
756
+ command.query['fields'] = fields unless fields.nil?
757
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
758
+ execute_or_queue_command(command, &block)
759
+ end
760
+
761
+ # Stop the mediation A/B experiment and choose a variant.
762
+ # @param [String] name
763
+ # Name of the mediation group, the experiment for which to choose a variant for.
764
+ # Example: accounts/pub-9876543210987654/mediationGroups/0123456789/
765
+ # mediationAbExperiments
766
+ # @param [Google::Apis::AdmobV1beta::StopMediationAbExperimentRequest] stop_mediation_ab_experiment_request_object
767
+ # @param [String] fields
768
+ # Selector specifying which fields to include in a partial response.
769
+ # @param [String] quota_user
770
+ # Available to use for quota purposes for server-side applications. Can be any
771
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
772
+ # @param [Google::Apis::RequestOptions] options
773
+ # Request-specific options
774
+ #
775
+ # @yield [result, err] Result & error if block supplied
776
+ # @yieldparam result [Google::Apis::AdmobV1beta::MediationAbExperiment] parsed result object
777
+ # @yieldparam err [StandardError] error object if request failed
778
+ #
779
+ # @return [Google::Apis::AdmobV1beta::MediationAbExperiment]
780
+ #
781
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
782
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
783
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
784
+ def stop_mediation_ab_experiment(name, stop_mediation_ab_experiment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
785
+ command = make_simple_command(:post, 'v1beta/{+name}:stop', options)
786
+ command.request_representation = Google::Apis::AdmobV1beta::StopMediationAbExperimentRequest::Representation
787
+ command.request_object = stop_mediation_ab_experiment_request_object
788
+ command.response_representation = Google::Apis::AdmobV1beta::MediationAbExperiment::Representation
789
+ command.response_class = Google::Apis::AdmobV1beta::MediationAbExperiment
790
+ command.params['name'] = name unless name.nil?
791
+ command.query['fields'] = fields unless fields.nil?
792
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
793
+ execute_or_queue_command(command, &block)
794
+ end
795
+
243
796
  # Generates an AdMob mediation report based on the provided report specification.
244
797
  # Returns result of a server-side streaming RPC. The result is returned in a
245
798
  # sequence of responses.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-admob_v1beta
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.22.0
4
+ version: 0.23.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-04-30 00:00:00.000000000 Z
11
+ date: 2023-08-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-admob_v1beta/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-admob_v1beta/v0.22.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-admob_v1beta/v0.23.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-admob_v1beta
63
63
  post_install_message:
64
64
  rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
75
  - !ruby/object:Gem::Version
76
76
  version: '0'
77
77
  requirements: []
78
- rubygems_version: 3.4.2
78
+ rubygems_version: 3.4.19
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Simple REST client for AdMob API V1beta