Skip to content

Commit 53cd896

Browse files
feat(retail): update the api
#### retail:v2 The following keys were deleted: - schemas.GoogleCloudRetailV2betaCreateMerchantCenterAccountLinkMetadata (Total Keys: 6) - schemas.GoogleCloudRetailV2betaMerchantCenterAccountLink (Total Keys: 23) #### retail:v2alpha The following keys were deleted: - schemas.GoogleCloudRetailV2betaCreateMerchantCenterAccountLinkMetadata (Total Keys: 6) - schemas.GoogleCloudRetailV2betaMerchantCenterAccountLink (Total Keys: 23) #### retail:v2beta The following keys were deleted: - schemas.GoogleCloudRetailV2betaCreateMerchantCenterAccountLinkMetadata (Total Keys: 6) - schemas.GoogleCloudRetailV2betaMerchantCenterAccountLink (Total Keys: 23)
1 parent 50f9cc5 commit 53cd896

8 files changed

+17
-317
lines changed

docs/dyn/retail_v2.projects.locations.catalogs.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ <h3>Method Details</h3>
169169
catalog: string, Required. Catalog for which the completion is performed. Full resource name of catalog, such as `projects/*/locations/global/catalogs/default_catalog`. (required)
170170
dataset: string, Determines which dataset to use for fetching completion. &quot;user-data&quot; will use the imported dataset through CompletionService.ImportCompletionData. &quot;cloud-retail&quot; will use the dataset generated by cloud retail based on user events. If leave empty, it will use the &quot;user-data&quot;. Current supported values: * user-data * cloud-retail: This option requires enabling auto-learning function first. See [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).
171171
deviceType: string, The device type context for completion suggestions. We recommend that you leave this field empty. It can apply different suggestions on different device types, e.g. `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device types. Supported formats: * `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
172-
enableAttributeSuggestions: boolean, If true, attribute suggestions are enabled and provided in response. This field is only available for &quot;cloud-retail&quot; dataset.
172+
enableAttributeSuggestions: boolean, If true, attribute suggestions are enabled and provided in the response. This field is only available for the &quot;cloud-retail&quot; dataset.
173173
entity: string, The entity for customers who run multiple entities, domains, sites, or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this is set, it must be an exact match with UserEvent.entity to get per-entity autocomplete results.
174174
languageCodes: string, Note that this field applies for `user-data` dataset only. For requests with `cloud-retail` dataset, setting this field has no effect. The language filters applied to the output suggestions. If set, it should contain the language of the query. If not set, suggestions are returned without considering language restrictions. This is the BCP-47 language code, such as &quot;en-US&quot; or &quot;sr-Latn&quot;. For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum number of language codes is 3. (repeated)
175175
maxSuggestions: integer, Completion max suggestions. If left unset or set to 0, then will fallback to the configured value CompletionConfig.max_suggestions. The maximum allowed max suggestions is 20. If it is set higher, it will be capped by 20.

docs/dyn/retail_v2alpha.projects.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -341,7 +341,7 @@ <h3>Method Details</h3>
341341
],
342342
}
343343

344-
updateMask: string, Indicates which fields in the provided LoggingConfig to update. The following are the only supported fields: * LoggingConfig.default_log_generation_rule * LoggingConfig.per_service_log_generation_rules If not set, all supported fields are updated.
344+
updateMask: string, Indicates which fields in the provided LoggingConfig to update. The following are the only supported fields: * LoggingConfig.default_log_generation_rule * LoggingConfig.service_log_generation_rules If not set, all supported fields are updated.
345345
x__xgafv: string, V1 error format.
346346
Allowed values
347347
1 - v1 error format

docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ <h2>Instance Methods</h2>
9797
<p class="firstline">Retrieves a Branch.</p>
9898
<p class="toc_element">
9999
<code><a href="#list">list(parent, view=None, x__xgafv=None)</a></code></p>
100-
<p class="firstline">Lists all Branchs under the specified parent Catalog.</p>
100+
<p class="firstline">Lists all instances of Branch under the specified parent Catalog.</p>
101101
<h3>Method Details</h3>
102102
<div class="method">
103103
<code class="details" id="close">close()</code>
@@ -123,7 +123,7 @@ <h3>Method Details</h3>
123123
Returns:
124124
An object of the form:
125125

126-
{ # A data branch that stores Products.
126+
{ # A data branch that stores all instances of Products.
127127
&quot;displayName&quot;: &quot;A String&quot;, # Output only. Human readable name of the branch to display in the UI.
128128
&quot;isDefault&quot;: True or False, # Output only. Indicates whether this branch is set as the default branch of its parent catalog.
129129
&quot;lastProductImportTime&quot;: &quot;A String&quot;, # Output only. Timestamp of last import through ProductService.ImportProducts. Empty value means no import has been made to this branch.
@@ -318,7 +318,7 @@ <h3>Method Details</h3>
318318

319319
<div class="method">
320320
<code class="details" id="list">list(parent, view=None, x__xgafv=None)</code>
321-
<pre>Lists all Branchs under the specified parent Catalog.
321+
<pre>Lists all instances of Branch under the specified parent Catalog.
322322

323323
Args:
324324
parent: string, Required. The parent catalog resource name. (required)
@@ -337,7 +337,7 @@ <h3>Method Details</h3>
337337

338338
{ # Response for BranchService.ListBranches method.
339339
&quot;branches&quot;: [ # The Branches.
340-
{ # A data branch that stores Products.
340+
{ # A data branch that stores all instances of Products.
341341
&quot;displayName&quot;: &quot;A String&quot;, # Output only. Human readable name of the branch to display in the UI.
342342
&quot;isDefault&quot;: True or False, # Output only. Indicates whether this branch is set as the default branch of its parent catalog.
343343
&quot;lastProductImportTime&quot;: &quot;A String&quot;, # Output only. Timestamp of last import through ProductService.ImportProducts. Empty value means no import has been made to this branch.

docs/dyn/retail_v2alpha.projects.locations.catalogs.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ <h3>Method Details</h3>
174174
catalog: string, Required. Catalog for which the completion is performed. Full resource name of catalog, such as `projects/*/locations/global/catalogs/default_catalog`. (required)
175175
dataset: string, Determines which dataset to use for fetching completion. &quot;user-data&quot; will use the imported dataset through CompletionService.ImportCompletionData. &quot;cloud-retail&quot; will use the dataset generated by cloud retail based on user events. If leave empty, it will use the &quot;user-data&quot;. Current supported values: * user-data * cloud-retail: This option requires enabling auto-learning function first. See [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).
176176
deviceType: string, The device type context for completion suggestions. We recommend that you leave this field empty. It can apply different suggestions on different device types, e.g. `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device types. Supported formats: * `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
177-
enableAttributeSuggestions: boolean, If true, attribute suggestions are enabled and provided in response. This field is only available for &quot;cloud-retail&quot; dataset.
177+
enableAttributeSuggestions: boolean, If true, attribute suggestions are enabled and provided in the response. This field is only available for the &quot;cloud-retail&quot; dataset.
178178
entity: string, The entity for customers who run multiple entities, domains, sites, or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this is set, it must be an exact match with UserEvent.entity to get per-entity autocomplete results.
179179
languageCodes: string, Note that this field applies for `user-data` dataset only. For requests with `cloud-retail` dataset, setting this field has no effect. The language filters applied to the output suggestions. If set, it should contain the language of the query. If not set, suggestions are returned without considering language restrictions. This is the BCP-47 language code, such as &quot;en-US&quot; or &quot;sr-Latn&quot;. For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum number of language codes is 3. (repeated)
180180
maxSuggestions: integer, Completion max suggestions. If left unset or set to 0, then will fallback to the configured value CompletionConfig.max_suggestions. The maximum allowed max suggestions is 20. If it is set higher, it will be capped by 20.

docs/dyn/retail_v2beta.projects.locations.catalogs.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ <h3>Method Details</h3>
169169
catalog: string, Required. Catalog for which the completion is performed. Full resource name of catalog, such as `projects/*/locations/global/catalogs/default_catalog`. (required)
170170
dataset: string, Determines which dataset to use for fetching completion. &quot;user-data&quot; will use the imported dataset through CompletionService.ImportCompletionData. &quot;cloud-retail&quot; will use the dataset generated by cloud retail based on user events. If leave empty, it will use the &quot;user-data&quot;. Current supported values: * user-data * cloud-retail: This option requires enabling auto-learning function first. See [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).
171171
deviceType: string, The device type context for completion suggestions. We recommend that you leave this field empty. It can apply different suggestions on different device types, e.g. `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device types. Supported formats: * `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
172-
enableAttributeSuggestions: boolean, If true, attribute suggestions are enabled and provided in response. This field is only available for &quot;cloud-retail&quot; dataset.
172+
enableAttributeSuggestions: boolean, If true, attribute suggestions are enabled and provided in the response. This field is only available for the &quot;cloud-retail&quot; dataset.
173173
entity: string, The entity for customers who run multiple entities, domains, sites, or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this is set, it must be an exact match with UserEvent.entity to get per-entity autocomplete results.
174174
languageCodes: string, Note that this field applies for `user-data` dataset only. For requests with `cloud-retail` dataset, setting this field has no effect. The language filters applied to the output suggestions. If set, it should contain the language of the query. If not set, suggestions are returned without considering language restrictions. This is the BCP-47 language code, such as &quot;en-US&quot; or &quot;sr-Latn&quot;. For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum number of language codes is 3. (repeated)
175175
maxSuggestions: integer, Completion max suggestions. If left unset or set to 0, then will fallback to the configured value CompletionConfig.max_suggestions. The maximum allowed max suggestions is 20. If it is set higher, it will be capped by 20.

googleapiclient/discovery_cache/documents/retail.v2.json

Lines changed: 2 additions & 102 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@
138138
"type": "string"
139139
},
140140
"enableAttributeSuggestions": {
141-
"description": "If true, attribute suggestions are enabled and provided in response. This field is only available for \"cloud-retail\" dataset.",
141+
"description": "If true, attribute suggestions are enabled and provided in the response. This field is only available for the \"cloud-retail\" dataset.",
142142
"location": "query",
143143
"type": "boolean"
144144
},
@@ -2092,7 +2092,7 @@
20922092
}
20932093
}
20942094
},
2095-
"revision": "20240530",
2095+
"revision": "20240614",
20962096
"rootUrl": "https://retail.googleapis.com/",
20972097
"schemas": {
20982098
"GoogleApiHttpBody": {
@@ -6517,23 +6517,6 @@
65176517
},
65186518
"type": "object"
65196519
},
6520-
"GoogleCloudRetailV2betaCreateMerchantCenterAccountLinkMetadata": {
6521-
"description": "Common metadata related to the progress of the operations.",
6522-
"id": "GoogleCloudRetailV2betaCreateMerchantCenterAccountLinkMetadata",
6523-
"properties": {
6524-
"createTime": {
6525-
"description": "Operation create time.",
6526-
"format": "google-datetime",
6527-
"type": "string"
6528-
},
6529-
"updateTime": {
6530-
"description": "Operation last update time. If the operation is done, this is also the finish time.",
6531-
"format": "google-datetime",
6532-
"type": "string"
6533-
}
6534-
},
6535-
"type": "object"
6536-
},
65376520
"GoogleCloudRetailV2betaCreateModelMetadata": {
65386521
"description": "Metadata associated with a create operation.",
65396522
"id": "GoogleCloudRetailV2betaCreateModelMetadata",
@@ -6751,89 +6734,6 @@
67516734
},
67526735
"type": "object"
67536736
},
6754-
"GoogleCloudRetailV2betaMerchantCenterAccountLink": {
6755-
"description": "Represents a link between a Merchant Center account and a branch. After a link is established, products from the linked Merchant Center account are streamed to the linked branch.",
6756-
"id": "GoogleCloudRetailV2betaMerchantCenterAccountLink",
6757-
"properties": {
6758-
"branchId": {
6759-
"description": "Required. The branch ID (e.g. 0/1/2) within the catalog that products from merchant_center_account_id are streamed to. When updating this field, an empty value will use the currently configured default branch. However, changing the default branch later on won't change the linked branch here. A single branch ID can only have one linked Merchant Center account ID.",
6760-
"type": "string"
6761-
},
6762-
"feedFilters": {
6763-
"description": "Criteria for the Merchant Center feeds to be ingested via the link. All offers will be ingested if the list is empty. Otherwise the offers will be ingested from selected feeds.",
6764-
"items": {
6765-
"$ref": "GoogleCloudRetailV2betaMerchantCenterAccountLinkMerchantCenterFeedFilter"
6766-
},
6767-
"type": "array"
6768-
},
6769-
"feedLabel": {
6770-
"description": "The FeedLabel used to perform filtering. Note: this replaces [region_id](https://developers.google.com/shopping-content/reference/rest/v2.1/products#Product.FIELDS.feed_label). Example value: `US`. Example value: `FeedLabel1`.",
6771-
"type": "string"
6772-
},
6773-
"id": {
6774-
"description": "Output only. Immutable. MerchantCenterAccountLink identifier, which is the final component of name. This field is auto generated and follows the convention: `BranchId_MerchantCenterAccountId`. `projects/*/locations/global/catalogs/default_catalog/merchantCenterAccountLinks/id_1`.",
6775-
"readOnly": true,
6776-
"type": "string"
6777-
},
6778-
"languageCode": {
6779-
"description": "Language of the title/description and other string attributes. Use language tags defined by [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). ISO 639-1. This specifies the language of offers in Merchant Center that will be accepted. If empty, no language filtering will be performed. Example value: `en`.",
6780-
"type": "string"
6781-
},
6782-
"merchantCenterAccountId": {
6783-
"description": "Required. The linked [Merchant center account id](https://developers.google.com/shopping-content/guides/accountstatuses). The account must be a standalone account or a sub-account of a MCA.",
6784-
"format": "int64",
6785-
"type": "string"
6786-
},
6787-
"name": {
6788-
"description": "Output only. Immutable. Full resource name of the Merchant Center Account Link, such as `projects/*/locations/global/catalogs/default_catalog/merchantCenterAccountLinks/merchant_center_account_link`.",
6789-
"readOnly": true,
6790-
"type": "string"
6791-
},
6792-
"projectId": {
6793-
"description": "Output only. Google Cloud project ID.",
6794-
"readOnly": true,
6795-
"type": "string"
6796-
},
6797-
"source": {
6798-
"description": "Optional. An optional arbitrary string that could be used as a tag for tracking link source.",
6799-
"type": "string"
6800-
},
6801-
"state": {
6802-
"description": "Output only. Represents the state of the link.",
6803-
"enum": [
6804-
"STATE_UNSPECIFIED",
6805-
"PENDING",
6806-
"ACTIVE",
6807-
"FAILED"
6808-
],
6809-
"enumDescriptions": [
6810-
"Default value.",
6811-
"Link is created and LRO is not complete.",
6812-
"Link is active.",
6813-
"Link creation failed."
6814-
],
6815-
"readOnly": true,
6816-
"type": "string"
6817-
}
6818-
},
6819-
"type": "object"
6820-
},
6821-
"GoogleCloudRetailV2betaMerchantCenterAccountLinkMerchantCenterFeedFilter": {
6822-
"description": "Merchant Center Feed filter criterion.",
6823-
"id": "GoogleCloudRetailV2betaMerchantCenterAccountLinkMerchantCenterFeedFilter",
6824-
"properties": {
6825-
"primaryFeedId": {
6826-
"description": "Merchant Center primary feed ID.",
6827-
"format": "int64",
6828-
"type": "string"
6829-
},
6830-
"primaryFeedName": {
6831-
"description": "Merchant Center primary feed name. The name is used for the display purposes only.",
6832-
"type": "string"
6833-
}
6834-
},
6835-
"type": "object"
6836-
},
68376737
"GoogleCloudRetailV2betaModel": {
68386738
"description": "Metadata that describes the training and serving parameters of a Model. A Model can be associated with a ServingConfig and then queried through the Predict API.",
68396739
"id": "GoogleCloudRetailV2betaModel",

0 commit comments

Comments
 (0)