|
3 | 3 | "oauth2": { |
4 | 4 | "scopes": { |
5 | 5 | "https://www.googleapis.com/auth/cloud-platform": { |
6 | | - "description": "See, edit, configure, and delete your Google Cloud Platform data" |
| 6 | + "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." |
7 | 7 | } |
8 | 8 | } |
9 | 9 | } |
|
1007 | 1007 | } |
1008 | 1008 | } |
1009 | 1009 | }, |
1010 | | - "revision": "20210730", |
| 1010 | + "revision": "20210812", |
1011 | 1011 | "rootUrl": "https://retail.googleapis.com/", |
1012 | 1012 | "schemas": { |
1013 | 1013 | "GoogleApiHttpBody": { |
|
1307 | 1307 | "type": "array" |
1308 | 1308 | }, |
1309 | 1309 | "recentSearchResults": { |
1310 | | - "description": "Matched recent searches of this user. This field is a restricted feature. Contact Retail Search support team if you are interested in enabling it. This feature is only available when CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The recent searches satisfy the follow rules: * They are ordered from latest to oldest. * They are matched with CompleteQueryRequest.query case insensitively. * They are transformed to lower cases. * They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.", |
| 1310 | + "description": "Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. Contact Retail Search support team if you are interested in enabling it. This feature is only available when CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The recent searches satisfy the follow rules: * They are ordered from latest to oldest. * They are matched with CompleteQueryRequest.query case insensitively. * They are transformed to lower cases. * They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.", |
1311 | 1311 | "items": { |
1312 | 1312 | "$ref": "GoogleCloudRetailV2CompleteQueryResponseRecentSearchResult" |
1313 | 1313 | }, |
|
1871 | 1871 | "additionalProperties": { |
1872 | 1872 | "$ref": "GoogleCloudRetailV2CustomAttribute" |
1873 | 1873 | }, |
1874 | | - "description": "Highly encouraged. Extra product attributes to be included. For example, for products, this could include the store name, vendor, style, color, etc. These are very strong signals for recommendation model, thus we highly recommend providing the attributes here. Features that can take on one of a limited number of possible values. Two types of features can be set are: Textual features. some examples would be the brand/maker of a product, or country of a customer. Numerical features. Some examples would be the height/weight of a product, or age of a customer. For example: `{ \"vendor\": {\"text\": [\"vendor123\", \"vendor456\"]}, \"lengths_cm\": {\"numbers\":[2.3, 15.4]}, \"heights_cm\": {\"numbers\":[8.1, 6.4]} }`. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * Max entries count: 200 by default; 100 for Type.VARIANT. * The key must be a UTF-8 encoded string with a length limit of 128 characters. * Max indexable entries count: 200 by default; 40 for Type.VARIANT. * Max searchable entries count: 30. * For indexable attribute, the key must match the pattern: a-zA-Z0-9*. For example, key0LikeThis or KEY_1_LIKE_THIS.", |
| 1874 | + "description": "Highly encouraged. Extra product attributes to be included. For example, for products, this could include the store name, vendor, style, color, etc. These are very strong signals for recommendation model, thus we highly recommend providing the attributes here. Features that can take on one of a limited number of possible values. Two types of features can be set are: Textual features. some examples would be the brand/maker of a product, or country of a customer. Numerical features. Some examples would be the height/weight of a product, or age of a customer. For example: `{ \"vendor\": {\"text\": [\"vendor123\", \"vendor456\"]}, \"lengths_cm\": {\"numbers\":[2.3, 15.4]}, \"heights_cm\": {\"numbers\":[8.1, 6.4]} }`. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * Max entries count: 200. * The key must be a UTF-8 encoded string with a length limit of 128 characters. * For indexable attribute, the key must match the pattern: a-zA-Z0-9*. For example, key0LikeThis or KEY_1_LIKE_THIS.", |
1875 | 1875 | "type": "object" |
1876 | 1876 | }, |
1877 | 1877 | "audience": { |
|
1955 | 1955 | "type": "array" |
1956 | 1956 | }, |
1957 | 1957 | "gtin": { |
1958 | | - "description": "The Global Trade Item Number (GTIN) of the product. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property [gtin](https://support.google.com/merchants/answer/6324461). Schema.org property [Product.isbn](https://schema.org/isbn) or [Product.gtin8](https://schema.org/gtin8) or [Product.gtin12](https://schema.org/gtin12) or [Product.gtin13](https://schema.org/gtin13) or [Product.gtin14](https://schema.org/gtin14). If the value is not a valid GTIN, an INVALID_ARGUMENT error is returned.", |
| 1958 | + "description": "The Global Trade Item Number (GTIN) of the product. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. This field must be a Unigram. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property [gtin](https://support.google.com/merchants/answer/6324461). Schema.org property [Product.isbn](https://schema.org/isbn) or [Product.gtin8](https://schema.org/gtin8) or [Product.gtin12](https://schema.org/gtin12) or [Product.gtin13](https://schema.org/gtin13) or [Product.gtin14](https://schema.org/gtin14). If the value is not a valid GTIN, an INVALID_ARGUMENT error is returned.", |
1959 | 1959 | "type": "string" |
1960 | 1960 | }, |
1961 | 1961 | "id": { |
|
1974 | 1974 | "type": "string" |
1975 | 1975 | }, |
1976 | 1976 | "materials": { |
1977 | | - "description": "The material of the product. For example, \"leather\", \"wooden\". A maximum of 5 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property [material](https://support.google.com/merchants/answer/6324410). Schema.org property [Product.material](https://schema.org/material).", |
| 1977 | + "description": "The material of the product. For example, \"leather\", \"wooden\". A maximum of 20 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property [material](https://support.google.com/merchants/answer/6324410). Schema.org property [Product.material](https://schema.org/material).", |
1978 | 1978 | "items": { |
1979 | 1979 | "type": "string" |
1980 | 1980 | }, |
|
1985 | 1985 | "type": "string" |
1986 | 1986 | }, |
1987 | 1987 | "patterns": { |
1988 | | - "description": "The pattern or graphic print of the product. For example, \"striped\", \"polka dot\", \"paisley\". A maximum of 5 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property [pattern](https://support.google.com/merchants/answer/6324483). Schema.org property [Product.pattern](https://schema.org/pattern).", |
| 1988 | + "description": "The pattern or graphic print of the product. For example, \"striped\", \"polka dot\", \"paisley\". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property [pattern](https://support.google.com/merchants/answer/6324483). Schema.org property [Product.pattern](https://schema.org/pattern).", |
1989 | 1989 | "items": { |
1990 | 1990 | "type": "string" |
1991 | 1991 | }, |
|
2539 | 2539 | "Automatic query expansion built by Google Retail Search." |
2540 | 2540 | ], |
2541 | 2541 | "type": "string" |
| 2542 | + }, |
| 2543 | + "pinUnexpandedResults": { |
| 2544 | + "description": "Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.", |
| 2545 | + "type": "boolean" |
2542 | 2546 | } |
2543 | 2547 | }, |
2544 | 2548 | "type": "object" |
|
2638 | 2642 | "expandedQuery": { |
2639 | 2643 | "description": "Bool describing whether query expansion has occurred.", |
2640 | 2644 | "type": "boolean" |
| 2645 | + }, |
| 2646 | + "pinnedResultCount": { |
| 2647 | + "description": "Number of pinned results. This field will only be set when expansion happens and SearchRequest.query_expansion_spec.pin_unexpanded_results is set to true.", |
| 2648 | + "format": "int64", |
| 2649 | + "type": "string" |
2641 | 2650 | } |
2642 | 2651 | }, |
2643 | 2652 | "type": "object" |
|
2671 | 2680 | "additionalProperties": { |
2672 | 2681 | "type": "any" |
2673 | 2682 | }, |
2674 | | - "description": "The rollup matching variant Product attributes. The key is one of the SearchRequest.variant_rollup_keys. The values are the merged and de-duplicated Product attributes. Notice that the rollup values are respect filter. For example, when filtering by \"colorFamilies:ANY(\\\"red\\\")\" and rollup \"colorFamilies\", only \"red\" is returned. For textual and numerical attributes, the rollup values is a list of string or double values with type google.protobuf.ListValue. For example, if there are two variants with colors \"red\" and \"blue\", the rollup values are { key: \"colorFamilies\" value { list_value { values { string_value: \"red\" } values { string_value: \"blue\" } } } } For FulfillmentInfo, the rollup values is a double value with type google.protobuf.Value. For example, {key: \"pickupInStore.store1\" value { number_value: 10 }} means a there are 10 variants in this product are available in the store \"store1\".", |
| 2683 | + "description": "The rollup matching variant Product attributes. The key is one of the SearchRequest.variant_rollup_keys. The values are the merged and de-duplicated Product attributes. Notice that the rollup values are respect filter. For example, when filtering by \"colorFamilies:ANY(\\\"red\\\")\" and rollup \"colorFamilies\", only \"red\" is returned. For textual and numerical attributes, the rollup values is a list of string or double values with type google.protobuf.ListValue. For example, if there are two variants with colors \"red\" and \"blue\", the rollup values are { key: \"colorFamilies\" value { list_value { values { string_value: \"red\" } values { string_value: \"blue\" } } } } For FulfillmentInfo, the rollup values is a double value with type google.protobuf.Value. For example, `{key: \"pickupInStore.store1\" value { number_value: 10 }}` means a there are 10 variants in this product are available in the store \"store1\".", |
2675 | 2684 | "type": "object" |
2676 | 2685 | } |
2677 | 2686 | }, |
|
0 commit comments