Class: Google::Apis::RetailV2beta::CloudRetailService

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

Overview

Retail API

Cloud Retail service enables customers to build end-to-end personalized recommendation systems without requiring a high level of expertise in machine learning, recommendation system, or Google Cloud.

Examples:

require 'google/apis/retail_v2beta'

Retail = Google::Apis::RetailV2beta # Alias the module
service = Retail::CloudRetailService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CloudRetailService

Returns a new instance of CloudRetailService.



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

def initialize
  super('https://retail.googleapis.com/', '',
        client_name: 'google-apis-retail_v2beta',
        client_version: Google::Apis::RetailV2beta::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/retail_v2beta/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/retail_v2beta/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#add_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2beta_add_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig

Adds the specified CatalogAttribute to the AttributesConfig. If the CatalogAttribute to add already exists, an ALREADY_EXISTS error is returned.

Parameters:

  • attributes_config (String) —

    Required. Full AttributesConfig resource name. Format: projects/ project_number/locations/location_id/catalogs/catalog_id/attributesConfig

  • google_cloud_retail_v2beta_add_catalog_attribute_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAddCatalogAttributeRequest) (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



463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 463

def add_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2beta_add_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+attributesConfig}:addCatalogAttribute', options)
  command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAddCatalogAttributeRequest::Representation
  command.request_object = google_cloud_retail_v2beta_add_catalog_attribute_request_object
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig
  command.params['attributesConfig'] = attributes_config unless attributes_config.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#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) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation

Incrementally adds place IDs to Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the added place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.

Parameters:

  • product (String) —

    Required. Full resource name of Product, such as projects/*/locations/global/ catalogs/default_catalog/branches/default_branch/products/some_product_id. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

  • google_cloud_retail_v2beta_add_fulfillment_places_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAddFulfillmentPlacesRequest) (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



647
648
649
650
651
652
653
654
655
656
657
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 647

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

#add_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2beta_add_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation

Updates local inventory information for a Product at a list of places, while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating inventory information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be modified using this method. ProductService. CreateProduct and ProductService.UpdateProduct has no effect on local inventories. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.

Parameters:

  • product (String) —

    Required. Full resource name of Product, such as projects/*/locations/global/ catalogs/default_catalog/branches/default_branch/products/some_product_id. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

  • google_cloud_retail_v2beta_add_local_inventories_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAddLocalInventoriesRequest) (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



697
698
699
700
701
702
703
704
705
706
707
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 697

def add_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2beta_add_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+product}:addLocalInventories', options)
  command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAddLocalInventoriesRequest::Representation
  command.request_object = google_cloud_retail_v2beta_add_local_inventories_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

#add_project_location_catalog_serving_config_control(serving_config, google_cloud_retail_v2beta_add_control_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig

Enables a Control on the specified ServingConfig. The control is added in the last position of the list of controls it belongs to (e.g. if it's a facet spec control it will be applied in the last position of servingConfig.facetSpecIds) Returns a ALREADY_EXISTS error if the control has already been applied. Returns a FAILED_PRECONDITION error if the addition could exceed maximum number of control allowed for that type of control.

Parameters:

  • serving_config (String) —

    Required. The source ServingConfig resource name . Format: projects/ project_number/locations/location_id/catalogs/catalog_id/servingConfigs/ serving_config_id

  • google_cloud_retail_v2beta_add_control_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAddControlRequest) (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



1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 1542

def add_project_location_catalog_serving_config_control(serving_config, google_cloud_retail_v2beta_add_control_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+servingConfig}:addControl', options)
  command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAddControlRequest::Representation
  command.request_object = google_cloud_retail_v2beta_add_control_request_object
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig
  command.params['servingConfig'] = serving_config unless serving_config.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_project_location_catalog_attributes_config_remove_catalog_attributes(attributes_config, google_cloud_retail_v2beta_batch_remove_catalog_attributes_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaBatchRemoveCatalogAttributesResponse

Removes all specified CatalogAttributes from the AttributesConfig.

Parameters:

  • attributes_config (String) —

    Required. The attributes config resource shared by all catalog attributes being deleted. Format: projects/project_number/locations/location_id/ catalogs/catalog_id/attributesConfig

  • google_cloud_retail_v2beta_batch_remove_catalog_attributes_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaBatchRemoveCatalogAttributesRequest) (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



498
499
500
501
502
503
504
505
506
507
508
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 498

def batch_project_location_catalog_attributes_config_remove_catalog_attributes(attributes_config, google_cloud_retail_v2beta_batch_remove_catalog_attributes_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+attributesConfig}:batchRemoveCatalogAttributes', options)
  command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaBatchRemoveCatalogAttributesRequest::Representation
  command.request_object = google_cloud_retail_v2beta_batch_remove_catalog_attributes_request_object
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaBatchRemoveCatalogAttributesResponse::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaBatchRemoveCatalogAttributesResponse
  command.params['attributesConfig'] = attributes_config unless attributes_config.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#collect_project_location_catalog_user_event(parent, ets: nil, uri: nil, user_event: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleApiHttpBody

Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

Parameters:

  • parent (String) —

    Required. The parent catalog name, such as projects/1234/locations/global/ catalogs/default_catalog.

  • ets (Fixnum) (defaults to: nil) —

    The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.

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

    The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for 3rd party requests.

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

    Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.

  • 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



1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 1892

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

#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) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompleteQueryResponse

Completes the specified prefix with keyword suggestions. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.

Parameters:

  • catalog (String) —

    Required. Catalog for which the completion is performed. Full resource name of catalog, such as projects/*/locations/global/catalogs/default_catalog.

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

    Determines which dataset to use for fetching completion. "user-data" will use the imported dataset through CompletionService.ImportCompletionData. "cloud- retail" will use the dataset generated by cloud retail based on user events. If leave empty, it will use the "user-data". Current supported values: * user- data * cloud-retail: This option requires enabling auto-learning function first. See guidelines.

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

    The device type context for completion suggestions. It is useful to apply different suggestions on different device types, e.g. DESKTOP, MOBILE. If it is empty, the suggestions are across all device types. Supported formats: * UNKNOWN_DEVICE_TYPE * DESKTOP * MOBILE * A customized string starts with OTHER_, e.g. OTHER_IPHONE.

  • language_codes (Array<String>, String) (defaults to: nil) —

    Note that this field applies for user-data dataset only. For requests with cloud-retail dataset, setting this field has no effect. The language filters applied to the output suggestions. If set, it should contain the language of the query. If not set, suggestions are returned without considering language restrictions. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages. The maximum number of language codes is 3.

  • max_suggestions (Fixnum) (defaults to: nil) —

    Completion max suggestions. If left unset or set to 0, then will fallback to the configured value CompletionConfig.max_suggestions. The maximum allowed max suggestions is 20. If it is set higher, it will be capped by 20.

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

    Required. The query used to generate suggestions. The maximum number of allowed characters is 255.

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

    Required field. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

  • 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



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 113

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

#create_project_location_catalog_branch_product(parent, google_cloud_retail_v2beta_product_object = nil, product_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct

Creates a Product.

Parameters:

  • parent (String) —

    Required. The parent catalog resource name, such as projects/*/locations/ global/catalogs/default_catalog/branches/default_branch.

  • google_cloud_retail_v2beta_product_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct) (defaults to: nil)
  • product_id (String) (defaults to: nil) —

    Required. The ID to use for the Product, which will become the final component of the Product.name. If the caller does not have permission to create the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Products with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

  • 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



739
740
741
742
743
744
745
746
747
748
749
750
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 739

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

#create_project_location_catalog_control(parent, google_cloud_retail_v2beta_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl

Creates a Control. If the Control to create already exists, an ALREADY_EXISTS error is returned.

Parameters:

  • parent (String) —

    Required. Full resource name of parent catalog. Format: projects/ project_number/locations/location_id/catalogs/catalog_id``

  • google_cloud_retail_v2beta_control_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl) (defaults to: nil)
  • control_id (String) (defaults to: nil) —

    Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value should be 4-63 characters, and valid characters are /a-z-_/.

  • 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



1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 1191

def create_project_location_catalog_control(parent, google_cloud_retail_v2beta_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+parent}/controls', options)
  command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl::Representation
  command.request_object = google_cloud_retail_v2beta_control_object
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl
  command.params['parent'] = parent unless parent.nil?
  command.query['controlId'] = control_id unless control_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

#create_project_location_catalog_serving_config(parent, google_cloud_retail_v2beta_serving_config_object = nil, serving_config_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig

Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned.

Parameters:

  • parent (String) —

    Required. Full resource name of parent. Format: projects/project_number/ locations/location_id/catalogs/catalog_id``

  • google_cloud_retail_v2beta_serving_config_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig) (defaults to: nil)
  • serving_config_id (String) (defaults to: nil) —

    Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-z-_/.

  • 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



1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 1581

def create_project_location_catalog_serving_config(parent, google_cloud_retail_v2beta_serving_config_object = nil, serving_config_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+parent}/servingConfigs', options)
  command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig::Representation
  command.request_object = google_cloud_retail_v2beta_serving_config_object
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig
  command.params['parent'] = parent unless parent.nil?
  command.query['servingConfigId'] = serving_config_id unless serving_config_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

#delete_project_location_catalog_branch_product(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleProtobufEmpty

Deletes a Product.

Parameters:

  • name (String) —

    Required. Full resource name of Product, such as projects/*/locations/global/ catalogs/default_catalog/branches/default_branch/products/some_product_id. If the caller does not have permission to delete the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Product to delete does not exist, a NOT_FOUND error is returned. The Product to delete can neither be a Product.Type.COLLECTION Product member nor a Product.Type.PRIMARY Product with more than one variants. Otherwise, an INVALID_ARGUMENT error is returned. All inventory information for the named Product will be deleted.

  • 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



780
781
782
783
784
785
786
787
788
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 780

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

#delete_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleProtobufEmpty

Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.

Parameters:

  • name (String) —

    Required. The resource name of the Control to delete. Format: projects/ project_number/locations/location_id/catalogs/catalog_id/controls/ control_id``

  • 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



1227
1228
1229
1230
1231
1232
1233
1234
1235
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 1227

def delete_project_location_catalog_control(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

#delete_project_location_catalog_serving_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleProtobufEmpty

Deletes a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.

Parameters:

  • name (String) —

    Required. The resource name of the ServingConfig to delete. Format: projects/ project_number/locations/location_id/catalogs/catalog_id/servingConfigs/ serving_config_id

  • 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



1617
1618
1619
1620
1621
1622
1623
1624
1625
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 1617

def delete_project_location_catalog_serving_config(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

#get_project_location_catalog_attributes_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig

Gets an AttributesConfig.

Parameters:

  • name (String) —

    Required. Full AttributesConfig resource name. Format: projects/ project_number/locations/location_id/catalogs/catalog_id/attributesConfig

  • 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



150
151
152
153
154
155
156
157
158
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 150

def get_project_location_catalog_attributes_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/{+name}', options)
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig
  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

#get_project_location_catalog_branch_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • 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



602
603
604
605
606
607
608
609
610
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 602

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

#get_project_location_catalog_branch_product(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct

Gets a Product.

Parameters:

  • name (String) —

    Required. Full resource name of Product, such as projects/*/locations/global/ catalogs/default_catalog/branches/default_branch/products/some_product_id. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Product does not exist, a NOT_FOUND error is returned.

  • 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



814
815
816
817
818
819
820
821
822
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 814

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

#get_project_location_catalog_completion_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig

Gets a CompletionConfig.

Parameters:

  • name (String) —

    Required. Full CompletionConfig resource name. Format: projects/ project_number/locations/location_id/catalogs/catalog_id/completionConfig

  • 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



181
182
183
184
185
186
187
188
189
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 181

def get_project_location_catalog_completion_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/{+name}', options)
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig
  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

#get_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl

Gets a Control.

Parameters:

  • name (String) —

    Required. The resource name of the Control to delete. Format: projects/ project_number/locations/location_id/catalogs/catalog_id/controls/ control_id``

  • 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



1259
1260
1261
1262
1263
1264
1265
1266
1267
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 1259

