| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </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></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="recommendationengine_v1beta1.projects.locations.catalogs.catalogItems.html">catalogItems()</a></code> |
| </p> |
| <p class="firstline">Returns the catalogItems Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="recommendationengine_v1beta1.projects.locations.catalogs.eventStores.html">eventStores()</a></code> |
| </p> |
| <p class="firstline">Returns the eventStores Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="recommendationengine_v1beta1.projects.locations.catalogs.operations.html">operations()</a></code> |
| </p> |
| <p class="firstline">Returns the operations Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists all the catalog configurations associated with the project.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates the catalog configuration.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists all the catalog configurations associated with the project. |
| |
| Args: |
| parent: string, Required. The account resource name with an associated location. (required) |
| pageSize: integer, Optional. Maximum number of results to return. If unspecified, defaults |
| to 50. Max allowed value is 1000. |
| pageToken: string, Optional. A page token, received from a previous `ListCatalogs` |
| call. Provide this to retrieve the subsequent page. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response for ListCatalogs method. |
| "catalogs": [ # Output only. All the customer's catalogs. |
| { # The catalog configuration. |
| # Next ID: 5. |
| "defaultEventStoreId": "A String", # Required. The id of the default event store. |
| "displayName": "A String", # Required. The catalog display name. |
| "name": "A String", # The fully qualified resource name of the catalog. |
| "catalogItemLevelConfig": { # Configures what level the catalog should be uploaded with regards to # Required. The catalog item level configuration. |
| # how users will be send events and how predictions will be made. |
| "eventItemLevel": "A String", # Optional. What level of the catalog are events uploaded at. |
| # See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels |
| # for more details. |
| "predictItemLevel": "A String", # Optional. What level of the catalog are predictions made at. |
| # See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels |
| # for more details. |
| }, |
| }, |
| ], |
| "nextPageToken": "A String", # Pagination token, if not returned indicates the last page. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Updates the catalog configuration. |
| |
| Args: |
| name: string, The fully qualified resource name of the catalog. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # The catalog configuration. |
| # Next ID: 5. |
| "defaultEventStoreId": "A String", # Required. The id of the default event store. |
| "displayName": "A String", # Required. The catalog display name. |
| "name": "A String", # The fully qualified resource name of the catalog. |
| "catalogItemLevelConfig": { # Configures what level the catalog should be uploaded with regards to # Required. The catalog item level configuration. |
| # how users will be send events and how predictions will be made. |
| "eventItemLevel": "A String", # Optional. What level of the catalog are events uploaded at. |
| # See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels |
| # for more details. |
| "predictItemLevel": "A String", # Optional. What level of the catalog are predictions made at. |
| # See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels |
| # for more details. |
| }, |
| } |
| |
| updateMask: string, Optional. Indicates which fields in the provided 'recommendation_model' to |
| update. If not set, will only update the catalog_item_level_config field. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The catalog configuration. |
| # Next ID: 5. |
| "defaultEventStoreId": "A String", # Required. The id of the default event store. |
| "displayName": "A String", # Required. The catalog display name. |
| "name": "A String", # The fully qualified resource name of the catalog. |
| "catalogItemLevelConfig": { # Configures what level the catalog should be uploaded with regards to # Required. The catalog item level configuration. |
| # how users will be send events and how predictions will be made. |
| "eventItemLevel": "A String", # Optional. What level of the catalog are events uploaded at. |
| # See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels |
| # for more details. |
| "predictItemLevel": "A String", # Optional. What level of the catalog are predictions made at. |
| # See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels |
| # for more details. |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |
