class Google::Apis::RetailV2beta::CloudRetailService

@see cloud.google.com/recommendations<br><br>service = Retail::CloudRetailService.new
Retail = Google::Apis::RetailV2beta # Alias the module
require ‘google/apis/retail_v2beta’
@example
learning, recommendation system, or Google Cloud.
recommendation systems without requiring a high level of expertise in machine
Cloud Retail service enables customers to build end-to-end personalized
Retail API

def add_project_location_catalog_branch_product_fulfillment_places(product, google_cloud_retail_v2beta_add_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)

Raises:
  • (Google::Apis::AuthorizationError) - Authorization is required
  • (Google::Apis::ClientError) - The request is invalid and should not be retried without modification
  • (Google::Apis::ServerError) - An error occurred on the server and the request can be retried

Returns:
  • (Google::Apis::RetailV2beta::GoogleLongrunningOperation) -

Other tags:
    Yieldparam: err - error object if request failed
    Yieldparam: result - parsed result object

Other tags:
    Yield: - Result & error if block supplied

Parameters:
  • options (Google::Apis::RequestOptions) --
  • quota_user (String) --
  • fields (String) --
  • google_cloud_retail_v2beta_add_fulfillment_places_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAddFulfillmentPlacesRequest) --
  • product (String) --
def add_project_location_catalog_branch_product_fulfillment_places(product, google_cloud_retail_v2beta_add_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+product}:addFulfillmentPlaces', options)
  command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAddFulfillmentPlacesRequest::Representation
  command.request_object = google_cloud_retail_v2beta_add_fulfillment_places_request_object
  command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation
  command.params['product'] = product unless product.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

def apply_command_defaults(command)

def apply_command_defaults(command)
  command.query['key'] = key unless key.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
end

def collect_project_location_catalog_user_event(parent, ets: nil, uri: nil, user_event: nil, fields: nil, quota_user: nil, options: nil, &block)

Raises:
  • (Google::Apis::AuthorizationError) - Authorization is required
  • (Google::Apis::ClientError) - The request is invalid and should not be retried without modification
  • (Google::Apis::ServerError) - An error occurred on the server and the request can be retried

Returns:
  • (Google::Apis::RetailV2beta::GoogleApiHttpBody) -

Other tags:
    Yieldparam: err - error object if request failed
    Yieldparam: result - parsed result object

Other tags:
    Yield: - Result & error if block supplied

Parameters:
  • options (Google::Apis::RequestOptions) --
  • quota_user (String) --
  • fields (String) --
  • user_event (String) --
  • uri (String) --
  • ets (Fixnum) --
  • parent (String) --
def collect_project_location_catalog_user_event(parent, ets: nil, uri: nil, user_event: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/{+parent}/userEvents:collect', options)
  command.response_representation = Google::Apis::RetailV2beta::GoogleApiHttpBody::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleApiHttpBody
  command.params['parent'] = parent unless parent.nil?
  command.query['ets'] = ets unless ets.nil?
  command.query['uri'] = uri unless uri.nil?
  command.query['userEvent'] = user_event unless user_event.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

def complete_project_location_catalog_query(catalog, dataset: nil, device_type: nil, language_codes: nil, max_suggestions: nil, query: nil, visitor_id: nil, fields: nil, quota_user: nil, options: nil, &block)

Raises:
  • (Google::Apis::AuthorizationError) - Authorization is required
  • (Google::Apis::ClientError) - The request is invalid and should not be retried without modification
  • (Google::Apis::ServerError) - An error occurred on the server and the request can be retried

Returns:
  • (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompleteQueryResponse) -

Other tags:
    Yieldparam: err - error object if request failed
    Yieldparam: result - parsed result object

Other tags:
    Yield: - Result & error if block supplied

Parameters:
  • options (Google::Apis::RequestOptions) --
  • quota_user (String) --
  • fields (String) --
  • visitor_id (String) --
  • query (String) --
  • max_suggestions (Fixnum) --
  • language_codes (Array, String) --
  • device_type (String) --
  • dataset (String) --
  • catalog (String) --
def complete_project_location_catalog_query(catalog, dataset: nil, device_type: nil, language_codes: nil, max_suggestions: nil, query: nil, visitor_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/{+catalog}:completeQuery', options)
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompleteQueryResponse::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompleteQueryResponse
  command.params['catalog'] = catalog unless catalog.nil?
  command.query['dataset'] = dataset unless dataset.nil?
  command.query['deviceType'] = device_type unless device_type.nil?
  command.query['languageCodes'] = language_codes unless language_codes.nil?
  command.query['maxSuggestions'] = max_suggestions unless max_suggestions.nil?
  command.query['query'] = query unless query.nil?
  command.query['visitorId'] = visitor_id unless visitor_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

def create_project_location_catalog_branch_product(parent, google_cloud_retail_v2beta_product_object = nil, product_id: nil, fields: nil, quota_user: nil, options: nil, &block)

Raises:
  • (Google::Apis::AuthorizationError) - Authorization is required
  • (Google::Apis::ClientError) - The request is invalid and should not be retried without modification
  • (Google::Apis::ServerError) - An error occurred on the server and the request can be retried

Returns:
  • (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct) -

Other tags:
    Yieldparam: err - error object if request failed
    Yieldparam: result - parsed result object

Other tags:
    Yield: - Result & error if block supplied

Parameters:
  • options (Google::Apis::RequestOptions) --
  • quota_user (String) --
  • fields (String) --
  • product_id (String) --
  • google_cloud_retail_v2beta_product_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct) --
  • parent (String) --
def create_project_location_catalog_branch_product(parent, google_cloud_retail_v2beta_product_object = nil, product_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+parent}/products', options)
  command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct::Representation
  command.request_object = google_cloud_retail_v2beta_product_object
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct
  command.params['parent'] = parent unless parent.nil?
  command.query['productId'] = product_id unless product_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

def delete_project_location_catalog_branch_product(name, fields: nil, quota_user: nil, options: nil, &block)

Raises:
  • (Google::Apis::AuthorizationError) - Authorization is required
  • (Google::Apis::ClientError) - The request is invalid and should not be retried without modification
  • (Google::Apis::ServerError) - An error occurred on the server and the request can be retried

Returns:
  • (Google::Apis::RetailV2beta::GoogleProtobufEmpty) -

Other tags:
    Yieldparam: err - error object if request failed
    Yieldparam: result - parsed result object

Other tags:
    Yield: - Result & error if block supplied

Parameters:
  • options (Google::Apis::RequestOptions) --
  • quota_user (String) --
  • fields (String) --
  • name (String) --
def delete_project_location_catalog_branch_product(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2beta/{+name}', options)
  command.response_representation = Google::Apis::RetailV2beta::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

def get_project_location_catalog_branch_operation(name, fields: nil, quota_user: nil, options: nil, &block)

Raises:
  • (Google::Apis::AuthorizationError) - Authorization is required
  • (Google::Apis::ClientError) - The request is invalid and should not be retried without modification
  • (Google::Apis::ServerError) - An error occurred on the server and the request can be retried

Returns:
  • (Google::Apis::RetailV2beta::GoogleLongrunningOperation) -

Other tags:
    Yieldparam: err - error object if request failed
    Yieldparam: result - parsed result object

Other tags:
    Yield: - Result & error if block supplied

Parameters:
  • options (Google::Apis::RequestOptions) --
  • quota_user (String) --
  • fields (String) --
  • name (String) --
def get_project_location_catalog_branch_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/{+name}', options)
  command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

def get_project_location_catalog_branch_product(name, fields: nil, quota_user: nil, options: nil, &block)

Raises:
  • (Google::Apis::AuthorizationError) - Authorization is required
  • (Google::Apis::ClientError) - The request is invalid and should not be retried without modification
  • (Google::Apis::ServerError) - An error occurred on the server and the request can be retried

Returns:
  • (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct) -

Other tags:
    Yieldparam: err - error object if request failed
    Yieldparam: result - parsed result object

Other tags:
    Yield: - Result & error if block supplied

Parameters:
  • options (Google::Apis::RequestOptions) --
  • quota_user (String) --
  • fields (String) --
  • name (String) --
def get_project_location_catalog_branch_product(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/{+name}', options)
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

def get_project_location_catalog_default_branch(catalog, fields: nil, quota_user: nil, options: nil, &block)

Raises:
  • (Google::Apis::AuthorizationError) - Authorization is required
  • (Google::Apis::ClientError) - The request is invalid and should not be retried without modification
  • (Google::Apis::ServerError) - An error occurred on the server and the request can be retried

Returns:
  • (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaGetDefaultBranchResponse) -

Other tags:
    Yieldparam: err - error object if request failed
    Yieldparam: result - parsed result object

Other tags:
    Yield: - Result & error if block supplied

Parameters:
  • options (Google::Apis::RequestOptions) --
  • quota_user (String) --
  • fields (String) --
  • catalog (String) --
def get_project_location_catalog_default_branch(catalog, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/{+catalog}:getDefaultBranch', options)
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaGetDefaultBranchResponse::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaGetDefaultBranchResponse
  command.params['catalog'] = catalog unless catalog.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

def get_project_location_catalog_operation(name, fields: nil, quota_user: nil, options: nil, &block)

Raises:
  • (Google::Apis::AuthorizationError) - Authorization is required
  • (Google::Apis::ClientError) - The request is invalid and should not be retried without modification
  • (Google::Apis::ServerError) - An error occurred on the server and the request can be retried

Returns:
  • (Google::Apis::RetailV2beta::GoogleLongrunningOperation) -

Other tags:
    Yieldparam: err - error object if request failed
    Yieldparam: result - parsed result object

Other tags:
    Yield: - Result & error if block supplied

Parameters:
  • options (Google::Apis::RequestOptions) --
  • quota_user (String) --
  • fields (String) --
  • name (String) --
def get_project_location_catalog_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/{+name}', options)
  command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)

Raises:
  • (Google::Apis::AuthorizationError) - Authorization is required
  • (Google::Apis::ClientError) - The request is invalid and should not be retried without modification
  • (Google::Apis::ServerError) - An error occurred on the server and the request can be retried

Returns:
  • (Google::Apis::RetailV2beta::GoogleLongrunningOperation) -

Other tags:
    Yieldparam: err - error object if request failed
    Yieldparam: result - parsed result object

Other tags:
    Yield: - Result & error if block supplied

Parameters:
  • options (Google::Apis::RequestOptions) --
  • quota_user (String) --
  • fields (String) --
  • name (String) --
def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/{+name}', options)
  command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

def import_project_location_catalog_branch_product(parent, google_cloud_retail_v2beta_import_products_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)

Raises:
  • (Google::Apis::AuthorizationError) - Authorization is required
  • (Google::Apis::ClientError) - The request is invalid and should not be retried without modification
  • (Google::Apis::ServerError) - An error occurred on the server and the request can be retried

Returns:
  • (Google::Apis::RetailV2beta::GoogleLongrunningOperation) -

Other tags:
    Yieldparam: err - error object if request failed
    Yieldparam: result - parsed result object

Other tags:
    Yield: - Result & error if block supplied

Parameters:
  • options (Google::Apis::RequestOptions) --
  • quota_user (String) --
  • fields (String) --
  • google_cloud_retail_v2beta_import_products_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaImportProductsRequest) --
  • parent (String) --
def import_project_location_catalog_branch_product(parent, google_cloud_retail_v2beta_import_products_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+parent}/products:import', options)
  command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaImportProductsRequest::Representation
  command.request_object = google_cloud_retail_v2beta_import_products_request_object
  command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation
  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

def import_project_location_catalog_completion_datum(parent, google_cloud_retail_v2beta_import_completion_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)

Raises:
  • (Google::Apis::AuthorizationError) - Authorization is required
  • (Google::Apis::ClientError) - The request is invalid and should not be retried without modification
  • (Google::Apis::ServerError) - An error occurred on the server and the request can be retried

Returns:
  • (Google::Apis::RetailV2beta::GoogleLongrunningOperation) -

Other tags:
    Yieldparam: err - error object if request failed
    Yieldparam: result - parsed result object

Other tags:
    Yield: - Result & error if block supplied

Parameters:
  • options (Google::Apis::RequestOptions) --
  • quota_user (String) --
  • fields (String) --
  • google_cloud_retail_v2beta_import_completion_data_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaImportCompletionDataRequest) --
  • parent (String) --
def import_project_location_catalog_completion_datum(parent, google_cloud_retail_v2beta_import_completion_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+parent}/completionData:import', options)
  command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaImportCompletionDataRequest::Representation
  command.request_object = google_cloud_retail_v2beta_import_completion_data_request_object
  command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation
  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

def import_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)

