google-apis-content_v2_1 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95cab701eb8cc992dde108a1d8d680eca0965390078623ab03f2b117f952d479
-  data.tar.gz: ee77754f02a4e0a036594192117a8d6a457f4e1cb560a767f85c5af66fbc1298
+  metadata.gz: 5cefc82b40f01f2d0c9af41758c2b094b21857c24d86a9be3eb13d8edd92daf4
+  data.tar.gz: 7911c0470d42ee19acd979a4814da864b5e0f40d58eddce7342a7d2d48ee30b6
 SHA512:
-  metadata.gz: 8d5608f514689d98ef99cdd17c781967ecafe22677b7262c59f5b63b5aea9d6a8bd66d2188f09d2f3a5e679fd1be6acdddced2a794632133fbde5b02cb46163a
-  data.tar.gz: 68a6f0e35d7894c271e7a65b54a4ef45d1923ffc5449bb1c268a1fed87feb948615621e16a4becf3d16683932ff7f1be8c88a90e58d1d7e1d2d5fe2d6faa3b8f
+  metadata.gz: 505cb62db2c9f9dcba8c6a26f37df069abd81a5ad437614ce295f7f4f6957d055a36df64443677caa10c5a9edc13a19d5e5f421762e1f22bf22a8efc16e021da
+  data.tar.gz: 6207bf4fa6c17bee20aa7965ee25260f0f8ccb2f16c51923f17a36b8984abd20861eeebc5d892ac434b06464add599a634d5499f2f0a0c2d04664d22b92bac4f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-content_v2_1
 
+### v0.4.0 (2021-02-16)
+
+* Regenerated from discovery document revision 20210211
+
 ### v0.3.0 (2021-02-11)
 
 * Regenerated from discovery document revision 20210210

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

@@ -4703,6 +4703,39 @@ module Google
         end
       end
       
+      # Performance metrics. Values are only set for metrics requested explicitly in
+      # the request's search query.
+      class Metrics
+        include Google::Apis::Core::Hashable
+      
+        # Number of clicks.
+        # Corresponds to the JSON property `clicks`
+        # @return [Fixnum]
+        attr_accessor :clicks
+      
+        # Number of clicks merchant's products receive (clicks) divided by the number of
+        # times the products are shown (impressions).
+        # Corresponds to the JSON property `ctr`
+        # @return [Float]
+        attr_accessor :ctr
+      
+        # Number of times merchant's products are shown.
+        # Corresponds to the JSON property `impressions`
+        # @return [Fixnum]
+        attr_accessor :impressions
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @clicks = args[:clicks] if args.key?(:clicks)
+          @ctr = args[:ctr] if args.key?(:ctr)
+          @impressions = args[:impressions] if args.key?(:impressions)
+        end
+      end
+      
       # 
       class MinimumOrderValueTable
         include Google::Apis::Core::Hashable
@@ -11316,6 +11349,37 @@ module Google
         end
       end
       
+      # Result row returned from the search query.
+      class ReportRow
+        include Google::Apis::Core::Hashable
+      
+        # Performance metrics. Values are only set for metrics requested explicitly in
+        # the request's search query.
+        # Corresponds to the JSON property `metrics`
+        # @return [Google::Apis::ContentV2_1::Metrics]
+        attr_accessor :metrics
+      
+        # Dimensions according to which metrics are segmented in the response. Values of
+        # product dimensions, e.g., offer id, reflect the state of a product at the time
+        # of the corresponding event, e.g., impression or order. Segment fields cannot
+        # be selected in queries without also selecting at least one metric field.
+        # Values are only set for dimensions requested explicitly in the request's
+        # search query.
+        # Corresponds to the JSON property `segments`
+        # @return [Google::Apis::ContentV2_1::Segments]
+        attr_accessor :segments
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @metrics = args[:metrics] if args.key?(:metrics)
+          @segments = args[:segments] if args.key?(:segments)
+        end
+      end
+      
       # Resource that represents a daily Repricing product report. Each report
       # contains stats for a single type of Repricing rule for a single product on a
       # given day. If there are multiple rules of the same type for the product on
@@ -12568,6 +12632,110 @@ module Google
         end
       end
       
+      # Request message for the ReportService.Search method.
+      class SearchRequest
+        include Google::Apis::Core::Hashable
+      
+        # Number of ReportRows to retrieve in a single page. Defaults to the maximum of
+        # 1000. Values above 1000 are coerced to 1000.
+        # Corresponds to the JSON property `pageSize`
+        # @return [Fixnum]
+        attr_accessor :page_size
+      
+        # Token of the page to retrieve. If not specified, the first page of results is
+        # returned. In order to request the next page of results, the value obtained
+        # from `next_page_token` in the previous response should be used.
+        # Corresponds to the JSON property `pageToken`
+        # @return [String]
+        attr_accessor :page_token
+      
+        # Required. Search query that defines performance metrics to retrieve and
+        # dimensions according to which the metrics are to be segmented.
+        # Corresponds to the JSON property `query`
+        # @return [String]
+        attr_accessor :query
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @page_size = args[:page_size] if args.key?(:page_size)
+          @page_token = args[:page_token] if args.key?(:page_token)
+          @query = args[:query] if args.key?(:query)
+        end
+      end
+      
+      # Response message for the ReportService.Search method.
+      class SearchResponse
+        include Google::Apis::Core::Hashable
+      
+        # Token which can be sent as `page_token` to retrieve the next page. If omitted,
+        # there are no subsequent pages.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        # Rows that matched the search query.
+        # Corresponds to the JSON property `results`
+        # @return [Array<Google::Apis::ContentV2_1::ReportRow>]
+        attr_accessor :results
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+          @results = args[:results] if args.key?(:results)
+        end
+      end
+      
+      # Dimensions according to which metrics are segmented in the response. Values of
+      # product dimensions, e.g., offer id, reflect the state of a product at the time
+      # of the corresponding event, e.g., impression or order. Segment fields cannot
+      # be selected in queries without also selecting at least one metric field.
+      # Values are only set for dimensions requested explicitly in the request's
+      # search query.
+      class Segments
+        include Google::Apis::Core::Hashable
+      
+        # Represents a whole or partial calendar date, such as a birthday. The time of
+        # day and time zone are either specified elsewhere or are insignificant. The
+        # date is relative to the Gregorian Calendar. This can represent one of the
+        # following: * A full date, with non-zero year, month, and day values * A month
+        # and day value, with a zero year, such as an anniversary * A year on its own,
+        # with zero month and day values * A year and month value, with a zero day, such
+        # as a credit card expiration date Related types are google.type.TimeOfDay and `
+        # google.protobuf.Timestamp`.
+        # Corresponds to the JSON property `date`
+        # @return [Google::Apis::ContentV2_1::Date]
+        attr_accessor :date
+      
+        # Merchant-provided id of the product.
+        # Corresponds to the JSON property `offerId`
+        # @return [String]
+        attr_accessor :offer_id
+      
+        # Program to which metrics apply, e.g., Free Product Listing.
+        # Corresponds to the JSON property `program`
+        # @return [String]
+        attr_accessor :program
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @date = args[:date] if args.key?(:date)
+          @offer_id = args[:offer_id] if args.key?(:offer_id)
+          @program = args[:program] if args.key?(:program)
+        end
+      end
+      
       # 
       class Service
         include Google::Apis::Core::Hashable

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module ContentV2_1
       # Version of the google-apis-content_v2_1 gem
-      GEM_VERSION = "0.3.0"
+      GEM_VERSION = "0.4.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.1.2"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20210210"
+      REVISION = "20210211"
     end
   end
 end

data/lib/google/apis/content_v2_1/representations.rb

@@ -772,6 +772,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class Metrics
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class MinimumOrderValueTable
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1678,6 +1684,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class ReportRow
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class RepricingProductReport
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1864,6 +1876,24 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class SearchRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class SearchResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class Segments
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Service
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -3408,6 +3438,15 @@ module Google
         end
       end
       
+      class Metrics
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :clicks, :numeric_string => true, as: 'clicks'
+          property :ctr, as: 'ctr'
+          property :impressions, :numeric_string => true, as: 'impressions'
+        end
+      end
+      
       class MinimumOrderValueTable
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -5154,6 +5193,16 @@ module Google
         end
       end
       
+      class ReportRow
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :metrics, as: 'metrics', class: Google::Apis::ContentV2_1::Metrics, decorator: Google::Apis::ContentV2_1::Metrics::Representation
+      
+          property :segments, as: 'segments', class: Google::Apis::ContentV2_1::Segments, decorator: Google::Apis::ContentV2_1::Segments::Representation
+      
+        end
+      end
+      
       class RepricingProductReport
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -5503,6 +5552,34 @@ module Google
         end
       end
       
+      class SearchRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :page_size, as: 'pageSize'
+          property :page_token, as: 'pageToken'
+          property :query, as: 'query'
+        end
+      end
+      
+      class SearchResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :next_page_token, as: 'nextPageToken'
+          collection :results, as: 'results', class: Google::Apis::ContentV2_1::ReportRow, decorator: Google::Apis::ContentV2_1::ReportRow::Representation
+      
+        end
+      end
+      
+      class Segments
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :date, as: 'date', class: Google::Apis::ContentV2_1::Date, decorator: Google::Apis::ContentV2_1::Date::Representation
+      
+          property :offer_id, as: 'offerId'
+          property :program, as: 'program'
+        end
+      end
+      
       class Service
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -4250,6 +4250,41 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Retrieves merchant performance mertrics matching the search query and
+        # optionally segmented by selected dimensions.
+        # @param [Fixnum] merchant_id
+        #   Required. Id of the merchant making the call. Must be a standalone account or
+        #   an MCA subaccount.
+        # @param [Google::Apis::ContentV2_1::SearchRequest] search_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::ContentV2_1::SearchResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::ContentV2_1::SearchResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def search_report(merchant_id, search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'content/v2.1/{merchantId}/reports/search', options)
+          command.request_representation = Google::Apis::ContentV2_1::SearchRequest::Representation
+          command.request_object = search_request_object
+          command.response_representation = Google::Apis::ContentV2_1::SearchResponse::Representation
+          command.response_class = Google::Apis::ContentV2_1::SearchResponse
+          command.params['merchantId'] = merchant_id unless merchant_id.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Creates a repricing rule for your Merchant Center account.
         # @param [Fixnum] merchant_id
         #   Required. The id of the merchant who owns the repricing rule.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-content_v2_1
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-15 00:00:00.000000000 Z
+date: 2021-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -52,7 +52,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/master/generated/google-apis-content_v2_1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-content_v2_1/v0.3.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-content_v2_1/v0.4.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-content_v2_1
 post_install_message: 
 rdoc_options: []