Skip to content

Commit 1ac6e1a

Browse files
feat(retail): update the api
#### retail:v2 The following keys were added: - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.predict (Total Keys: 12) - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.search (Total Keys: 12) #### retail:v2alpha The following keys were added: - resources.projects.resources.locations.resources.catalogs.methods.getCompletionConfig (Total Keys: 11) - resources.projects.resources.locations.resources.catalogs.methods.updateCompletionConfig (Total Keys: 15) - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.predict (Total Keys: 12) - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.search (Total Keys: 12) - schemas.GoogleCloudRetailV2alphaCompletionConfig (Total Keys: 21) #### retail:v2beta The following keys were added: - resources.projects.resources.locations.resources.catalogs.methods.getCompletionConfig (Total Keys: 11) - resources.projects.resources.locations.resources.catalogs.methods.updateCompletionConfig (Total Keys: 15) - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.predict (Total Keys: 12) - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.search (Total Keys: 12) - schemas.GoogleCloudRetailV2betaCatalog.properties.merchantCenterLinkingConfig.$ref (Total Keys: 1) - schemas.GoogleCloudRetailV2betaCompletionConfig (Total Keys: 21) - schemas.GoogleCloudRetailV2betaMerchantCenterLink (Total Keys: 13)
1 parent 5c5b504 commit 1ac6e1a

23 files changed

+2604
-76
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -439,7 +439,7 @@ <h3>Method Details</h3>
439439
Returns:
440440
An object of the form:
441441

442-
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
442+
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
443443
}</pre>
444444
</div>
445445

@@ -596,7 +596,7 @@ <h3>Method Details</h3>
596596
},
597597
&quot;inputConfig&quot;: { # The input config source for products. # Required. The desired input location of the data.
598598
&quot;bigQuerySource&quot;: { # BigQuery source import data from. # BigQuery input source.
599-
&quot;dataSchema&quot;: &quot;A String&quot;, # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: The schema is available here: https://support.google.com/analytics/answer/3437719. * `user_event_ga4`: This feature is in private preview. Please contact the support team for importing Google Analytics 4 events. The schema is available here: https://support.google.com/analytics/answer/7029846.
599+
&quot;dataSchema&quot;: &quot;A String&quot;, # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: The schema is available here: https://support.google.com/analytics/answer/3437719. * `user_event_ga4`: This feature is in private preview. Please contact the support team for importing Google Analytics 4 events. The schema is available here: https://support.google.com/analytics/answer/7029846. Supported values for auto-completion imports: * `suggestions` (default): One JSON completion suggestion per line. * `denylist`: One JSON deny suggestion per line. * `allowlist`: One JSON allow suggestion per line.
600600
&quot;datasetId&quot;: &quot;A String&quot;, # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.
601601
&quot;gcsStagingDir&quot;: &quot;A String&quot;, # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.
602602
&quot;partitionDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # BigQuery time partitioned table&#x27;s _PARTITIONDATE in YYYY-MM-DD format. Only supported when ImportProductsRequest.reconciliation_mode is set to `FULL`.
@@ -742,7 +742,7 @@ <h3>Method Details</h3>
742742
},
743743
&quot;notificationPubsubTopic&quot;: &quot;A String&quot;, # Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`. Only supported when ImportProductsRequest.reconciliation_mode is set to `FULL`.
744744
&quot;reconciliationMode&quot;: &quot;A String&quot;, # The mode of reconciliation between existing products and the products to be imported. Defaults to ReconciliationMode.INCREMENTAL.
745-
&quot;requestId&quot;: &quot;A String&quot;, # Unique identifier provided by client, within the ancestor dataset scope. Ensures idempotency and used for request deduplication. Server-generated if unspecified. Up to 128 characters long and must match the pattern: `[a-zA-Z0-9_]+`. This is returned as Operation.name in ImportMetadata. Only supported when ImportProductsRequest.reconciliation_mode is set to `FULL`.
745+
&quot;requestId&quot;: &quot;A String&quot;, # Deprecated. This field has no effect.
746746
&quot;updateMask&quot;: &quot;A String&quot;, # Indicates which fields in the provided imported &#x27;products&#x27; to update. If not set, will by default update all fields.
747747
}
748748

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ <h2>Instance Methods</h2>
7979
<p class="firstline">Close httplib2 connections.</p>
8080
<p class="toc_element">
8181
<code><a href="#import_">import_(parent, body=None, x__xgafv=None)</a></code></p>
82-
<p class="firstline">Bulk import of processed completion dataset. Request processing may be synchronous. Partial updating is not supported. This feature is only available for users who have Retail Search enabled. Please submit a form [here](https://cloud.google.com/contact) to contact cloud sales if you are interested in using Retail Search.</p>
82+
<p class="firstline">Bulk import of processed completion dataset. Request processing is asynchronous. Partial updating is not supported. The operation is successfully finished only after the imported suggestions are indexed successfully and ready for serving. The process takes hours. This feature is only available for users who have Retail Search enabled. Please submit a form [here](https://cloud.google.com/contact) to contact cloud sales if you are interested in using Retail Search.</p>
8383
<h3>Method Details</h3>
8484
<div class="method">
8585
<code class="details" id="close">close()</code>
@@ -88,7 +88,7 @@ <h3>Method Details</h3>
8888

8989
<div class="method">
9090
<code class="details" id="import_">import_(parent, body=None, x__xgafv=None)</code>
91-
<pre>Bulk import of processed completion dataset. Request processing may be synchronous. Partial updating is not supported. This feature is only available for users who have Retail Search enabled. Please submit a form [here](https://cloud.google.com/contact) to contact cloud sales if you are interested in using Retail Search.
91+
<pre>Bulk import of processed completion dataset. Request processing is asynchronous. Partial updating is not supported. The operation is successfully finished only after the imported suggestions are indexed successfully and ready for serving. The process takes hours. This feature is only available for users who have Retail Search enabled. Please submit a form [here](https://cloud.google.com/contact) to contact cloud sales if you are interested in using Retail Search.
9292

9393
Args:
9494
parent: string, Required. The catalog which the suggestions dataset belongs to. Format: `projects/1234/locations/global/catalogs/default_catalog`. (required)
@@ -98,7 +98,7 @@ <h3>Method Details</h3>
9898
{ # Request message for ImportCompletionData methods.
9999
&quot;inputConfig&quot;: { # The input config source for completion data. # Required. The desired input location of the data.
100100
&quot;bigQuerySource&quot;: { # BigQuery source import data from. # Required. BigQuery input source. Add the IAM permission &quot;BigQuery Data Viewer&quot; for [email protected] before using this feature otherwise an error is thrown.
101-
&quot;dataSchema&quot;: &quot;A String&quot;, # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: The schema is available here: https://support.google.com/analytics/answer/3437719. * `user_event_ga4`: This feature is in private preview. Please contact the support team for importing Google Analytics 4 events. The schema is available here: https://support.google.com/analytics/answer/7029846.
101+
&quot;dataSchema&quot;: &quot;A String&quot;, # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: The schema is available here: https://support.google.com/analytics/answer/3437719. * `user_event_ga4`: This feature is in private preview. Please contact the support team for importing Google Analytics 4 events. The schema is available here: https://support.google.com/analytics/answer/7029846. Supported values for auto-completion imports: * `suggestions` (default): One JSON completion suggestion per line. * `denylist`: One JSON deny suggestion per line. * `allowlist`: One JSON allow suggestion per line.
102102
&quot;datasetId&quot;: &quot;A String&quot;, # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.
103103
&quot;gcsStagingDir&quot;: &quot;A String&quot;, # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.
104104
&quot;partitionDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # BigQuery time partitioned table&#x27;s _PARTITIONDATE in YYYY-MM-DD format. Only supported when ImportProductsRequest.reconciliation_mode is set to `FULL`.

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

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,11 @@ <h2>Instance Methods</h2>
9494
</p>
9595
<p class="firstline">Returns the placements Resource.</p>
9696

97+
<p class="toc_element">
98+
<code><a href="retail_v2.projects.locations.catalogs.servingConfigs.html">servingConfigs()</a></code>
99+
</p>
100+
<p class="firstline">Returns the servingConfigs Resource.</p>
101+
97102
<p class="toc_element">
98103
<code><a href="retail_v2.projects.locations.catalogs.userEvents.html">userEvents()</a></code>
99104
</p>
@@ -147,10 +152,10 @@ <h3>Method Details</h3>
147152
An object of the form:
148153

149154
{ # Response of the auto-complete query.
150-
&quot;attributionToken&quot;: &quot;A String&quot;, # A unique complete token. This should be included in the SearchRequest resulting from this completion, which enables accurate attribution of complete model performance.
155+
&quot;attributionToken&quot;: &quot;A String&quot;, # A unique complete token. This should be included in the UserEvent.completion_detail for search events resulting from this completion, which enables accurate attribution of complete model performance.
151156
&quot;completionResults&quot;: [ # Results of the matching suggestions. The result list is ordered and the first result is top suggestion.
152157
{ # Resource that represents completion results.
153-
&quot;attributes&quot;: { # Additional custom attributes ingested through BigQuery.
158+
&quot;attributes&quot;: { # Custom attributes for the suggestion term. * For &quot;user-data&quot;, the attributes are additional custom attributes ingested through BigQuery. * For &quot;cloud-retail&quot;, the attributes are product attributes generated by Cloud Retail.
154159
&quot;a_key&quot;: { # A custom attribute that is not explicitly modeled in Product.
155160
&quot;indexable&quot;: True or False, # This field will only be used when AttributesConfig.attribute_config_level of the Catalog is &#x27;PRODUCT_LEVEL_ATTRIBUTE_CONFIG&#x27;, if true, custom attribute values are indexed, so that it can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details.
156161
&quot;numbers&quot;: [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is &quot;lengths_cm&quot;. Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.
@@ -299,7 +304,7 @@ <h3>Method Details</h3>
299304
Returns:
300305
An object of the form:
301306

302-
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
307+
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
303308
}</pre>
304309
</div>
305310

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ <h3>Method Details</h3>
9797
<pre>Makes a recommendation prediction.
9898

9999
Args:
100-
placement: string, Required. Full resource name of the format: {name=projects/*/locations/global/catalogs/default_catalog/placements/*} The ID of the Recommendations AI placement. Before you can request predictions from your model, you must create at least one placement for it. For more information, see [Managing placements](https://cloud.google.com/retail/recommendations-ai/docs/manage-placements). The full list of available placements can be seen at https://console.cloud.google.com/recommendation/catalogs/default_catalog/placements (required)
100+
placement: string, Required. Full resource name of the format: {name=projects/*/locations/global/catalogs/default_catalog/placements/*} or {name=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*} The ID of the Recommendations AI placement. Before you can request predictions from your model, you must create at least one placement for it. For more information, see [Managing placements](https://cloud.google.com/retail/recommendations-ai/docs/manage-placements). The full list of available placements can be seen at https://console.cloud.google.com/recommendation/catalogs/default_catalog/placements (required)
101101
body: object, The request body.
102102
The object takes the form of:
103103

@@ -322,7 +322,7 @@ <h3>Method Details</h3>
322322
<pre>Performs a search. This feature is only available for users who have Retail Search enabled. Please submit a form [here](https://cloud.google.com/contact) to contact cloud sales if you are interested in using Retail Search.
323323

324324
Args:
325-
placement: string, Required. The resource name of the search engine placement, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search`. This field is used to identify the serving configuration name and the set of models that will be used to make the search. (required)
325+
placement: string, Required. The resource name of the search engine placement, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search` or `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving configuration name and the set of models that will be used to make the search. (required)
326326
body: object, The request body.
327327
The object takes the form of:
328328

0 commit comments

Comments
 (0)