|
1030 | 1030 | "https://www.googleapis.com/auth/cloud-platform" |
1031 | 1031 | ] |
1032 | 1032 | }, |
| 1033 | + "export": { |
| 1034 | + "description": "Exports multiple Products.", |
| 1035 | + "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products:export", |
| 1036 | + "httpMethod": "POST", |
| 1037 | + "id": "retail.projects.locations.catalogs.branches.products.export", |
| 1038 | + "parameterOrder": [ |
| 1039 | + "parent" |
| 1040 | + ], |
| 1041 | + "parameters": { |
| 1042 | + "parent": { |
| 1043 | + "description": "Required. Resource name of a Branch, and `default_branch` for branch_id component is supported. For example `projects/1234/locations/global/catalogs/default_catalog/branches/default_branch`", |
| 1044 | + "location": "path", |
| 1045 | + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/branches/[^/]+$", |
| 1046 | + "required": true, |
| 1047 | + "type": "string" |
| 1048 | + } |
| 1049 | + }, |
| 1050 | + "path": "v2alpha/{+parent}/products:export", |
| 1051 | + "request": { |
| 1052 | + "$ref": "GoogleCloudRetailV2alphaExportProductsRequest" |
| 1053 | + }, |
| 1054 | + "response": { |
| 1055 | + "$ref": "GoogleLongrunningOperation" |
| 1056 | + }, |
| 1057 | + "scopes": [ |
| 1058 | + "https://www.googleapis.com/auth/cloud-platform" |
| 1059 | + ] |
| 1060 | + }, |
1033 | 1061 | "get": { |
1034 | 1062 | "description": "Gets a Product.", |
1035 | 1063 | "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}", |
|
2259 | 2287 | "https://www.googleapis.com/auth/cloud-platform" |
2260 | 2288 | ] |
2261 | 2289 | }, |
| 2290 | + "export": { |
| 2291 | + "description": "Exports user events. `Operation.response` is of type `ExportResponse`. `Operation.metadata` is of type `ExportMetadata`.", |
| 2292 | + "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:export", |
| 2293 | + "httpMethod": "POST", |
| 2294 | + "id": "retail.projects.locations.catalogs.userEvents.export", |
| 2295 | + "parameterOrder": [ |
| 2296 | + "parent" |
| 2297 | + ], |
| 2298 | + "parameters": { |
| 2299 | + "parent": { |
| 2300 | + "description": "Required. Resource name of a Catalog. For example `projects/1234/locations/global/catalogs/default_catalog`", |
| 2301 | + "location": "path", |
| 2302 | + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", |
| 2303 | + "required": true, |
| 2304 | + "type": "string" |
| 2305 | + } |
| 2306 | + }, |
| 2307 | + "path": "v2alpha/{+parent}/userEvents:export", |
| 2308 | + "request": { |
| 2309 | + "$ref": "GoogleCloudRetailV2alphaExportUserEventsRequest" |
| 2310 | + }, |
| 2311 | + "response": { |
| 2312 | + "$ref": "GoogleLongrunningOperation" |
| 2313 | + }, |
| 2314 | + "scopes": [ |
| 2315 | + "https://www.googleapis.com/auth/cloud-platform" |
| 2316 | + ] |
| 2317 | + }, |
2262 | 2318 | "import": { |
2263 | 2319 | "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`.", |
2264 | 2320 | "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:import", |
|
2557 | 2613 | } |
2558 | 2614 | } |
2559 | 2615 | }, |
2560 | | - "revision": "20240614", |
| 2616 | + "revision": "20240801", |
2561 | 2617 | "rootUrl": "https://retail.googleapis.com/", |
2562 | 2618 | "schemas": { |
2563 | 2619 | "GoogleApiHttpBody": { |
|
3405 | 3461 | "id": "GoogleCloudRetailV2alphaAlertConfigAlertPolicy", |
3406 | 3462 | "properties": { |
3407 | 3463 | "alertGroup": { |
3408 | | - "description": "The feature that provides alerting capability. Supported value is only `search-data-quality` for now.", |
| 3464 | + "description": "The feature that provides alerting capability. Supported value: - `search-data-quality` for retail search customers. - `conv-data-quality` for retail conversation customers.", |
3409 | 3465 | "type": "string" |
3410 | 3466 | }, |
3411 | 3467 | "enrollStatus": { |
|
3610 | 3666 | "readOnly": true, |
3611 | 3667 | "type": "array" |
3612 | 3668 | }, |
3613 | | - "productCounts": { |
3614 | | - "additionalProperties": { |
3615 | | - "format": "int64", |
3616 | | - "type": "string" |
3617 | | - }, |
3618 | | - "deprecated": true, |
3619 | | - "description": "Output only. The number of products in different groups that this branch has. The key is a group representing a set of products, and the value is the number of products in that group. Note: keys in this map may change over time. Possible keys: * \"primary-in-stock\", products have Product.Type.PRIMARY type and Product.Availability.IN_STOCK availability. * \"primary-out-of-stock\", products have Product.Type.PRIMARY type and Product.Availability.OUT_OF_STOCK availability. * \"primary-preorder\", products have Product.Type.PRIMARY type and Product.Availability.PREORDER availability. * \"primary-backorder\", products have Product.Type.PRIMARY type and Product.Availability.BACKORDER availability. * \"variant-in-stock\", products have Product.Type.VARIANT type and Product.Availability.IN_STOCK availability. * \"variant-out-of-stock\", products have Product.Type.VARIANT type and Product.Availability.OUT_OF_STOCK availability. * \"variant-preorder\", products have Product.Type.VARIANT type and Product.Availability.PREORDER availability. * \"variant-backorder\", products have Product.Type.VARIANT type and Product.Availability.BACKORDER availability. * \"price-discounted\", products have [Product.price_info.price] < [Product.price_info.original_price]. This field is not populated in BranchView.BASIC view.", |
3620 | | - "readOnly": true, |
3621 | | - "type": "object" |
3622 | | - }, |
3623 | 3669 | "qualityMetrics": { |
3624 | 3670 | "description": "Output only. The quality metrics measured among products of this branch. See QualityMetric.requirement_key for supported metrics. Metrics could be missing if failed to retrieve. This field is not populated in BranchView.BASIC view.", |
3625 | 3671 | "items": { |
|
3902 | 3948 | "mergedFacetKey": { |
3903 | 3949 | "description": "The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute.", |
3904 | 3950 | "type": "string" |
3905 | | - }, |
3906 | | - "mergedFacetValues": { |
3907 | | - "deprecated": true, |
3908 | | - "description": "Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value.", |
3909 | | - "items": { |
3910 | | - "$ref": "GoogleCloudRetailV2alphaCatalogAttributeFacetConfigMergedFacetValue" |
3911 | | - }, |
3912 | | - "type": "array" |
3913 | 3951 | } |
3914 | 3952 | }, |
3915 | 3953 | "type": "object" |
|
4009 | 4047 | "id": "GoogleCloudRetailV2alphaCompleteQueryResponseAttributeResult", |
4010 | 4048 | "properties": { |
4011 | 4049 | "suggestions": { |
4012 | | - "description": "The list of suggestions for the attribute.", |
4013 | 4050 | "items": { |
4014 | 4051 | "type": "string" |
4015 | 4052 | }, |
|
4050 | 4087 | }, |
4051 | 4088 | "GoogleCloudRetailV2alphaCompleteQueryResponseRecentSearchResult": { |
4052 | 4089 | "deprecated": true, |
4053 | | - "description": "Recent search of this user.", |
| 4090 | + "description": "Deprecated: Recent search of this user.", |
4054 | 4091 | "id": "GoogleCloudRetailV2alphaCompleteQueryResponseRecentSearchResult", |
4055 | 4092 | "properties": { |
4056 | 4093 | "recentSearch": { |
|
4479 | 4516 | }, |
4480 | 4517 | "type": "object" |
4481 | 4518 | }, |
| 4519 | + "GoogleCloudRetailV2alphaExportProductsRequest": { |
| 4520 | + "description": "Request message for ExportProducts method.", |
| 4521 | + "id": "GoogleCloudRetailV2alphaExportProductsRequest", |
| 4522 | + "properties": { |
| 4523 | + "filter": { |
| 4524 | + "description": "A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned products. Use this expression to restrict results to a specific time range, tag, or stock state or to filter products by product type. For example, `lastModifiedTime > \"2012-04-23T18:25:43.511Z\" lastModifiedTime<\"2012-04-23T18:25:43.511Z\" productType=primary` We expect only four types of fields: * `lastModifiedTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `lastModifiedTime` restriction should result in one, contiguous, valid, last-modified, time range. * `productType`: Supported values are `primary` and `variant`. The Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `productType` values by a space. * `availability`: Supported values are `IN_STOCK`, `OUT_OF_STOCK`, `PREORDER`, and `BACKORDER`. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `availability` values by a space. * `Tag expressions`: Restricts output to products that match all of the specified tags. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. Also supported is '`-\"tagA\"`', which is equivalent to '`NOT \"tagA\"`'. Tag values must be double-quoted, UTF-8 encoded strings and have a size limit of 1,000 characters. Some examples of valid filters expressions: * Example 1: `lastModifiedTime > \"2012-04-23T18:25:43.511Z\" lastModifiedTime < \"2012-04-23T18:30:43.511Z\"` * Example 2: `lastModifiedTime > \"2012-04-23T18:25:43.511Z\" productType = \"variant\"` * Example 3: `tag=(\"Red\" OR \"Blue\") tag=\"New-Arrival\" tag=(NOT \"promotional\") productType = \"primary\" lastModifiedTime < \"2018-04-23T18:30:43.511Z\"` * Example 4: `lastModifiedTime > \"2012-04-23T18:25:43.511Z\"` * Example 5: `availability = (IN_STOCK OR BACKORDER)`", |
| 4525 | + "type": "string" |
| 4526 | + }, |
| 4527 | + "outputConfig": { |
| 4528 | + "$ref": "GoogleCloudRetailV2alphaOutputConfig", |
| 4529 | + "description": "Required. The output location of the data." |
| 4530 | + } |
| 4531 | + }, |
| 4532 | + "type": "object" |
| 4533 | + }, |
4482 | 4534 | "GoogleCloudRetailV2alphaExportProductsResponse": { |
4483 | 4535 | "description": "Response of the ExportProductsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", |
4484 | 4536 | "id": "GoogleCloudRetailV2alphaExportProductsResponse", |
|
4501 | 4553 | }, |
4502 | 4554 | "type": "object" |
4503 | 4555 | }, |
| 4556 | + "GoogleCloudRetailV2alphaExportUserEventsRequest": { |
| 4557 | + "description": "Request message for the `ExportUserEvents` method.", |
| 4558 | + "id": "GoogleCloudRetailV2alphaExportUserEventsRequest", |
| 4559 | + "properties": { |
| 4560 | + "filter": { |
| 4561 | + "description": "A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned user events. Use this expression to restrict results to a specific time range or to filter events by eventType. For example, `eventTime > \"2012-04-23T18:25:43.511Z\" eventsMissingCatalogItems eventTime<\"2012-04-23T18:25:43.511Z\" eventType=search` We expect only three types of fields: * `eventTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `eventTime` restriction should result in one, contiguous, valid, `eventTime` range. * `eventType`: Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. * `eventsMissingCatalogItems`: This restricts results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\"` * Example 2: `eventTime > \"2012-04-23T18:25:43.511Z\" eventType = detail-page-view` * Example 3: `eventsMissingCatalogItems eventType = (NOT search) eventTime < \"2018-04-23T18:30:43.511Z\"` * Example 4: `eventTime > \"2012-04-23T18:25:43.511Z\"` * Example 5: `eventType = (detail-page-view OR search)` * Example 6: `eventsMissingCatalogItems`", |
| 4562 | + "type": "string" |
| 4563 | + }, |
| 4564 | + "outputConfig": { |
| 4565 | + "$ref": "GoogleCloudRetailV2alphaOutputConfig", |
| 4566 | + "description": "Required. The output location of the data." |
| 4567 | + } |
| 4568 | + }, |
| 4569 | + "type": "object" |
| 4570 | + }, |
4504 | 4571 | "GoogleCloudRetailV2alphaExportUserEventsResponse": { |
4505 | 4572 | "description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", |
4506 | 4573 | "id": "GoogleCloudRetailV2alphaExportUserEventsResponse", |
|
0 commit comments