google-apis-adsense_v2 0.21.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 24fd4988b7c6a246f286fd180ca47932e6f1c822b930a6a55fdd4314f4060583
4
- data.tar.gz: 8e1ceae16e1d23d655c30e9fc4267485a3c5acfe62be00d220aca889367c3d84
3
+ metadata.gz: 3fac539562fd232a890d2b127657932ee0c63025349ed0c799869b87ae86df37
4
+ data.tar.gz: 560ba23886973bedec65d2c273f08db070dedd396e7ac001cb7ddca406097a25
5
5
  SHA512:
6
- metadata.gz: f876eb16e1ee83c01f90a5fe59bb90c48e7a768764b050209aa1c30102a9a4333784bff63e572b3d3601cc86c7004dc609c6f594cf0c341bb3a590f76859ab6f
7
- data.tar.gz: 93e4b61551c1bac5c072c75f3438cd7499cc7a5e3b4d42a5db050c90981e5bfe9c7f5ad7ba2cd2810ea873819dd839e1400848eccf05ad43f083c9606c7fb2f5
6
+ metadata.gz: c451423eace95379113524cb1bf6ea744df8ac17c4236415a6a04b75c3958cd631740004c3afdb7347b40d575629ec10ac63b3e94facc012fe7210c3ae8a8515
7
+ data.tar.gz: a5e171c903bc305514613f008e598aa91602ead7596816074569c5a1a54ee77d224de6fa57b521063fecd8a5d4861abf8d8646e9ee54425013060dbdfa569d6c
data/CHANGELOG.md CHANGED
@@ -1,5 +1,14 @@
1
1
  # Release history for google-apis-adsense_v2
2
2
 
3
+ ### v0.23.0 (2022-09-23)
4
+
5
+ * Regenerated from discovery document revision 20220921
6
+ * Regenerated using generator version 0.10.0
7
+
8
+ ### v0.22.0 (2022-08-20)
9
+
10
+ * Regenerated from discovery document revision 20220817
11
+
3
12
  ### v0.21.0 (2022-08-09)
4
13
 
5
14
  * Regenerated from discovery document revision 20220808
@@ -81,6 +81,36 @@ module Google
81
81
  end
82
82
  end
83
83
 
84
+ # Representation of an ad blocking recovery tag. See https://support.google.com/
85
+ # adsense/answer/11575177.
86
+ class AdBlockingRecoveryTag
87
+ include Google::Apis::Core::Hashable
88
+
89
+ # Error protection code that can be used in conjunction with the tag. It'll
90
+ # display a message to users if an [ad blocking extension blocks their access to
91
+ # your site](https://support.google.com/adsense/answer/11575480).
92
+ # Corresponds to the JSON property `errorProtectionCode`
93
+ # @return [String]
94
+ attr_accessor :error_protection_code
95
+
96
+ # The ad blocking recovery tag. Note that the message generated by the tag can
97
+ # be blocked by an ad blocking extension. If this is not your desired outcome,
98
+ # then you'll need to use it in conjunction with the error protection code.
99
+ # Corresponds to the JSON property `tag`
100
+ # @return [String]
101
+ attr_accessor :tag
102
+
103
+ def initialize(**args)
104
+ update!(**args)
105
+ end
106
+
107
+ # Update properties of this object
108
+ def update!(**args)
109
+ @error_protection_code = args[:error_protection_code] if args.key?(:error_protection_code)
110
+ @tag = args[:tag] if args.key?(:tag)
111
+ end
112
+ end
113
+
84
114
  # Representation of an ad client. An ad client represents a user's subscription
85
115
  # with a specific AdSense product.
86
116
  class AdClient
@@ -315,6 +345,13 @@ module Google
315
345
  class CustomChannel
316
346
  include Google::Apis::Core::Hashable
317
347
 
348
+ # Whether the custom channel is active and collecting data. See https://support.
349
+ # google.com/adsense/answer/10077192.
350
+ # Corresponds to the JSON property `active`
351
+ # @return [Boolean]
352
+ attr_accessor :active
353
+ alias_method :active?, :active
354
+
318
355
  # Required. Display name of the custom channel.
