chore(recommendationengine): update the api

#### recommendationengine:v1beta1 The following keys were changed: - description (Total Keys: 1) - resources.projects.resources.locations.resources.catalogs.resources.eventStores.resources.placements.methods.predict (Total Keys: 1) - revision (Total Keys: 1) - schemas.GoogleCloudRecommendationengineV1beta1ProductEventDetail.properties.pageCategories (Total Keys: 1) - schemas.GoogleCloudRecommendationengineV1beta1ProductEventDetail.properties.searchQuery (Total Keys: 1) - title (Total Keys: 1)
googleapis · Mar 3, 2021 · e6ace9e · e6ace9e
1 parent 6e4c87a
commit e6ace9e
Show file tree

Hide file tree

Showing 12 changed files with 1,996 additions and 1,996 deletions.
diff --git a/docs/dyn/recommendationengine_v1beta1.html b/docs/dyn/recommendationengine_v1beta1.html
@@ -72,7 +72,7 @@
 
 </style>
 
-<h1><a href="recommendationengine_v1beta1.html">Recommendations AI</a></h1>
+<h1><a href="recommendationengine_v1beta1.html">Recommendations AI (Beta)</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="recommendationengine_v1beta1.projects.html">projects()</a></code>

diff --git a/docs/dyn/recommendationengine_v1beta1.projects.html b/docs/dyn/recommendationengine_v1beta1.projects.html
@@ -72,7 +72,7 @@
 
 </style>
 
-<h1><a href="recommendationengine_v1beta1.html">Recommendations AI</a> . <a href="recommendationengine_v1beta1.projects.html">projects</a></h1>
+<h1><a href="recommendationengine_v1beta1.html">Recommendations AI (Beta)</a> . <a href="recommendationengine_v1beta1.projects.html">projects</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="recommendationengine_v1beta1.projects.locations.html">locations()</a></code>

diff --git a/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.catalogItems.html b/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.catalogItems.html
@@ -72,7 +72,7 @@
 
 </style>
 
-<h1><a href="recommendationengine_v1beta1.html">Recommendations AI</a> . <a href="recommendationengine_v1beta1.projects.html">projects</a> . <a href="recommendationengine_v1beta1.projects.locations.html">locations</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.html">catalogs</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.catalogItems.html">catalogItems</a></h1>
+<h1><a href="recommendationengine_v1beta1.html">Recommendations AI (Beta)</a> . <a href="recommendationengine_v1beta1.projects.html">projects</a> . <a href="recommendationengine_v1beta1.projects.locations.html">locations</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.html">catalogs</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.catalogItems.html">catalogItems</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#close">close()</a></code></p>
@@ -451,7 +451,7 @@ <h3>Method Details</h3>
           &quot;productEventDetail&quot;: { # ProductEventDetail captures user event information specific to retail products. # Optional. Retail product specific user event metadata. This field is required for the following event types: * `add-to-cart` * `add-to-list` * `category-page-view` * `checkout-start` * `detail-page-view` * `purchase-complete` * `refund` * `remove-from-cart` * `remove-from-list` * `search` This field is optional for the following event types: * `page-visit` * `shopping-cart-page-view` - note that &#x27;product_event_detail&#x27; should be set for this unless the shopping cart is empty. This field is not allowed for the following event types: * `home-page-view`
             &quot;cartId&quot;: &quot;A String&quot;, # Optional. The id or name of the associated shopping cart. This id is used to associate multiple items added or present in the cart before purchase. This can only be set for `add-to-cart`, `remove-from-cart`, `checkout-start`, `purchase-complete`, or `shopping-cart-page-view` events.
             &quot;listId&quot;: &quot;A String&quot;, # Required for `add-to-list` and `remove-from-list` events. The id or name of the list that the item is being added to or removed from. Other event types should not set this field.
-            &quot;pageCategories&quot;: [ # Required for `category-page-view` events. Other event types should not set this field. The categories associated with a category page. Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: categories : [&quot;Sales&quot;, &quot;2017 Black Friday Deals&quot;].
+            &quot;pageCategories&quot;: [ # Required for `category-page-view` events. At least one of search_query or page_categories is required for `search` events. Other event types should not set this field. The categories associated with a category page. Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: categories : [&quot;Sales&quot;, &quot;2017 Black Friday Deals&quot;].
               { # Category represents catalog item category hierarchy.
                 &quot;categories&quot;: [ # Required. Catalog item categories. Each category should be a UTF-8 encoded string with a length limit of 2 KiB. Note that the order in the list denotes the specificity (from least to most specific).
                   &quot;A String&quot;,
@@ -496,7 +496,7 @@ <h3>Method Details</h3>
                 &quot;a_key&quot;: 3.14,
               },
             },
-            &quot;searchQuery&quot;: &quot;A String&quot;, # Required for `search` events. Other event types should not set this field. The user&#x27;s search query as UTF-8 encoded text with a length limit of 5 KiB.
+            &quot;searchQuery&quot;: &quot;A String&quot;, # At least one of search_query or page_categories is required for `search` events. Other event types should not set this field. The user&#x27;s search query as UTF-8 encoded text with a length limit of 5 KiB.
           },
           &quot;userInfo&quot;: { # Information of end users. # Required. User information.
             &quot;directUserRequest&quot;: True or False, # Optional. Indicates if the request is made directly from the end user in which case the user_agent and ip_address fields can be populated from the HTTP request. This should *not* be set when using the javascript pixel. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events).

diff --git a/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.eventStores.html b/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.eventStores.html
@@ -72,7 +72,7 @@
 
 </style>
 
-<h1><a href="recommendationengine_v1beta1.html">Recommendations AI</a> . <a href="recommendationengine_v1beta1.projects.html">projects</a> . <a href="recommendationengine_v1beta1.projects.locations.html">locations</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.html">catalogs</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.eventStores.html">eventStores</a></h1>
+<h1><a href="recommendationengine_v1beta1.html">Recommendations AI (Beta)</a> . <a href="recommendationengine_v1beta1.projects.html">projects</a> . <a href="recommendationengine_v1beta1.projects.locations.html">locations</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.html">catalogs</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.eventStores.html">eventStores</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="recommendationengine_v1beta1.projects.locations.catalogs.eventStores.operations.html">operations()</a></code>

diff --git a/.../dyn/recommendationengine_v1beta1.projects.locations.catalogs.eventStores.operations.html b/.../dyn/recommendationengine_v1beta1.projects.locations.catalogs.eventStores.operations.html
@@ -72,7 +72,7 @@
 
 </style>
 
-<h1><a href="recommendationengine_v1beta1.html">Recommendations AI</a> . <a href="recommendationengine_v1beta1.projects.html">projects</a> . <a href="recommendationengine_v1beta1.projects.locations.html">locations</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.html">catalogs</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.eventStores.html">eventStores</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.eventStores.operations.html">operations</a></h1>
+<h1><a href="recommendationengine_v1beta1.html">Recommendations AI (Beta)</a> . <a href="recommendationengine_v1beta1.projects.html">projects</a> . <a href="recommendationengine_v1beta1.projects.locations.html">locations</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.html">catalogs</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.eventStores.html">eventStores</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.eventStores.operations.html">operations</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#close">close()</a></code></p>

diff --git a/.../dyn/recommendationengine_v1beta1.projects.locations.catalogs.eventStores.placements.html b/.../dyn/recommendationengine_v1beta1.projects.locations.catalogs.eventStores.placements.html
@@ -72,14 +72,14 @@
 
 </style>
 
-<h1><a href="recommendationengine_v1beta1.html">Recommendations AI</a> . <a href="recommendationengine_v1beta1.projects.html">projects</a> . <a href="recommendationengine_v1beta1.projects.locations.html">locations</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.html">catalogs</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.eventStores.html">eventStores</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.eventStores.placements.html">placements</a></h1>
+<h1><a href="recommendationengine_v1beta1.html">Recommendations AI (Beta)</a> . <a href="recommendationengine_v1beta1.projects.html">projects</a> . <a href="recommendationengine_v1beta1.projects.locations.html">locations</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.html">catalogs</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.eventStores.html">eventStores</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.eventStores.placements.html">placements</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#close">close()</a></code></p>
 <p class="firstline">Close httplib2 connections.</p>
 <p class="toc_element">
   <code><a href="#predict">predict(name, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Makes a recommendation prediction. If using API Key based authentication, the API Key must be registered using the PredictionApiKeyRegistry service. [Learn more](/recommendations-ai/docs/setting-up#register-key).</p>
+<p class="firstline">Makes a recommendation prediction. If using API Key based authentication, the API Key must be registered using the PredictionApiKeyRegistry service. [Learn more](https://cloud.google.com/recommendations-ai/docs/setting-up#register-key).</p>
 <p class="toc_element">
   <code><a href="#predict_next">predict_next(previous_request, previous_response)</a></code></p>
 <p class="firstline">Retrieves the next page of results.</p>
@@ -91,7 +91,7 @@ <h3>Method Details</h3>
 
 <div class="method">
     <code class="details" id="predict">predict(name, body=None, x__xgafv=None)</code>
-  <pre>Makes a recommendation prediction. If using API Key based authentication, the API Key must be registered using the PredictionApiKeyRegistry service. [Learn more](/recommendations-ai/docs/setting-up#register-key).
+  <pre>Makes a recommendation prediction. If using API Key based authentication, the API Key must be registered using the PredictionApiKeyRegistry service. [Learn more](https://cloud.google.com/recommendations-ai/docs/setting-up#register-key).
 
 Args:
   name: string, Required. Full resource name of the format: {name=projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/*} The id of the recommendation engine placement. This id is used to identify the set of models that will be used to make the prediction. We currently support three placements with the following IDs by default: * `shopping_cart`: Predicts items frequently bought together with one or more catalog items in the same shopping session. Commonly displayed after `add-to-cart` events, on product detail pages, or on the shopping cart page. * `home_page`: Predicts the next product that a user will most likely engage with or purchase based on the shopping or viewing history of the specified `userId` or `visitorId`. For example - Recommendations for you. * `product_detail`: Predicts the next product that a user will most likely engage with or purchase. The prediction is based on the shopping or viewing history of the specified `userId` or `visitorId` and its relevance to a specified `CatalogItem`. Typically used on product detail pages. For example - More items like this. * `recently_viewed_default`: Returns up to 75 items recently viewed by the specified `userId` or `visitorId`, most recent ones first. Returns nothing if neither of them has viewed any items yet. For example - Recently viewed. The full list of available placements can be seen at https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard (required)
@@ -141,7 +141,7 @@ <h3>Method Details</h3>
     &quot;productEventDetail&quot;: { # ProductEventDetail captures user event information specific to retail products. # Optional. Retail product specific user event metadata. This field is required for the following event types: * `add-to-cart` * `add-to-list` * `category-page-view` * `checkout-start` * `detail-page-view` * `purchase-complete` * `refund` * `remove-from-cart` * `remove-from-list` * `search` This field is optional for the following event types: * `page-visit` * `shopping-cart-page-view` - note that &#x27;product_event_detail&#x27; should be set for this unless the shopping cart is empty. This field is not allowed for the following event types: * `home-page-view`
       &quot;cartId&quot;: &quot;A String&quot;, # Optional. The id or name of the associated shopping cart. This id is used to associate multiple items added or present in the cart before purchase. This can only be set for `add-to-cart`, `remove-from-cart`, `checkout-start`, `purchase-complete`, or `shopping-cart-page-view` events.
       &quot;listId&quot;: &quot;A String&quot;, # Required for `add-to-list` and `remove-from-list` events. The id or name of the list that the item is being added to or removed from. Other event types should not set this field.
-      &quot;pageCategories&quot;: [ # Required for `category-page-view` events. Other event types should not set this field. The categories associated with a category page. Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: categories : [&quot;Sales&quot;, &quot;2017 Black Friday Deals&quot;].
+      &quot;pageCategories&quot;: [ # Required for `category-page-view` events. At least one of search_query or page_categories is required for `search` events. Other event types should not set this field. The categories associated with a category page. Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: categories : [&quot;Sales&quot;, &quot;2017 Black Friday Deals&quot;].
         { # Category represents catalog item category hierarchy.
           &quot;categories&quot;: [ # Required. Catalog item categories. Each category should be a UTF-8 encoded string with a length limit of 2 KiB. Note that the order in the list denotes the specificity (from least to most specific).
             &quot;A String&quot;,
@@ -186,7 +186,7 @@ <h3>Method Details</h3>
           &quot;a_key&quot;: 3.14,
         },
       },
-      &quot;searchQuery&quot;: &quot;A String&quot;, # Required for `search` events. Other event types should not set this field. The user&#x27;s search query as UTF-8 encoded text with a length limit of 5 KiB.
+      &quot;searchQuery&quot;: &quot;A String&quot;, # At least one of search_query or page_categories is required for `search` events. Other event types should not set this field. The user&#x27;s search query as UTF-8 encoded text with a length limit of 5 KiB.
     },
     &quot;userInfo&quot;: { # Information of end users. # Required. User information.
       &quot;directUserRequest&quot;: True or False, # Optional. Indicates if the request is made directly from the end user in which case the user_agent and ip_address fields can be populated from the HTTP request. This should *not* be set when using the javascript pixel. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events).

diff --git a/...engine_v1beta1.projects.locations.catalogs.eventStores.predictionApiKeyRegistrations.html b/...engine_v1beta1.projects.locations.catalogs.eventStores.predictionApiKeyRegistrations.html
@@ -72,7 +72,7 @@
 
 </style>
 
-<h1><a href="recommendationengine_v1beta1.html">Recommendations AI</a> . <a href="recommendationengine_v1beta1.projects.html">projects</a> . <a href="recommendationengine_v1beta1.projects.locations.html">locations</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.html">catalogs</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.eventStores.html">eventStores</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.eventStores.predictionApiKeyRegistrations.html">predictionApiKeyRegistrations</a></h1>
+<h1><a href="recommendationengine_v1beta1.html">Recommendations AI (Beta)</a> . <a href="recommendationengine_v1beta1.projects.html">projects</a> . <a href="recommendationengine_v1beta1.projects.locations.html">locations</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.html">catalogs</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.eventStores.html">eventStores</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.eventStores.predictionApiKeyRegistrations.html">predictionApiKeyRegistrations</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#close">close()</a></code></p>