def get_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/{+name}', options)
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl
  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

#get_project_location_catalog_default_branch(catalog, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaGetDefaultBranchResponse

Get which branch is currently default branch set by CatalogService. SetDefaultBranch method under a specified parent catalog.

Parameters:

  • catalog (String) —

    The parent catalog resource name, such as projects/*/locations/global/ catalogs/default_catalog.

  • 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



213
214
215
216
217
218
219
220
221
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 213

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

#get_project_location_catalog_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • 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



1376
1377
1378
1379
1380
1381
1382
1383
1384
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 1376

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

#get_project_location_catalog_serving_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig

Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.

Parameters:

  • name (String) —

    Required. The resource name of the ServingConfig to get. Format: projects/ project_number/locations/location_id/catalogs/catalog_id/servingConfigs/ serving_config_id

  • 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



1650
1651
1652
1653
1654
1655
1656
1657
1658
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 1650

def get_project_location_catalog_serving_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/{+name}', options)
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig
  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

#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • 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



2075
2076
2077
2078
2079
2080
2081
2082
2083
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 2075

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

#get_project_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • 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



2152
2153
2154
2155
2156
2157
2158
2159
2160
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 2152

def get_project_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

#import_project_location_catalog_branch_product(parent, google_cloud_retail_v2beta_import_products_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation

Bulk import of multiple Products. Request processing may be synchronous. Non- existing items are created. Note that it is possible for a subset of the Products to be successfully updated.

Parameters:

  • parent (String) —

    Required. projects/1234/locations/global/catalogs/default_catalog/branches/ default_branch If no updateMask is specified, requires products.create permission. If updateMask is specified, requires products.update permission.

  • google_cloud_retail_v2beta_import_products_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaImportProductsRequest) (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



849
850
851
852
853
854
855
856
857
858
859
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 849

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

#import_project_location_catalog_completion_datum(parent, google_cloud_retail_v2beta_import_completion_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation

Bulk import of processed completion dataset. Request processing is asynchronous. Partial updating is not supported. The operation is successfully finished only after the imported suggestions are indexed successfully and ready for serving. The process takes hours. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.

Parameters:

  • parent (String) —

    Required. The catalog which the suggestions dataset belongs to. Format: projects/1234/locations/global/catalogs/default_catalog.

  • google_cloud_retail_v2beta_import_completion_data_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaImportCompletionDataRequest) (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



1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 1152

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

#import_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation

Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation. metadata is of type ImportMetadata.

Parameters:

  • parent (String) —

    Required. projects/1234/locations/global/catalogs/default_catalog

  • google_cloud_retail_v2beta_import_user_events_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaImportUserEventsRequest) (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



1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 1930

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

#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) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListProductsResponse

Gets a list of Products.

Parameters:

  • parent (String) —

    Required. The parent branch resource name, such as projects/*/locations/ global/catalogs/default_catalog/branches/0. Use default_branch as the branch ID, to list products under the default branch. If the caller does not have permission to list Products under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

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

    A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. * List Product.Type. VARIANT Products sharing the same Product.Type.PRIMARY Product. For example: primary_product_id = "some_product_id" * List Products bundled in a Product. Type.COLLECTION Product. For example: collection_product_id = " some_product_id" * List Products with a partibular type. For example: type = "PRIMARY" type = "VARIANT" type = "COLLECTION" If the field is unrecognizable, an INVALID_ARGUMENT error is returned. If the specified Product.Type.PRIMARY Product or Product.Type.COLLECTION Product does not exist, a NOT_FOUND error is returned.

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

    Maximum number of Products to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.

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

    A page token ListProductsResponse.next_page_token, received from a previous ProductService.ListProducts call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ProductService.ListProducts must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

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

    The fields of Product to return in the responses. If not set or empty, the following fields are returned: * Product.name * Product.id * Product.title * Product.uri * Product.images * Product.price_info * Product.brands If "*" is provided, all fields are returned. Product.name is always returned no matter what mask is set. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

  • 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



913
914
915
916
917
918
919
920
921
922
923
924
925
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 913

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

#list_project_location_catalog_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListControlsResponse

Lists all Controls linked to this catalog.

Parameters:

  • parent (String) —

    Required. The catalog resource name. Format: projects/project_number/ locations/location_id/catalogs/catalog_id``

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

    Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. * List controls that are used in a single ServingConfig: 'serving_config = " boosted_home_page_cvr"'

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

    Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.

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

    Optional. A page token, received from a previous ListControls call. Provide this to retrieve the subsequent page.

  • 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



1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 1301

def list_project_location_catalog_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/{+parent}/controls', options)
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListControlsResponse::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListControlsResponse
  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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_catalog_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/name=users/*/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

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

    The standard list filter.

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

    The standard list page size.

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

    The standard list page token.

  • 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



1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 1419

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

#list_project_location_catalog_serving_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListServingConfigsResponse

Lists all ServingConfigs linked to this catalog.

Parameters:

  • parent (String) —

    Required. The catalog resource name. Format: projects/project_number/ locations/location_id/catalogs/catalog_id

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

    Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.

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

    Optional. A page token, received from a previous ListServingConfigs call. Provide this to retrieve the subsequent page.

  • 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



1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 1687

def list_project_location_catalog_serving_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/{+parent}/servingConfigs', options)
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListServingConfigsResponse::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListServingConfigsResponse
  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

#list_project_location_catalogs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListCatalogsResponse

Lists all the Catalogs associated with the project.

Parameters:

  • parent (String) —

    Required. The account resource name with an associated location. If the caller does not have permission to list Catalogs under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.

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

    Maximum number of Catalogs to return. If unspecified, defaults to 50. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT is returned.

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

    A page token ListCatalogsResponse.next_page_token, received from a previous CatalogService.ListCatalogs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CatalogService.ListCatalogs must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

  • 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



255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 255

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

#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/name=users/*/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

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

    The standard list filter.

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

    The standard list page size.

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

    The standard list page token.

  • 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



2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 2118

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

#list_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/name=users/*/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

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

    The standard list filter.

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

    The standard list page size.

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

    The standard list page token.

  • 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



2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 2195

def list_project_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

#patch_project_location_catalog(name, google_cloud_retail_v2beta_catalog_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCatalog

Updates the Catalogs.

Parameters:

  • name (String) —

    Required. Immutable. The fully qualified resource name of the catalog.

  • google_cloud_retail_v2beta_catalog_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCatalog) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

  • 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



291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 291

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

#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) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct

Updates a Product.