319
356
  # Corresponds to the JSON property `displayName`
320
357
  # @return [String]
@@ -338,6 +375,7 @@ module Google
338
375
 
339
376
  # Update properties of this object
340
377
  def update!(**args)
378
+ @active = args[:active] if args.key?(:active)
341
379
  @display_name = args[:display_name] if args.key?(:display_name)
342
380
  @name = args[:name] if args.key?(:name)
343
381
  @reporting_dimension_id = args[:reporting_dimension_id] if args.key?(:reporting_dimension_id)
@@ -385,6 +423,22 @@ module Google
385
423
  end
386
424
  end
387
425
 
426
+ # A generic empty message that you can re-use to avoid defining duplicated empty
427
+ # messages in your APIs. A typical example is to use it as the request or the
428
+ # response type of an API method. For instance: service Foo ` rpc Bar(google.
429
+ # protobuf.Empty) returns (google.protobuf.Empty); `
430
+ class Empty
431
+ include Google::Apis::Core::Hashable
432
+
433
+ def initialize(**args)
434
+ update!(**args)
435
+ end
436
+
437
+ # Update properties of this object
438
+ def update!(**args)
439
+ end
440
+ end
441
+
388
442
  # The header information of the columns requested in the report.
389
443
  class Header
390
444
  include Google::Apis::Core::Hashable
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module AdsenseV2
18
18
  # Version of the google-apis-adsense_v2 gem
19
- GEM_VERSION = "0.21.0"
19
+ GEM_VERSION = "0.23.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.9.0"
22
+ GENERATOR_VERSION = "0.10.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20220808"
25
+ REVISION = "20220921"
26
26
  end
27
27
  end
28
28
  end
@@ -28,6 +28,12 @@ module Google
28
28
  include Google::Apis::Core::JsonObjectSupport
29
29
  end
30
30
 
31
+ class AdBlockingRecoveryTag
32
+ class Representation < Google::Apis::Core::JsonRepresentation; end
33
+
34
+ include Google::Apis::Core::JsonObjectSupport
35
+ end
36
+
31
37
  class AdClient
32
38
  class Representation < Google::Apis::Core::JsonRepresentation; end
33
39
 
@@ -82,6 +88,12 @@ module Google
82
88
  include Google::Apis::Core::JsonObjectSupport
83
89
  end
84
90
 
91
+ class Empty
92
+ class Representation < Google::Apis::Core::JsonRepresentation; end
93
+
94
+ include Google::Apis::Core::JsonObjectSupport
95
+ end
96
+
85
97
  class Header
86
98
  class Representation < Google::Apis::Core::JsonRepresentation; end
87
99
 
@@ -222,6 +234,14 @@ module Google
222
234
  end
223
235
  end
224
236
 
237
+ class AdBlockingRecoveryTag
238
+ # @private
239
+ class Representation < Google::Apis::Core::JsonRepresentation
240
+ property :error_protection_code, as: 'errorProtectionCode'
241
+ property :tag, as: 'tag'
242
+ end
243
+ end
244
+
225
245
  class AdClient
226
246
  # @private
227
247
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -288,6 +308,7 @@ module Google
288
308
  class CustomChannel
289
309
  # @private
290
310
  class Representation < Google::Apis::Core::JsonRepresentation
311
+ property :active, as: 'active'
291
312
  property :display_name, as: 'displayName'
292
313
  property :name, as: 'name'
293
314
  property :reporting_dimension_id, as: 'reportingDimensionId'
@@ -303,6 +324,12 @@ module Google
303
324
  end
304
325
  end
305
326
 
327
+ class Empty
328
+ # @private
329
+ class Representation < Google::Apis::Core::JsonRepresentation
330
+ end
331
+ end
332
+
306
333
  class Header
307
334
  # @private
308
335
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -80,6 +80,37 @@ module Google
80
80
  execute_or_queue_command(command, &block)
81
81
  end
82
82
 
83
+ # Gets the ad blocking recovery tag of an account.
84
+ # @param [String] name
85
+ # Required. The name of the account to get the tag for. Format: accounts/`
86
+ # account`
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::AdsenseV2::AdBlockingRecoveryTag] parsed result object
97
+ # @yieldparam err [StandardError] error object if request failed
98
+ #
99
+ # @return [Google::Apis::AdsenseV2::AdBlockingRecoveryTag]
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 get_account_ad_blocking_recovery_tag(name, fields: nil, quota_user: nil, options: nil, &block)
105
+ command = make_simple_command(:get, 'v2/{+name}/adBlockingRecoveryTag', options)
106
+ command.response_representation = Google::Apis::AdsenseV2::AdBlockingRecoveryTag::Representation
107
+ command.response_class = Google::Apis::AdsenseV2::AdBlockingRecoveryTag
108
+ command.params['name'] = name unless name.nil?
109
+ command.query['fields'] = fields unless fields.nil?
110
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
111
+ execute_or_queue_command(command, &block)
112
+ end
113
+
83
114
  # Lists all accounts available to this user.
84
115
  # @param [Fixnum] page_size
85
116
  # The maximum number of accounts to include in the response, used for paging. If
@@ -264,6 +295,46 @@ module Google
264
295
  execute_or_queue_command(command, &block)
265
296
  end
266
297
 
298
+ # Creates an ad unit. This method can only be used by projects enabled for the [
299
+ # AdSense for Platforms](https://developers.google.com/adsense/platforms/)
300
+ # product. Note that ad units can only be created for ad clients with an "AFC"
301
+ # product code. For more info see the [AdClient resource](https://developers.
302
+ # google.com/adsense/management/reference/rest/v2/accounts.adclients). For now,
303
+ # this method can only be used to create `DISPLAY` ad units. See: https://
304
+ # support.google.com/adsense/answer/9183566
305
+ # @param [String] parent
306
+ # Required. Ad client to create an ad unit under. Format: accounts/`account`/
307
+ # adclients/`adclient`
308
+ # @param [Google::Apis::AdsenseV2::AdUnit] ad_unit_object
309
+ # @param [String] fields
310
+ # Selector specifying which fields to include in a partial response.
311
+ # @param [String] quota_user
312
+ # Available to use for quota purposes for server-side applications. Can be any
313
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
314
+ # @param [Google::Apis::RequestOptions] options
315
+ # Request-specific options
316
+ #
317
+ # @yield [result, err] Result & error if block supplied
318
+ # @yieldparam result [Google::Apis::AdsenseV2::AdUnit] parsed result object
319
+ # @yieldparam err [StandardError] error object if request failed
320
+ #
321
+ # @return [Google::Apis::AdsenseV2::AdUnit]
322
+ #
323
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
324
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
325
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
326
+ def create_account_adclient_adunit(parent, ad_unit_object = nil, fields: nil, quota_user: nil, options: nil, &block)
327
+ command = make_simple_command(:post, 'v2/{+parent}/adunits', options)
328
+ command.request_representation = Google::Apis::AdsenseV2::AdUnit::Representation
329
+ command.request_object = ad_unit_object
330
+ command.response_representation = Google::Apis::AdsenseV2::AdUnit::Representation
331
+ command.response_class = Google::Apis::AdsenseV2::AdUnit
332
+ command.params['parent'] = parent unless parent.nil?
333
+ command.query['fields'] = fields unless fields.nil?
334
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
335
+ execute_or_queue_command(command, &block)
336
+ end
337
+
267
338
  # Gets an ad unit from a specified account and ad client.
268
339
  # @param [String] name
269
340
  # Required. AdUnit to get information about. Format: accounts/`account`/
@@ -412,6 +483,115 @@ module Google
412
483
  execute_or_queue_command(command, &block)
413
484
  end
414
485
 
