google-apis-dfareporting_v5 0.8.0 → 0.9.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: df58edef95baf708b83c5ef10aa1730be07729e330c17c707819bab97154a154
4
- data.tar.gz: 3e72882df394a791181be1d0f96fcaadbd08e3f8212d3aaa906f79b56e1b7c36
3
+ metadata.gz: 8277b73db5e6786a69241c0093bcf6e22790b9dc0335a97d3c729635195829cb
4
+ data.tar.gz: 9f96e48137a3c6fe323f56ba2a1ca401035f5d15f4e98e079f630c75e838f20b
5
5
  SHA512:
6
- metadata.gz: 0aca4ae7df82b5b760f9e5f30d0168de16615bf67367d54d92b108c2acf8a718d8d9ad860cb91810d3be2bef68dd114fc1047d8774ac0ce3cf22689d503c1d63
7
- data.tar.gz: b1bc26480f1f3338c9edb3e38cf1238b055902da7e29c00124062b4d2a1093847bc65f055d28cfb8afb4c8c32423703433b713a924d7d8108d760832e713a30c
6
+ metadata.gz: 969ba931de33befa2bda84c7adaedc9e1599d2c5e47d580e5d3a29782bf1bdd4af8cc435589540ef774aa1cbf430361f771fc56e2aad4b16b48fd1e41d43aff4
7
+ data.tar.gz: 316d56d3654e6caeafd6aaa532c760a6bd36d66f30114ebab85f44c8de48ea87b055ff77ae499e6917461f4e15a38266d9cc066a9138c23ee84f9eb145de363e
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-dfareporting_v5
2
2
 
3
+ ### v0.9.0 (2026-07-26)
4
+
5
+ * Regenerated from discovery document revision 20260721
6
+
3
7
  ### v0.8.0 (2026-06-14)
4
8
 
5
9
  * Regenerated from discovery document revision 20260527
@@ -2454,6 +2454,31 @@ module Google
2454
2454
  end
2455
2455
  end
2456
2456
 
2457
+ # A column header in the report.
2458
+ class ColumnHeader
2459
+ include Google::Apis::Core::Hashable
2460
+
2461
+ # Output only. The column name.
2462
+ # Corresponds to the JSON property `name`
2463
+ # @return [String]
2464
+ attr_accessor :name
2465
+
2466
+ # Output only. The column type.
2467
+ # Corresponds to the JSON property `type`
2468
+ # @return [String]
2469
+ attr_accessor :type
2470
+
2471
+ def initialize(**args)
2472
+ update!(**args)
2473
+ end
2474
+
2475
+ # Update properties of this object
2476
+ def update!(**args)
2477
+ @name = args[:name] if args.key?(:name)
2478
+ @type = args[:type] if args.key?(:type)
2479
+ end
2480
+ end
2481
+
2457
2482
  # Companion Click-through override.
2458
2483
  class CompanionClickThroughOverride
2459
2484
  include Google::Apis::Core::Hashable
@@ -3704,6 +3729,14 @@ module Google
3704
3729
  # @return [Fixnum]
3705
3730
  attr_accessor :subaccount_id
3706
3731
 
3732
+ # Optional. Whether to add a label to the creative as created or edited using AI
3733
+ # when served in regions with local AI labeling regulations. [Learn more about
3734
+ # labeling requirements in AI regulations.](https://support.google.com/
3735
+ # campaignmanager/answer/17232030)
3736
+ # Corresponds to the JSON property `syntheticContentAttestationStatus`
3737
+ # @return [String]
3738
+ attr_accessor :synthetic_content_attestation_status
3739
+
3707
3740
  # Third-party URL used to record backup image impressions. Applicable to the
3708
3741
  # following creative types: all RICH_MEDIA.
3709
3742
  # Corresponds to the JSON property `thirdPartyBackupImageImpressionsUrl`
@@ -3822,6 +3855,7 @@ module Google
3822
3855
  @studio_creative_id = args[:studio_creative_id] if args.key?(:studio_creative_id)
