google-apis-adsense_v2 0.22.0 → 0.24.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 626cd01520963650067eadb6e07834187f693c805e33258941682555e112aebb
4
- data.tar.gz: 574304a41556fc8a98091b5fbb62357b7b1d2f1bc20f4c677f92905a46656d8b
3
+ metadata.gz: 19527c0dfaa3e27d8f2b188162579aa4d2152168d986dd94be3ad9c1ea0f5217
4
+ data.tar.gz: b0be9f9b298758024318014fb0e88e944345ef438e5d3f54439f132b29ab9cd3
5
5
  SHA512:
6
- metadata.gz: 7652fe624752b4a6c74bceb8f981665d494ae4bf7b24940c5b246123f9c343a71e42d0989df7cbfb699a8224a73145c633cea25898f79b63d6c0ab3bc348ca2d
7
- data.tar.gz: 32e0b170b2ee0c5ba5223cb2f52c1afe659442248786af77cb38a2a61789564c7bb4a571672e55d1d0df4426d653a9af3c5eb431a1712f0ca557e84aacd8a54a
6
+ metadata.gz: 0d0d5c72c1874815641b9329bafa77da05170dd310ed1333f5906b580bba8dbfc48d227ce36110949517b253312a105c130ea67d24eb677adf60fdf7583003e7
7
+ data.tar.gz: dc88bf009d73e938c1d5292ff877a6152f4353300a8e9c88bb5b15ebc619fcd61fedbd9942765f54748b140018198c89cab66d5b79cbc08f172b228bd1431169
data/CHANGELOG.md CHANGED
@@ -1,5 +1,15 @@
1
1
  # Release history for google-apis-adsense_v2
2
2
 
3
+ ### v0.24.0 (2022-11-03)
4
+
5
+ * Regenerated from discovery document revision 20221025
6
+ * Regenerated using generator version 0.11.0
7
+
8
+ ### v0.23.0 (2022-09-23)
9
+
10
+ * Regenerated from discovery document revision 20220921
11
+ * Regenerated using generator version 0.10.0
12
+
3
13
  ### v0.22.0 (2022-08-20)
4
14
 
5
15
  * Regenerated from discovery document revision 20220817
@@ -345,6 +345,13 @@ module Google
345
345
  class CustomChannel
346
346
  include Google::Apis::Core::Hashable
347
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
+
348
355
  # Required. Display name of the custom channel.
349
356
  # Corresponds to the JSON property `displayName`
350
357
  # @return [String]
@@ -368,6 +375,7 @@ module Google
368
375
 
369
376
  # Update properties of this object
370
377
  def update!(**args)
378
+ @active = args[:active] if args.key?(:active)
371
379
  @display_name = args[:display_name] if args.key?(:display_name)
372
380
  @name = args[:name] if args.key?(:name)
373
381
  @reporting_dimension_id = args[:reporting_dimension_id] if args.key?(:reporting_dimension_id)
@@ -415,6 +423,22 @@ module Google
415
423
  end
416
424
  end
417
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
+
418
442
  # The header information of the columns requested in the report.
419
443
  class Header
420
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.22.0"
19
+ GEM_VERSION = "0.24.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.11.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20220817"
25
+ REVISION = "20221025"
26
26
  end
27
27
  end
28
28
  end
@@ -88,6 +88,12 @@ module Google
88
88
  include Google::Apis::Core::JsonObjectSupport
89
89
  end
90
90
 
91
+ class Empty
92
+ class Representation < Google::Apis::Core::JsonRepresentation; end
93
+
94
+ include Google::Apis::Core::JsonObjectSupport
95
+ end
96
+
91
97
  class Header
92
98
  class Representation < Google::Apis::Core::JsonRepresentation; end
93
99
 
@@ -302,6 +308,7 @@ module Google
302
308
  class CustomChannel
303
309
  # @private
304
310
  class Representation < Google::Apis::Core::JsonRepresentation
311
+ property :active, as: 'active'
305
312
  property :display_name, as: 'displayName'
306
313
  property :name, as: 'name'
307
314
  property :reporting_dimension_id, as: 'reportingDimensionId'
@@ -317,6 +324,12 @@ module Google
317
324
  end
318
325
  end
319
326
 
327
+ class Empty
328
+ # @private
329
+ class Representation < Google::Apis::Core::JsonRepresentation
330
+ end
331
+ end
332
+
320
333
  class Header
321
334
  # @private
322
335
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -295,6 +295,46 @@ module Google
295
295
  execute_or_queue_command(command, &block)
296
296
  end
297
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](/adsense/management/
302
+ # reference/rest/v2/accounts.adclients). For now, this method can only be used
303
+ # to create `DISPLAY` ad units. See: https://support.google.com/adsense/answer/
304
+ # 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
+
298
338
  # Gets an ad unit from a specified account and ad client.
299
339
  # @param [String] name
300
340
  # Required. AdUnit to get information about. Format: accounts/`account`/
@@ -443,6 +483,115 @@ module Google
443
483
  execute_or_queue_command(command, &block)
444
484
  end
445
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
+
446
595
  # Gets information about the selected custom channel.
447
596
  # @param [String] name
448
597
  # Required. Name of the custom channel. Format: accounts/`account`/adclients/`
@@ -558,6 +707,45 @@ module Google
558
707
  execute_or_queue_command(command, &block)
559
708
  end
560
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
+
561
749
  # Gets information about the selected url channel.
562
750
  # @param [String] name
563
751
  # Required. The name of the url channel to retrieve. Format: accounts/`account`/
@@ -720,7 +908,9 @@ module Google
720
908
  # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
721
909
  # year.
722
910
  # @param [Array<String>, String] filters
723
- # Filters to be run on the report.
911
+ # A list of [filters](/adsense/management/reporting/filtering) to apply to the
912
+ # report. All provided filters must match in order for the data to be included
913
+ # in the report.
724
914
  # @param [String] language_code
725
915
  # The language to use for translating report output. If unspecified, this
726
916
  # defaults to English ("en"). If the given language is not supported, report
@@ -816,7 +1006,9 @@ module Google
816
1006
  # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
817
1007
  # year.
818
1008
  # @param [Array<String>, String] filters
819
- # Filters to be run on the report.
1009
+ # A list of [filters](/adsense/management/reporting/filtering) to apply to the
1010
+ # report. All provided filters must match in order for the data to be included
1011
+ # in the report.
820
1012
  # @param [String] language_code
821
1013
  # The language to use for translating report output. If unspecified, this
822
1014
  # defaults to English ("en"). If the given language is not supported, report
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.22.0
4
+ version: 0.24.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-22 00:00:00.000000000 Z
11
+ date: 2022-11-07 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.1
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.1
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.22.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-adsense_v2/v0.24.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: []