- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- UserEventInputConfig
- UserEventInlineSource
- Try it!
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
.
HTTP request
POST https://retail.googleapis.com/v2alpha/{parent=projects/*/locations/*/catalogs/*}/userEvents:import
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "inputConfig": { object ( |
Fields | |
---|---|
input |
Required. The desired input location of the data. |
errors |
The desired location of errors incurred during the Import. Cannot be set for inline user event imports. |
Response body
If successful, the response body contains an instance of Operation
.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the parent
resource:
retail.userEvents.import
For more information, see the IAM documentation.
UserEventInputConfig
The input config source for user events.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field source . The source of the input. source can be only one of the following: |
|
user |
Required. The Inline source for the input content for UserEvents. |
gcs |
Required. Google Cloud Storage location for the input content. |
big |
Required. BigQuery input source. |
UserEventInlineSource
The inline source for the input config for userEvents.import method.
JSON representation |
---|
{
"userEvents": [
{
object ( |
Fields | |
---|---|
user |
Required. A list of user events to import. Recommended max of 10k items. |