As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

UserEventService

class google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.recommendationengine_v1beta1.services.user_event_service.transports.base.UserEventServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

Service for ingesting end user actions on the customer website.

Instantiates the user event service client.

Parameters
  • credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

  • transport (Union[str, UserEventServiceTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

async collect_user_event(request: Optional[google.cloud.recommendationengine_v1beta1.types.user_event_service.CollectUserEventRequest] = None, *, parent: Optional[str] = None, user_event: Optional[str] = None, uri: Optional[str] = None, ets: Optional[int] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api.httpbody_pb2.HttpBody[source]

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.

Parameters
  • request (google.cloud.recommendationengine_v1beta1.types.CollectUserEventRequest) – The request object. Request message for CollectUserEvent method.

  • parent (str) –

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • user_event (str) –

    Required. URL encoded UserEvent proto.

    This corresponds to the user_event field on the request instance; if request is provided, this should not be set.

  • uri (str) –

    Optional. The url including cgi- arameters 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.

    This corresponds to the uri field on the request instance; if request is provided, this should not be set.

  • ets (int) –

    Optional. The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.

    This corresponds to the ets field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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.

Return type

google.api.httpbody_pb2.HttpBody

static common_billing_account_path(billing_account: str)str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str

Returns a fully-qualified location string.

static common_organization_path(organization: str)str

Returns a fully-qualified organization string.

static common_project_path(project: str)str

Returns a fully-qualified project string.

static event_store_path(project: str, location: str, catalog: str, event_store: str)str

Returns a fully-qualified event_store string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

UserEventServiceAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

UserEventServiceAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

UserEventServiceAsyncClient

get_transport_class()Type[google.cloud.recommendationengine_v1beta1.services.user_event_service.transports.base.UserEventServiceTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

async import_user_events(request: Optional[google.cloud.recommendationengine_v1beta1.types.import_.ImportUserEventsRequest] = None, *, parent: Optional[str] = None, request_id: Optional[str] = None, input_config: Optional[google.cloud.recommendationengine_v1beta1.types.import_.InputConfig] = None, errors_config: Optional[google.cloud.recommendationengine_v1beta1.types.import_.ImportErrorsConfig] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

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.

Parameters
  • request (google.cloud.recommendationengine_v1beta1.types.ImportUserEventsRequest) – The request object. Request message for the ImportUserEvents request.

  • parent (str) –

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • request_id (str) –

    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.

    This corresponds to the request_id field on the request instance; if request is provided, this should not be set.

  • input_config (google.cloud.recommendationengine_v1beta1.types.InputConfig) –

    Required. The desired input location of the data.

    This corresponds to the input_config field on the request instance; if request is provided, this should not be set.

  • errors_config (google.cloud.recommendationengine_v1beta1.types.ImportErrorsConfig) –

    Optional. The desired location of errors incurred during the Import.

    This corresponds to the errors_config field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.recommendationengine_v1beta1.types.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.

Return type

google.api_core.operation_async.AsyncOperation

async list_user_events(request: Optional[google.cloud.recommendationengine_v1beta1.types.user_event_service.ListUserEventsRequest] = None, *, parent: Optional[str] = None, filter: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.recommendationengine_v1beta1.services.user_event_service.pagers.ListUserEventsAsyncPager[source]

Gets a list of user events within a time range, with potential filtering.

Parameters
  • request (google.cloud.recommendationengine_v1beta1.types.ListUserEventsRequest) – The request object. Request message for ListUserEvents method.

  • parent (str) –

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • filter (str) –

    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

    This corresponds to the filter field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListUserEvents method. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.recommendationengine_v1beta1.services.user_event_service.pagers.ListUserEventsAsyncPager

static parse_common_billing_account_path(path: str)Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str]

Parse a project path into its component segments.

static parse_event_store_path(path: str)Dict[str, str]

Parses a event_store path into its component segments.

async purge_user_events(request: Optional[google.cloud.recommendationengine_v1beta1.types.user_event_service.PurgeUserEventsRequest] = None, *, parent: Optional[str] = None, filter: Optional[str] = None, force: Optional[bool] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

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.

Parameters
  • request (google.cloud.recommendationengine_v1beta1.types.PurgeUserEventsRequest) – The request object. Request message for PurgeUserEvents method.

  • parent (str) –

    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}

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • filter (str) –

    Required. The filter string to specify the events to be deleted. Empty string filter is not allowed. This filter can also be used with ListUserEvents API to list events that will be deleted. The eligible fields for filtering are:

    • eventType - UserEvent.eventType field of type string.

    • eventTime - in ISO 8601 “zulu” format.

    • visitorId - field of type string. Specifying this will delete all events associated with a visitor.

    • userId - field of type string. Specifying this will delete all events associated with a user. Example 1: Deleting all events in a time range. eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" Example 2: Deleting specific eventType in time range. eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view" Example 3: Deleting all events for a specific visitor visitorId = visitor1024 The filtering fields are assumed to have an implicit AND.

    This corresponds to the filter field on the request instance; if request is provided, this should not be set.

  • force (bool) –

    Optional. The default value is false. Override this flag to true to actually perform the purge. If the field is not set to true, a sampling of events to be deleted will be returned.

    This corresponds to the force field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.recommendationengine_v1beta1.types.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.

Return type

google.api_core.operation_async.AsyncOperation

property transport: google.cloud.recommendationengine_v1beta1.services.user_event_service.transports.base.UserEventServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

UserEventServiceTransport

async write_user_event(request: Optional[google.cloud.recommendationengine_v1beta1.types.user_event_service.WriteUserEventRequest] = None, *, parent: Optional[str] = None, user_event: Optional[google.cloud.recommendationengine_v1beta1.types.user_event.UserEvent] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.recommendationengine_v1beta1.types.user_event.UserEvent[source]

Writes a single user event.

Parameters
  • request (google.cloud.recommendationengine_v1beta1.types.WriteUserEventRequest) – The request object. Request message for WriteUserEvent method.

  • parent (str) –

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • user_event (google.cloud.recommendationengine_v1beta1.types.UserEvent) – Required. User event to write. This corresponds to the user_event field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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

Return type

google.cloud.recommendationengine_v1beta1.types.UserEvent

class google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.recommendationengine_v1beta1.services.user_event_service.transports.base.UserEventServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

Service for ingesting end user actions on the customer website.

Instantiates the user event service client.

Parameters
  • credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

  • transport (Union[str, UserEventServiceTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

  • client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]

Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

collect_user_event(request: Optional[Union[google.cloud.recommendationengine_v1beta1.types.user_event_service.CollectUserEventRequest, dict]] = None, *, parent: Optional[str] = None, user_event: Optional[str] = None, uri: Optional[str] = None, ets: Optional[int] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api.httpbody_pb2.HttpBody[source]

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.

Parameters
  • request (Union[google.cloud.recommendationengine_v1beta1.types.CollectUserEventRequest, dict]) – The request object. Request message for CollectUserEvent method.

  • parent (str) –

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • user_event (str) –

    Required. URL encoded UserEvent proto.

    This corresponds to the user_event field on the request instance; if request is provided, this should not be set.

  • uri (str) –

    Optional. The url including cgi- arameters 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.

    This corresponds to the uri field on the request instance; if request is provided, this should not be set.

  • ets (int) –

    Optional. The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.

    This corresponds to the ets field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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.

Return type

google.api.httpbody_pb2.HttpBody

static common_billing_account_path(billing_account: str)str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str)str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str)str[source]

Returns a fully-qualified project string.

static event_store_path(project: str, location: str, catalog: str, event_store: str)str[source]

Returns a fully-qualified event_store string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

UserEventServiceClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

UserEventServiceClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

UserEventServiceClient

import_user_events(request: Optional[Union[google.cloud.recommendationengine_v1beta1.types.import_.ImportUserEventsRequest, dict]] = None, *, parent: Optional[str] = None, request_id: Optional[str] = None, input_config: Optional[google.cloud.recommendationengine_v1beta1.types.import_.InputConfig] = None, errors_config: Optional[google.cloud.recommendationengine_v1beta1.types.import_.ImportErrorsConfig] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

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.

Parameters
  • request (Union[google.cloud.recommendationengine_v1beta1.types.ImportUserEventsRequest, dict]) – The request object. Request message for the ImportUserEvents request.

  • parent (str) –

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • request_id (str) –

    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.

    This corresponds to the request_id field on the request instance; if request is provided, this should not be set.

  • input_config (google.cloud.recommendationengine_v1beta1.types.InputConfig) –

    Required. The desired input location of the data.

    This corresponds to the input_config field on the request instance; if request is provided, this should not be set.

  • errors_config (google.cloud.recommendationengine_v1beta1.types.ImportErrorsConfig) –

    Optional. The desired location of errors incurred during the Import.

    This corresponds to the errors_config field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.recommendationengine_v1beta1.types.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.

Return type

google.api_core.operation.Operation

list_user_events(request: Optional[Union[google.cloud.recommendationengine_v1beta1.types.user_event_service.ListUserEventsRequest, dict]] = None, *, parent: Optional[str] = None, filter: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.recommendationengine_v1beta1.services.user_event_service.pagers.ListUserEventsPager[source]

Gets a list of user events within a time range, with potential filtering.

Parameters
  • request (Union[google.cloud.recommendationengine_v1beta1.types.ListUserEventsRequest, dict]) – The request object. Request message for ListUserEvents method.

  • parent (str) –

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • filter (str) –

    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

    This corresponds to the filter field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListUserEvents method. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.recommendationengine_v1beta1.services.user_event_service.pagers.ListUserEventsPager

static parse_common_billing_account_path(path: str)Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str][source]

Parse a project path into its component segments.

static parse_event_store_path(path: str)Dict[str, str][source]

Parses a event_store path into its component segments.

purge_user_events(request: Optional[Union[google.cloud.recommendationengine_v1beta1.types.user_event_service.PurgeUserEventsRequest, dict]] = None, *, parent: Optional[str] = None, filter: Optional[str] = None, force: Optional[bool] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

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.

Parameters
  • request (Union[google.cloud.recommendationengine_v1beta1.types.PurgeUserEventsRequest, dict]) – The request object. Request message for PurgeUserEvents method.

  • parent (str) –

    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}

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • filter (str) –

    Required. The filter string to specify the events to be deleted. Empty string filter is not allowed. This filter can also be used with ListUserEvents API to list events that will be deleted. The eligible fields for filtering are:

    • eventType - UserEvent.eventType field of type string.

    • eventTime - in ISO 8601 “zulu” format.

    • visitorId - field of type string. Specifying this will delete all events associated with a visitor.

    • userId - field of type string. Specifying this will delete all events associated with a user. Example 1: Deleting all events in a time range. eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" Example 2: Deleting specific eventType in time range. eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view" Example 3: Deleting all events for a specific visitor visitorId = visitor1024 The filtering fields are assumed to have an implicit AND.

    This corresponds to the filter field on the request instance; if request is provided, this should not be set.

  • force (bool) –

    Optional. The default value is false. Override this flag to true to actually perform the purge. If the field is not set to true, a sampling of events to be deleted will be returned.

    This corresponds to the force field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.recommendationengine_v1beta1.types.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.

Return type

google.api_core.operation.Operation

property transport: google.cloud.recommendationengine_v1beta1.services.user_event_service.transports.base.UserEventServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

UserEventServiceTransport

write_user_event(request: Optional[Union[google.cloud.recommendationengine_v1beta1.types.user_event_service.WriteUserEventRequest, dict]] = None, *, parent: Optional[str] = None, user_event: Optional[google.cloud.recommendationengine_v1beta1.types.user_event.UserEvent] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.recommendationengine_v1beta1.types.user_event.UserEvent[source]

Writes a single user event.

Parameters
  • request (Union[google.cloud.recommendationengine_v1beta1.types.WriteUserEventRequest, dict]) – The request object. Request message for WriteUserEvent method.

  • parent (str) –

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • user_event (google.cloud.recommendationengine_v1beta1.types.UserEvent) – Required. User event to write. This corresponds to the user_event field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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

Return type

google.cloud.recommendationengine_v1beta1.types.UserEvent

class google.cloud.recommendationengine_v1beta1.services.user_event_service.pagers.ListUserEventsAsyncPager(method: Callable[[...], Awaitable[google.cloud.recommendationengine_v1beta1.types.user_event_service.ListUserEventsResponse]], request: google.cloud.recommendationengine_v1beta1.types.user_event_service.ListUserEventsRequest, response: google.cloud.recommendationengine_v1beta1.types.user_event_service.ListUserEventsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_user_events requests.

This class thinly wraps an initial google.cloud.recommendationengine_v1beta1.types.ListUserEventsResponse object, and provides an __aiter__ method to iterate through its user_events field.

If there are more pages, the __aiter__ method will make additional ListUserEvents requests and continue to iterate through the user_events field on the corresponding responses.

All the usual google.cloud.recommendationengine_v1beta1.types.ListUserEventsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.recommendationengine_v1beta1.services.user_event_service.pagers.ListUserEventsPager(method: Callable[[...], google.cloud.recommendationengine_v1beta1.types.user_event_service.ListUserEventsResponse], request: google.cloud.recommendationengine_v1beta1.types.user_event_service.ListUserEventsRequest, response: google.cloud.recommendationengine_v1beta1.types.user_event_service.ListUserEventsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_user_events requests.

This class thinly wraps an initial google.cloud.recommendationengine_v1beta1.types.ListUserEventsResponse object, and provides an __iter__ method to iterate through its user_events field.

If there are more pages, the __iter__ method will make additional ListUserEvents requests and continue to iterate through the user_events field on the corresponding responses.

All the usual google.cloud.recommendationengine_v1beta1.types.ListUserEventsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters