placements

Creates, updates, deletes, gets or lists a placements resource.

Overview

Name	placements
Type	Resource
Id	google.retail.placements

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_catalogs_placements_predict	exec	projectsId, locationsId, catalogsId, placementsId		Makes a recommendation prediction.
projects_locations_catalogs_placements_search	exec	projectsId, locationsId, catalogsId, placementsId		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.
projects_locations_catalogs_placements_conversational_search	exec	projectsId, locationsId, catalogsId, placementsId		Performs a conversational search. This feature is only available for users who have Conversational Search enabled.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
catalogsId	string
locationsId	string
placementsId	string
projectsId	string

Lifecycle Methods

projects_locations_catalogs_placements_predict

Makes a recommendation prediction.

EXEC google.retail.placements.projects_locations_catalogs_placements_predict 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@catalogsId='{{ catalogsId }}' --required, 
@placementsId='{{ placementsId }}' --required 
@@json=
'{
"userEvent": "{{ userEvent }}", 
"pageSize": {{ pageSize }}, 
"labels": "{{ labels }}", 
"validateOnly": {{ validateOnly }}, 
"filter": "{{ filter }}", 
"pageToken": "{{ pageToken }}", 
"params": "{{ params }}"
}'
;

projects_locations_catalogs_placements_search

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.

EXEC google.retail.placements.projects_locations_catalogs_placements_search 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@catalogsId='{{ catalogsId }}' --required, 
@placementsId='{{ placementsId }}' --required 
@@json=
'{
"canonicalFilter": "{{ canonicalFilter }}", 
"conversationalSearchSpec": "{{ conversationalSearchSpec }}", 
"placeId": "{{ placeId }}", 
"searchMode": "{{ searchMode }}", 
"pageToken": "{{ pageToken }}", 
"userAttributes": "{{ userAttributes }}", 
"dynamicFacetSpec": "{{ dynamicFacetSpec }}", 
"offset": {{ offset }}, 
"query": "{{ query }}", 
"facetSpecs": "{{ facetSpecs }}", 
"languageCode": "{{ languageCode }}", 
"personalizationSpec": "{{ personalizationSpec }}", 
"queryExpansionSpec": "{{ queryExpansionSpec }}", 
"variantRollupKeys": "{{ variantRollupKeys }}", 
"tileNavigationSpec": "{{ tileNavigationSpec }}", 
"pageSize": {{ pageSize }}, 
"regionCode": "{{ regionCode }}", 
"pageCategories": "{{ pageCategories }}", 
"userInfo": "{{ userInfo }}", 
"visitorId": "{{ visitorId }}", 
"labels": "{{ labels }}", 
"spellCorrectionSpec": "{{ spellCorrectionSpec }}", 
"filter": "{{ filter }}", 
"boostSpec": "{{ boostSpec }}", 
"branch": "{{ branch }}", 
"entity": "{{ entity }}", 
"orderBy": "{{ orderBy }}"
}'
;

projects_locations_catalogs_placements_conversational_search

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

EXEC google.retail.placements.projects_locations_catalogs_placements_conversational_search 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@catalogsId='{{ catalogsId }}' --required, 
@placementsId='{{ placementsId }}' --required 
@@json=
'{
"pageCategories": "{{ pageCategories }}", 
"userInfo": "{{ userInfo }}", 
"conversationalFilteringSpec": "{{ conversationalFilteringSpec }}", 
"query": "{{ query }}", 
"branch": "{{ branch }}", 
"safetySettings": "{{ safetySettings }}", 
"searchParams": "{{ searchParams }}", 
"visitorId": "{{ visitorId }}", 
"conversationId": "{{ conversationId }}", 
"userLabels": "{{ userLabels }}"
}'
;