3823
3856
  @studio_trafficked_creative_id = args[:studio_trafficked_creative_id] if args.key?(:studio_trafficked_creative_id)
3824
3857
  @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id)
3858
+ @synthetic_content_attestation_status = args[:synthetic_content_attestation_status] if args.key?(:synthetic_content_attestation_status)
3825
3859
  @third_party_backup_image_impressions_url = args[:third_party_backup_image_impressions_url] if args.key?(:third_party_backup_image_impressions_url)
3826
3860
  @third_party_rich_media_impressions_url = args[:third_party_rich_media_impressions_url] if args.key?(:third_party_rich_media_impressions_url)
3827
3861
  @third_party_urls = args[:third_party_urls] if args.key?(:third_party_urls)
@@ -11510,6 +11544,123 @@ module Google
11510
11544
  end
11511
11545
  end
11512
11546
 
11547
+ # The request body containing ad-hoc query parameters.
11548
+ class ReportDataQueryRequest
11549
+ include Google::Apis::Core::Hashable
11550
+
11551
+ # Represents a date range.
11552
+ # Corresponds to the JSON property `dateRange`
11553
+ # @return [Google::Apis::DfareportingV5::DateRange]
11554
+ attr_accessor :date_range
11555
+
11556
+ # Optional. The list of dimension values on which report lines are filtered.
11557
+ # Utilizes the existing legacy filter message `DimensionValue`.
11558
+ # Corresponds to the JSON property `dimensionFilters`
11559
+ # @return [Array<Google::Apis::DfareportingV5::DimensionValue>]
11560
+ attr_accessor :dimension_filters
11561
+
11562
+ # Optional. The list of dimension names to group by.
11563
+ # Corresponds to the JSON property `dimensionNames`
11564
+ # @return [Array<String>]
11565
+ attr_accessor :dimension_names
11566
+
11567
+ # Optional. Maximum number of result rows to return per page. The default value
11568
+ # is 100. The maximum allowed value is 1000. Values above 1000 will be coerced (
11569
+ # clamped) down to 1000. Negative values will be rejected.
11570
+ # Corresponds to the JSON property `maxResults`
11571
+ # @return [Fixnum]
11572
+ attr_accessor :max_results
11573
+
11574
+ # Required. The list of metric names to include.
11575
+ # Corresponds to the JSON property `metricNames`
11576
+ # @return [Array<String>]
11577
+ attr_accessor :metric_names
11578
+
11579
+ # Optional. Continuation token for paginating results.
11580
+ # Corresponds to the JSON property `pageToken`
11581
+ # @return [String]
11582
+ attr_accessor :page_token
11583
+
11584
+ # Optional. Sort options across either requested dimensions or metrics.
11585
+ # Corresponds to the JSON property `sortBys`
11586
+ # @return [Array<Google::Apis::DfareportingV5::SortBy>]
11587
+ attr_accessor :sort_bys
11588
+
11589
+ def initialize(**args)
11590
+ update!(**args)
11591
+ end
11592
+
11593
+ # Update properties of this object
11594
+ def update!(**args)
11595
+ @date_range = args[:date_range] if args.key?(:date_range)
11596
+ @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters)
11597
+ @dimension_names = args[:dimension_names] if args.key?(:dimension_names)
11598
+ @max_results = args[:max_results] if args.key?(:max_results)
11599
+ @metric_names = args[:metric_names] if args.key?(:metric_names)
11600
+ @page_token = args[:page_token] if args.key?(:page_token)
11601
+ @sort_bys = args[:sort_bys] if args.key?(:sort_bys)
11602
+ end
11603
+ end
11604
+
11605
+ # Represents a response to report data request.
11606
+ class ReportDataResponse
11607
+ include Google::Apis::Core::Hashable
11608
+
11609
+ # Output only. Ordered descriptors of the requested column fields.
11610
+ # Corresponds to the JSON property `columnHeaders`
11611
+ # @return [Array<Google::Apis::DfareportingV5::ColumnHeader>]
11612
+ attr_accessor :column_headers
11613
+
11614
+ # Output only. Token to retrieve the next page of rows, or empty if end of
11615
+ # results.
11616
+ # Corresponds to the JSON property `nextPageToken`
11617
+ # @return [String]
11618
+ attr_accessor :next_page_token
11619
+
11620
+ # Output only. The resulting set of matching data rows.
11621
+ # Corresponds to the JSON property `rows`
11622
+ # @return [Array<Google::Apis::DfareportingV5::ReportDataRow>]
11623
+ attr_accessor :rows
11624
+
11625
+ # A row of report data.
11626
+ # Corresponds to the JSON property `totalRow`
11627
+ # @return [Google::Apis::DfareportingV5::ReportDataRow]
11628
+ attr_accessor :total_row
11629
+
11630
+ def initialize(**args)
11631
+ update!(**args)
11632
+ end
11633
+
11634
+ # Update properties of this object
11635
+ def update!(**args)
11636
+ @column_headers = args[:column_headers] if args.key?(:column_headers)
11637
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
11638
+ @rows = args[:rows] if args.key?(:rows)
11639
+ @total_row = args[:total_row] if args.key?(:total_row)
11640
+ end
11641
+ end
11642
+
11643
+ # A row of report data.
11644
+ class ReportDataRow
11645
+ include Google::Apis::Core::Hashable
11646
+
11647
+ # Output only. A single sequential list of all cell values matching
11648
+ # column_headers indices exactly. - Metric cells that are suppressed due to
11649
+ # Minimum Reporting Standard (MRS) privacy protection constraints return "-".
11650
+ # Corresponds to the JSON property `values`
11651
+ # @return [Array<String>]
11652
+ attr_accessor :values
11653
+
11654
+ def initialize(**args)
11655
+ update!(**args)
11656
+ end
11657
+
11658
+ # Update properties of this object
11659
+ def update!(**args)
11660
+ @values = args[:values] if args.key?(:values)
11661
+ end
11662
+ end
11663
+
11513
11664
  # Represents the list of reports.