Raises:
  • (Google::Apis::AuthorizationError) - Authorization is required
  • (Google::Apis::ClientError) - The request is invalid and should not be retried without modification
  • (Google::Apis::ServerError) - An error occurred on the server and the request can be retried

Returns:
  • (Google::Apis::RetailV2beta::GoogleLongrunningOperation) -

Other tags:
    Yieldparam: err - error object if request failed
    Yieldparam: result - parsed result object

Other tags:
    Yield: - Result & error if block supplied

Parameters:
  • options (Google::Apis::RequestOptions) --
  • quota_user (String) --
  • fields (String) --
  • google_cloud_retail_v2beta_import_user_events_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaImportUserEventsRequest) --
  • parent (String) --
def import_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+parent}/userEvents:import', options)
  command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaImportUserEventsRequest::Representation
  command.request_object = google_cloud_retail_v2beta_import_user_events_request_object
  command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation
  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

def initialize

def initialize
  super('https://retail.googleapis.com/', '',
        client_name: 'google-apis-retail_v2beta',
        client_version: Google::Apis::RetailV2beta::GEM_VERSION)
  @batch_path = 'batch'
end

def list_project_location_catalog_branch_products(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)

Raises:
  • (Google::Apis::AuthorizationError) - Authorization is required
  • (Google::Apis::ClientError) - The request is invalid and should not be retried without modification
  • (Google::Apis::ServerError) - An error occurred on the server and the request can be retried

Returns:
  • (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListProductsResponse) -

Other tags:
    Yieldparam: err - error object if request failed
    Yieldparam: result - parsed result object

Other tags:
    Yield: - Result & error if block supplied

Parameters:
  • options (Google::Apis::RequestOptions) --
  • quota_user (String) --
  • fields (String) --
  • read_mask (String) --
  • page_token (String) --
  • page_size (Fixnum) --
  • filter (String) --
  • parent (String) --
def list_project_location_catalog_branch_products(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/{+parent}/products', options)
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListProductsResponse::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListProductsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

def list_project_location_catalog_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)

Raises:
  • (Google::Apis::AuthorizationError) - Authorization is required
  • (Google::Apis::ClientError) - The request is invalid and should not be retried without modification
  • (Google::Apis::ServerError) - An error occurred on the server and the request can be retried

Returns:
  • (Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse) -

Other tags:
    Yieldparam: err - error object if request failed
    Yieldparam: result - parsed result object

Other tags:
    Yield: - Result & error if block supplied

Parameters:
  • options (Google::Apis::RequestOptions) --
  • quota_user (String) --
  • fields (String) --
  • page_token (String) --
  • page_size (Fixnum) --
  • filter (String) --
  • name (String) --
def list_project_location_catalog_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/{+name}/operations', options)
  command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

def list_project_location_catalogs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)