486
+ # Updates an ad unit. This method can only be used by projects enabled for the [
487
+ # AdSense for Platforms](https://developers.google.com/adsense/platforms/)
488
+ # product. For now, this method can only be used to update `DISPLAY` ad units.
489
+ # See: https://support.google.com/adsense/answer/9183566
490
+ # @param [String] name
491
+ # Output only. Resource name of the ad unit. Format: accounts/`account`/
492
+ # adclients/`adclient`/adunits/`adunit`
493
+ # @param [Google::Apis::AdsenseV2::AdUnit] ad_unit_object
494
+ # @param [String] update_mask
495
+ # The list of fields to update. If empty, a full update is performed.
496
+ # @param [String] fields
497
+ # Selector specifying which fields to include in a partial response.
498
+ # @param [String] quota_user
499
+ # Available to use for quota purposes for server-side applications. Can be any
500
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
501
+ # @param [Google::Apis::RequestOptions] options
502
+ # Request-specific options
503
+ #
504
+ # @yield [result, err] Result & error if block supplied
505
+ # @yieldparam result [Google::Apis::AdsenseV2::AdUnit] parsed result object
506
+ # @yieldparam err [StandardError] error object if request failed
507
+ #
508
+ # @return [Google::Apis::AdsenseV2::AdUnit]
509
+ #
510
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
511
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
512
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
513
+ def patch_account_adclient_adunit(name, ad_unit_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
514
+ command = make_simple_command(:patch, 'v2/{+name}', options)
515
+ command.request_representation = Google::Apis::AdsenseV2::AdUnit::Representation
516
+ command.request_object = ad_unit_object
517
+ command.response_representation = Google::Apis::AdsenseV2::AdUnit::Representation
518
+ command.response_class = Google::Apis::AdsenseV2::AdUnit
519
+ command.params['name'] = name unless name.nil?
520
+ command.query['updateMask'] = update_mask unless update_mask.nil?
521
+ command.query['fields'] = fields unless fields.nil?
522
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
523
+ execute_or_queue_command(command, &block)
524
+ end
525
+
526
+ # Creates a custom channel. This method can only be used by projects enabled for
527
+ # the [AdSense for Platforms](https://developers.google.com/adsense/platforms/)
528
+ # product.
529
+ # @param [String] parent
530
+ # Required. The ad client to create a custom channel under. Format: accounts/`
531
+ # account`/adclients/`adclient`
532
+ # @param [Google::Apis::AdsenseV2::CustomChannel] custom_channel_object
533
+ # @param [String] fields
534
+ # Selector specifying which fields to include in a partial response.
535
+ # @param [String] quota_user
536
+ # Available to use for quota purposes for server-side applications. Can be any
537
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
538
+ # @param [Google::Apis::RequestOptions] options
539
+ # Request-specific options
540
+ #
541
+ # @yield [result, err] Result & error if block supplied
542
+ # @yieldparam result [Google::Apis::AdsenseV2::CustomChannel] parsed result object
543
+ # @yieldparam err [StandardError] error object if request failed
544
+ #
545
+ # @return [Google::Apis::AdsenseV2::CustomChannel]
546
+ #
547
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
548
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
549
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
550
+ def create_account_adclient_customchannel(parent, custom_channel_object = nil, fields: nil, quota_user: nil, options: nil, &block)
551
+ command = make_simple_command(:post, 'v2/{+parent}/customchannels', options)
552
+ command.request_representation = Google::Apis::AdsenseV2::CustomChannel::Representation
553
+ command.request_object = custom_channel_object
554
+ command.response_representation = Google::Apis::AdsenseV2::CustomChannel::Representation
555
+ command.response_class = Google::Apis::AdsenseV2::CustomChannel
556
+ command.params['parent'] = parent unless parent.nil?
557
+ command.query['fields'] = fields unless fields.nil?
558
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
559
+ execute_or_queue_command(command, &block)
560
+ end
561
+
562
+ # Deletes a custom channel. This method can only be used by projects enabled for
563
+ # the [AdSense for Platforms](https://developers.google.com/adsense/platforms/)
564
+ # product.
565
+ # @param [String] name
566
+ # Required. Name of the custom channel to delete. Format: accounts/`account`/
567
+ # adclients/`adclient`/customchannels/`customchannel`
568
+ # @param [String] fields
569
+ # Selector specifying which fields to include in a partial response.
570
+ # @param [String] quota_user
571
+ # Available to use for quota purposes for server-side applications. Can be any
572
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
573
+ # @param [Google::Apis::RequestOptions] options
574
+ # Request-specific options
575
+ #
576
+ # @yield [result, err] Result & error if block supplied
577
+ # @yieldparam result [Google::Apis::AdsenseV2::Empty] parsed result object
578
+ # @yieldparam err [StandardError] error object if request failed
579
+ #
580
+ # @return [Google::Apis::AdsenseV2::Empty]
581
+ #
582
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
583
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
584
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
585
+ def delete_account_adclient_customchannel(name, fields: nil, quota_user: nil, options: nil, &block)
586
+ command = make_simple_command(:delete, 'v2/{+name}', options)
587
+ command.response_representation = Google::Apis::AdsenseV2::Empty::Representation
588
+ command.response_class = Google::Apis::AdsenseV2::Empty
589
+ command.params['name'] = name unless name.nil?
590
+ command.query['fields'] = fields unless fields.nil?
591
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
592
+ execute_or_queue_command(command, &block)
593
+ end
594
+
415
595
  # Gets information about the selected custom channel.
416
596
  # @param [String] name
417
597
  # Required. Name of the custom channel. Format: accounts/`account`/adclients/`
@@ -527,6 +707,45 @@ module Google
527
707
  execute_or_queue_command(command, &block)
528
708
  end
529
709
 
710
+ # Updates a custom channel. This method can only be used by projects enabled for
711
+ # the [AdSense for Platforms](https://developers.google.com/adsense/platforms/)
712
+ # product.
713
+ # @param [String] name
714
+ # Output only. Resource name of the custom channel. Format: accounts/`account`/
715
+ # adclients/`adclient`/customchannels/`customchannel`
716
+ # @param [Google::Apis::AdsenseV2::CustomChannel] custom_channel_object
717
+ # @param [String] update_mask
718
+ # The list of fields to update. If empty, a full update is performed.
719
+ # @param [String] fields
720
+ # Selector specifying which fields to include in a partial response.
721
+ # @param [String] quota_user
722
+ # Available to use for quota purposes for server-side applications. Can be any
723
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
724
+ # @param [Google::Apis::RequestOptions] options
725
+ # Request-specific options
726
+ #
727
+ # @yield [result, err] Result & error if block supplied
728
+ # @yieldparam result [Google::Apis::AdsenseV2::CustomChannel] parsed result object
729
+ # @yieldparam err [StandardError] error object if request failed
730
+ #
731
+ # @return [Google::Apis::AdsenseV2::CustomChannel]
732
+ #
733
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
734
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
735
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
736
+ def patch_account_adclient_customchannel(name, custom_channel_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
737
+ command = make_simple_command(:patch, 'v2/{+name}', options)
738
+ command.request_representation = Google::Apis::AdsenseV2::CustomChannel::Representation
739
+ command.request_object = custom_channel_object
740
+ command.response_representation = Google::Apis::AdsenseV2::CustomChannel::Representation
741
+ command.response_class = Google::Apis::AdsenseV2::CustomChannel
742
+ command.params['name'] = name unless name.nil?
743
+ command.query['updateMask'] = update_mask unless update_mask.nil?
744
+ command.query['fields'] = fields unless fields.nil?
745
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
746
+ execute_or_queue_command(command, &block)
747
+ end
748
+
530
749
  # Gets information about the selected url channel.
531
750
  # @param [String] name
532
751
  # Required. The name of the url channel to retrieve. Format: accounts/`account`/
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-adsense_v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.21.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: 2022-08-15 00:00:00.000000000 Z
11
+ date: 2022-09-26 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: '0.7'
19
+ version: 0.9.0
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: '0.7'
29
+ version: 0.9.0
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -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-adsense_v2/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-adsense_v2/v0.21.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-adsense_v2/v0.23.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-adsense_v2
63
63
  post_install_message:
64
64
  rdoc_options: []