Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

REST Resource: customers.offlineUserDataJobs

Resource: OfflineUserDataJob

A job containing offline user data of store visitors, or user list members that will be processed asynchronously. The uploaded data isn't readable and the processing results of the job can only be read using OfflineUserDataJobService.GetOfflineUserDataJob.

JSON representation
{
  "resourceName": string,
  "type": enum (OfflineUserDataJobType),
  "status": enum (OfflineUserDataJobStatus),
  "failureReason": enum (OfflineUserDataJobFailureReason),
  "id": string,
  "externalId": string,

  // Union field metadata can be only one of the following:
  "customerMatchUserListMetadata": {
    object (CustomerMatchUserListMetadata)
  },
  "storeSalesMetadata": {
    object (StoreSalesMetadata)
  }
  // End of list of possible types for union field metadata.
}
Fields
resourceName

string

Immutable. The resource name of the offline user data job. Offline user data job resource names have the form:

customers/{customerId}/offlineUserDataJobs/{offline_user_data_job_id}

type

enum (OfflineUserDataJobType)

Immutable. Type of the job.

status

enum (OfflineUserDataJobStatus)

Output only. Status of the job.

failureReason

enum (OfflineUserDataJobFailureReason)

Output only. Reason for the processing failure, if status is FAILED.

id

string (int64 format)

Output only. ID of this offline user data job.

externalId

string (int64 format)

Immutable. User specified job ID.

Union field metadata. Metadata of the job. metadata can be only one of the following:
customerMatchUserListMetadata

object (CustomerMatchUserListMetadata)

Immutable. Metadata for data updates to a CRM-based user list.

storeSalesMetadata

object (StoreSalesMetadata)

Immutable. Metadata for store sales data update.

OfflineUserDataJobType

The type of an offline user data job.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
STORE_SALES_UPLOAD_FIRST_PARTY Store Sales Direct data for self service.
STORE_SALES_UPLOAD_THIRD_PARTY Store Sales Direct data for third party.
CUSTOMER_MATCH_USER_LIST Customer Match user list data.
CUSTOMER_MATCH_WITH_ATTRIBUTES Customer Match with attribute data.

OfflineUserDataJobStatus

The status of an offline user data job.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
PENDING The job has been successfully created and pending for uploading.
RUNNING Upload(s) have been accepted and data is being processed.
SUCCESS Uploaded data has been successfully processed.
FAILED Uploaded data has failed to be processed.

OfflineUserDataJobFailureReason

The failure reason of an offline user data job.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
INSUFFICIENT_MATCHED_TRANSACTIONS The matched transactions are insufficient.
INSUFFICIENT_TRANSACTIONS The uploaded transactions are insufficient.

CustomerMatchUserListMetadata

Metadata for customer match user list.

JSON representation
{
  "userList": string
}
Fields
userList

string

The resource name of remarketing list to update data. Required for job of CUSTOMER_MATCH_USER_LIST type.

StoreSalesMetadata

Metadata for Store Sales Direct.

JSON representation
{
  "thirdPartyMetadata": {
    object (StoreSalesThirdPartyMetadata)
  },
  "loyaltyFraction": number,
  "transactionUploadFraction": number,
  "customKey": string
}
Fields
thirdPartyMetadata

object (StoreSalesThirdPartyMetadata)

Metadata for a third party Store Sales upload.

loyaltyFraction

number

This is the fraction of all transactions that are identifiable (i.e., associated with any form of customer information). Required. The fraction needs to be between 0 and 1 (excluding 0).

transactionUploadFraction

number

This is the ratio of sales being uploaded compared to the overall sales that can be associated with a customer. Required. The fraction needs to be between 0 and 1 (excluding 0). For example, if you upload half the sales that you are able to associate with a customer, this would be 0.5.

customKey

string

Name of the store sales custom variable key. A predefined key that can be applied to the transaction and then later used for custom segmentation in reporting. Accessible only to customers on the allow-list.

StoreSalesThirdPartyMetadata

Metadata for a third party Store Sales. This product is only for customers on the allow-list. Please contact your Google business development representative for details on the upload configuration.

JSON representation
{
  "advertiserUploadDateTime": string,
  "validTransactionFraction": number,
  "partnerMatchFraction": number,
  "partnerUploadFraction": number,
  "bridgeMapVersionId": string,
  "partnerId": string
}
Fields
advertiserUploadDateTime

string

Time the advertiser uploaded the data to the partner. Required. The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"

validTransactionFraction

number

The fraction of transactions that are valid. Invalid transactions may include invalid formats or values. Required. The fraction needs to be between 0 and 1 (excluding 0).

partnerMatchFraction

number

The fraction of valid transactions that are matched to a third party assigned user ID on the partner side. Required. The fraction needs to be between 0 and 1 (excluding 0).

partnerUploadFraction

number

The fraction of valid transactions that are uploaded by the partner to Google. Required. The fraction needs to be between 0 and 1 (excluding 0).

bridgeMapVersionId

string

Version of partner IDs to be used for uploads. Required.

partnerId

string (int64 format)

ID of the third party partner updating the transaction feed.

Methods

addOperations

Adds operations to the offline user data job.

create

Creates an offline user data job.

get

Returns the offline user data job.

run

Runs the offline user data job.