Object which is represent autocomplete request and encapsulate all passed parameters.
| Name | Type | Description | Notes |
|---|---|---|---|
| area | str | Area i.e. 'Production' Will not be used immediately. This will be useful when we eventually need to support a US area vs a Canada area. But this would require using the custom dataset instead of user-generated. | |
| collection | str | Name of the collection used to determine the retail backend to use. Usually it is name which is associated with retail project in command center (project configuration). | |
| search_items | int | Completion max suggestions. The maximum allowed max suggestions is 20. | |
| query | str | String. Required. The query used to generate suggestions. The maximum number of allowed characters is 255. | |
| enable_attribute_suggestion | bool | Enable attribute suggestions, by setting the field enableAttributeSuggestion=true in the API request. Then in response, there will be an additional field attributeResults to show direct match results on brands/categories Note that attribute results directly come from the products we import and Google does not apply any cleaning on them. | [optional] |
| extended_suggestions | bool | Optional param which is define if extended suggestions will be returned in autocomplete response or not. Possibly values: true, false, not specified (If not specified default collection setting will be used). | [optional] |
| extended_attributes | List[str] | List with extended attributes which are would be returned in autocomplete response. Requires extendedSuggestions to be enabled using search param or on collection layer. | [optional] |
| visitor_id | str | String. Not required field. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. | [optional] |
| site | str | Name of site filter. If not specified, the specified area's default site will be applied if configured in Command Center. To not use default specify empty value i.e."". If the site doesn't exist then the search will execute without the site filter. | [optional] |
from gb_retailapi_client.models.request import Request
# TODO update the JSON string below
json = "{}"
# create an instance of Request from a JSON string
request_instance = Request.from_json(json)
# print the JSON string representation of the object
print Request.to_json()
# convert the object into a dict
request_dict = request_instance.to_dict()
# create an instance of Request from a dict
request_form_dict = request.from_dict(request_dict)