11514
11665
  class ReportList
11515
11666
  include Google::Apis::Core::Hashable
@@ -12246,6 +12397,31 @@ module Google
12246
12397
  end
12247
12398
  end
12248
12399
 
12400
+ # Specifies the sort configuration for a specific field in the report.
12401
+ class SortBy
12402
+ include Google::Apis::Core::Hashable
12403
+
12404
+ # Required. The dimension or metric field name to sort on.
12405
+ # Corresponds to the JSON property `name`
12406
+ # @return [String]
12407
+ attr_accessor :name
12408
+
12409
+ # Optional. The sort order of this column.
12410
+ # Corresponds to the JSON property `sortOrder`
12411
+ # @return [String]
12412
+ attr_accessor :sort_order
12413
+
12414
+ def initialize(**args)
12415
+ update!(**args)
12416
+ end
12417
+
12418
+ # Update properties of this object
12419
+ def update!(**args)
12420
+ @name = args[:name] if args.key?(:name)
12421
+ @sort_order = args[:sort_order] if args.key?(:sort_order)
12422
+ end
12423
+ end
12424
+
12249
12425
  # Represents a sorted dimension.
12250
12426
  class SortedDimension
12251
12427
  include Google::Apis::Core::Hashable
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DfareportingV5
18
18
  # Version of the google-apis-dfareporting_v5 gem
19
- GEM_VERSION = "0.8.0"
19
+ GEM_VERSION = "0.9.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.19.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20260527"
25
+ REVISION = "20260721"
26
26
  end
27
27
  end
28
28
  end
@@ -286,6 +286,12 @@ module Google
286
286
  include Google::Apis::Core::JsonObjectSupport
287
287
  end
288
288
 
289
+ class ColumnHeader
290
+ class Representation < Google::Apis::Core::JsonRepresentation; end
291
+
292
+ include Google::Apis::Core::JsonObjectSupport
293
+ end
294
+
289
295
  class CompanionClickThroughOverride
290
296
  class Representation < Google::Apis::Core::JsonRepresentation; end
291
297
 
@@ -1306,6 +1312,24 @@ module Google
1306
1312
  include Google::Apis::Core::JsonObjectSupport
1307
1313
  end
1308
1314
 
1315
+ class ReportDataQueryRequest
1316
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1317
+
1318
+ include Google::Apis::Core::JsonObjectSupport
1319
+ end
1320
+
1321
+ class ReportDataResponse
1322
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1323
+
1324
+ include Google::Apis::Core::JsonObjectSupport
1325
+ end
1326
+
1327
+ class ReportDataRow
1328
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1329
+
1330
+ include Google::Apis::Core::JsonObjectSupport
1331
+ end
1332
+
1309
1333
  class ReportList
1310
1334
  class Representation < Google::Apis::Core::JsonRepresentation; end
1311
1335
 
@@ -1402,6 +1426,12 @@ module Google
1402
1426
  include Google::Apis::Core::JsonObjectSupport
1403
1427
  end
1404
1428
 
1429
+ class SortBy
1430
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1431
+
1432
+ include Google::Apis::Core::JsonObjectSupport
1433
+ end
1434
+
1405
1435
  class SortedDimension
1406
1436
  class Representation < Google::Apis::Core::JsonRepresentation; end
1407
1437
 
@@ -2250,6 +2280,14 @@ module Google
2250
2280
  end
2251
2281
  end
2252
2282
 
2283
+ class ColumnHeader
2284
+ # @private
2285
+ class Representation < Google::Apis::Core::JsonRepresentation
2286
+ property :name, as: 'name'
2287
+ property :type, as: 'type'
2288
+ end
2289
+ end
2290
+
2253
2291
  class CompanionClickThroughOverride
2254
2292
  # @private
2255
2293
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2556,6 +2594,7 @@ module Google
2556
2594
  property :studio_creative_id, :numeric_string => true, as: 'studioCreativeId'
2557
2595
  property :studio_trafficked_creative_id, :numeric_string => true, as: 'studioTraffickedCreativeId'
2558
2596
  property :subaccount_id, :numeric_string => true, as: 'subaccountId'
2597
+ property :synthetic_content_attestation_status, as: 'syntheticContentAttestationStatus'
2559
2598
  property :third_party_backup_image_impressions_url, as: 'thirdPartyBackupImageImpressionsUrl'
2560
2599
  property :third_party_rich_media_impressions_url, as: 'thirdPartyRichMediaImpressionsUrl'
2561
2600
  collection :third_party_urls, as: 'thirdPartyUrls', class: Google::Apis::DfareportingV5::ThirdPartyTrackingUrl, decorator: Google::Apis::DfareportingV5::ThirdPartyTrackingUrl::Representation
@@ -4527,6 +4566,42 @@ module Google
4527
4566
  end
4528
4567
  end
4529
4568
 
4569
+ class ReportDataQueryRequest
4570
+ # @private
4571
+ class Representation < Google::Apis::Core::JsonRepresentation
4572
+ property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV5::DateRange, decorator: Google::Apis::DfareportingV5::DateRange::Representation
4573
+
4574
+ collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV5::DimensionValue, decorator: Google::Apis::DfareportingV5::DimensionValue::Representation
4575
+
4576
+ collection :dimension_names, as: 'dimensionNames'
4577
+ property :max_results, as: 'maxResults'
4578
+ collection :metric_names, as: 'metricNames'
4579
+ property :page_token, as: 'pageToken'
4580
+ collection :sort_bys, as: 'sortBys', class: Google::Apis::DfareportingV5::SortBy, decorator: Google::Apis::DfareportingV5::SortBy::Representation
4581
+
4582
+ end
4583
+ end
4584
+
4585
+ class ReportDataResponse
4586
+ # @private
4587
+ class Representation < Google::Apis::Core::JsonRepresentation
4588
+ collection :column_headers, as: 'columnHeaders', class: Google::Apis::DfareportingV5::ColumnHeader, decorator: Google::Apis::DfareportingV5::ColumnHeader::Representation
4589
+
4590
+ property :next_page_token, as: 'nextPageToken'
4591
+ collection :rows, as: 'rows', class: Google::Apis::DfareportingV5::ReportDataRow, decorator: Google::Apis::DfareportingV5::ReportDataRow::Representation
4592
+
4593
+ property :total_row, as: 'totalRow', class: Google::Apis::DfareportingV5::ReportDataRow, decorator: Google::Apis::DfareportingV5::ReportDataRow::Representation
4594
+
4595
+ end
4596
+ end
4597
+
4598
+ class ReportDataRow
4599
+ # @private
4600
+ class Representation < Google::Apis::Core::JsonRepresentation
4601
+ collection :values, as: 'values'
4602
+ end
4603
+ end
4604
+
4530
4605
  class ReportList
4531
4606
  # @private
4532
4607
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4718,6 +4793,14 @@ module Google
4718
4793
  end
4719
4794
  end
4720
4795
 
4796
+ class SortBy
4797
+ # @private
4798
+ class Representation < Google::Apis::Core::JsonRepresentation
4799
+ property :name, as: 'name'
4800
+ property :sort_order, as: 'sortOrder'
4801
+ end
4802
+ end
4803
+
4721
4804
  class SortedDimension
4722
4805
  # @private
4723
4806
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -6602,6 +6602,39 @@ module Google
6602
6602
  execute_or_queue_command(command, &block)
6603
6603
  end
6604
6604
 
6605
+ # Executes an ad-hoc query and returns structured JSON payload data.
6606
+ # @param [Fixnum] profile_id
6607
+ # Required. The Campaign Manager 360 user profile ID.
6608
+ # @param [Google::Apis::DfareportingV5::ReportDataQueryRequest] report_data_query_request_object
6609
+ # @param [String] fields
6610
+ # Selector specifying which fields to include in a partial response.
6611
+ # @param [String] quota_user
6612
+ # Available to use for quota purposes for server-side applications. Can be any
6613
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6614
+ # @param [Google::Apis::RequestOptions] options
6615
+ # Request-specific options
6616
+ #
6617
+ # @yield [result, err] Result & error if block supplied
6618
+ # @yieldparam result [Google::Apis::DfareportingV5::ReportDataResponse] parsed result object
6619
+ # @yieldparam err [StandardError] error object if request failed
6620
+ #
6621
+ # @return [Google::Apis::DfareportingV5::ReportDataResponse]
6622
+ #
6623
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6624
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6625
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6626
+ def query_report_datum(profile_id, report_data_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
6627
+ command = make_simple_command(:post, 'userprofiles/{profileId}/reportdata/query', options)
6628
+ command.request_representation = Google::Apis::DfareportingV5::ReportDataQueryRequest::Representation
6629
+ command.request_object = report_data_query_request_object
6630
+ command.response_representation = Google::Apis::DfareportingV5::ReportDataResponse::Representation
6631
+ command.response_class = Google::Apis::DfareportingV5::ReportDataResponse
6632
+ command.params['profileId'] = profile_id unless profile_id.nil?
6633
+ command.query['fields'] = fields unless fields.nil?
6634
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6635
+ execute_or_queue_command(command, &block)
6636
+ end
6637
+
6605
6638
  # Deletes a report by its ID.
6606
6639
  # @param [Fixnum] profile_id
6607
6640
  # The Campaign Manager 360 user profile ID.
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-dfareporting_v5
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.8.0
4
+ version: 0.9.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
@@ -57,7 +57,7 @@ licenses:
57
57
  metadata:
58
58
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
59
59
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-dfareporting_v5/CHANGELOG.md
60
- documentation_uri: https://googleapis.dev/ruby/google-apis-dfareporting_v5/v0.8.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-dfareporting_v5/v0.9.0
61
61
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-dfareporting_v5
62
62
  rdoc_options: []
63
63
  require_paths: