Class: Google::Apis::RetailV2alpha::CloudRetailService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::RetailV2alpha::CloudRetailService
- Defined in:
- lib/google/apis/retail_v2alpha/service.rb
Overview
Retail API
Cloud Retail service enables customers to build end-to-end personalized recommendation systems without requiring a high level of expertise in machine learning, recommendation system, or Google Cloud.
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.
-
#collect_project_location_catalog_user_event(parent, ets: nil, prebuilt_rule: nil, raw_json: nil, uri: nil, user_event: 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.
-
#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.
-
#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_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_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_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_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_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, 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, 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, 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_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_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.
49 50 51 52 53 54 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 49 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.
42 43 44 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 42 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.
47 48 49 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 47 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
2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2914 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', ) 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.
681 682 683 684 685 686 687 688 689 690 691 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 681 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', ) 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.
897 898 899 900 901 902 903 904 905 906 907 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 897 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', ) 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.
945 946 947 948 949 950 951 952 953 954 955 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 945 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', ) 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.
2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2220 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', ) 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.
716 717 718 719 720 721 722 723 724 725 726 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 716 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', ) 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 |
#collect_project_location_catalog_user_event(parent, ets: nil, prebuilt_rule: nil, raw_json: nil, uri: nil, user_event: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleApiHttpBody
Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2578 def collect_project_location_catalog_user_event(parent, ets: nil, prebuilt_rule: nil, raw_json: nil, uri: nil, user_event: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2alpha/{+parent}/userEvents:collect', ) command.response_representation = Google::Apis::RetailV2alpha::GoogleApiHttpBody::Representation command.response_class = Google::Apis::RetailV2alpha::GoogleApiHttpBody command.params['parent'] = parent unless parent.nil? command.query['ets'] = ets unless ets.nil? command.query['prebuiltRule'] = prebuilt_rule unless prebuilt_rule.nil? command.query['rawJson'] = raw_json unless raw_json.nil? command.query['uri'] = uri unless uri.nil? command.query['userEvent'] = user_event unless user_event.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#complete_project_location_catalog_query(catalog, dataset: nil, device_type: nil, 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.
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 293 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', ) 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 |
#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.
987 988 989 990 991 992 993 994 995 996 997 998 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 987 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', ) 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.
1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1491 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', ) 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.
1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1678 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', ) 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.
1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1779 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', ) 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.
2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2259 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', ) 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.
1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1034 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}', ) 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.
1527 1528 1529 1530 1531 1532 1533 1534 1535 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1527 def delete_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2alpha/{+name}', ) 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.
1713 1714 1715 1716 1717 1718 1719 1720 1721 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1713 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}', ) 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.
1814 1815 1816 1817 1818 1819 1820 1821 1822 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1814 def delete_project_location_catalog_model(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2alpha/{+name}', ) 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.
2295 2296 2297 2298 2299 2300 2301 2302 2303 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2295 def delete_project_location_catalog_serving_config(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2alpha/{+name}', ) 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.
81 82 83 84 85 86 87 88 89 90 91 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 81 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', ) 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.
335 336 337 338 339 340 341 342 343 344 345 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 335 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', ) 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 |
#get_project_location_catalog_attributes_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig
Gets an AttributesConfig.
368 369 370 371 372 373 374 375 376 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 368 def get_project_location_catalog_attributes_config(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2alpha/{+name}', ) 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_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.
820 821 822 823 824 825 826 827 828 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 820 def get_project_location_catalog_branch_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2alpha/{+name}', ) 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.
851 852 853 854 855 856 857 858 859 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 851 def get_project_location_catalog_branch_place_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2alpha/{+name}', ) 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.
1069 1070 1071 1072 1073 1074 1075 1076 1077 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1069 def get_project_location_catalog_branch_product(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2alpha/{+name}', ) 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.
399 400 401 402 403 404 405 406 407 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 399 def get_project_location_catalog_completion_config(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2alpha/{+name}', ) 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.
1559 1560 1561 1562 1563 1564 1565 1566 1567 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1559 def get_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2alpha/{+name}', ) 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_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.
431 432 433 434 435 436 437 438 439 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 431 def get_project_location_catalog_default_branch(catalog, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2alpha/{+catalog}:getDefaultBranch', ) 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_model(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel
Gets a model.
1845 1846 1847 1848 1849 1850 1851 1852 1853 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1845 def get_project_location_catalog_model(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2alpha/{+name}', ) 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.
2060 2061 2062 2063 2064 2065 2066 2067 2068 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2060 def get_project_location_catalog_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2alpha/{+name}', ) 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.
2328 2329 2330 2331 2332 2333 2334 2335 2336 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2328 def get_project_location_catalog_serving_config(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2alpha/{+name}', ) 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.
2769 2770 2771 2772 2773 2774 2775 2776 2777 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2769 def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2alpha/{+name}', ) 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.
114 115 116 117 118 119 120 121 122 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 114 def get_project_logging_config(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2alpha/{+name}', ) 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.
2840 2841 2842 2843 2844 2845 2846 2847 2848 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2840 def get_project_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2alpha/{+name}', ) 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.
146 147 148 149 150 151 152 153 154 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 146 def get_project_retail_project(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2alpha/{+name}', ) 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.
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1104 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', ) 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.
1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1452 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', ) 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.
2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2618 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', ) 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.
177 178 179 180 181 182 183 184 185 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 177 def list_project_enrolled_solutions(parent, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2alpha/{+parent}:enrolledSolutions', ) 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.
1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1172 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', ) 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_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.
1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1601 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', ) 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_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.
1744 1745 1746 1747 1748 1749 1750 1751 1752 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1744 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', ) 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.
1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1882 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', ) 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, 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.
2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2097 def list_project_location_catalog_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2alpha/{+name}/operations', ) 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['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.
2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2365 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', ) 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.
473 474 475 476 477 478 479 480 481 482 483 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 473 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', ) 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, 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.
2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2806 def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2alpha/{+name}/operations', ) 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['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningListOperationsResponse
Lists operations that match the specified filter in the request. If the server
doesn't support this method, it returns UNIMPLEMENTED.
2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2877 def list_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2alpha/{+name}/operations', ) 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['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.
509 510 511 512 513 514 515 516 517 518 519 520 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 509 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}', ) 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.
1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1220 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}', ) 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.
1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1642 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}', ) 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.
1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1923 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}', ) 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.
2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2403 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}', ) 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.
1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1958 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', ) 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.
2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2140 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', ) 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.
2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2446 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', ) 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.
1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1264 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', ) 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.
2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2655 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', ) 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.
2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2696 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', ) 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.
751 752 753 754 755 756 757 758 759 760 761 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 751 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', ) 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.
1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1313 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', ) 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.
1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1359 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', ) 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.
2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2483 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', ) 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.
787 788 789 790 791 792 793 794 795 796 797 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 787 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', ) 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.
1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1992 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', ) 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.
2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2180 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', ) 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.
2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2523 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', ) 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.
1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1413 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', ) 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.
561 562 563 564 565 566 567 568 569 570 571 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 561 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', ) 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.
2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2027 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', ) 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_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.
605 606 607 608 609 610 611 612 613 614 615 616 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 605 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}', ) 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.
645 646 647 648 649 650 651 652 653 654 655 656 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 645 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}', ) 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_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.
213 214 215 216 217 218 219 220 221 222 223 224 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 213 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}', ) 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.
2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 |
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2735 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', ) 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 |