openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 83.3 kB
JSON
{"openapi":"3.0.0","servers":[{"url":"https://recommendationengine.googleapis.com/"}],"info":{"contact":{"name":"Google","url":"https://google.com","x-twitter":"youtube"},"description":"Note that we now highly recommend new customers to use Retail API, which incorporates the GA version of the Recommendations AI funtionalities. To enable Retail API, please visit https://console.cloud.google.com/apis/library/retail.googleapis.com. The Recommendations AI service enables customers to build end-to-end personalized recommendation systems without requiring a high level of expertise in machine learning, recommendation system, or Google Cloud.","license":{"name":"Creative Commons Attribution 3.0","url":"http://creativecommons.org/licenses/by/3.0/"},"termsOfService":"https://developers.google.com/terms/","title":"Recommendations AI (Beta)","version":"v1beta1","x-apisguru-categories":["analytics","media"],"x-logo":{"url":"https://upload.wikimedia.org/wikipedia/commons/e/e1/YouTube_play_buttom_icon_%282013-2017%29.svg"},"x-origin":[{"format":"google","url":"https://recommendationengine.googleapis.com/$discovery/rest?version=v1beta1","version":"v1"}],"x-providerName":"googleapis.com","x-serviceName":"recommendationengine"},"externalDocs":{"url":"https://cloud.google.com/recommendations-ai/docs"},"tags":[{"name":"projects"}],"paths":{"/v1beta1/{name}":{"delete":{"description":"Unregister an apiKey from using for predict method.","operationId":"recommendationengine.projects.locations.catalogs.eventStores.predictionApiKeyRegistrations.delete","parameters":[{"description":"Required. The API key to unregister including full resource path. `projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/`","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleProtobufEmpty"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"get":{"description":"Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.","operationId":"recommendationengine.projects.locations.catalogs.operations.get","parameters":[{"description":"The name of the operation resource.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningOperation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"patch":{"description":"Updates a catalog item. Partial updating is supported. Non-existing items will be created.","operationId":"recommendationengine.projects.locations.catalogs.catalogItems.patch","parameters":[{"description":"Required. Full resource name of catalog item, such as `projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id`.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"Optional. Indicates which fields in the provided 'item' to update. If not set, will by default update all fields.","in":"query","name":"updateMask","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1CatalogItem"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1CatalogItem"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1beta1/{name}/operations":{"get":{"description":"Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.","operationId":"recommendationengine.projects.locations.catalogs.operations.list","parameters":[{"description":"The name of the operation's parent resource.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"The standard list filter.","in":"query","name":"filter","schema":{"type":"string"}},{"description":"The standard list page size.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"The standard list page token.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningListOperationsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/v1beta1/{name}:predict":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"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).","operationId":"recommendationengine.projects.locations.catalogs.eventStores.placements.predict","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1PredictRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1PredictResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1beta1/{parent}/catalogItems":{"get":{"description":"Gets a list of catalog items.","operationId":"recommendationengine.projects.locations.catalogs.catalogItems.list","parameters":[{"description":"Required. The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"Optional. Use of this field is not supported by version v1beta1.","in":"query","name":"filter","schema":{"type":"string"}},{"description":"Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Optional. The previous ListCatalogItemsResponse.next_page_token.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1ListCatalogItemsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Creates a catalog item.","operationId":"recommendationengine.projects.locations.catalogs.catalogItems.create","parameters":[{"description":"Required. The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1CatalogItem"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1CatalogItem"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1beta1/{parent}/catalogItems:import":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Bulk import of multiple catalog items. Request processing may be synchronous. No partial updating supported. Non-existing items will be created. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully updated.","operationId":"recommendationengine.projects.locations.catalogs.catalogItems.import","parameters":[{"description":"Required. `projects/1234/locations/global/catalogs/default_catalog` If no updateMask is specified, requires catalogItems.create permission. If updateMask is specified, requires catalogItems.update permission.","in":"path","name":"parent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1ImportCatalogItemsRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningOperation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1beta1/{parent}/catalogs":{"get":{"description":"Lists all the catalog configurations associated with the project.","operationId":"recommendationengine.projects.locations.catalogs.list","parameters":[{"description":"Required. The account resource name with an associated location.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Optional. A page token, received from a previous `ListCatalogs` call. Provide this to retrieve the subsequent page.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1ListCatalogsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/v1beta1/{parent}/predictionApiKeyRegistrations":{"get":{"description":"List the registered apiKeys for use with predict method.","operationId":"recommendationengine.projects.locations.catalogs.eventStores.predictionApiKeyRegistrations.list","parameters":[{"description":"Required. The parent placement resource name such as `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"Optional. Maximum number of results to return per page. If unset, the service will choose a reasonable default.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Optional. The previous `ListPredictionApiKeyRegistration.nextPageToken`.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1ListPredictionApiKeyRegistrationsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Register an API key for use with predict method.","operationId":"recommendationengine.projects.locations.catalogs.eventStores.predictionApiKeyRegistrations.create","parameters":[{"description":"Required. The parent resource path. `projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1CreatePredictionApiKeyRegistrationRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1PredictionApiKeyRegistration"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1beta1/{parent}/userEvents":{"get":{"description":"Gets a list of user events within a time range, with potential filtering. The method does not list unjoined user events. Unjoined user event definition: when a user event is ingested from Recommendations AI User Event APIs, the catalog item included in the user event is connected with the current catalog. If a catalog item of the ingested event is not in the current catalog, it could lead to degraded model quality. This is called an unjoined event.","operationId":"recommendationengine.projects.locations.catalogs.eventStores.userEvents.list","parameters":[{"description":"Required. The parent eventStore resource name, such as `projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"Optional. Filtering expression to specify restrictions over returned events. This is a sequence of terms, where each term applies some kind of a restriction to the returned user events. Use this expression to restrict results to a specific time range, or filter events by eventType. eg: eventTime > \"2012-04-23T18:25:43.511Z\" eventsMissingCatalogItems eventTime<\"2012-04-23T18:25:43.511Z\" eventType=search We expect only 3 types of fields: * eventTime: this can be specified a maximum of 2 times, once with a less than operator and once with a greater than operator. The eventTime restrict should result in one contiguous valid eventTime range. * eventType: only 1 eventType restriction can be specified. * eventsMissingCatalogItems: specififying this will restrict 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 = search eventTime < \"2018-04-23T18:30:43.511Z\" * Example 4: eventTime > \"2012-04-23T18:25:43.511Z\" * Example 5: eventType = search * Example 6: eventsMissingCatalogItems","in":"query","name":"filter","schema":{"type":"string"}},{"description":"Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Optional. The previous ListUserEventsResponse.next_page_token.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1ListUserEventsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/v1beta1/{parent}/userEvents:collect":{"get":{"description":"Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Recommendations AI JavaScript pixel. Users should not call this method directly.","operationId":"recommendationengine.projects.locations.catalogs.eventStores.userEvents.collect","parameters":[{"description":"Required. The parent eventStore name, such as `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"Optional. The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.","in":"query","name":"ets","schema":{"type":"string"}},{"description":"Optional. The url including cgi-parameters but excluding the hash fragment. The URL must be truncated to 1.5K bytes to conservatively be under the 2K bytes. This is often more useful than the referer url, because many browsers only send the domain for 3rd party requests.","in":"query","name":"uri","schema":{"type":"string"}},{"description":"Required. URL encoded UserEvent proto.","in":"query","name":"userEvent","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleApiHttpBody"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/v1beta1/{parent}/userEvents:import":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"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.","operationId":"recommendationengine.projects.locations.catalogs.eventStores.userEvents.import","parameters":[{"description":"Required. `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`","in":"path","name":"parent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1ImportUserEventsRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningOperation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1beta1/{parent}/userEvents:purge":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.","operationId":"recommendationengine.projects.locations.catalogs.eventStores.userEvents.purge","parameters":[{"description":"Required. The resource name of the event_store under which the events are created. The format is `projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}`","in":"path","name":"parent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningOperation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1beta1/{parent}/userEvents:rejoin":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Triggers a user event rejoin operation with latest catalog data. Events will not be annotated with detailed catalog information if catalog item is missing at the time the user event is ingested, and these events are stored as unjoined events with a limited usage on training and serving. This API can be used to trigger a 'join' operation on specified events with latest version of catalog items. It can also be used to correct events joined with wrong catalog items.","operationId":"recommendationengine.projects.locations.catalogs.eventStores.userEvents.rejoin","parameters":[{"description":"Required. Full resource name of user event, such as `projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1RejoinUserEventsRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningOperation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1beta1/{parent}/userEvents:write":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Writes a single user event.","operationId":"recommendationengine.projects.locations.catalogs.eventStores.userEvents.write","parameters":[{"description":"Required. The parent eventStore resource name, such as \"projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store\".","in":"path","name":"parent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1UserEvent"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1UserEvent"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}}},"components":{"parameters":{"_.xgafv":{"description":"V1 error format.","in":"query","name":"$.xgafv","schema":{"enum":["1","2"],"type":"string"}},"access_token":{"description":"OAuth access token.","in":"query","name":"access_token","schema":{"type":"string"}},"alt":{"description":"Data format for response.","in":"query","name":"alt","schema":{"enum":["json","media","proto"],"type":"string"}},"callback":{"description":"JSONP","in":"query","name":"callback","schema":{"type":"string"}},"fields":{"description":"Selector specifying which fields to include in a partial response.","in":"query","name":"fields","schema":{"type":"string"}},"key":{"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","in":"query","name":"key","schema":{"type":"string"}},"oauth_token":{"description":"OAuth 2.0 token for the current user.","in":"query","name":"oauth_token","schema":{"type":"string"}},"prettyPrint":{"description":"Returns response with indentations and line breaks.","in":"query","name":"prettyPrint","schema":{"type":"boolean"}},"quotaUser":{"description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","in":"query","name":"quotaUser","schema":{"type":"string"}},"uploadType":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","in":"query","name":"uploadType","schema":{"type":"string"}},"upload_protocol":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","in":"query","name":"upload_protocol","schema":{"type":"string"}}},"schemas":{"GoogleApiHttpBody":{"description":"Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.","properties":{"contentType":{"description":"The HTTP Content-Type header value specifying the content type of the body.","type":"string"},"data":{"description":"The HTTP request/response body as raw binary.","format":"byte","type":"string"},"extensions":{"description":"Application specific response metadata. Must be set in the first response for streaming APIs.","items":{"additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."},"type":"object"},"type":"array"}},"type":"object"},"GoogleCloudRecommendationengineV1alphaRejoinCatalogMetadata":{"description":"Metadata for TriggerCatalogRejoin method.","properties":{},"type":"object"},"GoogleCloudRecommendationengineV1alphaRejoinCatalogResponse":{"description":"Response message for TriggerCatalogRejoin method.","properties":{"rejoinedUserEventsCount":{"description":"Number of user events that were joined with latest catalog items.","format":"int64","type":"string"}},"type":"object"},"GoogleCloudRecommendationengineV1alphaTuningMetadata":{"description":"Metadata associated with a tune operation.","properties":{"recommendationModel":{"description":"The resource name of the recommendation model that this tune applies to. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/eventStores/{event_store_id}/recommendationModels/{recommendation_model_id}","type":"string"}},"type":"object"},"GoogleCloudRecommendationengineV1alphaTuningResponse":{"description":"Response associated with a tune operation.","properties":{},"type":"object"},"GoogleCloudRecommendationengineV1beta1BigQuerySource":{"description":"BigQuery source import data from.","properties":{"dataSchema":{"description":"Optional. The schema to use when parsing the data from the source. Supported values for catalog imports: 1: \"catalog_recommendations_ai\" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#json (Default for catalogItems.import) 2: \"catalog_merchant_center\" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#mc Supported values for user event imports: 1: \"user_events_recommendations_ai\" using https://cloud.google.com/recommendations-ai/docs/manage-user-events#import (Default for userEvents.import) 2. \"user_events_ga360\" using https://support.google.com/analytics/answer/3437719?hl=en","type":"string"},"datasetId":{"description":"Required. The BigQuery data set to copy the data from.","type":"string"},"gcsStagingDir":{"description":"Optional. Intermediate Cloud Storage directory used for the import. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.","type":"string"},"projectId":{"description":"Optional. The project id (can be project # or id) that the BigQuery source is in. If not specified, inherits the project id from the parent request.","type":"string"},"tableId":{"description":"Required. The BigQuery table to copy the data from.","type":"string"}},"type":"object"},"GoogleCloudRecommendationengineV1beta1Catalog":{"description":"The catalog configuration. Next ID: 5.","properties":{"catalogItemLevelConfig":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1CatalogItemLevelConfig","description":"Required. The catalog item level configuration."},"defaultEventStoreId":{"description":"Required. The ID of the default event store.","type":"string"},"displayName":{"description":"Required. The catalog display name.","type":"string"},"name":{"description":"The fully qualified resource name of the catalog.","type":"string"}},"type":"object"},"GoogleCloudRecommendationengineV1beta1CatalogInlineSource":{"description":"The inline source for the input config for ImportCatalogItems method.","properties":{"catalogItems":{"description":"Optional. A list of catalog items to update/create. Recommended max of 10k items.","items":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1CatalogItem"},"type":"array"}},"type":"object"},"GoogleCloudRecommendationengineV1beta1CatalogItem":{"description":"CatalogItem captures all metadata information of items to be recommended.","properties":{"categoryHierarchies":{"description":"Required. Catalog item categories. This field is repeated for supporting one catalog item belonging to several parallel category hierarchies. For example, if a shoes product belongs to both [\"Shoes & Accessories\" -> \"Shoes\"] and [\"Sports & Fitness\" -> \"Athletic Clothing\" -> \"Shoes\"], it could be represented as: \"categoryHierarchies\": [ { \"categories\": [\"Shoes & Accessories\", \"Shoes\"]}, { \"categories\": [\"Sports & Fitness\", \"Athletic Clothing\", \"Shoes\"] } ]","items":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy"},"type":"array"},"description":{"description":"Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB.","type":"string"},"id":{"description":"Required. Catalog item identifier. UTF-8 encoded string with a length limit of 128 bytes. This id must be unique among all catalog items within the same catalog. It should also be used when logging user events in order for the user events to be joined with the Catalog.","type":"string"},"itemAttributes":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1FeatureMap","description":"Optional. Highly encouraged. Extra catalog item attributes to be included in the recommendation model. For example, for retail products, this could include the store name, vendor, style, color, etc. These are very strong signals for recommendation model, thus we highly recommend providing the item attributes here."},"itemGroupId":{"description":"Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes. This field must be enabled before it can be used. [Learn more](/recommendations-ai/docs/catalog#item-group-id).","type":"string"},"languageCode":{"description":"Optional. Deprecated. The model automatically detects the text language. Your catalog can include text in different languages, but duplicating catalog items to provide text in multiple languages can result in degraded model performance.","type":"string"},"productMetadata":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1ProductCatalogItem","description":"Optional. Metadata specific to retail products."},"tags":{"description":"Optional. Filtering tags associated with the catalog item. Each tag should be a UTF-8 encoded string with a length limit of 1 KiB. This tag can be used for filtering recommendation results by passing the tag as part of the predict request filter.","items":{"type":"string"},"type":"array"},"title":{"description":"Required. Catalog item title. UTF-8 encoded string with a length limit of 1 KiB.","type":"string"}},"type":"object"},"GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy":{"description":"Category represents catalog item category hierarchy.","properties":{"categories":{"description":"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).","items":{"type":"string"},"type":"array"}},"type":"object"},"GoogleCloudRecommendationengineV1beta1CatalogItemLevelConfig":{"description":"Configures the catalog level that users send events to, and the level at which predictions are made.","properties":{"eventItemLevel":{"description":"Optional. Level of the catalog at which events are uploaded. See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels for more details.","enum":["CATALOG_ITEM_LEVEL_UNSPECIFIED","VARIANT","MASTER"],"type":"string"},"predictItemLevel":{"description":"Optional. Level of the catalog at which predictions are made. See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels for more details.","enum":["CATALOG_ITEM_LEVEL_UNSPECIFIED","VARIANT","MASTER"],"type":"string"}},"type":"object"},"GoogleCloudRecommendationengineV1beta1CreatePredictionApiKeyRegistrationRequest":{"description":"Request message for the `CreatePredictionApiKeyRegistration` method.","properties":{"predictionApiKeyRegistration":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1PredictionApiKeyRegistration","description":"Required. The prediction API key registration."}},"type":"object"},"GoogleCloudRecommendationengineV1beta1EventDetail":{"description":"User event details shared by all recommendation types.","properties":{"eventAttributes":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1FeatureMap","description":"Optional. Extra user event features to include in the recommendation model. For product recommendation, an example of extra user information is traffic_channel, i.e. how user arrives at the site. Users can arrive at the site by coming to the site directly, or coming through Google search, and etc."},"experimentIds":{"description":"Optional. A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Recommendation Engine system, using different recommendation models).","items":{"type":"string"},"type":"array"},"pageViewId":{"description":"Optional. A unique id of a web page view. This should be kept the same for all user events triggered from the same pageview. For example, an item detail page view could trigger multiple events as the user is browsing the page. The `pageViewId` property should be kept the same for all these events so that they can be grouped together properly. This `pageViewId` will be automatically generated if using the JavaScript pixel.","type":"string"},"recommendationToken":{"description":"Optional. Recommendation token included in the recommendation prediction response. This field enables accurate attribution of recommendation model performance. This token enables us to accurately attribute page view or purchase back to the event and the particular predict response containing this clicked/purchased item. If user clicks on product K in the recommendation results, pass the `PredictResponse.recommendationToken` property as a url parameter to product K's page. When recording events on product K's page, log the PredictResponse.recommendation_token to this field. Optional, but highly encouraged for user events that are the result of a recommendation prediction query.","type":"string"},"referrerUri":{"description":"Optional. The referrer url of the current page. When using the JavaScript pixel, this value is filled in automatically.","type":"string"},"uri":{"description":"Optional. Complete url (window.location.href) of the user's current page. When using the JavaScript pixel, this value is filled in automatically. Maximum length 5KB.","type":"string"}},"type":"object"},"GoogleCloudRecommendationengineV1beta1FeatureMap":{"description":"FeatureMap represents extra features that customers want to include in the recommendation model for catalogs/user events as categorical/numerical features.","properties":{"categoricalFeatures":{"additionalProperties":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1FeatureMapStringList"},"description":"Categorical features that can take on one of a limited number of possible values. Some examples would be the brand/maker of a product, or country of a customer. Feature names and values must be UTF-8 encoded strings. For example: `{ \"colors\": {\"value\": [\"yellow\", \"green\"]}, \"sizes\": {\"value\":[\"S\", \"M\"]}`","type":"object"},"numericalFeatures":{"additionalProperties":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1FeatureMapFloatList"},"description":"Numerical features. Some examples would be the height/weight of a product, or age of a customer. Feature names must be UTF-8 encoded strings. For example: `{ \"lengths_cm\": {\"value\":[2.3, 15.4]}, \"heights_cm\": {\"value\":[8.1, 6.4]} }`","type":"object"}},"type":"object"},"GoogleCloudRecommendationengineV1beta1FeatureMapFloatList":{"description":"A list of float features.","properties":{"value":{"description":"Float feature value.","items":{"format":"float","type":"number"},"type":"array"}},"type":"object"},"GoogleCloudRecommendationengineV1beta1FeatureMapStringList":{"description":"A list of string features.","properties":{"value":{"description":"String feature value with a length limit of 128 bytes.","items":{"type":"string"},"type":"array"}},"type":"object"},"GoogleCloudRecommendationengineV1beta1GcsSource":{"description":"Google Cloud Storage location for input content. format.","properties":{"inputUris":{"description":"Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing catalog information](/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions.","items":{"type":"string"},"type":"array"},"jsonSchema":{"description":"Optional. The schema to use when parsing the data from the source. Supported values for catalog imports: 1: \"catalog_recommendations_ai\" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#json (Default for catalogItems.import) 2: \"catalog_merchant_center\" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#mc Supported values for user events imports: 1: \"user_events_recommendations_ai\" using https://cloud.google.com/recommendations-ai/docs/manage-user-events#import (Default for userEvents.import) 2. \"user_events_ga360\" using https://support.google.com/analytics/answer/3437719?hl=en","type":"string"}},"type":"object"},"GoogleCloudRecommendationengineV1beta1Image":{"description":"Catalog item thumbnail/detail image.","properties":{"height":{"description":"Optional. Height of the image in number of pixels.","format":"int32","type":"integer"},"uri":{"description":"Required. URL of the image with a length limit of 5 KiB.","type":"string"},"width":{"description":"Optional. Width of the image in number of pixels.","format":"int32","type":"integer"}},"type":"object"},"GoogleCloudRecommendationengineV1beta1ImportCatalogItemsRequest":{"description":"Request message for Import methods.","properties":{"errorsConfig":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1ImportErrorsConfig","description":"Optional. The desired location of errors incurred during the Import."},"inputConfig":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1InputConfig","description":"Required. The desired input location of the data."},"requestId":{"description":"Optional. 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. This is returned as google.longrunning.Operation.name in the response.","type":"string"},"updateMask":{"description":"Optional. Indicates which fields in the provided imported 'items' to update. If not set, will by default update all fields.","format":"google-fieldmask","type":"string"}},"type":"object"},"GoogleCloudRecommendationengineV1beta1ImportCatalogItemsResponse":{"description":"Response of the ImportCatalogItemsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.","properties":{"errorSamples":{"description":"A sample of errors encountered while processing the request.","items":{"$ref":"#/components/schemas/GoogleRpcStatus"},"type":"array"},"errorsConfig":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1ImportErrorsConfig","description":"Echoes the destination for the complete errors in the request if set."}},"type":"object"},"GoogleCloudRecommendationengineV1beta1ImportErrorsConfig":{"description":"Configuration of destination for Import related errors.","properties":{"gcsPrefix":{"description":"Google Cloud Storage path for import errors. This must be an empty, existing Cloud Storage bucket. Import errors will be written to a file in this bucket, one per line, as a JSON-encoded `google.rpc.Status` message.","type":"string"}},"type":"object"},"GoogleCloudRecommendationengineV1beta1ImportMetadata":{"description":"Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.","properties":{"createTime":{"description":"Operation create time.","format":"google-datetime","type":"string"},"failureCount":{"description":"Count of entries that encountered errors while processing.","format":"int64","type":"string"},"operationName":{"description":"Name of the operation.","type":"string"},"requestId":{"description":"Id of the request / operation. This is parroting back the requestId that was passed in the request.","type":"string"},"successCount":{"description":"Count of entries that were processed successfully.","format":"int64","type":"string"},"updateTime":{"description":"Operation last update time. If the operation is done, this is also the finish time.","format":"google-datetime","type":"string"}},"type":"object"},"GoogleCloudRecommendationengineV1beta1ImportUserEventsRequest":{"description":"Request message for the ImportUserEvents request.","properties":{"errorsConfig":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1ImportErrorsConfig","description":"Optional. The desired location of errors incurred during the Import."},"inputConfig":{"$ref":"#/components/schemas/GoogleCloudRecommendationengineV1beta1InputConfig","description":"Required. The desired input location of the data."},"requestId":{"description":"Optional. Unique identifier provided by client, within the ancestor dataset scope. Ensures idempotency for expensive long running operations. Server-generated if unspecified. Up to 128 characters long. This is returned as google.longrunning.Operation.name in the response. Note that this field must not be set if the desired input config is catalog_inline_source.","type":"string"}},"type":"object"},"GoogleCloudRecommendationengineV1beta1ImportUserEventsResponse":{"description":"Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.","properties":{"errorSamples":{"description":"A sample of errors encountered while processing the request.","items":{"$ref":"#/components/schemas/GoogleRpcStatus"},"type":"array"},"error