Class: Google::Apis::RetailV2::CloudRetailService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::RetailV2::CloudRetailService
- Defined in:
- lib/google/apis/retail_v2/service.rb
Overview
Vertex AI Search for Retail API
Vertex AI Search for Retail API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications.
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
-
#add_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2_add_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig
Adds the specified CatalogAttribute to the AttributesConfig.
-
#add_project_location_catalog_branch_product_fulfillment_places(product, google_cloud_retail_v2_add_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::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_v2_add_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::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_v2_add_control_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2ServingConfig
Enables a Control on the specified ServingConfig.
-
#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::RetailV2::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::RetailV2::GoogleCloudRetailV2CompleteQueryResponse
Completes the specified prefix with keyword suggestions.
-
#create_project_location_catalog_branch_product(parent, google_cloud_retail_v2_product_object = nil, product_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2Product
Creates a Product.
-
#create_project_location_catalog_control(parent, google_cloud_retail_v2_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2Control
Creates a Control.
-
#create_project_location_catalog_model(parent, google_cloud_retail_v2_model_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleLongrunningOperation
Creates a new model.
-
#create_project_location_catalog_serving_config(parent, google_cloud_retail_v2_serving_config_object = nil, serving_config_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2ServingConfig
Creates a ServingConfig.
-
#delete_project_location_catalog_branch_product(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleProtobufEmpty
Deletes a Product.
-
#delete_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleProtobufEmpty
Deletes a Control.
-
#delete_project_location_catalog_model(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleProtobufEmpty
Deletes an existing model.
-
#delete_project_location_catalog_serving_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleProtobufEmpty
Deletes a ServingConfig.
-
#export_project_location_catalog_analytics_metrics(catalog, google_cloud_retail_v2_export_analytics_metrics_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleLongrunningOperation
Exports analytics metrics.
-
#get_project_location_catalog_attributes_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig
Gets an AttributesConfig.
-
#get_project_location_catalog_branch_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::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::RetailV2::GoogleCloudRetailV2Product
Gets a Product.
-
#get_project_location_catalog_completion_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig
Gets a CompletionConfig.
-
#get_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2Control
Gets a Control.
-
#get_project_location_catalog_default_branch(catalog, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2GetDefaultBranchResponse
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::RetailV2::GoogleCloudRetailV2Model
Gets a model.
-
#get_project_location_catalog_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::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::RetailV2::GoogleCloudRetailV2ServingConfig
Gets a ServingConfig.
-
#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleLongrunningOperation
Gets the latest state of a long-running operation.
-
#get_project_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleLongrunningOperation
Gets the latest state of a long-running operation.
-
#import_project_location_catalog_branch_product(parent, google_cloud_retail_v2_import_products_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleLongrunningOperation
Bulk import of multiple Products.
-
#import_project_location_catalog_completion_datum(parent, google_cloud_retail_v2_import_completion_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleLongrunningOperation
Bulk import of processed completion dataset.
-
#import_project_location_catalog_user_event(parent, google_cloud_retail_v2_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleLongrunningOperation
Bulk import of User events.
-
#initialize ⇒ CloudRetailService
constructor
A new instance of CloudRetailService.
-
#list_project_location_catalog_branch_products(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2ListProductsResponse
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::RetailV2::GoogleCloudRetailV2ListControlsResponse
Lists all Controls by their 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::RetailV2::GoogleCloudRetailV2ListModelsResponse
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::RetailV2::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::RetailV2::GoogleCloudRetailV2ListServingConfigsResponse
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::RetailV2::GoogleCloudRetailV2ListCatalogsResponse
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::RetailV2::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::RetailV2::GoogleLongrunningListOperationsResponse
Lists operations that match the specified filter in the request.
-
#patch_project_location_catalog(name, google_cloud_retail_v2_catalog_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2Catalog
Updates the Catalogs.
-
#patch_project_location_catalog_branch_product(name, google_cloud_retail_v2_product_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2Product
Updates a Product.
-
#patch_project_location_catalog_control(name, google_cloud_retail_v2_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2Control
Updates a Control.
-
#patch_project_location_catalog_model(name, google_cloud_retail_v2_model_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2Model
Update of model metadata.
-
#patch_project_location_catalog_serving_config(name, google_cloud_retail_v2_serving_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2ServingConfig
Updates a ServingConfig.
-
#pause_project_location_catalog_model(name, google_cloud_retail_v2_pause_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2Model
Pauses the training of an existing model.
-
#predict_project_location_catalog_placement(placement, google_cloud_retail_v2_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse
Makes a recommendation prediction.
-
#predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse
Makes a recommendation prediction.
-
#purge_project_location_catalog_branch_product(parent, google_cloud_retail_v2_purge_products_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleLongrunningOperation
Permanently deletes all selected Products under a branch.
-
#purge_project_location_catalog_user_event(parent, google_cloud_retail_v2_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleLongrunningOperation
Deletes permanently all user events specified by the filter provided.
-
#rejoin_project_location_catalog_user_event(parent, google_cloud_retail_v2_rejoin_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleLongrunningOperation
Starts a user-event rejoin operation with latest product catalog.
-
#remove_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2_remove_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig
Removes the specified CatalogAttribute from the AttributesConfig.
-
#remove_project_location_catalog_branch_product_fulfillment_places(product, google_cloud_retail_v2_remove_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::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_v2_remove_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::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_v2_remove_control_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2ServingConfig
Disables a Control on the specified ServingConfig.
-
#replace_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2_replace_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig
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_v2_resume_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2Model
Resumes the training of an existing model.
-
#search_project_location_catalog_placements(placement, google_cloud_retail_v2_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse
Performs a search.
-
#search_project_location_catalog_serving_configs(placement, google_cloud_retail_v2_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse
Performs a search.
-
#set_project_location_catalog_branch_product_inventory(name, google_cloud_retail_v2_set_inventory_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::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_v2_set_default_branch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleProtobufEmpty
Set a specified branch id as default branch.
-
#tune_project_location_catalog_model(name, google_cloud_retail_v2_tune_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleLongrunningOperation
Tunes an existing model.
-
#update_project_location_catalog_attributes_config(name, google_cloud_retail_v2_attributes_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig
Updates the AttributesConfig.
-
#update_project_location_catalog_completion_config(name, google_cloud_retail_v2_completion_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig
Updates the CompletionConfigs.
-
#write_project_location_catalog_user_event(parent, google_cloud_retail_v2_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2UserEvent
Writes a single user event.
Constructor Details
#initialize ⇒ CloudRetailService
Returns a new instance of CloudRetailService.
50 51 52 53 54 55 |
# File 'lib/google/apis/retail_v2/service.rb', line 50 def initialize super(DEFAULT_ENDPOINT_TEMPLATE, '', client_name: 'google-apis-retail_v2', client_version: Google::Apis::RetailV2::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.
43 44 45 |
# File 'lib/google/apis/retail_v2/service.rb', line 43 def key @key end |
#quota_user ⇒ String
Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
48 49 50 |
# File 'lib/google/apis/retail_v2/service.rb', line 48 def quota_user @quota_user end |
Instance Method Details
#add_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2_add_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig
Adds the specified CatalogAttribute to the AttributesConfig. If the CatalogAttribute to add already exists, an ALREADY_EXISTS error is returned.
512 513 514 515 516 517 518 519 520 521 522 |
# File 'lib/google/apis/retail_v2/service.rb', line 512 def add_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2_add_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+attributesConfig}:addCatalogAttribute', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2AddCatalogAttributeRequest::Representation command.request_object = google_cloud_retail_v2_add_catalog_attribute_request_object command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig 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_v2_add_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::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.
662 663 664 665 666 667 668 669 670 671 672 |
# File 'lib/google/apis/retail_v2/service.rb', line 662 def add_project_location_catalog_branch_product_fulfillment_places(product, google_cloud_retail_v2_add_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+product}:addFulfillmentPlaces', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2AddFulfillmentPlacesRequest::Representation command.request_object = google_cloud_retail_v2_add_fulfillment_places_request_object command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2::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_v2_add_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::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.
710 711 712 713 714 715 716 717 718 719 720 |
# File 'lib/google/apis/retail_v2/service.rb', line 710 def add_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2_add_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+product}:addLocalInventories', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2AddLocalInventoriesRequest::Representation command.request_object = google_cloud_retail_v2_add_local_inventories_request_object command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2::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_v2_add_control_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2ServingConfig
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.
1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 |
# File 'lib/google/apis/retail_v2/service.rb', line 1874 def add_project_location_catalog_serving_config_control(serving_config, google_cloud_retail_v2_add_control_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+servingConfig}:addControl', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2AddControlRequest::Representation command.request_object = google_cloud_retail_v2_add_control_request_object command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ServingConfig::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2ServingConfig 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 |
#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::RetailV2::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.
2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 |
# File 'lib/google/apis/retail_v2/service.rb', line 2232 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, 'v2/{+parent}/userEvents:collect', ) command.response_representation = Google::Apis::RetailV2::GoogleApiHttpBody::Representation command.response_class = Google::Apis::RetailV2::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::RetailV2::GoogleCloudRetailV2CompleteQueryResponse
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.
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/google/apis/retail_v2/service.rb', line 124 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, 'v2/{+catalog}:completeQuery', ) command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2CompleteQueryResponse::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2CompleteQueryResponse 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_v2_product_object = nil, product_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2Product
Creates a Product.
752 753 754 755 756 757 758 759 760 761 762 763 |
# File 'lib/google/apis/retail_v2/service.rb', line 752 def create_project_location_catalog_branch_product(parent, google_cloud_retail_v2_product_object = nil, product_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+parent}/products', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Product::Representation command.request_object = google_cloud_retail_v2_product_object command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Product::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2Product 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_v2_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2Control
Creates a Control. If the Control to create already exists, an ALREADY_EXISTS error is returned.
1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 |
# File 'lib/google/apis/retail_v2/service.rb', line 1244 def create_project_location_catalog_control(parent, google_cloud_retail_v2_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+parent}/controls', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Control::Representation command.request_object = google_cloud_retail_v2_control_object command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Control::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2Control 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_model(parent, google_cloud_retail_v2_model_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleLongrunningOperation
Creates a new model.
1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 |
# File 'lib/google/apis/retail_v2/service.rb', line 1433 def create_project_location_catalog_model(parent, google_cloud_retail_v2_model_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+parent}/models', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Model::Representation command.request_object = google_cloud_retail_v2_model_object command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2::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_v2_serving_config_object = nil, serving_config_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2ServingConfig
Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned.
1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 |
# File 'lib/google/apis/retail_v2/service.rb', line 1913 def create_project_location_catalog_serving_config(parent, google_cloud_retail_v2_serving_config_object = nil, serving_config_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+parent}/servingConfigs', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ServingConfig::Representation command.request_object = google_cloud_retail_v2_serving_config_object command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ServingConfig::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2ServingConfig command.params['parent'] = parent unless parent.nil? command.query['servingConfigId'] = serving_config_id unless serving_config_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_location_catalog_branch_product(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleProtobufEmpty
Deletes a Product.
793 794 795 796 797 798 799 800 801 |
# File 'lib/google/apis/retail_v2/service.rb', line 793 def delete_project_location_catalog_branch_product(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2/{+name}', ) command.response_representation = Google::Apis::RetailV2::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::RetailV2::GoogleProtobufEmpty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleProtobufEmpty
Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.
1280 1281 1282 1283 1284 1285 1286 1287 1288 |
# File 'lib/google/apis/retail_v2/service.rb', line 1280 def delete_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2/{+name}', ) command.response_representation = Google::Apis::RetailV2::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::RetailV2::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::RetailV2::GoogleProtobufEmpty
Deletes an existing model.
1468 1469 1470 1471 1472 1473 1474 1475 1476 |
# File 'lib/google/apis/retail_v2/service.rb', line 1468 def delete_project_location_catalog_model(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2/{+name}', ) command.response_representation = Google::Apis::RetailV2::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::RetailV2::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::RetailV2::GoogleProtobufEmpty
Deletes a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
1949 1950 1951 1952 1953 1954 1955 1956 1957 |
# File 'lib/google/apis/retail_v2/service.rb', line 1949 def delete_project_location_catalog_serving_config(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2/{+name}', ) command.response_representation = Google::Apis::RetailV2::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::RetailV2::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 |
#export_project_location_catalog_analytics_metrics(catalog, google_cloud_retail_v2_export_analytics_metrics_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleLongrunningOperation
Exports analytics metrics. Operation.response
is of type
ExportAnalyticsMetricsResponse
. Operation.metadata
is of type
ExportMetadata
.
166 167 168 169 170 171 172 173 174 175 176 |
# File 'lib/google/apis/retail_v2/service.rb', line 166 def export_project_location_catalog_analytics_metrics(catalog, google_cloud_retail_v2_export_analytics_metrics_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+catalog}:exportAnalyticsMetrics', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ExportAnalyticsMetricsRequest::Representation command.request_object = google_cloud_retail_v2_export_analytics_metrics_request_object command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2::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::RetailV2::GoogleCloudRetailV2AttributesConfig
Gets an AttributesConfig.
199 200 201 202 203 204 205 206 207 |
# File 'lib/google/apis/retail_v2/service.rb', line 199 def get_project_location_catalog_attributes_config(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+name}', ) command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig 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::RetailV2::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.
616 617 618 619 620 621 622 623 624 |
# File 'lib/google/apis/retail_v2/service.rb', line 616 def get_project_location_catalog_branch_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+name}', ) command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2::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::RetailV2::GoogleCloudRetailV2Product
Gets a Product.
827 828 829 830 831 832 833 834 835 |
# File 'lib/google/apis/retail_v2/service.rb', line 827 def get_project_location_catalog_branch_product(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+name}', ) command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Product::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2Product 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::RetailV2::GoogleCloudRetailV2CompletionConfig
Gets a CompletionConfig.
230 231 232 233 234 235 236 237 238 |
# File 'lib/google/apis/retail_v2/service.rb', line 230 def get_project_location_catalog_completion_config(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+name}', ) command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig 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::RetailV2::GoogleCloudRetailV2Control
Gets a Control.
1312 1313 1314 1315 1316 1317 1318 1319 1320 |
# File 'lib/google/apis/retail_v2/service.rb', line 1312 def get_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+name}', ) command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Control::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2Control 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::RetailV2::GoogleCloudRetailV2GetDefaultBranchResponse
Get which branch is currently default branch set by CatalogService. SetDefaultBranch method under a specified parent catalog.
262 263 264 265 266 267 268 269 270 |
# File 'lib/google/apis/retail_v2/service.rb', line 262 def get_project_location_catalog_default_branch(catalog, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+catalog}:getDefaultBranch', ) command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2GetDefaultBranchResponse::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2GetDefaultBranchResponse 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::RetailV2::GoogleCloudRetailV2Model
Gets a model.
1499 1500 1501 1502 1503 1504 1505 1506 1507 |
# File 'lib/google/apis/retail_v2/service.rb', line 1499 def get_project_location_catalog_model(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+name}', ) command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Model::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2Model 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::RetailV2::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.
1714 1715 1716 1717 1718 1719 1720 1721 1722 |
# File 'lib/google/apis/retail_v2/service.rb', line 1714 def get_project_location_catalog_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+name}', ) command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2::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::RetailV2::GoogleCloudRetailV2ServingConfig
Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
1982 1983 1984 1985 1986 1987 1988 1989 1990 |
# File 'lib/google/apis/retail_v2/service.rb', line 1982 def get_project_location_catalog_serving_config(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+name}', ) command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ServingConfig::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2ServingConfig 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::RetailV2::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.
2423 2424 2425 2426 2427 2428 2429 2430 2431 |
# File 'lib/google/apis/retail_v2/service.rb', line 2423 def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+name}', ) command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2::GoogleLongrunningOperation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::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.
2494 2495 2496 2497 2498 2499 2500 2501 2502 |
# File 'lib/google/apis/retail_v2/service.rb', line 2494 def get_project_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+name}', ) command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2::GoogleLongrunningOperation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#import_project_location_catalog_branch_product(parent, google_cloud_retail_v2_import_products_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::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.
862 863 864 865 866 867 868 869 870 871 872 |
# File 'lib/google/apis/retail_v2/service.rb', line 862 def import_project_location_catalog_branch_product(parent, google_cloud_retail_v2_import_products_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+parent}/products:import', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ImportProductsRequest::Representation command.request_object = google_cloud_retail_v2_import_products_request_object command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2::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_v2_import_completion_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::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.
1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 |
# File 'lib/google/apis/retail_v2/service.rb', line 1205 def import_project_location_catalog_completion_datum(parent, google_cloud_retail_v2_import_completion_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+parent}/completionData:import', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ImportCompletionDataRequest::Representation command.request_object = google_cloud_retail_v2_import_completion_data_request_object command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2::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_v2_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::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
.
2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 |
# File 'lib/google/apis/retail_v2/service.rb', line 2272 def import_project_location_catalog_user_event(parent, google_cloud_retail_v2_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+parent}/userEvents:import', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ImportUserEventsRequest::Representation command.request_object = google_cloud_retail_v2_import_user_events_request_object command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2::GoogleLongrunningOperation command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_catalog_branch_products(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2ListProductsResponse
Gets a list of Products.
926 927 928 929 930 931 932 933 934 935 936 937 938 |
# File 'lib/google/apis/retail_v2/service.rb', line 926 def list_project_location_catalog_branch_products(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+parent}/products', ) command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ListProductsResponse::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2ListProductsResponse command.params['parent'] = parent unless parent.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['readMask'] = read_mask unless read_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_catalog_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2ListControlsResponse
Lists all Controls by their parent Catalog.
1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 |
# File 'lib/google/apis/retail_v2/service.rb', line 1354 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, 'v2/{+parent}/controls', ) command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ListControlsResponse::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2ListControlsResponse 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_models(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2ListModelsResponse
Lists all the models linked to this event store.
1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 |
# File 'lib/google/apis/retail_v2/service.rb', line 1536 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, 'v2/{+parent}/models', ) command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ListModelsResponse::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2ListModelsResponse 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::RetailV2::GoogleLongrunningListOperationsResponse
Lists operations that match the specified filter in the request. If the server
doesn't support this method, it returns UNIMPLEMENTED
.
1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 |
# File 'lib/google/apis/retail_v2/service.rb', line 1751 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, 'v2/{+name}/operations', ) command.response_representation = Google::Apis::RetailV2::GoogleLongrunningListOperationsResponse::Representation command.response_class = Google::Apis::RetailV2::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::RetailV2::GoogleCloudRetailV2ListServingConfigsResponse
Lists all ServingConfigs linked to this catalog.
2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 |
# File 'lib/google/apis/retail_v2/service.rb', line 2019 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, 'v2/{+parent}/servingConfigs', ) command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ListServingConfigsResponse::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2ListServingConfigsResponse 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::RetailV2::GoogleCloudRetailV2ListCatalogsResponse
Lists all the Catalogs associated with the project.
304 305 306 307 308 309 310 311 312 313 314 |
# File 'lib/google/apis/retail_v2/service.rb', line 304 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, 'v2/{+parent}/catalogs', ) command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ListCatalogsResponse::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2ListCatalogsResponse 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::RetailV2::GoogleLongrunningListOperationsResponse
Lists operations that match the specified filter in the request. If the server
doesn't support this method, it returns UNIMPLEMENTED
.
2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 |
# File 'lib/google/apis/retail_v2/service.rb', line 2460 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, 'v2/{+name}/operations', ) command.response_representation = Google::Apis::RetailV2::GoogleLongrunningListOperationsResponse::Representation command.response_class = Google::Apis::RetailV2::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::RetailV2::GoogleLongrunningListOperationsResponse
Lists operations that match the specified filter in the request. If the server
doesn't support this method, it returns UNIMPLEMENTED
.
2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 |
# File 'lib/google/apis/retail_v2/service.rb', line 2531 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, 'v2/{+name}/operations', ) command.response_representation = Google::Apis::RetailV2::GoogleLongrunningListOperationsResponse::Representation command.response_class = Google::Apis::RetailV2::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_v2_catalog_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2Catalog
Updates the Catalogs.
340 341 342 343 344 345 346 347 348 349 350 351 |
# File 'lib/google/apis/retail_v2/service.rb', line 340 def patch_project_location_catalog(name, google_cloud_retail_v2_catalog_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v2/{+name}', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Catalog::Representation command.request_object = google_cloud_retail_v2_catalog_object command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Catalog::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2Catalog 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_v2_product_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2Product
Updates a Product.
973 974 975 976 977 978 979 980 981 982 983 984 985 |
# File 'lib/google/apis/retail_v2/service.rb', line 973 def patch_project_location_catalog_branch_product(name, google_cloud_retail_v2_product_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v2/{+name}', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Product::Representation command.request_object = google_cloud_retail_v2_product_object command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Product::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2Product 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_v2_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2Control
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.
1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 |
# File 'lib/google/apis/retail_v2/service.rb', line 1395 def patch_project_location_catalog_control(name, google_cloud_retail_v2_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v2/{+name}', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Control::Representation command.request_object = google_cloud_retail_v2_control_object command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Control::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2Control 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_v2_model_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2Model
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.
1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 |
# File 'lib/google/apis/retail_v2/service.rb', line 1577 def patch_project_location_catalog_model(name, google_cloud_retail_v2_model_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v2/{+name}', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Model::Representation command.request_object = google_cloud_retail_v2_model_object command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Model::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2Model 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_v2_serving_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2ServingConfig
Updates a ServingConfig.
2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 |
# File 'lib/google/apis/retail_v2/service.rb', line 2057 def patch_project_location_catalog_serving_config(name, google_cloud_retail_v2_serving_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v2/{+name}', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ServingConfig::Representation command.request_object = google_cloud_retail_v2_serving_config_object command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ServingConfig::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2ServingConfig 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_v2_pause_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2Model
Pauses the training of an existing model.
1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 |
# File 'lib/google/apis/retail_v2/service.rb', line 1612 def pause_project_location_catalog_model(name, google_cloud_retail_v2_pause_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+name}:pause', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2PauseModelRequest::Representation command.request_object = google_cloud_retail_v2_pause_model_request_object command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Model::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2Model 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_v2_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse
Makes a recommendation prediction.
1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 |
# File 'lib/google/apis/retail_v2/service.rb', line 1794 def predict_project_location_catalog_placement(placement, google_cloud_retail_v2_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+placement}:predict', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2PredictRequest::Representation command.request_object = google_cloud_retail_v2_predict_request_object command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse 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_v2_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse
Makes a recommendation prediction.
2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 |
# File 'lib/google/apis/retail_v2/service.rb', line 2100 def predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+placement}:predict', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2PredictRequest::Representation command.request_object = google_cloud_retail_v2_predict_request_object command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse 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_v2_purge_products_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::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.
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 |
# File 'lib/google/apis/retail_v2/service.rb', line 1017 def purge_project_location_catalog_branch_product(parent, google_cloud_retail_v2_purge_products_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+parent}/products:purge', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2PurgeProductsRequest::Representation command.request_object = google_cloud_retail_v2_purge_products_request_object command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2::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_v2_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::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.
2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 |
# File 'lib/google/apis/retail_v2/service.rb', line 2309 def purge_project_location_catalog_user_event(parent, google_cloud_retail_v2_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+parent}/userEvents:purge', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2PurgeUserEventsRequest::Representation command.request_object = google_cloud_retail_v2_purge_user_events_request_object command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2::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_v2_rejoin_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::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.
2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 |
# File 'lib/google/apis/retail_v2/service.rb', line 2350 def rejoin_project_location_catalog_user_event(parent, google_cloud_retail_v2_rejoin_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+parent}/userEvents:rejoin', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2RejoinUserEventsRequest::Representation command.request_object = google_cloud_retail_v2_rejoin_user_events_request_object command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2::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_v2_remove_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig
Removes the specified CatalogAttribute from the AttributesConfig. If the CatalogAttribute to remove does not exist, a NOT_FOUND error is returned.
547 548 549 550 551 552 553 554 555 556 557 |
# File 'lib/google/apis/retail_v2/service.rb', line 547 def remove_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2_remove_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+attributesConfig}:removeCatalogAttribute', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2RemoveCatalogAttributeRequest::Representation command.request_object = google_cloud_retail_v2_remove_catalog_attribute_request_object command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig 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_v2_remove_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::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.
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 |
# File 'lib/google/apis/retail_v2/service.rb', line 1066 def remove_project_location_catalog_branch_product_fulfillment_places(product, google_cloud_retail_v2_remove_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+product}:removeFulfillmentPlaces', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2RemoveFulfillmentPlacesRequest::Representation command.request_object = google_cloud_retail_v2_remove_fulfillment_places_request_object command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2::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_v2_remove_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::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.
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 |
# File 'lib/google/apis/retail_v2/service.rb', line 1112 def remove_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2_remove_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+product}:removeLocalInventories', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2RemoveLocalInventoriesRequest::Representation command.request_object = google_cloud_retail_v2_remove_local_inventories_request_object command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2::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_v2_remove_control_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2ServingConfig
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.
2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 |
# File 'lib/google/apis/retail_v2/service.rb', line 2137 def remove_project_location_catalog_serving_config_control(serving_config, google_cloud_retail_v2_remove_control_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+servingConfig}:removeControl', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2RemoveControlRequest::Representation command.request_object = google_cloud_retail_v2_remove_control_request_object command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ServingConfig::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2ServingConfig 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_v2_replace_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig
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.
583 584 585 586 587 588 589 590 591 592 593 |
# File 'lib/google/apis/retail_v2/service.rb', line 583 def replace_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2_replace_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+attributesConfig}:replaceCatalogAttribute', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ReplaceCatalogAttributeRequest::Representation command.request_object = google_cloud_retail_v2_replace_catalog_attribute_request_object command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig 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_v2_resume_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2Model
Resumes the training of an existing model.
1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 |
# File 'lib/google/apis/retail_v2/service.rb', line 1646 def resume_project_location_catalog_model(name, google_cloud_retail_v2_resume_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+name}:resume', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ResumeModelRequest::Representation command.request_object = google_cloud_retail_v2_resume_model_request_object command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Model::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2Model 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_v2_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse
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.
1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 |
# File 'lib/google/apis/retail_v2/service.rb', line 1834 def search_project_location_catalog_placements(placement, google_cloud_retail_v2_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+placement}:search', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest::Representation command.request_object = google_cloud_retail_v2_search_request_object command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse 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_v2_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse
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.
2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 |
# File 'lib/google/apis/retail_v2/service.rb', line 2177 def search_project_location_catalog_serving_configs(placement, google_cloud_retail_v2_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+placement}:search', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest::Representation command.request_object = google_cloud_retail_v2_search_request_object command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse 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_v2_set_inventory_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::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.
1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 |
# File 'lib/google/apis/retail_v2/service.rb', line 1166 def set_project_location_catalog_branch_product_inventory(name, google_cloud_retail_v2_set_inventory_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+name}:setInventory', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2SetInventoryRequest::Representation command.request_object = google_cloud_retail_v2_set_inventory_request_object command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2::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_v2_set_default_branch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::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
.
392 393 394 395 396 397 398 399 400 401 402 |
# File 'lib/google/apis/retail_v2/service.rb', line 392 def set_project_location_catalog_default_branch(catalog, google_cloud_retail_v2_set_default_branch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+catalog}:setDefaultBranch', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2SetDefaultBranchRequest::Representation command.request_object = google_cloud_retail_v2_set_default_branch_request_object command.response_representation = Google::Apis::RetailV2::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::RetailV2::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_v2_tune_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleLongrunningOperation
Tunes an existing model.
1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 |
# File 'lib/google/apis/retail_v2/service.rb', line 1681 def tune_project_location_catalog_model(name, google_cloud_retail_v2_tune_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+name}:tune', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2TuneModelRequest::Representation command.request_object = google_cloud_retail_v2_tune_model_request_object command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2::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_v2_attributes_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig
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.
436 437 438 439 440 441 442 443 444 445 446 447 |
# File 'lib/google/apis/retail_v2/service.rb', line 436 def update_project_location_catalog_attributes_config(name, google_cloud_retail_v2_attributes_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v2/{+name}', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig::Representation command.request_object = google_cloud_retail_v2_attributes_config_object command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig 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_v2_completion_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig
Updates the CompletionConfigs.
476 477 478 479 480 481 482 483 484 485 486 487 |
# File 'lib/google/apis/retail_v2/service.rb', line 476 def update_project_location_catalog_completion_config(name, google_cloud_retail_v2_completion_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v2/{+name}', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig::Representation command.request_object = google_cloud_retail_v2_completion_config_object command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig 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_v2_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2UserEvent
Writes a single user event.
2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 |
# File 'lib/google/apis/retail_v2/service.rb', line 2389 def write_project_location_catalog_user_event(parent, google_cloud_retail_v2_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+parent}/userEvents:write', ) command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2UserEvent::Representation command.request_object = google_cloud_retail_v2_user_event_object command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2UserEvent::Representation command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2UserEvent 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 |