Class: Google::Apis::RetailV2alpha::CloudRetailService

Inherits:

Core::BaseService

Object
Core::BaseService
Google::Apis::RetailV2alpha::CloudRetailService

show all

Defined in:: lib/google/apis/retail_v2alpha/service.rb

Overview

Vertex AI Search for commerce API

Vertex AI Search for commerce API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications.

Examples:

require 'google/apis/retail_v2alpha'

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

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE =

"https://retail.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

#key ⇒ String
API key.
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.

Instance Method Summary collapse

#accept_project_retail_project_terms(project, google_cloud_retail_v2alpha_accept_terms_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProject
Accepts service terms for this project.
#add_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2alpha_add_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig
Adds the specified CatalogAttribute to the AttributesConfig.
#add_project_location_catalog_branch_product_fulfillment_places(product, google_cloud_retail_v2alpha_add_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation
We recommend that you use the ProductService.AddLocalInventories method instead of the ProductService.AddFulfillmentPlaces method.
#add_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2alpha_add_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation
Updates local inventory information for a Product at a list of places, while respecting the last update timestamps of each inventory field.
#add_project_location_catalog_serving_config_control(serving_config, google_cloud_retail_v2alpha_add_control_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig
Enables a Control on the specified ServingConfig.
#batch_project_location_catalog_attributes_config_remove_catalog_attributes(attributes_config, google_cloud_retail_v2alpha_batch_remove_catalog_attributes_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesResponse
Removes all specified CatalogAttributes from the AttributesConfig.
#batch_project_location_catalog_generative_question_update(parent, google_cloud_retail_v2alpha_batch_update_generative_question_configs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsResponse
Allows management of multiple questions.
#collect_project_location_catalog_user_event(parent, google_cloud_retail_v2alpha_collect_user_event_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleApiHttpBody
Writes a single user event from the browser.
#complete_project_location_catalog_query(catalog, dataset: nil, device_type: nil, enable_attribute_suggestions: nil, entity: nil, language_codes: nil, max_suggestions: nil, query: nil, visitor_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompleteQueryResponse
Completes the specified prefix with keyword suggestions.
#conversational_project_location_catalog_placement_search(placement, google_cloud_retail_v2alpha_conversational_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse
Performs a conversational search.
#conversational_project_location_catalog_serving_config_search(placement, google_cloud_retail_v2alpha_conversational_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse
Performs a conversational search.
#create_project_location_catalog_branch_product(parent, google_cloud_retail_v2alpha_product_object = nil, product_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct
Creates a Product.
#create_project_location_catalog_control(parent, google_cloud_retail_v2alpha_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl
Creates a Control.
#create_project_location_catalog_merchant_center_account_link(parent, google_cloud_retail_v2alpha_merchant_center_account_link_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation
Creates a MerchantCenterAccountLink.
#create_project_location_catalog_model(parent, google_cloud_retail_v2alpha_model_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation
Creates a new model.
#create_project_location_catalog_serving_config(parent, google_cloud_retail_v2alpha_serving_config_object = nil, serving_config_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig
Creates a ServingConfig.
#delete_project_location_catalog_branch_product(name, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleProtobufEmpty
Deletes a Product.
#delete_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleProtobufEmpty
Deletes a Control.
#delete_project_location_catalog_merchant_center_account_link(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleProtobufEmpty
Deletes a MerchantCenterAccountLink.
#delete_project_location_catalog_model(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleProtobufEmpty
Deletes an existing model.
#delete_project_location_catalog_serving_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleProtobufEmpty
Deletes a ServingConfig.
#enroll_project_solution(project, google_cloud_retail_v2alpha_enroll_solution_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation
The method enrolls a solution of type Retail Search into a project.
#export_project_location_catalog_analytics_metrics(catalog, google_cloud_retail_v2alpha_export_analytics_metrics_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation
Exports analytics metrics.
#export_project_location_catalog_branch_product(parent, google_cloud_retail_v2alpha_export_products_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation
Exports multiple Products.
#export_project_location_catalog_user_event(parent, google_cloud_retail_v2alpha_export_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation
Exports user events.
#get_project_alert_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAlertConfig
Get the AlertConfig of the requested project.
#get_project_location_catalog_attributes_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig
Gets an AttributesConfig.
#get_project_location_catalog_branch(name, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBranch
Retrieves a Branch.
#get_project_location_catalog_branch_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation
Gets the latest state of a long-running operation.
#get_project_location_catalog_branch_place_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation
Gets the latest state of a long-running operation.
#get_project_location_catalog_branch_product(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct
Gets a Product.
#get_project_location_catalog_completion_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig
Gets a CompletionConfig.
#get_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl
Gets a Control.
#get_project_location_catalog_conversational_search_customization_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig
Returns the conversational search customization config for a given catalog.
#get_project_location_catalog_default_branch(catalog, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGetDefaultBranchResponse
Get which branch is currently default branch set by CatalogService.
#get_project_location_catalog_generative_question_feature(catalog, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig
Manages overal generative question feature state -- enables toggling feature on and off.
#get_project_location_catalog_model(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel
Gets a model.
#get_project_location_catalog_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation
Gets the latest state of a long-running operation.
#get_project_location_catalog_serving_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig
Gets a ServingConfig.
#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation
Gets the latest state of a long-running operation.
#get_project_logging_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLoggingConfig
Gets the LoggingConfig of the requested project.
#get_project_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation
Gets the latest state of a long-running operation.
#get_project_retail_project(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProject
Gets the project.
#import_project_location_catalog_branch_product(parent, google_cloud_retail_v2alpha_import_products_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation
Bulk import of multiple Products.
#import_project_location_catalog_completion_datum(parent, google_cloud_retail_v2alpha_import_completion_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation
Bulk import of processed completion dataset.
#import_project_location_catalog_user_event(parent, google_cloud_retail_v2alpha_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation
Bulk import of User events.
#initialize ⇒ CloudRetailService constructor
A new instance of CloudRetailService.
#list_project_enrolled_solutions(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListEnrolledSolutionsResponse
Lists all the retail API solutions the project has enrolled.
#list_project_location_catalog_branch_products(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, require_total_size: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListProductsResponse
Gets a list of Products.
#list_project_location_catalog_branches(parent, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListBranchesResponse
Lists all instances of Branch under the specified parent Catalog.
#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::RetailV2alpha::GoogleCloudRetailV2alphaListControlsResponse
Lists all Controls by their parent Catalog.
#list_project_location_catalog_generative_questions(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListGenerativeQuestionConfigsResponse
Returns all questions for a given catalog.
#list_project_location_catalog_merchant_center_account_links(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListMerchantCenterAccountLinksResponse
Lists all MerchantCenterAccountLinks under the specified parent Catalog.
#list_project_location_catalog_models(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListModelsResponse
Lists all the models linked to this event store.
#list_project_location_catalog_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningListOperationsResponse
Lists operations that match the specified filter in the request.
#list_project_location_catalog_serving_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListServingConfigsResponse
Lists all ServingConfigs linked to this catalog.
#list_project_location_catalogs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListCatalogsResponse
Lists all the Catalogs associated with the project.
#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningListOperationsResponse
Lists operations that match the specified filter in the request.
#list_project_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningListOperationsResponse
Lists operations that match the specified filter in the request.
#patch_project_location_catalog(name, google_cloud_retail_v2alpha_catalog_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalog
Updates the Catalogs.
#patch_project_location_catalog_branch_product(name, google_cloud_retail_v2alpha_product_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct
Updates a Product.
#patch_project_location_catalog_control(name, google_cloud_retail_v2alpha_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl
Updates a Control.
#patch_project_location_catalog_model(name, google_cloud_retail_v2alpha_model_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel
Update of model metadata.
#patch_project_location_catalog_serving_config(name, google_cloud_retail_v2alpha_serving_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig
Updates a ServingConfig.
#pause_project_location_catalog_model(name, google_cloud_retail_v2alpha_pause_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel
Pauses the training of an existing model.
#predict_project_location_catalog_placement(placement, google_cloud_retail_v2alpha_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse
Makes a recommendation prediction.
#predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2alpha_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse
Makes a recommendation prediction.
#purge_project_location_catalog_branch_product(parent, google_cloud_retail_v2alpha_purge_products_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation
Permanently deletes all selected Products under a branch.
#purge_project_location_catalog_user_event(parent, google_cloud_retail_v2alpha_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation
Deletes permanently all user events specified by the filter provided.
#rejoin_project_location_catalog_user_event(parent, google_cloud_retail_v2alpha_rejoin_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation
Starts a user-event rejoin operation with latest product catalog.
#remove_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2alpha_remove_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig
Removes the specified CatalogAttribute from the AttributesConfig.
#remove_project_location_catalog_branch_product_fulfillment_places(product, google_cloud_retail_v2alpha_remove_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation
We recommend that you use the ProductService.RemoveLocalInventories method instead of the ProductService.RemoveFulfillmentPlaces method.
#remove_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2alpha_remove_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation
Remove local inventory information for a Product at a list of places at a removal timestamp.
#remove_project_location_catalog_serving_config_control(serving_config, google_cloud_retail_v2alpha_remove_control_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig
Disables a Control on the specified ServingConfig.
#replace_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2alpha_replace_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig
Replaces the specified CatalogAttribute in the AttributesConfig by updating the catalog attribute with the same CatalogAttribute.key.
#resume_project_location_catalog_model(name, google_cloud_retail_v2alpha_resume_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel
Resumes the training of an existing model.
#search_project_location_catalog_placements(placement, google_cloud_retail_v2alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse
Performs a search.
#search_project_location_catalog_serving_configs(placement, google_cloud_retail_v2alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse
Performs a search.
#set_project_location_catalog_branch_product_inventory(name, google_cloud_retail_v2alpha_set_inventory_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation
Updates inventory information for a Product while respecting the last update timestamps of each inventory field.
#set_project_location_catalog_default_branch(catalog, google_cloud_retail_v2alpha_set_default_branch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleProtobufEmpty
Set a specified branch id as default branch.
#tune_project_location_catalog_model(name, google_cloud_retail_v2alpha_tune_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation
Tunes an existing model.
#update_project_alert_config(name, google_cloud_retail_v2alpha_alert_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAlertConfig
Update the alert config of the requested project.
#update_project_location_catalog_attributes_config(name, google_cloud_retail_v2alpha_attributes_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig
Updates the AttributesConfig.
#update_project_location_catalog_completion_config(name, google_cloud_retail_v2alpha_completion_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig
Updates the CompletionConfigs.
#update_project_location_catalog_conversational_search_customization_config(catalog, google_cloud_retail_v2alpha_conversational_search_customization_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig
Updates the conversational search customization config for a given catalog.
#update_project_location_catalog_generative_question(catalog, google_cloud_retail_v2alpha_generative_question_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGenerativeQuestionConfig
Allows management of individual questions.
#update_project_location_catalog_generative_question_feature(catalog, google_cloud_retail_v2alpha_generative_questions_feature_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig
Manages overal generative question feature state -- enables toggling feature on and off.
#update_project_logging_config(name, google_cloud_retail_v2alpha_logging_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLoggingConfig
Updates the LoggingConfig of the requested project.
#write_project_location_catalog_user_event(parent, google_cloud_retail_v2alpha_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserEvent
Writes a single user event.

Constructor Details

#initialize ⇒ `CloudRetailService`

Returns a new instance of CloudRetailService.

# File 'lib/google/apis/retail_v2alpha/service.rb', line 50

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-retail_v2alpha',
        client_version: Google::Apis::RetailV2alpha::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.



43
44
45

# File 'lib/google/apis/retail_v2alpha/service.rb', line 43

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.



48
49
50

# File 'lib/google/apis/retail_v2alpha/service.rb', line 48

def quota_user
  @quota_user
end

Instance Method Details

#accept_project_retail_project_terms(project, google_cloud_retail_v2alpha_accept_terms_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProject`

Accepts service terms for this project. By making requests to this API, you agree to the terms of service linked below. https://cloud.google.com/retail/ data-use-terms

Parameters:

project (String) —
Required. Full resource name of the project. Format: projects/ project_number_or_id/retailProject
google_cloud_retail_v2alpha_accept_terms_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAcceptTermsRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProject) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProject)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 3462

def accept_project_retail_project_terms(project, google_cloud_retail_v2alpha_accept_terms_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+project}:acceptTerms', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAcceptTermsRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_accept_terms_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProject::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProject
  command.params['project'] = project unless project.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_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2alpha_add_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig`

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_v2alpha_add_catalog_attribute_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddCatalogAttributeRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 938

def add_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2alpha_add_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+attributesConfig}:addCatalogAttribute', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddCatalogAttributeRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_add_catalog_attribute_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig
  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_v2alpha_add_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleLongrunningOperation`

We recommend that you use the ProductService.AddLocalInventories method instead of the ProductService.AddFulfillmentPlaces method. ProductService. AddLocalInventories achieves the same results but provides more fine-grained control over ingesting local inventory data. 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.

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_v2alpha_add_fulfillment_places_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddFulfillmentPlacesRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleLongrunningOperation)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 1227

def add_project_location_catalog_branch_product_fulfillment_places(product, google_cloud_retail_v2alpha_add_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+product}:addFulfillmentPlaces', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddFulfillmentPlacesRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_add_fulfillment_places_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_v2alpha_add_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::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.

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_v2alpha_add_local_inventories_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddLocalInventoriesRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleLongrunningOperation)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 1275

def add_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2alpha_add_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+product}:addLocalInventories', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddLocalInventoriesRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_add_local_inventories_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_v2alpha_add_control_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig`

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_v2alpha_add_control_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddControlRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2697

def add_project_location_catalog_serving_config_control(serving_config, google_cloud_retail_v2alpha_add_control_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+servingConfig}:addControl', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddControlRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_add_control_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig
  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_v2alpha_batch_remove_catalog_attributes_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesResponse`

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_v2alpha_batch_remove_catalog_attributes_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesResponse)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 973

def batch_project_location_catalog_attributes_config_remove_catalog_attributes(attributes_config, google_cloud_retail_v2alpha_batch_remove_catalog_attributes_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+attributesConfig}:batchRemoveCatalogAttributes', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_batch_remove_catalog_attributes_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesResponse
  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

#batch_project_location_catalog_generative_question_update(parent, google_cloud_retail_v2alpha_batch_update_generative_question_configs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsResponse`

Allows management of multiple questions.

Parameters:

parent (String) —
Optional. Resource name of the parent catalog. Format: projects/project/ locations/location/catalogs/catalog
google_cloud_retail_v2alpha_batch_update_generative_question_configs_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsResponse)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2042

