Class: Google::Shopping::Merchant::Reports::V1beta::ReportService::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/google/shopping/merchant/reports/v1beta/report_service/client.rb

Overview

Client for the ReportService service.

Service for retrieving reports and insights about your products, their performance, and their competitive environment on Google.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new ReportService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Shopping::Merchant::Reports::V1beta::ReportService::Client.new

# Create a client using a custom configuration
client = ::Google::Shopping::Merchant::Reports::V1beta::ReportService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the ReportService client.

Yield Parameters:



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/google/shopping/merchant/reports/v1beta/report_service/client.rb', line 126

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/shopping/merchant/reports/v1beta/reports_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @report_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Shopping::Merchant::Reports::V1beta::ReportService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool
  )
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the ReportService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all ReportService clients
::Google::Shopping::Merchant::Reports::V1beta::ReportService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/google/shopping/merchant/reports/v1beta/report_service/client.rb', line 59

def self.configure
  @configure ||= begin
    namespace = ["Google", "Shopping", "Merchant", "Reports", "V1beta"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.timeout = 60.0
    default_config.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

Configure the ReportService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



96
97
98
99
 
# File 'lib/google/shopping/merchant/reports/v1beta/report_service/client.rb', line 96

def configure
  yield @config if block_given?
  @config
end

#search(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Shopping::Merchant::Reports::V1beta::ReportRow> #search(parent: nil, query: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Shopping::Merchant::Reports::V1beta::ReportRow>

Retrieves a report defined by a search query. The response might contain fewer rows than specified by page_size. Rely on next_page_token to determine if there are more rows to be requested.

Examples:

Basic example

require "google/shopping/merchant/reports/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Merchant::Reports::V1beta::ReportService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Merchant::Reports::V1beta::SearchRequest.new

# Call the search method.
result = client.search request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Shopping::Merchant::Reports::V1beta::ReportRow.
  p item
end

Overloads:

  • #search(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Shopping::Merchant::Reports::V1beta::ReportRow>

    Pass arguments to search via a request object, either of type SearchRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Shopping::Merchant::Reports::V1beta::SearchRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #search(parent: nil, query: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Shopping::Merchant::Reports::V1beta::ReportRow>

    Pass arguments to search via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. Id of the account making the call. Must be a standalone account or an MCA subaccount. Format: accounts/{account}

    • query (::String) (defaults to: nil) —

      Required. Query that defines a report to be retrieved.

      For details on how to construct your query, see the Query Language guide. For the full list of available tables and fields, see the Available fields.

    • page_size (::Integer) (defaults to: nil) —

      Optional. Number of ReportRows to retrieve in a single page. Defaults to the maximum of 1000. Values above 1000 are coerced to 1000.

    • page_token (::String) (defaults to: nil) —

      Optional. 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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/google/shopping/merchant/reports/v1beta/report_service/client.rb', line 233

def search request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Reports::V1beta::SearchRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.search.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Shopping::Merchant::Reports::V1beta::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.search.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.search.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @report_service_stub.call_rpc :search, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @report_service_stub, :search, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


106
107
108
 
# File 'lib/google/shopping/merchant/reports/v1beta/report_service/client.rb', line 106

def universe_domain
  @report_service_stub.universe_domain
end