Class: Google::Apis::MerchantapiReportsV1beta::MerchantService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/merchantapi_reports_v1beta/service.rb

Overview

Merchant API

Programmatically manage your Merchant Center Accounts.

Examples:

require 'google/apis/merchantapi_reports_v1beta'

Merchantapi = Google::Apis::MerchantapiReportsV1beta # Alias the module
service = Merchantapi::MerchantService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://merchantapi.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ MerchantService

Returns a new instance of MerchantService.



47
48
49
50
51
52
 
# File 'lib/google/apis/merchantapi_reports_v1beta/service.rb', line 47

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-merchantapi_reports_v1beta',
        client_version: Google::Apis::MerchantapiReportsV1beta::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



40
41
42
 
# File 'lib/google/apis/merchantapi_reports_v1beta/service.rb', line 40

def key
  @key
end

#quota_user ⇒ String

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

Returns:

  • (String) —

    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.



45
46
47
 
# File 'lib/google/apis/merchantapi_reports_v1beta/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#search_report(parent, search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiReportsV1beta::SearchResponse

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.

Parameters:

  • parent (String) —

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

  • search_request_object (Google::Apis::MerchantapiReportsV1beta::SearchRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/google/apis/merchantapi_reports_v1beta/service.rb', line 78

def search_report(parent, search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'reports/v1beta/{+parent}/reports:search', options)
  command.request_representation = Google::Apis::MerchantapiReportsV1beta::SearchRequest::Representation
  command.request_object = search_request_object
  command.response_representation = Google::Apis::MerchantapiReportsV1beta::SearchResponse::Representation
  command.response_class = Google::Apis::MerchantapiReportsV1beta::SearchResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end