def batch_project_location_catalog_generative_question_update(parent, google_cloud_retail_v2alpha_batch_update_generative_question_configs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/generativeQuestion:batchUpdate', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_batch_update_generative_question_configs_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsResponse
  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

#collect_project_location_catalog_user_event(parent, google_cloud_retail_v2alpha_collect_user_event_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleApiHttpBody`

Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. 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.
google_cloud_retail_v2alpha_collect_user_event_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCollectUserEventRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleApiHttpBody) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleApiHttpBody)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 3076

def collect_project_location_catalog_user_event(parent, google_cloud_retail_v2alpha_collect_user_event_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/userEvents:collect', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCollectUserEventRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_collect_user_event_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleApiHttpBody::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleApiHttpBody
  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

#complete_project_location_catalog_query(catalog, dataset: nil, device_type: nil, enable_attribute_suggestions: nil, entity: nil, language_codes: nil, max_suggestions: nil, query: nil, visitor_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompleteQueryResponse`

Completes the specified prefix with keyword suggestions. This feature is only available for users who have Retail Search enabled. 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 dataset imported through CompletionService.ImportCompletionData. cloud- retail will use the dataset generated by Cloud Retail based on user events. If left empty, completions will be fetched from the user-data dataset. 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. We recommend that you leave this field empty. It can 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.
enable_attribute_suggestions (Boolean) (defaults to: nil) —
If true, attribute suggestions are enabled and provided in the response. This field is only available for the cloud-retail dataset.
entity (String) (defaults to: nil) —
The entity for customers who run multiple entities, domains, sites, or regions, for example, Google US, Google Ads, Waymo, google.com, youtube.com, etc. If this is set, it must be an exact match with UserEvent.entity to get per-entity autocomplete results. This field will be applied to completion_results only. It has no effect on the attribute_results. Also, this entity should be limited to 256 characters, if too long, it will be truncated to 256 characters in both generation and serving time, and may lead to mis-match. To ensure it works, please set the entity with string within 256 characters.
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) —
Recommended 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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompleteQueryResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompleteQueryResponse)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 369

