ProjectsLocationsCatalogs
class ProjectsLocationsCatalogs extends Resource (View source)
The "catalogs" collection of methods.
Typical usage is:
$retailService = new Google\Service\CloudRetail(...);
$catalogs = $retailService->projects_locations_catalogs;Methods
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. (catalogs.completeQuery)
Exports analytics metrics. Operation.response is of type
ExportAnalyticsMetricsResponse. Operation.metadata is of type
ExportMetadata. (catalogs.exportAnalyticsMetrics)
Gets an AttributesConfig. (catalogs.getAttributesConfig)
Gets a CompletionConfig. (catalogs.getCompletionConfig)
Get which branch is currently default branch set by CatalogService.SetDefaultBranch method under a specified parent catalog.
Lists all the Catalogs associated with the project.
Updates the Catalogs. (catalogs.patch)
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.
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. (catalogs.updateAttributesConfig)
Updates the CompletionConfigs. (catalogs.updateCompletionConfig)
Details
GoogleCloudRetailV2CompleteQueryResponse
completeQuery(string $catalog, array $optParams = [])
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. (catalogs.completeQuery)
GoogleLongrunningOperation
exportAnalyticsMetrics(string $catalog, GoogleCloudRetailV2ExportAnalyticsMetricsRequest $postBody, array $optParams = [])
Exports analytics metrics. Operation.response is of type
ExportAnalyticsMetricsResponse. Operation.metadata is of type
ExportMetadata. (catalogs.exportAnalyticsMetrics)
GoogleCloudRetailV2AttributesConfig
getAttributesConfig(string $name, array $optParams = [])
Gets an AttributesConfig. (catalogs.getAttributesConfig)
GoogleCloudRetailV2CompletionConfig
getCompletionConfig(string $name, array $optParams = [])
Gets a CompletionConfig. (catalogs.getCompletionConfig)
GoogleCloudRetailV2GetDefaultBranchResponse
getDefaultBranch(string $catalog, array $optParams = [])
Get which branch is currently default branch set by CatalogService.SetDefaultBranch method under a specified parent catalog.
(catalogs.getDefaultBranch)
GoogleCloudRetailV2ListCatalogsResponse
listProjectsLocationsCatalogs(string $parent, array $optParams = [])
Lists all the Catalogs associated with the project.
(catalogs.listProjectsLocationsCatalogs)
GoogleCloudRetailV2Catalog
patch(string $name, GoogleCloudRetailV2Catalog $postBody, array $optParams = [])
Updates the Catalogs. (catalogs.patch)
GoogleProtobufEmpty
setDefaultBranch(string $catalog, GoogleCloudRetailV2SetDefaultBranchRequest $postBody, array $optParams = [])
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}.
(catalogs.setDefaultBranch)
GoogleCloudRetailV2AttributesConfig
updateAttributesConfig(string $name, GoogleCloudRetailV2AttributesConfig $postBody, array $optParams = [])
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. (catalogs.updateAttributesConfig)
GoogleCloudRetailV2CompletionConfig
updateCompletionConfig(string $name, GoogleCloudRetailV2CompletionConfig $postBody, array $optParams = [])
Updates the CompletionConfigs. (catalogs.updateCompletionConfig)