- JSON representation
- OfflineUserDataJobType
- OfflineUserDataJobStatus
- OfflineUserDataJobFailureReason
- OfflineUserDataJobMetadata
- OfflineUserDataJobMatchRateRange
- StoreSalesMetadata
- StoreSalesThirdPartyMetadata
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 GoogleAdsService.Search/SearchStream.
JSON representation |
---|
{ "resourceName": string, "type": enum ( |
Fields | |
---|---|
resourceName |
Immutable. The resource name of the offline user data job. Offline user data job resource names have the form:
|
type |
Immutable. Type of the job. |
status |
Output only. Status of the job. |
failureReason |
Output only. Reason for the processing failure, if status is FAILED. |
operationMetadata |
Output only. Metadata of offline user data job depicting match rate range. |
id |
Output only. ID of this offline user data job. |
externalId |
Immutable. User specified job ID. |
Union field metadata . Metadata of the job. metadata can be only one of the following: |
|
customerMatchUserListMetadata |
Immutable. Metadata for data updates to a CRM-based user list. |
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. |
HIGH_AVERAGE_TRANSACTION_VALUE |
The average transaction value is unusually high for your account. If this is intended, contact support to request an exception. Learn more at https://support.google.com/google-ads/answer/10018944#transaction_value |
LOW_AVERAGE_TRANSACTION_VALUE |
The average transaction value is unusually low for your account. If this is intended, contact support to request an exception. Learn more at https://support.google.com/google-ads/answer/10018944#transaction_value |
NEWLY_OBSERVED_CURRENCY_CODE |
There's a currency code that you haven't used before in your uploads. If this is intended, contact support to request an exception. Learn more at https://support.google.com/google-ads/answer/10018944#Unrecognized_currency |
OfflineUserDataJobMetadata
Metadata of offline user data job.
JSON representation |
---|
{
"matchRateRange": enum ( |
Fields | |
---|---|
matchRateRange |
Output only. Match rate of the Customer Match user list upload. Describes the estimated match rate when the status of the job is "RUNNING" and final match rate when the final match rate is available after the status of the job is "SUCCESS/FAILED". |
OfflineUserDataJobMatchRateRange
The match rate range of an offline user data job.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Default value for match rate range. |
MATCH_RANGE_LESS_THAN_20 |
Match rate range for offline data upload entity is between 0% and 19%. |
MATCH_RANGE_20_TO_30 |
Match rate range for offline data upload entity is between 20% and 30%. |
MATCH_RANGE_31_TO_40 |
Match rate range for offline data upload entity is between 31% and 40%. |
MATCH_RANGE_41_TO_50 |
Match rate range for offline data upload entity is between 41% and 50%. |
MATCH_RANGE_51_TO_60 |
Match rate range for offline data upload entity is between 51% and 60%. |
MATCH_RANGE_61_TO_70 |
Match rate range for offline data upload entity is between 61% and 70%. |
MATCH_RANGE_71_TO_80 |
Match rate range for offline data upload entity is between 71% and 80%. |
MATCH_RANGE_81_TO_90 |
Match rate range for offline data upload entity is between 81% and 90%. |
MATCH_RANGE_91_TO_100 |
Match rate range for offline data upload entity is more than or equal to 91%. |
StoreSalesMetadata
Metadata for Store Sales Direct.
JSON representation |
---|
{
"thirdPartyMetadata": {
object ( |
Fields | |
---|---|
thirdPartyMetadata |
Metadata for a third party Store Sales upload. |
loyaltyFraction |
This is the fraction of all transactions that are identifiable (for example, associated with any form of customer information). Required. The fraction needs to be between 0 and 1 (excluding 0). |
transactionUploadFraction |
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 |
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. 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 |
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 |
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 |
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 |
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 |
Version of partner IDs to be used for uploads. Required. |
partnerId |
ID of the third party partner updating the transaction feed. |