def complete_project_location_catalog_query(catalog, dataset: nil, device_type: nil, enable_attribute_suggestions: nil, entity: 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, 'v2alpha/{+catalog}:completeQuery', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompleteQueryResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompleteQueryResponse
  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['enableAttributeSuggestions'] = enable_attribute_suggestions unless enable_attribute_suggestions.nil?
  command.query['entity'] = entity unless entity.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

#conversational_project_location_catalog_placement_search(placement, google_cloud_retail_v2alpha_conversational_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse`

Performs a conversational search. This feature is only available for users who have Conversational Search enabled.

Parameters:

placement (String) —
Required. The resource name of the search engine placement, such as projects/* /locations/global/catalogs/default_catalog/placements/default_search or projects/*/locations/global/catalogs/default_catalog/servingConfigs/ default_serving_config This field is used to identify the serving config name and the set of models that will be used to make the search.
google_cloud_retail_v2alpha_conversational_search_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2575

def conversational_project_location_catalog_placement_search(placement, google_cloud_retail_v2alpha_conversational_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+placement}:conversationalSearch', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_conversational_search_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse
  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

#conversational_project_location_catalog_serving_config_search(placement, google_cloud_retail_v2alpha_conversational_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse`

Performs a conversational search. This feature is only available for users who have Conversational Search enabled.

Parameters:

placement (String) —
Required. The resource name of the search engine placement, such as projects/* /locations/global/catalogs/default_catalog/placements/default_search or projects/*/locations/global/catalogs/default_catalog/servingConfigs/ default_serving_config This field is used to identify the serving config name and the set of models that will be used to make the search.
google_cloud_retail_v2alpha_conversational_search_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2735

def conversational_project_location_catalog_serving_config_search(placement, google_cloud_retail_v2alpha_conversational_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+placement}:conversationalSearch', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_conversational_search_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse
  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

#create_project_location_catalog_branch_product(parent, google_cloud_retail_v2alpha_product_object = nil, product_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct`

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_v2alpha_product_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct) (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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 1317

def create_project_location_catalog_branch_product(parent, google_cloud_retail_v2alpha_product_object = nil, product_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/products', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct::Representation
  command.request_object = google_cloud_retail_v2alpha_product_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct
  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_v2alpha_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl`

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_v2alpha_control_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl) (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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 1856

def create_project_location_catalog_control(parent, google_cloud_retail_v2alpha_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/controls', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl::Representation
  command.request_object = google_cloud_retail_v2alpha_control_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl
  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_merchant_center_account_link(parent, google_cloud_retail_v2alpha_merchant_center_account_link_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleLongrunningOperation`

Creates a MerchantCenterAccountLink.

Parameters:

parent (String) —
Required. The branch resource where this MerchantCenterAccountLink will be created. Format: projects/PROJECT_NUMBER/locations/global/catalogs/ CATALOG_ID``
google_cloud_retail_v2alpha_merchant_center_account_link_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaMerchantCenterAccountLink) (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:

result (Google::Apis::RetailV2alpha::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleLongrunningOperation)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2108

def create_project_location_catalog_merchant_center_account_link(parent, google_cloud_retail_v2alpha_merchant_center_account_link_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/merchantCenterAccountLinks', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaMerchantCenterAccountLink::Representation
  command.request_object = google_cloud_retail_v2alpha_merchant_center_account_link_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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

#create_project_location_catalog_model(parent, google_cloud_retail_v2alpha_model_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleLongrunningOperation`

Creates a new model.

Parameters:

parent (String) —
Required. The parent resource under which to create the model. Format: projects/project_number/locations/location_id/catalogs/catalog_id``
google_cloud_retail_v2alpha_model_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel) (defaults to: nil)
dry_run (Boolean) (defaults to: nil) —
Optional. Whether to run a dry run to validate the request (without actually creating the model).
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:

result (Google::Apis::RetailV2alpha::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleLongrunningOperation)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2209

def create_project_location_catalog_model(parent, google_cloud_retail_v2alpha_model_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/models', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel::Representation
  command.request_object = google_cloud_retail_v2alpha_model_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['dryRun'] = dry_run unless dry_run.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_v2alpha_serving_config_object = nil, serving_config_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig`

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_v2alpha_serving_config_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig) (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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2774

def create_project_location_catalog_serving_config(parent, google_cloud_retail_v2alpha_serving_config_object = nil, serving_config_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/servingConfigs', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig::Representation
  command.request_object = google_cloud_retail_v2alpha_serving_config_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig
  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, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::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.
force (Boolean) (defaults to: nil) —
This value only applies to the case when the target product is of type PRIMARY. When deleting a product of VARIANT/COLLECTION type, this value will be ignored. When set to true, the subsequent variant products will be deleted. When set to false, if the primary product has active variant products, an error will be 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:

result (Google::Apis::RetailV2alpha::GoogleProtobufEmpty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleProtobufEmpty)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 1364

def delete_project_location_catalog_branch_product(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['force'] = force unless force.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::RetailV2alpha::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:

result (Google::Apis::RetailV2alpha::GoogleProtobufEmpty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleProtobufEmpty)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 1892

def delete_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_merchant_center_account_link(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleProtobufEmpty`

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

Parameters:

name (String) —
Required. Full resource name. Format: projects/project_number/locations/ location_id/catalogs/catalog_id/merchantCenterAccountLinks/ merchant_center_account_link_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:

result (Google::Apis::RetailV2alpha::GoogleProtobufEmpty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleProtobufEmpty)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2143

def delete_project_location_catalog_merchant_center_account_link(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_model(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleProtobufEmpty`

Deletes an existing model.

Parameters:

name (String) —
Required. The resource name of the Model to delete. Format: projects/ project_number/locations/location_id/catalogs/catalog_id/models/model_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:

result (Google::Apis::RetailV2alpha::GoogleProtobufEmpty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleProtobufEmpty)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2244

def delete_project_location_catalog_model(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::RetailV2alpha::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::RetailV2alpha::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:

result (Google::Apis::RetailV2alpha::GoogleProtobufEmpty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleProtobufEmpty)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2810

def delete_project_location_catalog_serving_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::RetailV2alpha::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

#enroll_project_solution(project, google_cloud_retail_v2alpha_enroll_solution_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleLongrunningOperation`

The method enrolls a solution of type Retail Search into a project. The Recommendations AI solution type is enrolled by default when your project enables Retail API, so you don't need to call the enrollSolution method for recommendations.

Parameters:

project (String) —
Required. Full resource name of parent. Format: projects/ project_number_or_id``
google_cloud_retail_v2alpha_enroll_solution_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaEnrollSolutionRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleLongrunningOperation)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 82

def enroll_project_solution(project, google_cloud_retail_v2alpha_enroll_solution_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+project}:enrollSolution', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaEnrollSolutionRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_enroll_solution_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
  command.params['project'] = project unless project.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#export_project_location_catalog_analytics_metrics(catalog, google_cloud_retail_v2alpha_export_analytics_metrics_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleLongrunningOperation`

Exports analytics metrics. Operation.response is of type ExportAnalyticsMetricsResponse. Operation.metadata is of type ExportMetadata.

Parameters:

catalog (String) —
Required. Full resource name of the parent catalog. Expected format: projects/ */locations/*/catalogs/*
google_cloud_retail_v2alpha_export_analytics_metrics_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExportAnalyticsMetricsRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleLongrunningOperation)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 411

def export_project_location_catalog_analytics_metrics(catalog, google_cloud_retail_v2alpha_export_analytics_metrics_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+catalog}:exportAnalyticsMetrics', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExportAnalyticsMetricsRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_export_analytics_metrics_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
  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

#export_project_location_catalog_branch_product(parent, google_cloud_retail_v2alpha_export_products_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleLongrunningOperation`

Exports multiple Products.

Parameters:

parent (String) —
Required. Resource name of a Branch, and default_branch for branch_id component is supported. For example projects/1234/locations/global/catalogs/ default_catalog/branches/default_branch
google_cloud_retail_v2alpha_export_products_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExportProductsRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleLongrunningOperation)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 1398

def export_project_location_catalog_branch_product(parent, google_cloud_retail_v2alpha_export_products_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/products:export', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExportProductsRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_export_products_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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

#export_project_location_catalog_user_event(parent, google_cloud_retail_v2alpha_export_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleLongrunningOperation`

Exports user events. Operation.response is of type ExportResponse. Operation.metadata is of type ExportMetadata.

Parameters:

parent (String) —
Required. Resource name of a Catalog. For example projects/1234/locations/ global/catalogs/default_catalog
google_cloud_retail_v2alpha_export_user_events_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExportUserEventsRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleLongrunningOperation)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 3111

def export_project_location_catalog_user_event(parent, google_cloud_retail_v2alpha_export_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/userEvents:export', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExportUserEventsRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_export_user_events_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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

#get_project_alert_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAlertConfig`

Get the AlertConfig of the requested project.

Parameters:

name (String) —
Required. Full AlertConfig resource name. Format: projects/project_number/ alertConfig
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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAlertConfig) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAlertConfig)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 115

def get_project_alert_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAlertConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAlertConfig
  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::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig`

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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 444

def get_project_location_catalog_attributes_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig
  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(name, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBranch`

Retrieves a Branch.

Parameters:

name (String) —
Required. The name of the branch to retrieve. Format: projects/*/locations/ global/catalogs/default_catalog/branches/some_branch_id. "default_branch" can be used as a special branch_id, it returns the default branch that has been set for the catalog.
view (String) (defaults to: nil) —
The view to apply to the returned Branch. Defaults to [Branch.BranchView.BASIC] if unspecified. See documentation of fields of Branch to find what fields are excluded from BASIC view.
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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBranch) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBranch)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 1083

def get_project_location_catalog_branch(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBranch::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBranch
  command.params['name'] = name unless name.nil?
  command.query['view'] = view unless view.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::RetailV2alpha::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:

result (Google::Apis::RetailV2alpha::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleLongrunningOperation)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 1150

def get_project_location_catalog_branch_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_place_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::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:

result (Google::Apis::RetailV2alpha::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleLongrunningOperation)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 1181

def get_project_location_catalog_branch_place_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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::RetailV2alpha::GoogleCloudRetailV2alphaProduct`

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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 1434

def get_project_location_catalog_branch_product(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct
  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::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig`

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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 475

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

Gets a Control.

Parameters:

name (String) —
Required. The resource name of the Control to get. 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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 1924

def get_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl
  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_conversational_search_customization_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig`

Returns the conversational search customization config for a given catalog.

Parameters:

name (String) —
Required. Resource name of the parent catalog. Format: projects/project/ locations/location/catalogs/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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 506

def get_project_location_catalog_conversational_search_customization_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}/conversationalSearchCustomizationConfig', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig
  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::RetailV2alpha::GoogleCloudRetailV2alphaGetDefaultBranchResponse`

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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGetDefaultBranchResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGetDefaultBranchResponse)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 538

def get_project_location_catalog_default_branch(catalog, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+catalog}:getDefaultBranch', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGetDefaultBranchResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGetDefaultBranchResponse
  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_generative_question_feature(catalog, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig`

Manages overal generative question feature state -- enables toggling feature on and off.

Parameters:

catalog (String) —
Required. Resource name of the parent catalog. Format: projects/project/ locations/location/catalogs/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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 570

def get_project_location_catalog_generative_question_feature(catalog, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+catalog}/generativeQuestionFeature', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig
  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_model(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel`

Gets a model.

Parameters:

name (String) —
Required. The resource name of the Model to get. Format: projects/ project_number/locations/location_id/catalogs/catalog/models/model_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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2275

def get_project_location_catalog_model(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel
  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_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::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:

result (Google::Apis::RetailV2alpha::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleLongrunningOperation)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2490

def get_project_location_catalog_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig`

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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2843

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

result (Google::Apis::RetailV2alpha::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleLongrunningOperation)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 3299

def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_logging_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLoggingConfig`

Gets the LoggingConfig of the requested project.

Parameters:

name (String) —
Required. Full LoggingConfig resource name. Format: projects/project_number/ loggingConfig
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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLoggingConfig) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLoggingConfig)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 146

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

result (Google::Apis::RetailV2alpha::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleLongrunningOperation)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 3379

def get_project_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_retail_project(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProject`

Gets the project. Throws NOT_FOUND if the project wasn't initialized for the Retail API service.

Parameters:

name (String) —
Required. Full resource name of the project. Format: projects/ project_number_or_id/retailProject
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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProject) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProject)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 178

def get_project_retail_project(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProject::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProject
  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_v2alpha_import_products_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::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_v2alpha_import_products_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaImportProductsRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleLongrunningOperation)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 1469

def import_project_location_catalog_branch_product(parent, google_cloud_retail_v2alpha_import_products_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/products:import', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaImportProductsRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_import_products_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_v2alpha_import_completion_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::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. 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_v2alpha_import_completion_data_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaImportCompletionDataRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleLongrunningOperation)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 1817

def import_project_location_catalog_completion_datum(parent, google_cloud_retail_v2alpha_import_completion_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/completionData:import', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaImportCompletionDataRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_import_completion_data_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_v2alpha_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::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_v2alpha_import_user_events_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaImportUserEventsRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleLongrunningOperation)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 3148

def import_project_location_catalog_user_event(parent, google_cloud_retail_v2alpha_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/userEvents:import', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaImportUserEventsRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_import_user_events_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_enrolled_solutions(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListEnrolledSolutionsResponse`

Lists all the retail API solutions the project has enrolled.

Parameters:

parent (String) —
Required. Full resource name of parent. Format: projects/ project_number_or_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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListEnrolledSolutionsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListEnrolledSolutionsResponse)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 209

def list_project_enrolled_solutions(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+parent}:enrolledSolutions', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListEnrolledSolutionsResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListEnrolledSolutionsResponse
  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, require_total_size: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListProductsResponse`

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.
require_total_size (Boolean) (defaults to: nil) —
If true and page_token is empty, ListProductsResponse.total_size is set to the total count of matched items irrespective of pagination. Notice that setting this field to true affects the performance.
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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListProductsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListProductsResponse)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 1537

def list_project_location_catalog_branch_products(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, require_total_size: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+parent}/products', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListProductsResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListProductsResponse
  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['requireTotalSize'] = require_total_size unless require_total_size.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_branches(parent, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListBranchesResponse`

Lists all instances of Branch under the specified parent Catalog.

Parameters:

parent (String) —
Required. The parent catalog resource name.
view (String) (defaults to: nil) —
The view to apply to the returned Branch. Defaults to [Branch.BranchView.BASIC] if unspecified. See documentation of fields of Branch to find what fields are excluded from BASIC view.
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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListBranchesResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListBranchesResponse)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 1118

def list_project_location_catalog_branches(parent, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+parent}/branches', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListBranchesResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListBranchesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['view'] = view unless view.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::RetailV2alpha::GoogleCloudRetailV2alphaListControlsResponse`

Lists all Controls by their parent 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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListControlsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListControlsResponse)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 1966

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, 'v2alpha/{+parent}/controls', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListControlsResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListControlsResponse
  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_generative_questions(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListGenerativeQuestionConfigsResponse`

Returns all questions for a given catalog.

Parameters:

parent (String) —
Required. Resource name of the parent catalog. Format: projects/project/ locations/location/catalogs/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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListGenerativeQuestionConfigsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListGenerativeQuestionConfigsResponse)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2075

def list_project_location_catalog_generative_questions(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+parent}/generativeQuestions', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListGenerativeQuestionConfigsResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListGenerativeQuestionConfigsResponse
  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_merchant_center_account_links(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListMerchantCenterAccountLinksResponse`

Lists all MerchantCenterAccountLinks under the specified parent Catalog.

Parameters:

parent (String) —
Required. The parent Catalog of the resource. It must match this format: projects/PROJECT_NUMBER/locations/global/catalogs/CATALOG_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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListMerchantCenterAccountLinksResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListMerchantCenterAccountLinksResponse)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2174

