PurgeProductsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)Request message for PurgeProducts method.
Attributes |
|
|---|---|
| Name | Description |
parent |
str
Required. The resource name of the branch under which the products are created. The format is projects/${projectId}/locations/global/catalogs/${catalogId}/branches/${branchId}
|
filter |
str
Required. The filter string to specify the products to be deleted with a length limit of 5,000 characters. Empty string filter is not allowed. "*" implies delete all items in a branch. The eligible fields for filtering are: - availability: Double quoted
Product.availability
string.
- create_time : in ISO 8601 "zulu" format.
Supported syntax:
- Comparators (">", "<", "="">=", "<=", "="). Examples:
- create_time <= " 2015-02-13t17:05:46z"="" -="" availability="IN_STOCK" -="" conjunctions="" ("and")="" examples:="" -="" create_time=""><= "2015-02-13t17:05:46z"="" and="" availability="PREORDER" -="" disjunctions="" ("or")="" examples:="" -="" create_time=""><= "2015-02-13t17:05:46z"="" or="" availability="IN_STOCK" -="" can="" support="" nested="" queries.="" examples:="" -="" (create_time=""><= "2015-02-13t17:05:46z"="" and="" availability="PREORDER" )="" or="" (create_time="">=
"2015-02-14T13:03:32Z" AND availability = "IN_STOCK")
- Filter Limits:
- Filter should not contain more than 6 conditions.
- Max nesting depth should not exceed 2 levels.
Examples queries:
- Delete back order products created before a timestamp.
create_time <= "2015-02-13t17:05:46z"="" or="" availability="BACKORDER" .=""> |
force |
bool
Actually perform the purge. If force is set to false,
the method will return the expected purge count without
deleting any products.
|