Raises:
  • (Google::Apis::AuthorizationError) - Authorization is required
  • (Google::Apis::ClientError) - The request is invalid and should not be retried without modification
  • (Google::Apis::ServerError) - An error occurred on the server and the request can be retried

Returns:
  • (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListCatalogsResponse) -

Other tags:
    Yieldparam: err - error object if request failed
    Yieldparam: result - parsed result object

Other tags:
    Yield: - Result & error if block supplied

Parameters:
  • options (Google::Apis::RequestOptions) --
  • quota_user (String) --
  • fields (String) --
  • page_token (String) --
  • page_size (Fixnum) --
  • parent (String) --
def list_project_location_catalogs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/{+parent}/catalogs', options)
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListCatalogsResponse::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListCatalogsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)

Raises:
  • (Google::Apis::AuthorizationError) - Authorization is required
  • (Google::Apis::ClientError) - The request is invalid and should not be retried without modification
  • (Google::Apis::ServerError) - An error occurred on the server and the request can be retried

Returns:
  • (Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse) -

Other tags:
    Yieldparam: err - error object if request failed
    Yieldparam: result - parsed result object

Other tags:
    Yield: - Result & error if block supplied

Parameters:
  • options (Google::Apis::RequestOptions) --
  • quota_user (String) --
  • fields (String) --
  • page_token (String) --
  • page_size (Fixnum) --
  • filter (String) --
  • name (String) --
def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/{+name}/operations', options)
  command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

def patch_project_location_catalog(name, google_cloud_retail_v2beta_catalog_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)

Raises:
  • (Google::Apis::AuthorizationError) - Authorization is required
  • (Google::Apis::ClientError) - The request is invalid and should not be retried without modification
  • (Google::Apis::ServerError) - An error occurred on the server and the request can be retried

Returns:
  • (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCatalog) -

Other tags:
    Yieldparam: err - error object if request failed
    Yieldparam: result - parsed result object

Other tags:
    Yield: - Result & error if block supplied

Parameters:
  • options (Google::Apis::RequestOptions) --
  • quota_user (String) --
  • fields (String) --
  • update_mask (String) --
  • google_cloud_retail_v2beta_catalog_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCatalog) --
  • name (String) --
def patch_project_location_catalog(name, google_cloud_retail_v2beta_catalog_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta/{+name}', options)
  command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCatalog::Representation
  command.request_object = google_cloud_retail_v2beta_catalog_object
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCatalog::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCatalog
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

def patch_project_location_catalog_branch_product(name, google_cloud_retail_v2beta_product_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)

Raises:
  • (Google::Apis::AuthorizationError) - Authorization is required
  • (Google::Apis::ClientError) - The request is invalid and should not be retried without modification
  • (Google::Apis::ServerError) - An error occurred on the server and the request can be retried

Returns:
  • (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct) -

Other tags:
    Yieldparam: err - error object if request failed
    Yieldparam: result - parsed result object

Other tags:
    Yield: - Result & error if block supplied

Parameters:
  • options (Google::Apis::RequestOptions) --
  • quota_user (String) --
  • fields (String) --
  • update_mask (String) --
  • allow_missing (Boolean) --
  • google_cloud_retail_v2beta_product_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct) --
  • name (String) --
def patch_project_location_catalog_branch_product(name, google_cloud_retail_v2beta_product_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta/{+name}', options)
  command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct::Representation
  command.request_object = google_cloud_retail_v2beta_product_object
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

def predict_project_location_catalog_placement(placement, google_cloud_retail_v2beta_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)

Raises:
  • (Google::Apis::AuthorizationError) - Authorization is required
  • (Google::Apis::ClientError) - The request is invalid and should not be retried without modification
  • (Google::Apis::ServerError) - An error occurred on the server and the request can be retried

Returns:
  • (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictResponse) -

Other tags:
    Yieldparam: err - error object if request failed
    Yieldparam: result - parsed result object

Other tags:
    Yield: - Result & error if block supplied

Parameters:
  • options (Google::Apis::RequestOptions) --
  • quota_user (String) --
  • fields (String) --
  • google_cloud_retail_v2beta_predict_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictRequest) --
  • placement (String) --
def predict_project_location_catalog_placement(placement, google_cloud_retail_v2beta_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+placement}:predict', options)
  command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictRequest::Representation
  command.request_object = google_cloud_retail_v2beta_predict_request_object
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictResponse::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictResponse
  command.params['placement'] = placement unless placement.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

def purge_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)

Raises:
  • (Google::Apis::AuthorizationError) - Authorization is required
  • (Google::Apis::ClientError) - The request is invalid and should not be retried without modification
  • (Google::Apis::ServerError) - An error occurred on the server and the request can be retried

Returns:
  • (Google::Apis::RetailV2beta::GoogleLongrunningOperation) -

Other tags:
    Yieldparam: err - error object if request failed
    Yieldparam: result - parsed result object

Other tags:
    Yield: - Result & error if block supplied

Parameters:
  • options (Google::Apis::RequestOptions) --
  • quota_user (String) --
  • fields (String) --
  • google_cloud_retail_v2beta_purge_user_events_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPurgeUserEventsRequest) --
  • parent (String) --
def purge_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+parent}/userEvents:purge', options)
  command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPurgeUserEventsRequest::Representation
  command.request_object = google_cloud_retail_v2beta_purge_user_events_request_object
  command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation
  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

def rejoin_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_rejoin_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)

Raises:
  • (Google::Apis::AuthorizationError) - Authorization is required
  • (Google::Apis::ClientError) - The request is invalid and should not be retried without modification
  • (Google::Apis::ServerError) - An error occurred on the server and the request can be retried

Returns:
  • (Google::Apis::RetailV2beta::GoogleLongrunningOperation) -

Other tags:
    Yieldparam: err - error object if request failed
    Yieldparam: result - parsed result object

Other tags:
    Yield: - Result & error if block supplied

Parameters:
  • options (Google::Apis::RequestOptions) --
  • quota_user (String) --
  • fields (String) --
  • google_cloud_retail_v2beta_rejoin_user_events_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRejoinUserEventsRequest) --
  • parent (String) --
def rejoin_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_rejoin_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+parent}/userEvents:rejoin', options)
  command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRejoinUserEventsRequest::Representation
  command.request_object = google_cloud_retail_v2beta_rejoin_user_events_request_object
  command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation
  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

def remove_project_location_catalog_branch_product_fulfillment_places(product, google_cloud_retail_v2beta_remove_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)

Raises:
  • (Google::Apis::AuthorizationError) - Authorization is required
  • (Google::Apis::ClientError) - The request is invalid and should not be retried without modification
  • (Google::Apis::ServerError) - An error occurred on the server and the request can be retried

Returns:
  • (Google::Apis::RetailV2beta::GoogleLongrunningOperation) -

Other tags:
    Yieldparam: err - error object if request failed
    Yieldparam: result - parsed result object

Other tags:
    Yield: - Result & error if block supplied

Parameters:
  • options (Google::Apis::RequestOptions) --
  • quota_user (String) --
  • fields (String) --
  • google_cloud_retail_v2beta_remove_fulfillment_places_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRemoveFulfillmentPlacesRequest) --
  • product (String) --
def remove_project_location_catalog_branch_product_fulfillment_places(product, google_cloud_retail_v2beta_remove_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+product}:removeFulfillmentPlaces', options)
  command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRemoveFulfillmentPlacesRequest::Representation
  command.request_object = google_cloud_retail_v2beta_remove_fulfillment_places_request_object
  command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation
  command.params['product'] = product unless product.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

def search_project_location_catalog_placements(placement, google_cloud_retail_v2beta_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)

Raises:
  • (Google::Apis::AuthorizationError) - Authorization is required
  • (Google::Apis::ClientError) - The request is invalid and should not be retried without modification
  • (Google::Apis::ServerError) - An error occurred on the server and the request can be retried

Returns:
  • (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponse) -

Other tags:
    Yieldparam: err - error object if request failed
    Yieldparam: result - parsed result object

Other tags:
    Yield: - Result & error if block supplied

Parameters:
  • options (Google::Apis::RequestOptions) --
  • quota_user (String) --
  • fields (String) --
  • google_cloud_retail_v2beta_search_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequest) --
  • placement (String) --
def search_project_location_catalog_placements(placement, google_cloud_retail_v2beta_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+placement}:search', options)
  command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequest::Representation
  command.request_object = google_cloud_retail_v2beta_search_request_object
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponse::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponse
  command.params['placement'] = placement unless placement.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

def set_project_location_catalog_branch_product_inventory(name, google_cloud_retail_v2beta_set_inventory_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)

Raises:
  • (Google::Apis::AuthorizationError) - Authorization is required
  • (Google::Apis::ClientError) - The request is invalid and should not be retried without modification
  • (Google::Apis::ServerError) - An error occurred on the server and the request can be retried

Returns:
  • (Google::Apis::RetailV2beta::GoogleLongrunningOperation) -

Other tags:
    Yieldparam: err - error object if request failed
    Yieldparam: result - parsed result object

Other tags:
    Yield: - Result & error if block supplied

Parameters:
  • options (Google::Apis::RequestOptions) --
  • quota_user (String) --
  • fields (String) --
  • google_cloud_retail_v2beta_set_inventory_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSetInventoryRequest) --
  • name (String) --
def set_project_location_catalog_branch_product_inventory(name, google_cloud_retail_v2beta_set_inventory_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+name}:setInventory', options)
  command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSetInventoryRequest::Representation
  command.request_object = google_cloud_retail_v2beta_set_inventory_request_object
  command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

def set_project_location_catalog_default_branch(catalog, google_cloud_retail_v2beta_set_default_branch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)

Raises:
  • (Google::Apis::AuthorizationError) - Authorization is required
  • (Google::Apis::ClientError) - The request is invalid and should not be retried without modification
  • (Google::Apis::ServerError) - An error occurred on the server and the request can be retried

Returns:
  • (Google::Apis::RetailV2beta::GoogleProtobufEmpty) -

Other tags:
    Yieldparam: err - error object if request failed
    Yieldparam: result - parsed result object

Other tags:
    Yield: - Result & error if block supplied

Parameters:
  • options (Google::Apis::RequestOptions) --
  • quota_user (String) --
  • fields (String) --
  • google_cloud_retail_v2beta_set_default_branch_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSetDefaultBranchRequest) --
  • catalog (String) --
def set_project_location_catalog_default_branch(catalog, google_cloud_retail_v2beta_set_default_branch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+catalog}:setDefaultBranch', options)
  command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSetDefaultBranchRequest::Representation
  command.request_object = google_cloud_retail_v2beta_set_default_branch_request_object
  command.response_representation = Google::Apis::RetailV2beta::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleProtobufEmpty
  command.params['catalog'] = catalog unless catalog.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

def write_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_user_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)

Raises:
  • (Google::Apis::AuthorizationError) - Authorization is required
  • (Google::Apis::ClientError) - The request is invalid and should not be retried without modification
  • (Google::Apis::ServerError) - An error occurred on the server and the request can be retried

Returns:
  • (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaUserEvent) -

Other tags:
    Yieldparam: err - error object if request failed
    Yieldparam: result - parsed result object

Other tags:
    Yield: - Result & error if block supplied

Parameters:
  • options (Google::Apis::RequestOptions) --
  • quota_user (String) --
  • fields (String) --
  • google_cloud_retail_v2beta_user_event_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaUserEvent) --
  • parent (String) --
def write_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_user_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+parent}/userEvents:write', options)
  command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaUserEvent::Representation
  command.request_object = google_cloud_retail_v2beta_user_event_object
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaUserEvent::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaUserEvent
  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