def list_project_location_catalog_merchant_center_account_links(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+parent}/merchantCenterAccountLinks', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListMerchantCenterAccountLinksResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListMerchantCenterAccountLinksResponse
  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_models(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListModelsResponse`

Lists all the models linked to this event store.

Parameters:

parent (String) —
Required. The parent for which to list models. 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 50. Max allowed value is 1000.
page_token (String) (defaults to: nil) —
Optional. A page token, received from a previous ListModels 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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListModelsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListModelsResponse)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2312

def list_project_location_catalog_models(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+parent}/models', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListModelsResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListModelsResponse
  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_catalog_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleLongrunningListOperationsResponse`

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

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.
return_partial_success (Boolean) (defaults to: nil) —
When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse. unreachable field. This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-". This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.
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:

result (Google::Apis::RetailV2alpha::GoogleLongrunningListOperationsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleLongrunningListOperationsResponse)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2535

def list_project_location_catalog_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}/operations', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::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['returnPartialSuccess'] = return_partial_success unless return_partial_success.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::RetailV2alpha::GoogleCloudRetailV2alphaListServingConfigsResponse`

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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListServingConfigsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListServingConfigsResponse)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2880

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, 'v2alpha/{+parent}/servingConfigs', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListServingConfigsResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListServingConfigsResponse
  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::RetailV2alpha::GoogleCloudRetailV2alphaListCatalogsResponse`

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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListCatalogsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListCatalogsResponse)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 612

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, 'v2alpha/{+parent}/catalogs', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListCatalogsResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListCatalogsResponse
  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, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleLongrunningListOperationsResponse`

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

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.
return_partial_success (Boolean) (defaults to: nil) —
When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse. unreachable field. This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-". This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.
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:

result (Google::Apis::RetailV2alpha::GoogleLongrunningListOperationsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleLongrunningListOperationsResponse)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 3344

def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}/operations', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::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['returnPartialSuccess'] = return_partial_success unless return_partial_success.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, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleLongrunningListOperationsResponse`

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

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.
return_partial_success (Boolean) (defaults to: nil) —
When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse. unreachable field. This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-". This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.
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:

result (Google::Apis::RetailV2alpha::GoogleLongrunningListOperationsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleLongrunningListOperationsResponse)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 3424

def list_project_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}/operations', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::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['returnPartialSuccess'] = return_partial_success unless return_partial_success.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_v2alpha_catalog_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalog`

Updates the Catalogs.

Parameters:

name (String) —
Required. Immutable. The fully qualified resource name of the catalog.
google_cloud_retail_v2alpha_catalog_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalog) (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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalog) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalog)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 648

def patch_project_location_catalog(name, google_cloud_retail_v2alpha_catalog_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2alpha/{+name}', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalog::Representation
  command.request_object = google_cloud_retail_v2alpha_catalog_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalog::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalog
  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_v2alpha_product_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct`

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_v2alpha_product_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct) (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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 1585

def patch_project_location_catalog_branch_product(name, google_cloud_retail_v2alpha_product_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2alpha/{+name}', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct::Representation
  command.request_object = google_cloud_retail_v2alpha_product_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct
  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_v2alpha_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl`

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

Parameters:

name (String) —
Immutable. Fully qualified name projects/*/locations/global/catalogs/*/ controls/*
google_cloud_retail_v2alpha_control_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl) (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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2007

def patch_project_location_catalog_control(name, google_cloud_retail_v2alpha_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2alpha/{+name}', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl::Representation
  command.request_object = google_cloud_retail_v2alpha_control_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl
  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_model(name, google_cloud_retail_v2alpha_model_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel`

Update of model metadata. Only fields that currently can be updated are: filtering_option and periodic_tuning_state. If other values are provided, this API method ignores them.

Parameters:

name (String) —
Required. The fully qualified resource name of the model. Format: projects/ project_number/locations/location_id/catalogs/catalog_id/models/model_id catalog_id has char limit of 50. recommendation_model_id has char limit of 40.
google_cloud_retail_v2alpha_model_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel) (defaults to: nil)
update_mask (String) (defaults to: nil) —
Optional. Indicates which fields in the provided 'model' to update. If not set, by default updates all fields.
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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2353

def patch_project_location_catalog_model(name, google_cloud_retail_v2alpha_model_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2alpha/{+name}', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel::Representation
  command.request_object = google_cloud_retail_v2alpha_model_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel
  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_v2alpha_serving_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig`

Updates a ServingConfig.

Parameters:

name (String) —
Immutable. Fully qualified name projects/*/locations/global/catalogs/*/ servingConfig/*
google_cloud_retail_v2alpha_serving_config_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig) (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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2918

def patch_project_location_catalog_serving_config(name, google_cloud_retail_v2alpha_serving_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2alpha/{+name}', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig::Representation
  command.request_object = google_cloud_retail_v2alpha_serving_config_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig
  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

#pause_project_location_catalog_model(name, google_cloud_retail_v2alpha_pause_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel`

Pauses the training of an existing model.

Parameters:

name (String) —
Required. The name of the model to pause. Format: projects/project_number/ locations/location_id/catalogs/catalog_id/models/model_id``
google_cloud_retail_v2alpha_pause_model_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPauseModelRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2388

def pause_project_location_catalog_model(name, google_cloud_retail_v2alpha_pause_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+name}:pause', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPauseModelRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_pause_model_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel
  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

#predict_project_location_catalog_placement(placement, google_cloud_retail_v2alpha_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse`

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 Manage serving configs. 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_v2alpha_predict_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2617

def predict_project_location_catalog_placement(placement, google_cloud_retail_v2alpha_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+placement}:predict', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_predict_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse
  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_v2alpha_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse`

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 Manage serving configs. 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_v2alpha_predict_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2961

def predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2alpha_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+placement}:predict', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_predict_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse
  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_branch_product(parent, google_cloud_retail_v2alpha_purge_products_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleLongrunningOperation`

Permanently deletes all selected Products under a branch. This process is asynchronous. If the request is valid, the removal will be enqueued and processed offline. Depending on the number of Products, this operation could take hours to complete. Before the operation completes, some Products may still be returned by ProductService.GetProduct or ProductService.ListProducts. Depending on the number of Products, this operation could take hours to complete. To get a sample of Products that would be deleted, set PurgeProductsRequest.force to false.

Parameters:

parent (String) —
Required. The resource name of the branch under which the products are created. The format is projects/$projectId/locations/global/catalogs/$catalogId/ branches/$branchId``
google_cloud_retail_v2alpha_purge_products_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPurgeProductsRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleLongrunningOperation)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 1629

def purge_project_location_catalog_branch_product(parent, google_cloud_retail_v2alpha_purge_products_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/products:purge', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPurgeProductsRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_purge_products_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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

#purge_project_location_catalog_user_event(parent, google_cloud_retail_v2alpha_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::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_v2alpha_purge_user_events_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPurgeUserEventsRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleLongrunningOperation)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 3185

def purge_project_location_catalog_user_event(parent, google_cloud_retail_v2alpha_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/userEvents:purge', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPurgeUserEventsRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_purge_user_events_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_v2alpha_rejoin_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleLongrunningOperation`

Starts a user-event rejoin operation with latest product catalog. Events are not annotated with detailed product information for products that are missing from the catalog when the user event is ingested. These events are stored as unjoined events with limited usage on training and serving. You can use this method to start a join operation on specified events with the latest version of product catalog. You can also use this method 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_v2alpha_rejoin_user_events_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRejoinUserEventsRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleLongrunningOperation)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 3226

def rejoin_project_location_catalog_user_event(parent, google_cloud_retail_v2alpha_rejoin_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/userEvents:rejoin', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRejoinUserEventsRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_rejoin_user_events_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_v2alpha_remove_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig`

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_v2alpha_remove_catalog_attribute_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveCatalogAttributeRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 1008

def remove_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2alpha_remove_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+attributesConfig}:removeCatalogAttribute', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveCatalogAttributeRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_remove_catalog_attribute_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig
  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_v2alpha_remove_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleLongrunningOperation`

We recommend that you use the ProductService.RemoveLocalInventories method instead of the ProductService.RemoveFulfillmentPlaces method. ProductService. RemoveLocalInventories achieves the same results but provides more fine- grained control over ingesting local inventory data. 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.

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_v2alpha_remove_fulfillment_places_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveFulfillmentPlacesRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleLongrunningOperation)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 1678

def remove_project_location_catalog_branch_product_fulfillment_places(product, google_cloud_retail_v2alpha_remove_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+product}:removeFulfillmentPlaces', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveFulfillmentPlacesRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_remove_fulfillment_places_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_v2alpha_remove_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::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.

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_v2alpha_remove_local_inventories_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveLocalInventoriesRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleLongrunningOperation)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 1724

def remove_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2alpha_remove_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+product}:removeLocalInventories', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveLocalInventoriesRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_remove_local_inventories_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_v2alpha_remove_control_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig`

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_v2alpha_remove_control_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveControlRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2998

def remove_project_location_catalog_serving_config_control(serving_config, google_cloud_retail_v2alpha_remove_control_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+servingConfig}:removeControl', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveControlRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_remove_control_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig
  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_v2alpha_replace_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig`

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_v2alpha_replace_catalog_attribute_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaReplaceCatalogAttributeRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 1044

def replace_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2alpha_replace_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+attributesConfig}:replaceCatalogAttribute', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaReplaceCatalogAttributeRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_replace_catalog_attribute_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig
  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

#resume_project_location_catalog_model(name, google_cloud_retail_v2alpha_resume_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel`

Resumes the training of an existing model.

Parameters:

name (String) —
Required. The name of the model to resume. Format: projects/project_number/ locations/location_id/catalogs/catalog_id/models/model_id``
google_cloud_retail_v2alpha_resume_model_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaResumeModelRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2422

def resume_project_location_catalog_model(name, google_cloud_retail_v2alpha_resume_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+name}:resume', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaResumeModelRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_resume_model_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel
  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

#search_project_location_catalog_placements(placement, google_cloud_retail_v2alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse`

Performs a search. This feature is only available for users who have Retail Search enabled. 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 config name and the set of models that are used to make the search.
google_cloud_retail_v2alpha_search_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2657

def search_project_location_catalog_placements(placement, google_cloud_retail_v2alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+placement}:search', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_search_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse
  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_v2alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse`

Performs a search. This feature is only available for users who have Retail Search enabled. 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 config name and the set of models that are used to make the search.
google_cloud_retail_v2alpha_search_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 3038

def search_project_location_catalog_serving_configs(placement, google_cloud_retail_v2alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+placement}:search', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_search_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse
  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_v2alpha_set_inventory_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::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 is 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) overwrite any existing value(s) while ignoring the last update time for this field. Furthermore, the last update times for the specified inventory fields are overwritten by the times 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 is used. If no inventory fields are set in SetInventoryRequest. set_mask, then any existing inventory information is preserved. Pre-existing inventory information can only be updated with ProductService.SetInventory, ProductService.AddFulfillmentPlaces, and ProductService. RemoveFulfillmentPlaces. The returned Operations is obsolete after one day, and the GetOperation API returns NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates are not marked as done until they are obsolete.

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_v2alpha_set_inventory_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSetInventoryRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleLongrunningOperation)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 1778

def set_project_location_catalog_branch_product_inventory(name, google_cloud_retail_v2alpha_set_inventory_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+name}:setInventory', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSetInventoryRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_set_inventory_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_v2alpha_set_default_branch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::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_v2alpha_set_default_branch_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSetDefaultBranchRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleProtobufEmpty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleProtobufEmpty)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 700

def set_project_location_catalog_default_branch(catalog, google_cloud_retail_v2alpha_set_default_branch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+catalog}:setDefaultBranch', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSetDefaultBranchRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_set_default_branch_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::RetailV2alpha::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

#tune_project_location_catalog_model(name, google_cloud_retail_v2alpha_tune_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleLongrunningOperation`

Tunes an existing model.

Parameters:

name (String) —
Required. The resource name of the model to tune. Format: projects/ project_number/locations/location_id/catalogs/catalog_id/models/model_id
google_cloud_retail_v2alpha_tune_model_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaTuneModelRequest) (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:

result (Google::Apis::RetailV2alpha::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleLongrunningOperation)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 2457

def tune_project_location_catalog_model(name, google_cloud_retail_v2alpha_tune_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+name}:tune', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaTuneModelRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_tune_model_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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

#update_project_alert_config(name, google_cloud_retail_v2alpha_alert_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAlertConfig`

Update the alert config of the requested project.

Parameters:

name (String) —
Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/*/alertConfig
google_cloud_retail_v2alpha_alert_config_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAlertConfig) (defaults to: nil)
update_mask (String) (defaults to: nil) —
Indicates which fields in the provided AlertConfig to update. 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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAlertConfig) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAlertConfig)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 244