Parameters:

  • name (String) —

    Immutable. Full resource name of the product, such as projects/*/locations/ global/catalogs/default_catalog/branches/default_branch/products/product_id.

  • google_cloud_retail_v2beta_product_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct) (defaults to: nil)
  • allow_missing (Boolean) (defaults to: nil) —

    If set to true, and the Product is not found, a new Product will be created. In this situation, update_mask is ignored.

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

    Indicates which fields in the provided Product to update. The immutable and output only fields are NOT supported. If not set, all supported fields (the fields that are neither immutable nor output only) are updated. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. The attribute key can be updated by setting the mask path as " attributes.$key_name". If a key name is present in the mask but not in the patching product from the request, this key will be deleted after the update.

  • 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



960
961
962
963
964
965
966
967
968
969
970
971
972
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 960

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

#patch_project_location_catalog_control(name, google_cloud_retail_v2beta_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl

Updates a Control. Control cannot be set to a different oneof field, if so an INVALID_ARGUMENT is returned. If the Control to delete does not exist, a NOT_FOUND error is returned.

Parameters:

  • name (String) —

    Immutable. Fully qualified name projects/*/locations/global/catalogs/*/ controls/*

  • google_cloud_retail_v2beta_control_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name If not set or empty, all supported fields are updated.

  • 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



1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 1342

def patch_project_location_catalog_control(name, google_cloud_retail_v2beta_control_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::GoogleCloudRetailV2betaControl::Representation
  command.request_object = google_cloud_retail_v2beta_control_object
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl
  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

#patch_project_location_catalog_serving_config(name, google_cloud_retail_v2beta_serving_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig

Updates a ServingConfig.

Parameters:

  • name (String) —

    Immutable. Fully qualified name projects/*/locations/global/catalogs/*/ servingConfig/*

  • google_cloud_retail_v2beta_serving_config_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.

  • 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



1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 1725

def patch_project_location_catalog_serving_config(name, google_cloud_retail_v2beta_serving_config_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::GoogleCloudRetailV2betaServingConfig::Representation
  command.request_object = google_cloud_retail_v2beta_serving_config_object
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig
  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

#predict_project_location_catalog_placement(placement, google_cloud_retail_v2beta_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictResponse

Makes a recommendation prediction.

Parameters:

  • placement (String) —

    Required. Full resource name of the format: placement=projects/*/locations/ global/catalogs/default_catalog/servingConfigs/* or placement=projects/*/ locations/global/catalogs/default_catalog/placements/*. We recommend using the servingConfigs resource. placements is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see Managing serving configurations. The full list of available serving configs can be seen at https://console.cloud.google.com/ai/ retail/catalogs/default_catalog/configs

  • google_cloud_retail_v2beta_predict_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictRequest) (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



1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 1462

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

#predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2beta_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictResponse

Makes a recommendation prediction.

Parameters:

  • placement (String) —

    Required. Full resource name of the format: placement=projects/*/locations/ global/catalogs/default_catalog/servingConfigs/* or placement=projects/*/ locations/global/catalogs/default_catalog/placements/*. We recommend using the servingConfigs resource. placements is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see Managing serving configurations. The full list of available serving configs can be seen at https://console.cloud.google.com/ai/ retail/catalogs/default_catalog/configs

  • google_cloud_retail_v2beta_predict_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictRequest) (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



1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 1768

def predict_project_location_catalog_serving_config(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

#purge_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation

Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.

Parameters:

  • parent (String) —

    Required. The resource name of the catalog under which the events are created. The format is projects/$projectId/locations/global/catalogs/$catalogId``

  • google_cloud_retail_v2beta_purge_user_events_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPurgeUserEventsRequest) (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



1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 1967

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

#rejoin_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_rejoin_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation

Starts a user event rejoin operation with latest product catalog. Events will not be annotated with detailed product information if product is missing from the catalog at the time the user event is ingested, and these events are stored as unjoined events with a limited usage on training and serving. This method can be used to start a join operation on specified events with latest version of product catalog. It can also be used to correct events joined with the wrong product catalog. A rejoin operation can take hours or days to complete.

Parameters:

  • parent (String) —

    Required. The parent catalog resource name, such as projects/1234/locations/ global/catalogs/default_catalog.

  • google_cloud_retail_v2beta_rejoin_user_events_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRejoinUserEventsRequest) (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



2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 2008

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

#remove_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2beta_remove_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig

Removes the specified CatalogAttribute from the AttributesConfig. If the CatalogAttribute to remove does not exist, a NOT_FOUND error is returned.

Parameters:

  • attributes_config (String) —

    Required. Full AttributesConfig resource name. Format: projects/ project_number/locations/location_id/catalogs/catalog_id/attributesConfig

  • google_cloud_retail_v2beta_remove_catalog_attribute_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRemoveCatalogAttributeRequest) (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



533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 533

def remove_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2beta_remove_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+attributesConfig}:removeCatalogAttribute', options)
  command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRemoveCatalogAttributeRequest::Representation
  command.request_object = google_cloud_retail_v2beta_remove_catalog_attribute_request_object
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig
  command.params['attributesConfig'] = attributes_config unless attributes_config.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#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) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation

Incrementally removes place IDs from a Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the removed place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.

Parameters:

  • product (String) —

    Required. Full resource name of Product, such as projects/*/locations/global/ catalogs/default_catalog/branches/default_branch/products/some_product_id. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

  • google_cloud_retail_v2beta_remove_fulfillment_places_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRemoveFulfillmentPlacesRequest) (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



1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 1009

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

#remove_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2beta_remove_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation

Remove local inventory information for a Product at a list of places at a removal timestamp. This process is asynchronous. If the request is valid, the removal will be enqueued and processed downstream. As a consequence, when a response is returned, removals are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be removed using this method. ProductService. CreateProduct and ProductService.UpdateProduct has no effect on local inventories. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.

Parameters:

  • product (String) —

    Required. Full resource name of Product, such as projects/*/locations/global/ catalogs/default_catalog/branches/default_branch/products/some_product_id. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

  • google_cloud_retail_v2beta_remove_local_inventories_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRemoveLocalInventoriesRequest) (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



1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 1057

def remove_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2beta_remove_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+product}:removeLocalInventories', options)
  command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRemoveLocalInventoriesRequest::Representation
  command.request_object = google_cloud_retail_v2beta_remove_local_inventories_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

#remove_project_location_catalog_serving_config_control(serving_config, google_cloud_retail_v2beta_remove_control_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig

Disables a Control on the specified ServingConfig. The control is removed from the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for the ServingConfig.

Parameters:

  • serving_config (String) —

    Required. The source ServingConfig resource name . Format: projects/ project_number/locations/location_id/catalogs/catalog_id/servingConfigs/ serving_config_id

  • google_cloud_retail_v2beta_remove_control_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRemoveControlRequest) (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



1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 1805

def remove_project_location_catalog_serving_config_control(serving_config, google_cloud_retail_v2beta_remove_control_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+servingConfig}:removeControl', options)
  command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRemoveControlRequest::Representation
  command.request_object = google_cloud_retail_v2beta_remove_control_request_object
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig
  command.params['servingConfig'] = serving_config unless serving_config.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#replace_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2beta_replace_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig

Replaces the specified CatalogAttribute in the AttributesConfig by updating the catalog attribute with the same CatalogAttribute.key. If the CatalogAttribute to replace does not exist, a NOT_FOUND error is returned.

Parameters:

  • attributes_config (String) —

    Required. Full AttributesConfig resource name. Format: projects/ project_number/locations/location_id/catalogs/catalog_id/attributesConfig

  • google_cloud_retail_v2beta_replace_catalog_attribute_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaReplaceCatalogAttributeRequest) (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



569
570
571
572
573
574
575
576
577
578
579
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 569

def replace_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2beta_replace_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+attributesConfig}:replaceCatalogAttribute', options)
  command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaReplaceCatalogAttributeRequest::Representation
  command.request_object = google_cloud_retail_v2beta_replace_catalog_attribute_request_object
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig
  command.params['attributesConfig'] = attributes_config unless attributes_config.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_project_location_catalog_placements(placement, google_cloud_retail_v2beta_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponse

Performs a search. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.

Parameters:

  • placement (String) —

    Required. The resource name of the Retail Search serving config, such as projects/*/locations/global/catalogs/default_catalog/servingConfigs/ default_serving_config or the name of the legacy placement resource, such as projects/*/locations/global/catalogs/default_catalog/placements/default_search . This field is used to identify the serving configuration name and the set of models that will be used to make the search.

  • google_cloud_retail_v2beta_search_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequest) (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



1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 1502

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

#search_project_location_catalog_serving_configs(placement, google_cloud_retail_v2beta_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponse

Performs a search. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.

Parameters:

  • placement (String) —

    Required. The resource name of the Retail Search serving config, such as projects/*/locations/global/catalogs/default_catalog/servingConfigs/ default_serving_config or the name of the legacy placement resource, such as projects/*/locations/global/catalogs/default_catalog/placements/default_search . This field is used to identify the serving configuration name and the set of models that will be used to make the search.

  • google_cloud_retail_v2beta_search_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequest) (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



1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 1845

def search_project_location_catalog_serving_configs(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

#set_project_location_catalog_branch_product_inventory(name, google_cloud_retail_v2beta_set_inventory_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation

Updates inventory information for a Product while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. When inventory is updated with ProductService. CreateProduct and ProductService.UpdateProduct, the specified inventory field value(s) will overwrite any existing value(s) while ignoring the last update time for this field. Furthermore, the last update time for the specified inventory fields will be overwritten to the time of the ProductService. CreateProduct or ProductService.UpdateProduct request. If no inventory fields are set in CreateProductRequest.product, then any pre-existing inventory information for this product will be used. If no inventory fields are set in SetInventoryRequest.set_mask, then any existing inventory information will be preserved. Pre-existing inventory information can only be updated with ProductService.SetInventory, ProductService.AddFulfillmentPlaces, and ProductService.RemoveFulfillmentPlaces. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.

Parameters:

  • name (String) —

    Immutable. Full resource name of the product, such as projects/*/locations/ global/catalogs/default_catalog/branches/default_branch/products/product_id.

  • google_cloud_retail_v2beta_set_inventory_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSetInventoryRequest) (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



1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 1113

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

#set_project_location_catalog_default_branch(catalog, google_cloud_retail_v2beta_set_default_branch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleProtobufEmpty

Set a specified branch id as default branch. API methods such as SearchService. Search, ProductService.GetProduct, ProductService.ListProducts will treat requests using "default_branch" to the actual branch id set as default. For example, if projects/*/locations/*/catalogs/*/branches/1 is set as default, setting SearchRequest.branch to projects/*/locations/*/catalogs/*/branches/ default_branch is equivalent to setting SearchRequest.branch to projects/*/ locations/*/catalogs/*/branches/1. Using multiple branches can be useful when developers would like to have a staging branch to test and verify for future usage. When it becomes ready, developers switch on the staging branch using this API while keeping using projects/*/locations/*/catalogs/*/branches/ default_branch as SearchRequest.branch to route the traffic to this staging branch. CAUTION: If you have live predict/search traffic, switching the default branch could potentially cause outages if the ID space of the new branch is very different from the old one. More specifically: * PredictionService will only return product IDs from branch newBranch. * SearchService will only return product IDs from branch newBranch (if branch is not explicitly set). * UserEventService will only join events with products from branch newBranch.

Parameters:

  • catalog (String) —

    Full resource name of the catalog, such as projects/*/locations/global/ catalogs/default_catalog.

  • google_cloud_retail_v2beta_set_default_branch_request_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSetDefaultBranchRequest) (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



343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 343

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

#update_project_location_catalog_attributes_config(name, google_cloud_retail_v2beta_attributes_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig

Updates the AttributesConfig. The catalog attributes in the request will be updated in the catalog, or inserted if they do not exist. Existing catalog attributes not included in the request will remain unchanged. Attributes that are assigned to products, but do not exist at the catalog level, are always included in the response. The product attribute is assigned default values for missing catalog attribute fields, e.g., searchable and dynamic facetable options.

Parameters:

  • name (String) —

    Required. Immutable. The fully qualified resource name of the attribute config. Format: projects/*/locations/*/catalogs/*/attributesConfig

  • google_cloud_retail_v2beta_attributes_config_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Indicates which fields in the provided AttributesConfig to update. The following is the only supported field: * AttributesConfig.catalog_attributes If not set, all supported fields are updated.

  • 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



387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 387

def update_project_location_catalog_attributes_config(name, google_cloud_retail_v2beta_attributes_config_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::GoogleCloudRetailV2betaAttributesConfig::Representation
  command.request_object = google_cloud_retail_v2beta_attributes_config_object
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig
  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

#update_project_location_catalog_completion_config(name, google_cloud_retail_v2beta_completion_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig

Updates the CompletionConfigs.

Parameters:

  • name (String) —

    Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/ completionConfig

  • google_cloud_retail_v2beta_completion_config_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated.

  • 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



427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 427

def update_project_location_catalog_completion_config(name, google_cloud_retail_v2beta_completion_config_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::GoogleCloudRetailV2betaCompletionConfig::Representation
  command.request_object = google_cloud_retail_v2beta_completion_config_object
  command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig::Representation
  command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig
  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

#write_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_user_event_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaUserEvent

Writes a single user event.

Parameters:

  • parent (String) —

    Required. The parent catalog resource name, such as projects/1234/locations/ global/catalogs/default_catalog.

  • google_cloud_retail_v2beta_user_event_object (Google::Apis::RetailV2beta::GoogleCloudRetailV2betaUserEvent) (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



2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
 
# File 'lib/google/apis/retail_v2beta/service.rb', line 2042

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