google-apis-doubleclickbidmanager_v2 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3382ded7237b606cebf1b728df6439f03dcef135fbcc19adb68c18086e0c0617
-  data.tar.gz: 3b7400ff3d078c4903cc3faf4bff99725df1ae025028ba61343f5df0ceeb8f8c
+  metadata.gz: d67dedc5583479b1fa0ae15878598766d6147e1c9106b62731c91dee92b3acaa
+  data.tar.gz: 873f8e9aa950b951f87571ba30b48259aaf5ccebce0d754edf8805e9c32f6c8c
 SHA512:
-  metadata.gz: 142c7c8bc854b6c5a028398b901fb36de27dcf7fb6bf428cf624045759393921aa2d3a3b414497f59c02b4497a9a027c33606507e11a72f716f09d2791e60f92
-  data.tar.gz: '08ce9802cb0b2a6dfcd4e8bbdc37ea9c92e9bc9f791b58355c1ec6dd1329cb84ce8eeae95faec58b9677453839fba8d0587e058bcbbd67a885069063e036dba3'
+  metadata.gz: 3bb17a122e05afb0b8452e7186da17f2a7b378e9ad6d97cc05c931e6c7699ba982ff6dcc99105790e8059fe48180059258620d54569b20693c5a882bc78d0ba1
+  data.tar.gz: 60ffb01b3039986ad60d9c68486694911829f6cabd9a8912ff293c8afedeaeda0664ccf401b55374480ac9dd08e942f584b4854f530f8a1fb4e7b07b41c23930

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release history for google-apis-doubleclickbidmanager_v2
 
+### v0.14.0 (2024-08-11)
+
+* Regenerated from discovery document revision 20240731
+* Regenerated using generator version 0.15.1
+
 ### v0.13.0 (2024-05-19)
 
 * Regenerated using generator version 0.15.0

data/lib/google/apis/doubleclickbidmanager_v2/classes.rb

@@ -22,7 +22,7 @@ module Google
   module Apis
     module DoubleclickbidmanagerV2
       
-      # Report data range.
+      # The date range to be reported on.
       class DataRange
         include Google::Apis::Core::Hashable
       
@@ -50,7 +50,9 @@ module Google
         # @return [Google::Apis::DoubleclickbidmanagerV2::Date]
         attr_accessor :custom_start_date
       
-        # Report data range used to generate the report.
+        # The preset date range to be reported on. If `CUSTOM_DATES` is assigned to this
+        # field, fields custom_start_date and custom_end_date must be set to specify the
+        # custom date range.
         # Corresponds to the JSON property `range`
         # @return [String]
         attr_accessor :range
@@ -108,16 +110,17 @@ module Google
         end
       end
       
-      # Filter used to match traffic data in your report.
+      # Represents a single filter rule.
       class FilterPair
         include Google::Apis::Core::Hashable
       
-        # Filter type.
+        # The type of value to filter by. Defined by a [Filter](/bid-manager/reference/
+        # rest/v2/filters-metrics#filters) value.
         # Corresponds to the JSON property `type`
         # @return [String]
         attr_accessor :type
       
-        # Filter value.
+        # The identifying value to filter by, such as a relevant resource ID.
         # Corresponds to the JSON property `value`
         # @return [String]
         attr_accessor :value
@@ -137,13 +140,14 @@ module Google
       class ListQueriesResponse
         include Google::Apis::Core::Hashable
       
-        # A token, which can be sent as page_token to retrieve the next page of queries.
-        # If this field is omitted, there are no subsequent pages.
+        # A token to retrieve the next page of results. Pass this value in the
+        # page_token field in the subsequent call to `queries.list` method to retrieve
+        # the next page of results.
         # Corresponds to the JSON property `nextPageToken`
         # @return [String]
         attr_accessor :next_page_token
       
-        # The list of queries.
+        # The list of queries. This field will be absent if empty.
         # Corresponds to the JSON property `queries`
         # @return [Array<Google::Apis::DoubleclickbidmanagerV2::Query>]
         attr_accessor :queries
@@ -163,13 +167,14 @@ module Google
       class ListReportsResponse
         include Google::Apis::Core::Hashable
       
-        # A token, which can be sent as page_token to retrieve the next page of reports.
-        # If this field is omitted, there are no subsequent pages.
+        # A token to retrieve the next page of results. Pass this value in the
+        # page_token field in the subsequent call to `queries.reports.list` method to
+        # retrieve the next page of results.
         # Corresponds to the JSON property `nextPageToken`
         # @return [String]
         attr_accessor :next_page_token
       
-        # Retrieved reports.
+        # The list of reports. This field will be absent if empty.
         # Corresponds to the JSON property `reports`
         # @return [Array<Google::Apis::DoubleclickbidmanagerV2::Report>]
         attr_accessor :reports
@@ -185,13 +190,13 @@ module Google
         end
       end
       
-      # Additional query options.
+      # Report parameter options.
       class Options
         include Google::Apis::Core::Hashable
       
-        # Set to true and filter your report by `FILTER_INSERTION_ORDER` or `
-        # FILTER_LINE_ITEM` to include data for audience lists specifically targeted by
-        # those items.
+        # Whether to include data for audience lists specifically targeted by filtered
+        # line items or insertion orders. Requires the use of `FILTER_INSERTION_ORDER`
+        # or `FILTER_LINE_ITEM` filters.
         # Corresponds to the JSON property `includeOnlyTargetedUserLists`
         # @return [Boolean]
         attr_accessor :include_only_targeted_user_lists
@@ -207,32 +212,34 @@ module Google
         end
       end
       
-      # Parameters of a query or report.
+      # Parameters of a generated report.
       class Parameters
         include Google::Apis::Core::Hashable
       
-        # Filters used to match traffic data in your report.
+        # Filters to limit the scope of reported data.
         # Corresponds to the JSON property `filters`
         # @return [Array<Google::Apis::DoubleclickbidmanagerV2::FilterPair>]
         attr_accessor :filters
       
-        # Data is grouped by the filters listed in this field.
+        # Dimensions by which to segment and group the data. Defined by [Filter](/bid-
+        # manager/reference/rest/v2/filters-metrics#filters) values.
         # Corresponds to the JSON property `groupBys`
         # @return [Array<String>]
         attr_accessor :group_bys
       
-        # Metrics to include as columns in your report.
+        # Metrics to define the data populating the report. Defined by [Metric](/bid-
+        # manager/reference/rest/v2/filters-metrics#metrics) values.
         # Corresponds to the JSON property `metrics`
         # @return [Array<String>]
         attr_accessor :metrics
       
-        # Additional query options.
+        # Report parameter options.
         # Corresponds to the JSON property `options`
         # @return [Google::Apis::DoubleclickbidmanagerV2::Options]
         attr_accessor :options
       
-        # The type of the report. The type of the report will dictate what dimesions,
-        # filters, and metrics can be used.
+        # The type of the report. The type of the report determines the dimesions,
+        # filters, and metrics that can be used.
         # Corresponds to the JSON property `type`
         # @return [String]
         attr_accessor :type
@@ -251,26 +258,26 @@ module Google
         end
       end
       
-      # Represents a query.
+      # A single query used to generate a report.
       class Query
         include Google::Apis::Core::Hashable
       
-        # Query metadata.
+        # The metadata of the query.
         # Corresponds to the JSON property `metadata`
         # @return [Google::Apis::DoubleclickbidmanagerV2::QueryMetadata]
         attr_accessor :metadata
       
-        # Parameters of a query or report.
+        # Parameters of a generated report.
         # Corresponds to the JSON property `params`
         # @return [Google::Apis::DoubleclickbidmanagerV2::Parameters]
         attr_accessor :params
       
-        # Output only. Query ID.
+        # Output only. The unique ID of the query.
         # Corresponds to the JSON property `queryId`
         # @return [Fixnum]
         attr_accessor :query_id
       
-        # Information on when and how frequently to run a query.
+        # Settings on when and how frequently to run a query.
         # Corresponds to the JSON property `schedule`
         # @return [Google::Apis::DoubleclickbidmanagerV2::QuerySchedule]
         attr_accessor :schedule
@@ -288,34 +295,38 @@ module Google
         end
       end
       
-      # Query metadata.
+      # The metadata of the query.
       class QueryMetadata
         include Google::Apis::Core::Hashable
       
-        # Report data range.
+        # The date range to be reported on.
         # Corresponds to the JSON property `dataRange`
         # @return [Google::Apis::DoubleclickbidmanagerV2::DataRange]
         attr_accessor :data_range
       
-        # Format of the generated report.
+        # The format of the report generated by the query.
         # Corresponds to the JSON property `format`
         # @return [String]
         attr_accessor :format
       
-        # Whether to send an email notification when a report is ready. Defaults to
-        # false.
+        # Whether an email notification is sent to the query creator when a report
+        # generated by the query is ready. This value is `false` by default.
         # Corresponds to the JSON property `sendNotification`
         # @return [Boolean]
         attr_accessor :send_notification
         alias_method :send_notification?, :send_notification
       
-        # List of email addresses which are sent email notifications when the report is
-        # finished. Separate from send_notification.
+        # List of additional email addresses with which to share the query. If
+        # send_notification is `true`, these email addresses will receive a notification
+        # when a report generated by the query is ready. If these email addresses are
+        # connected to Display & Video 360 users, the query will be available to them in
+        # the Display & Video 360 interface.
         # Corresponds to the JSON property `shareEmailAddress`
         # @return [Array<String>]
         attr_accessor :share_email_address
       
-        # Query title. It is used to name the reports generated from this query.
+        # The display name of the query. This value will be used in the file name of
+        # reports generated by the query.
         # Corresponds to the JSON property `title`
         # @return [String]
         attr_accessor :title
@@ -334,7 +345,7 @@ module Google
         end
       end
       
-      # Information on when and how frequently to run a query.
+      # Settings on when and how frequently to run a query.
       class QuerySchedule
         include Google::Apis::Core::Hashable
       
@@ -350,12 +361,14 @@ module Google
         # @return [Google::Apis::DoubleclickbidmanagerV2::Date]
         attr_accessor :end_date
       
-        # How often the query is run.
+        # How frequently to run the query. If set to `ONE_TIME`, the query will only be
+        # run when queries.run is called.
         # Corresponds to the JSON property `frequency`
         # @return [String]
         attr_accessor :frequency
       
-        # Canonical timezone code for report generation time. Defaults to `America/
+        # The canonical code for the timezone the query schedule is based on. Scheduled
+        # runs are usually conducted in the morning of a given day. Defaults to `America/
         # New_York`.
         # Corresponds to the JSON property `nextRunTimezoneCode`
         # @return [String]
@@ -386,21 +399,21 @@ module Google
         end
       end
       
-      # Represents a report.
+      # A single report generated by its parent report.
       class Report
         include Google::Apis::Core::Hashable
       
-        # Key used to identify a report.
+        # Identifying information of a report.
         # Corresponds to the JSON property `key`
         # @return [Google::Apis::DoubleclickbidmanagerV2::ReportKey]
         attr_accessor :key
       
-        # Report metadata.
+        # The metadata of a report.
         # Corresponds to the JSON property `metadata`
         # @return [Google::Apis::DoubleclickbidmanagerV2::ReportMetadata]
         attr_accessor :metadata
       
-        # Parameters of a query or report.
+        # Parameters of a generated report.
         # Corresponds to the JSON property `params`
         # @return [Google::Apis::DoubleclickbidmanagerV2::Parameters]
         attr_accessor :params
@@ -417,16 +430,16 @@ module Google
         end
       end
       
-      # Key used to identify a report.
+      # Identifying information of a report.
       class ReportKey
         include Google::Apis::Core::Hashable
       
-        # Output only. Query ID.
+        # Output only. The unique ID of the query that generated the report.
         # Corresponds to the JSON property `queryId`
         # @return [Fixnum]
         attr_accessor :query_id
       
-        # Output only. Report ID.
+        # Output only. The unique ID of the report.
         # Corresponds to the JSON property `reportId`
         # @return [Fixnum]
         attr_accessor :report_id
@@ -442,12 +455,12 @@ module Google
         end
       end
       
-      # Report metadata.
+      # The metadata of a report.
       class ReportMetadata
         include Google::Apis::Core::Hashable
       
-        # Output only. The path to the location in Google Cloud Storage where the report
-        # is stored.
+        # Output only. The location of the generated report file in Google Cloud Storage.
+        # This field will be absent if status.state is not `DONE`.
         # Corresponds to the JSON property `googleCloudStoragePath`
         # @return [String]
         attr_accessor :google_cloud_storage_path
@@ -476,7 +489,7 @@ module Google
         # @return [Google::Apis::DoubleclickbidmanagerV2::Date]
         attr_accessor :report_data_start_date
       
-        # Report status.
+        # The status of a report.
         # Corresponds to the JSON property `status`
         # @return [Google::Apis::DoubleclickbidmanagerV2::ReportStatus]
         attr_accessor :status
@@ -494,21 +507,22 @@ module Google
         end
       end
       
-      # Report status.
+      # The status of a report.
       class ReportStatus
         include Google::Apis::Core::Hashable
       
-        # Output only. The time when this report either completed successfully or failed.
+        # Output only. The timestamp of when report generation finished successfully or
+        # in failure. This field will not be set unless state is `DONE` or `FAILED`.
         # Corresponds to the JSON property `finishTime`
         # @return [String]
         attr_accessor :finish_time
       
-        # The file type of the report.
+        # The format of the generated report file.
         # Corresponds to the JSON property `format`
         # @return [String]
         attr_accessor :format
       
-        # Output only. The state of the report.
+        # Output only. The state of the report generation.
         # Corresponds to the JSON property `state`
         # @return [String]
         attr_accessor :state
@@ -525,11 +539,11 @@ module Google
         end
       end
       
-      # Request to run a stored query to generate a report.
+      # Details specifying how to run a query.
       class RunQueryRequest
         include Google::Apis::Core::Hashable
       
-        # Report data range.
+        # The date range to be reported on.
         # Corresponds to the JSON property `dataRange`
         # @return [Google::Apis::DoubleclickbidmanagerV2::DataRange]
         attr_accessor :data_range

data/lib/google/apis/doubleclickbidmanager_v2/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module DoubleclickbidmanagerV2
       # Version of the google-apis-doubleclickbidmanager_v2 gem
-      GEM_VERSION = "0.13.0"
+      GEM_VERSION = "0.14.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.15.0"
+      GENERATOR_VERSION = "0.15.1"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20240424"
+      REVISION = "20240731"
     end
   end
 end

data/lib/google/apis/doubleclickbidmanager_v2/service.rb

@@ -52,7 +52,7 @@ module Google
           @batch_path = 'batch'
         end
         
-        # Creates a query.
+        # Creates a new query.
         # @param [Google::Apis::DoubleclickbidmanagerV2::Query] query_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -82,9 +82,9 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Deletes a query as well as the associated reports.
+        # Deletes an existing query as well as its generated reports.
         # @param [Fixnum] query_id
-        #   Required. ID of query to delete.
+        #   Required. The ID of the query to delete.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -112,7 +112,7 @@ module Google
         
         # Retrieves a query.
         # @param [Fixnum] query_id
-        #   Required. ID of query to retrieve.
+        #   Required. The ID of the query to retrieve.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -142,16 +142,17 @@ module Google
         
         # Lists queries created by the current user.
         # @param [String] order_by
-        #   Name of a field used to order results. The default sorting order is ascending.
-        #   To specify descending order for a field, append a " desc" suffix. For example "
-        #   metadata.title desc". Sorting is only supported for the following fields: * `
-        #   queryId` * `metadata.title`
+        #   Field to sort the list by. Accepts the following values: * `queryId` (default)
+        #   * `metadata.title` The default sorting order is ascending. To specify
+        #   descending order for a field, add the suffix `desc` to the field name. For
+        #   example, `queryId desc`.
         # @param [Fixnum] page_size
         #   Maximum number of results per page. Must be between `1` and `100`. Defaults to
         #   `100` if unspecified.
         # @param [String] page_token
-        #   A page token, received from a previous list call. Provide this to retrieve the
-        #   subsequent page of queries.
+        #   A token identifying which page of results the server should return. Typically,
+        #   this is the value of nextPageToken, returned from the previous call to the `
+        #   queries.list` method. If unspecified, the first page of results is returned.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -181,14 +182,14 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Runs a stored query to generate a report.
+        # Runs an existing query to generate a report.
         # @param [Fixnum] query_id
-        #   Required. ID of query to run.
+        #   Required. The ID of the query to run.
         # @param [Google::Apis::DoubleclickbidmanagerV2::RunQueryRequest] run_query_request_object
         # @param [Boolean] synchronous
-        #   Whether the query should be run synchronously. When true, this method will not
-        #   return until the query has finished running. When false or not specified, this
-        #   method will return immediately.
+        #   Whether the query should be run synchronously. When `true`, the request won't
+        #   return until the resulting report has finished running. This parameter is `
+        #   false` by default. Setting this parameter to `true` is **not recommended**.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -221,9 +222,9 @@ module Google
         
         # Retrieves a report.
         # @param [Fixnum] query_id
-        #   Required. ID of the query the report is associated with.
+        #   Required. The ID of the query that generated the report.
         # @param [Fixnum] report_id
-        #   Required. ID of the report to retrieve.
+        #   Required. The ID of the query to retrieve.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -252,20 +253,22 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Lists reports associated with a query.
+        # Lists reports generated by the provided query.
         # @param [Fixnum] query_id
-        #   Required. ID of the query with which the reports are associated.
+        #   Required. The ID of the query that generated the reports.
         # @param [String] order_by
-        #   Name of a field used to order results. The default sorting order is ascending.
-        #   To specify descending order for a field, append a " desc" suffix. For example "
-        #   key.reportId desc". Sorting is only supported for the following fields: * `key.
-        #   reportId`
+        #   Field to sort the list by. Accepts the following values: * `key.reportId` (
+        #   default) The default sorting order is ascending. To specify descending order
+        #   for a field, add the suffix `desc` to the field name. For example, `key.
+        #   reportId desc`.
         # @param [Fixnum] page_size
         #   Maximum number of results per page. Must be between `1` and `100`. Defaults to
         #   `100` if unspecified.
         # @param [String] page_token
-        #   A page token, received from a previous list call. Provide this to retrieve the
-        #   subsequent page of reports.
+        #   A token identifying which page of results the server should return. Typically,
+        #   this is the value of nextPageToken returned from the previous call to the `
+        #   queries.reports.list` method. If unspecified, the first page of results is
+        #   returned.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-doubleclickbidmanager_v2
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-19 00:00:00.000000000 Z
+date: 2024-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-doubleclickbidmanager_v2/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-doubleclickbidmanager_v2/v0.13.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-doubleclickbidmanager_v2/v0.14.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-doubleclickbidmanager_v2
 post_install_message: 
 rdoc_options: []