def update_project_alert_config(name, google_cloud_retail_v2alpha_alert_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2alpha/{+name}', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAlertConfig::Representation
  command.request_object = google_cloud_retail_v2alpha_alert_config_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAlertConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAlertConfig
  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_attributes_config(name, google_cloud_retail_v2alpha_attributes_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig`

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_v2alpha_attributes_config_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig) (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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 744

def update_project_location_catalog_attributes_config(name, google_cloud_retail_v2alpha_attributes_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2alpha/{+name}', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig::Representation
  command.request_object = google_cloud_retail_v2alpha_attributes_config_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig
  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_v2alpha_completion_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig`

Updates the CompletionConfigs.

Parameters:

name (String) —
Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/ completionConfig
google_cloud_retail_v2alpha_completion_config_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig) (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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 784

def update_project_location_catalog_completion_config(name, google_cloud_retail_v2alpha_completion_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2alpha/{+name}', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig::Representation
  command.request_object = google_cloud_retail_v2alpha_completion_config_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig
  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_conversational_search_customization_config(catalog, google_cloud_retail_v2alpha_conversational_search_customization_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig`

Updates the conversational search customization config for a given catalog.

Parameters:

catalog (String) —
Required. Resource name of the catalog. Format: projects/project/locations/location/catalogs/catalog
google_cloud_retail_v2alpha_conversational_search_customization_config_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig) (defaults to: nil)
update_mask (String) (defaults to: nil) —
Optional. Indicates which fields in the provided ConversationalSearchCustomizationConfig to update. 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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 823

def update_project_location_catalog_conversational_search_customization_config(catalog, google_cloud_retail_v2alpha_conversational_search_customization_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2alpha/{+catalog}/conversationalSearchCustomizationConfig', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig::Representation
  command.request_object = google_cloud_retail_v2alpha_conversational_search_customization_config_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig
  command.params['catalog'] = catalog unless catalog.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_generative_question(catalog, google_cloud_retail_v2alpha_generative_question_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGenerativeQuestionConfig`

Allows management of individual questions.

Parameters:

catalog (String) —
Required. Resource name of the catalog. Format: projects/project/locations/location/catalogs/catalog
google_cloud_retail_v2alpha_generative_question_config_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGenerativeQuestionConfig) (defaults to: nil)
update_mask (String) (defaults to: nil) —
Optional. Indicates which fields in the provided GenerativeQuestionConfig to update. The following are NOT supported: * GenerativeQuestionConfig.frequency 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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGenerativeQuestionConfig) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGenerativeQuestionConfig)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 862

def update_project_location_catalog_generative_question(catalog, google_cloud_retail_v2alpha_generative_question_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2alpha/{+catalog}/generativeQuestion', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGenerativeQuestionConfig::Representation
  command.request_object = google_cloud_retail_v2alpha_generative_question_config_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGenerativeQuestionConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGenerativeQuestionConfig
  command.params['catalog'] = catalog unless catalog.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_generative_question_feature(catalog, google_cloud_retail_v2alpha_generative_questions_feature_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig`

Manages overal generative question feature state -- enables toggling feature on and off.

Parameters:

catalog (String) —
Required. Resource name of the affected catalog. Format: projects/project/ locations/location/catalogs/catalog
google_cloud_retail_v2alpha_generative_questions_feature_config_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig) (defaults to: nil)
update_mask (String) (defaults to: nil) —
Optional. Indicates which fields in the provided GenerativeQuestionsFeatureConfig to update. 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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 902

def update_project_location_catalog_generative_question_feature(catalog, google_cloud_retail_v2alpha_generative_questions_feature_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2alpha/{+catalog}/generativeQuestionFeature', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig::Representation
  command.request_object = google_cloud_retail_v2alpha_generative_questions_feature_config_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig
  command.params['catalog'] = catalog unless catalog.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_logging_config(name, google_cloud_retail_v2alpha_logging_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLoggingConfig`

Updates the LoggingConfig of the requested project.

Parameters:

name (String) —
Required. Immutable. The name of the LoggingConfig singleton resource. Format: projects/*/loggingConfig
google_cloud_retail_v2alpha_logging_config_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLoggingConfig) (defaults to: nil)
update_mask (String) (defaults to: nil) —
Indicates which fields in the provided LoggingConfig to update. The following are the only supported fields: * LoggingConfig.default_log_generation_rule * LoggingConfig.service_log_generation_rules 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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLoggingConfig) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLoggingConfig)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 284

def update_project_logging_config(name, google_cloud_retail_v2alpha_logging_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2alpha/{+name}', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLoggingConfig::Representation
  command.request_object = google_cloud_retail_v2alpha_logging_config_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLoggingConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLoggingConfig
  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_v2alpha_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserEvent`

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_v2alpha_user_event_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserEvent) (defaults to: nil)
write_async (Boolean) (defaults to: nil) —
If set to true, the user event will be written asynchronously after validation, and the API will respond without waiting for the write. Therefore, silent failures can occur even if the API returns success. In case of silent failures, error messages can be found in Stackdriver logs.
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:

result (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserEvent) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserEvent)

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

# File 'lib/google/apis/retail_v2alpha/service.rb', line 3265

def write_project_location_catalog_user_event(parent, google_cloud_retail_v2alpha_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/userEvents:write', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserEvent::Representation
  command.request_object = google_cloud_retail_v2alpha_user_event_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserEvent::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserEvent
  command.params['parent'] = parent unless parent.nil?
  command.query['writeAsync'] = write_async unless write_async.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

Class: Google::Apis::RetailV2alpha::CloudRetailService

Overview

Examples:

Constant Summary collapse

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CloudRetailService

Instance Attribute Details

#key ⇒ String

#quota_user ⇒ String

Instance Method Details

#accept_project_retail_project_terms(project, google_cloud_retail_v2alpha_accept_terms_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProject

#add_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2alpha_add_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig

#add_project_location_catalog_branch_product_fulfillment_places(product, google_cloud_retail_v2alpha_add_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation

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

#add_project_location_catalog_serving_config_control(serving_config, google_cloud_retail_v2alpha_add_control_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig

#collect_project_location_catalog_user_event(parent, google_cloud_retail_v2alpha_collect_user_event_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleApiHttpBody

#conversational_project_location_catalog_placement_search(placement, google_cloud_retail_v2alpha_conversational_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse

#conversational_project_location_catalog_serving_config_search(placement, google_cloud_retail_v2alpha_conversational_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse

#create_project_location_catalog_branch_product(parent, google_cloud_retail_v2alpha_product_object = nil, product_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct

#create_project_location_catalog_control(parent, google_cloud_retail_v2alpha_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl

#create_project_location_catalog_merchant_center_account_link(parent, google_cloud_retail_v2alpha_merchant_center_account_link_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation

#create_project_location_catalog_model(parent, google_cloud_retail_v2alpha_model_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation

#create_project_location_catalog_serving_config(parent, google_cloud_retail_v2alpha_serving_config_object = nil, serving_config_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig

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

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

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

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

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

#enroll_project_solution(project, google_cloud_retail_v2alpha_enroll_solution_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation

#export_project_location_catalog_analytics_metrics(catalog, google_cloud_retail_v2alpha_export_analytics_metrics_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation

#export_project_location_catalog_branch_product(parent, google_cloud_retail_v2alpha_export_products_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation

#export_project_location_catalog_user_event(parent, google_cloud_retail_v2alpha_export_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation

#get_project_alert_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAlertConfig

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

#get_project_location_catalog_branch(name, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBranch

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

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

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

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

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

#get_project_location_catalog_conversational_search_customization_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig

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

#get_project_location_catalog_generative_question_feature(catalog, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig

#get_project_location_catalog_model(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel

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

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

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

#get_project_logging_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLoggingConfig

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

#get_project_retail_project(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProject

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

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

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

#list_project_enrolled_solutions(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListEnrolledSolutionsResponse

#list_project_location_catalog_branch_products(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, require_total_size: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListProductsResponse

#list_project_location_catalog_branches(parent, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListBranchesResponse

#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::RetailV2alpha::GoogleCloudRetailV2alphaListControlsResponse

#list_project_location_catalog_generative_questions(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListGenerativeQuestionConfigsResponse

#list_project_location_catalog_merchant_center_account_links(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListMerchantCenterAccountLinksResponse

#list_project_location_catalog_models(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListModelsResponse

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

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

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

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

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

#patch_project_location_catalog(name, google_cloud_retail_v2alpha_catalog_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalog

#patch_project_location_catalog_branch_product(name, google_cloud_retail_v2alpha_product_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct

#patch_project_location_catalog_control(name, google_cloud_retail_v2alpha_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl

#patch_project_location_catalog_model(name, google_cloud_retail_v2alpha_model_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel

#patch_project_location_catalog_serving_config(name, google_cloud_retail_v2alpha_serving_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig

#pause_project_location_catalog_model(name, google_cloud_retail_v2alpha_pause_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel

#predict_project_location_catalog_placement(placement, google_cloud_retail_v2alpha_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse

#predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2alpha_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse

#purge_project_location_catalog_branch_product(parent, google_cloud_retail_v2alpha_purge_products_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation

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

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

#remove_project_location_catalog_branch_product_fulfillment_places(product, google_cloud_retail_v2alpha_remove_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation

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

#initialize ⇒ `CloudRetailService`

#key ⇒ `String`

#quota_user ⇒ `String`

#accept_project_retail_project_terms(project, google_cloud_retail_v2alpha_accept_terms_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProject`

#add_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2alpha_add_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig`

#add_project_location_catalog_branch_product_fulfillment_places(product, google_cloud_retail_v2alpha_add_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleLongrunningOperation`

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

#add_project_location_catalog_serving_config_control(serving_config, google_cloud_retail_v2alpha_add_control_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig`

#collect_project_location_catalog_user_event(parent, google_cloud_retail_v2alpha_collect_user_event_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleApiHttpBody`

#conversational_project_location_catalog_placement_search(placement, google_cloud_retail_v2alpha_conversational_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse`

#conversational_project_location_catalog_serving_config_search(placement, google_cloud_retail_v2alpha_conversational_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse`

#create_project_location_catalog_branch_product(parent, google_cloud_retail_v2alpha_product_object = nil, product_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct`

#create_project_location_catalog_control(parent, google_cloud_retail_v2alpha_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl`

#create_project_location_catalog_merchant_center_account_link(parent, google_cloud_retail_v2alpha_merchant_center_account_link_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleLongrunningOperation`

#create_project_location_catalog_model(parent, google_cloud_retail_v2alpha_model_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleLongrunningOperation`

#create_project_location_catalog_serving_config(parent, google_cloud_retail_v2alpha_serving_config_object = nil, serving_config_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig`

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

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

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

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

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

#enroll_project_solution(project, google_cloud_retail_v2alpha_enroll_solution_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleLongrunningOperation`

#export_project_location_catalog_analytics_metrics(catalog, google_cloud_retail_v2alpha_export_analytics_metrics_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleLongrunningOperation`

#export_project_location_catalog_branch_product(parent, google_cloud_retail_v2alpha_export_products_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleLongrunningOperation`

#export_project_location_catalog_user_event(parent, google_cloud_retail_v2alpha_export_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleLongrunningOperation`

#get_project_alert_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAlertConfig`

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

#get_project_location_catalog_branch(name, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBranch`

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

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

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

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

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

#get_project_location_catalog_conversational_search_customization_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig`

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

#get_project_location_catalog_generative_question_feature(catalog, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig`

#get_project_location_catalog_model(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel`

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

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

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

#get_project_logging_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLoggingConfig`

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

#get_project_retail_project(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProject`

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

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

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

#list_project_enrolled_solutions(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListEnrolledSolutionsResponse`

#list_project_location_catalog_branch_products(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, require_total_size: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListProductsResponse`

#list_project_location_catalog_branches(parent, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListBranchesResponse`

#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::RetailV2alpha::GoogleCloudRetailV2alphaListControlsResponse`

#list_project_location_catalog_generative_questions(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListGenerativeQuestionConfigsResponse`

#list_project_location_catalog_merchant_center_account_links(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListMerchantCenterAccountLinksResponse`

#list_project_location_catalog_models(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListModelsResponse`

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

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

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

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

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

#patch_project_location_catalog(name, google_cloud_retail_v2alpha_catalog_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalog`

#patch_project_location_catalog_branch_product(name, google_cloud_retail_v2alpha_product_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct`

#patch_project_location_catalog_control(name, google_cloud_retail_v2alpha_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl`

#patch_project_location_catalog_model(name, google_cloud_retail_v2alpha_model_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel`

#patch_project_location_catalog_serving_config(name, google_cloud_retail_v2alpha_serving_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig`

#pause_project_location_catalog_model(name, google_cloud_retail_v2alpha_pause_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel`

#predict_project_location_catalog_placement(placement, google_cloud_retail_v2alpha_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse`

#predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2alpha_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse`

#purge_project_location_catalog_branch_product(parent, google_cloud_retail_v2alpha_purge_products_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleLongrunningOperation`

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

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

#remove_project_location_catalog_branch_product_fulfillment_places(product, google_cloud_retail_v2alpha_remove_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleLongrunningOperation`

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

#remove_project_location_catalog_serving_config_control(serving_config, google_cloud_retail_v2alpha_remove_control_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig`

#resume_project_location_catalog_model(name, google_cloud_retail_v2alpha_resume_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel`

#search_project_location_catalog_placements(placement, google_cloud_retail_v2alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse`

#search_project_location_catalog_serving_configs(placement, google_cloud_retail_v2alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse`

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

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

#tune_project_location_catalog_model(name, google_cloud_retail_v2alpha_tune_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleLongrunningOperation`

#update_project_alert_config(name, google_cloud_retail_v2alpha_alert_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAlertConfig`

#update_project_location_catalog_attributes_config(name, google_cloud_retail_v2alpha_attributes_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig`