Package types (0.3.3)

Version 0.3.3

• 0.10.10 (latest)
• 0.10.9
• 0.9.0
• 0.8.2
• 0.7.1
• 0.6.2
• 0.5.1
• 0.4.0
• 0.3.3
• 0.2.2
• 0.1.0

API documentation for recommendationengine_v1beta1.types package.

Classes

CatalogInlineSource

The inline source for the input config for ImportCatalogItems method.

CatalogItem

CatalogItem captures all metadata information of items to be recommended.

CollectUserEventRequest

Request message for CollectUserEvent method. .. attribute:: parent

Required. The parent eventStore name, such as projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store.

:type: str

CreateCatalogItemRequest

Request message for CreateCatalogItem method. .. attribute:: parent

Required. The parent catalog resource name, such as projects/*/locations/global/catalogs/default_catalog.

:type: str

CreatePredictionApiKeyRegistrationRequest

Request message for the CreatePredictionApiKeyRegistration method.

DeleteCatalogItemRequest

Request message for DeleteCatalogItem method. .. attribute:: name

Required. Full resource name of catalog item, such as projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id.

:type: str

DeletePredictionApiKeyRegistrationRequest

Request message for DeletePredictionApiKeyRegistration method. .. attribute:: name

Required. The API key to unregister including full resource path. projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/<YOUR_API_KEY>

:type: str

EventDetail

User event details shared by all recommendation types. .. attribute:: uri

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: str

FeatureMap

FeatureMap represents extra features that customers want to include in the recommendation model for catalogs/user events as categorical/numerical features.

GcsSource

Google Cloud Storage location for input content. format.

GetCatalogItemRequest

Request message for GetCatalogItem method. .. attribute:: name

Required. Full resource name of catalog item, such as projects/*/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id.

:type: str

Image

Catalog item thumbnail/detail image. .. attribute:: uri

Required. URL of the image with a length limit of 5 KiB.

:type: str

ImportCatalogItemsRequest

Request message for Import methods. .. attribute:: parent

Required. projects/1234/locations/global/catalogs/default_catalog

:type: str

ImportCatalogItemsResponse

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.

ImportErrorsConfig

Configuration of destination for Import related errors. .. attribute:: gcs_prefix

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: str

ImportMetadata

Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.

ImportUserEventsRequest

Request message for the ImportUserEvents request. .. attribute:: parent

Required. projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store

:type: str

ImportUserEventsResponse

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.

InputConfig

The input config source. .. attribute:: catalog_inline_source

The Inline source for the input content for Catalog items.

:type: google.cloud.recommendationengine_v1beta1.types.CatalogInlineSource

ListCatalogItemsRequest

Request message for ListCatalogItems method. .. attribute:: parent

Required. The parent catalog resource name, such as projects/*/locations/global/catalogs/default_catalog.

:type: str

ListCatalogItemsResponse

Response message for ListCatalogItems method. .. attribute:: catalog_items

The catalog items.

:type: Sequence[google.cloud.recommendationengine_v1beta1.types.CatalogItem]

ListPredictionApiKeyRegistrationsRequest

Request message for the ListPredictionApiKeyRegistrations. .. attribute:: parent

Required. The parent placement resource name such as projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store

:type: str

ListPredictionApiKeyRegistrationsResponse

Response message for the ListPredictionApiKeyRegistrations. .. attribute:: prediction_api_key_registrations

The list of registered API keys.

:type: Sequence[google.cloud.recommendationengine_v1beta1.types.PredictionApiKeyRegistration]

ListUserEventsRequest

Request message for ListUserEvents method. .. attribute:: parent

Required. The parent eventStore resource name, such as projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store.

:type: str

ListUserEventsResponse

Response message for ListUserEvents method. .. attribute:: user_events

The user events.

:type: Sequence[google.cloud.recommendationengine_v1beta1.types.UserEvent]

PredictRequest

Request message for Predict method. .. attribute:: name

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

  :type: str

PredictResponse

Response message for predict method. .. attribute:: results

A list of recommended items. The order represents the ranking (from the most relevant item to the least).

:type: Sequence[google.cloud.recommendationengine_v1beta1.types.PredictResponse.PredictionResult]

PredictionApiKeyRegistration

Registered Api Key. .. attribute:: api_key

The API key.

:type: str

ProductCatalogItem

ProductCatalogItem captures item metadata specific to retail products.

ProductDetail

Detailed product information associated with a user event. .. attribute:: id

Required. Catalog item ID. UTF-8 encoded string with a length limit of 128 characters.

:type: str

ProductEventDetail

ProductEventDetail captures user event information specific to retail products.

PurchaseTransaction

A transaction represents the entire purchase transaction. .. attribute:: id

Optional. The transaction ID with a length limit of 128 bytes.

:type: str

PurgeUserEventsMetadata

Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.

PurgeUserEventsRequest

Request message for PurgeUserEvents method. .. attribute:: parent

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}

:type: str

PurgeUserEventsResponse

Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

UpdateCatalogItemRequest

Request message for UpdateCatalogItem method. .. attribute:: name

Required. Full resource name of catalog item, such as projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id

:type: str

UserEvent

UserEvent captures all metadata information recommendation engine needs to know about how end users interact with customers' website.

UserEventImportSummary

A summary of import result. The UserEventImportSummary summarizes the import status for user events.

UserEventInlineSource

The inline source for the input config for ImportUserEvents method.

UserInfo

Information of end users. .. attribute:: visitor_id

Required. A unique identifier for tracking visitors with a length limit of 128 bytes.

For example, this could be implemented with a http cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Maximum length 128 bytes. Cannot be empty.

:type: str

WriteUserEventRequest

Request message for WriteUserEvent method. .. attribute:: parent

Required. The parent eventStore resource name, such as projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store.

:type: str