Page Summary
-
The IngestionService allows uploading and removing audience data to supported destinations through methods like
IngestAudienceMembersandRemoveAudienceMembers. -
The API supports different types of identifiers for audience members and events, including user-provided data, PAIR IDs, and mobile device data.
-
Detailed status information for requests can be retrieved using the
RetrieveRequestStatusmethod, including success, processing, failed, or partial success statuses per destination. -
Data can be encrypted using Google Cloud Platform wrapped keys, and the API provides specific reasons for processing errors and warnings.
-
User data and events can include consent information for DMA compliance and advertiser-assessed user properties.
Index
-
IngestionService(interface) -
MarketingDataInsightsService(interface) -
PartnerLinkService(interface) -
UserListDirectLicenseService(interface) -
UserListGlobalLicenseService(interface) -
UserListService(interface) -
AdIdentifiers(message) -
AddressInfo(message) -
AgeRange(enum) -
AudienceMember(message) -
AwsWrappedKeyInfo(message) -
AwsWrappedKeyInfo.KeyType(enum) -
Baseline(message) -
Baseline.Location(message) -
CartData(message) -
Consent(message) -
ConsentStatus(enum) -
ContactIdInfo(message) -
CreatePartnerLinkRequest(message) -
CreateUserListDirectLicenseRequest(message) -
CreateUserListGlobalLicenseRequest(message) -
CreateUserListRequest(message) -
CustomVariable(message) -
CustomerType(enum) -
CustomerValueBucket(enum) -
DataSourceType(enum) -
DeletePartnerLinkRequest(message) -
DeleteUserListRequest(message) -
Destination(message) -
DeviceInfo(message) -
Encoding(enum) -
EncryptionInfo(message) -
ErrorCount(message) -
ErrorInfo(message) -
ErrorReason(enum) -
Event(message) -
EventParameter(message) -
EventSource(enum) -
ExperimentalField(message) -
GcpWrappedKeyInfo(message) -
GcpWrappedKeyInfo.KeyType(enum) -
Gender(enum) -
GetUserListDirectLicenseRequest(message) -
GetUserListGlobalLicenseRequest(message) -
GetUserListRequest(message) -
IngestAudienceMembersRequest(message) -
IngestAudienceMembersResponse(message) -
IngestEventsRequest(message) -
IngestEventsResponse(message) -
IngestedUserListInfo(message) -
IngestedUserListInfo.UploadKeyType(enum) -
Item(message) -
ItemParameter(message) -
ListUserListDirectLicensesRequest(message) -
ListUserListDirectLicensesResponse(message) -
ListUserListGlobalLicenseCustomerInfosRequest(message) -
ListUserListGlobalLicenseCustomerInfosResponse(message) -
ListUserListGlobalLicensesRequest(message) -
ListUserListGlobalLicensesResponse(message) -
ListUserListsRequest(message) -
ListUserListsResponse(message) -
MatchRateRange(enum) -
MobileData(message) -
MobileIdInfo(message) -
MobileIdInfo.KeySpace(enum) -
PairData(message) -
PairIdInfo(message) -
PartnerAudienceInfo(message) -
PartnerAudienceInfo.PartnerAudienceSource(enum) -
PartnerLink(message) -
PpidData(message) -
ProcessingErrorReason(enum) -
ProcessingWarningReason(enum) -
Product(enum) (deprecated) -
ProductAccount(message) -
ProductAccount.AccountType(enum) -
PseudonymousIdInfo(message) -
PseudonymousIdInfo.SyncStatus(enum) -
RemoveAudienceMembersRequest(message) -
RemoveAudienceMembersResponse(message) -
RequestStatusPerDestination(message) -
RequestStatusPerDestination.IngestAudienceMembersStatus(message) -
RequestStatusPerDestination.IngestEventsStatus(message) -
RequestStatusPerDestination.IngestMobileDataStatus(message) -
RequestStatusPerDestination.IngestPairDataStatus(message) -
RequestStatusPerDestination.IngestPpidDataStatus(message) -
RequestStatusPerDestination.IngestUserDataStatus(message) -
RequestStatusPerDestination.IngestUserIdDataStatus(message) -
RequestStatusPerDestination.RemoveAudienceMembersStatus(message) -
RequestStatusPerDestination.RemoveMobileDataStatus(message) -
RequestStatusPerDestination.RemovePairDataStatus(message) -
RequestStatusPerDestination.RemovePpidDataStatus(message) -
RequestStatusPerDestination.RemoveUserDataStatus(message) -
RequestStatusPerDestination.RemoveUserIdDataStatus(message) -
RequestStatusPerDestination.RequestStatus(enum) -
RetrieveInsightsRequest(message) -
RetrieveInsightsResponse(message) -
RetrieveInsightsResponse.MarketingDataInsight(message) -
RetrieveInsightsResponse.MarketingDataInsight.AudienceInsightsDimension(enum) -
RetrieveInsightsResponse.MarketingDataInsight.MarketingDataInsightsAttribute(message) -
RetrieveRequestStatusRequest(message) -
RetrieveRequestStatusResponse(message) -
SearchPartnerLinksRequest(message) -
SearchPartnerLinksResponse(message) -
SizeInfo(message) -
TargetNetworkInfo(message) -
TermsOfService(message) -
TermsOfServiceStatus(enum) -
UpdateUserListDirectLicenseRequest(message) -
UpdateUserListGlobalLicenseRequest(message) -
UpdateUserListRequest(message) -
UserData(message) -
UserIdData(message) -
UserIdInfo(message) -
UserIdentifier(message) -
UserList(message) -
UserList.AccessReason(enum) -
UserList.AccessStatus(enum) -
UserList.ClosingReason(enum) -
UserList.MembershipStatus(enum) -
UserListDirectLicense(message) -
UserListGlobalLicense(message) -
UserListGlobalLicenseCustomerInfo(message) -
UserListGlobalLicenseType(enum) -
UserListLicenseClientAccountType(enum) -
UserListLicenseMetrics(message) -
UserListLicensePricing(message) -
UserListLicensePricing.UserListPricingBuyerApprovalState(enum) -
UserListLicensePricing.UserListPricingCostType(enum) -
UserListLicenseStatus(enum) -
UserProperties(message) -
UserProperty(message) -
WarningCount(message) -
WarningInfo(message)
IngestionService
Service for sending audience data to supported destinations.
rpc IngestAudienceMembers(
IngestAudienceMembersRequest
) returns ( IngestAudienceMembersResponse
)
Uploads a list of AudienceMember
resources to the provided Destination
.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/datamanager
-
rpc IngestEvents(
IngestEventsRequest
) returns ( IngestEventsResponse
)
Uploads a list of Event
resources from the provided Destination
.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/datamanager
-
rpc RemoveAudienceMembers(
RemoveAudienceMembersRequest
) returns ( RemoveAudienceMembersResponse
)
Removes a list of AudienceMember
resources from the provided Destination
.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/datamanager
-
rpc RetrieveRequestStatus(
RetrieveRequestStatusRequest
) returns ( RetrieveRequestStatusResponse
)
Gets the status of a request given request id.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/datamanager
-
MarketingDataInsightsService
Service to return insights on marketing data.
This feature is only available to data partners.
rpc RetrieveInsights(
RetrieveInsightsRequest
) returns ( RetrieveInsightsResponse
)
Retrieves marketing data insights for a given user list.
This feature is only available to data partners.
Authorization Headers:
This method supports the following optional headers to define how the API authorizes access for the request:
-
login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format:accountTypes/{loginAccountType}/accounts/{loginAccountId} -
linked-account: (Optional) The resource name of the account with an established product link to thelogin-account. Format:accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/datamanager
-
PartnerLinkService
Service for managing partner links.
rpc CreatePartnerLink(
CreatePartnerLinkRequest
) returns ( PartnerLink
)
Creates a partner link for the given account.
Authorization Headers:
This method supports the following optional headers to define how the API authorizes access for the request:
-
login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format:accountTypes/{loginAccountType}/accounts/{loginAccountId} -
linked-account: (Optional) The resource name of the account with an established product link to thelogin-account. Format:accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/datamanager
-
rpc DeletePartnerLink(
DeletePartnerLinkRequest
) returns ( Empty
)
Deletes a partner link for the given account.
Authorization Headers:
This method supports the following optional headers to define how the API authorizes access for the request:
-
login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format:accountTypes/{loginAccountType}/accounts/{loginAccountId} -
linked-account: (Optional) The resource name of the account with an established product link to thelogin-account. Format:accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/datamanager
-
rpc SearchPartnerLinks(
SearchPartnerLinksRequest
) returns ( SearchPartnerLinksResponse
)
Searches for all partner links to and from a given account.
Authorization Headers:
This method supports the following optional headers to define how the API authorizes access for the request:
-
login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format:accountTypes/{loginAccountType}/accounts/{loginAccountId} -
linked-account: (Optional) The resource name of the account with an established product link to thelogin-account. Format:accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/datamanager
-
UserListDirectLicenseService
Service for managing user list direct licenses. Delete is not a supported operation for UserListDirectLicenses. Callers should update the license status to DISABLED to instead to deactivate a license.
This feature is only available to data partners.
rpc CreateUserListDirectLicense(
CreateUserListDirectLicenseRequest
) returns ( UserListDirectLicense
)
Creates a user list direct license.
This feature is only available to data partners.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/datamanager
-
rpc GetUserListDirectLicense(
GetUserListDirectLicenseRequest
) returns ( UserListDirectLicense
)
Retrieves a user list direct license.
This feature is only available to data partners.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/datamanager
-
rpc ListUserListDirectLicenses(
ListUserListDirectLicensesRequest
) returns ( ListUserListDirectLicensesResponse
)
Lists all user list direct licenses owned by the parent account.
This feature is only available to data partners.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/datamanager
-
rpc UpdateUserListDirectLicense(
UpdateUserListDirectLicenseRequest
) returns ( UserListDirectLicense
)
Updates a user list direct license.
This feature is only available to data partners.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/datamanager
-
UserListGlobalLicenseService
Service for managing user list global licenses. Delete is not a supported operation for UserListGlobalLicenses. Callers should update the license status to DISABLED to instead to deactivate a license.
This feature is only available to data partners.
rpc CreateUserListGlobalLicense(
CreateUserListGlobalLicenseRequest
) returns ( UserListGlobalLicense
)
Creates a user list global license.
This feature is only available to data partners.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/datamanager
-
rpc GetUserListGlobalLicense(
GetUserListGlobalLicenseRequest
) returns ( UserListGlobalLicense
)
Retrieves a user list global license.
This feature is only available to data partners.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/datamanager
-
rpc ListUserListGlobalLicenseCustomerInfos(
ListUserListGlobalLicenseCustomerInfosRequest
) returns ( ListUserListGlobalLicenseCustomerInfosResponse
)
Lists all customer info for a user list global license.
This feature is only available to data partners.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/datamanager
-
rpc ListUserListGlobalLicenses(
ListUserListGlobalLicensesRequest
) returns ( ListUserListGlobalLicensesResponse
)
Lists all user list global licenses owned by the parent account.
This feature is only available to data partners.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/datamanager
-
rpc UpdateUserListGlobalLicense(
UpdateUserListGlobalLicenseRequest
) returns ( UserListGlobalLicense
)
Updates a user list global license.
This feature is only available to data partners.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/datamanager
-
UserListService
Service for managing UserList resources.
rpc CreateUserList(
CreateUserListRequest
) returns ( UserList
)
Creates a UserList.
Authorization Headers:
This method supports the following optional headers to define how the API authorizes access for the request:
-
login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format:accountTypes/{loginAccountType}/accounts/{loginAccountId} -
linked-account: (Optional) The resource name of the account with an established product link to thelogin-account. Format:accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/datamanager
-
rpc DeleteUserList(
DeleteUserListRequest
) returns ( Empty
)
Deletes a UserList.
Authorization Headers:
This method supports the following optional headers to define how the API authorizes access for the request:
-
login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format:accountTypes/{loginAccountType}/accounts/{loginAccountId} -
linked-account: (Optional) The resource name of the account with an established product link to thelogin-account. Format:accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/datamanager
-
rpc GetUserList(
GetUserListRequest
) returns ( UserList
)
Gets a UserList.
Authorization Headers:
This method supports the following optional headers to define how the API authorizes access for the request:
-
login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format:accountTypes/{loginAccountType}/accounts/{loginAccountId} -
linked-account: (Optional) The resource name of the account with an established product link to thelogin-account. Format:accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/datamanager
-
rpc ListUserLists(
ListUserListsRequest
) returns ( ListUserListsResponse
)
Lists UserLists.
Authorization Headers:
This method supports the following optional headers to define how the API authorizes access for the request:
-
login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format:accountTypes/{loginAccountType}/accounts/{loginAccountId} -
linked-account: (Optional) The resource name of the account with an established product link to thelogin-account. Format:accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/datamanager
-
rpc UpdateUserList(
UpdateUserListRequest
) returns ( UserList
)
Updates a UserList.
Authorization Headers:
This method supports the following optional headers to define how the API authorizes access for the request:
-
login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format:accountTypes/{loginAccountType}/accounts/{loginAccountId} -
linked-account: (Optional) The resource name of the account with an established product link to thelogin-account. Format:accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/datamanager
-
AdIdentifiers
Identifiers and other information used to match the conversion event with other online activity (such as ad clicks).
| Fields | |
|---|---|
session_attributes
|
Optional. Session attributes for event attribution and modeling. |
gclid
|
Optional. The Google click ID (gclid) associated with this event. |
gbraid
|
Optional. The click identifier for clicks associated with app events and originating from iOS devices starting with iOS14. |
wbraid
|
Optional. The click identifier for clicks associated with web events and originating from iOS devices starting with iOS14. |
landing_page_device_info
|
Optional. Information gathered about the device being used (if any) at the time of landing onto the advertiser’s site after interacting with the ad. |
AddressInfo
Address information for the user.
| Fields | |
|---|---|
given_name
|
Required. Given (first) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256. |
family_name
|
Required. Family (last) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256. |
region_code
|
Required. The 2-letter region code in ISO-3166-1 alpha-2 of the user's address. |
postal_code
|
Required. The postal code of the user's address. |
AgeRange
The demographic age ranges
| Enums | |
|---|---|
AGE_RANGE_UNSPECIFIED
|
Not specified. |
AGE_RANGE_UNKNOWN
|
Unknown. |
AGE_RANGE_18_24
|
Between 18 and 24 years old. |
AGE_RANGE_25_34
|
Between 25 and 34 years old. |
AGE_RANGE_35_44
|
Between 35 and 44 years old. |
AGE_RANGE_45_54
|
Between 45 and 54 years old. |
AGE_RANGE_55_64
|
Between 55 and 64 years old. |
AGE_RANGE_65_UP
|
65 years old and beyond. |
AudienceMember
The audience member to be operated on.
destination_references[]
string
Optional. Defines which Destination
to send the audience member to.
data
. The type of identifying data to be operated on. data
can be only one of the following:user_data
User-provided data that identifies the user.
pair_data
Publisher Advertiser Identity Reconciliation (PAIR) IDs .
This feature is only available to data partners.
mobile_data
Data identifying the user's mobile devices.
user_id_data
Data related to unique identifiers for a user, as defined by the advertiser.
ppid_data
Data related to publisher provided identifiers.
This feature is only available to data partners.
AwsWrappedKeyInfo
A data encryption key wrapped by an AWS KMS key.
| Fields | |
|---|---|
key_type
|
Required. The type of algorithm used to encrypt the data. |
role_arn
|
Required. The Amazon Resource Name of the IAM Role to assume for KMS decryption access. Should be in the format of |
kek_uri
|
Required. The URI of the AWS KMS key used to decrypt the DEK. Should be in the format of |
encrypted_dek
|
Required. The base64 encoded encrypted data encryption key. |
KeyType
The type of algorithm used to encrypt the data.
| Enums | |
|---|---|
KEY_TYPE_UNSPECIFIED
|
Unspecified key type. Should never be used. |
XCHACHA20_POLY1305
|
Algorithm XChaCha20-Poly1305 |
Baseline
Baseline criteria against which insights are compared.
baseline
. Baseline location against which insights are compared. baseline
can be only one of the following:baseline_location
The baseline location of the request. Baseline location is an OR-list of the requested regions.
location_auto_detection_enabled
bool
If set to true, the service will try to automatically detect the baseline location for insights.
Location
The baseline location of the request. Baseline location is on OR-list of ISO 3166-1 alpha-2 region codes of the requested regions.
| Fields | |
|---|---|
region_codes[]
|
List of ISO 3166-1 alpha-2 region codes. |
CartData
The cart data associated with the event.
| Fields | |
|---|---|
merchant_id
|
Optional. The Merchant Center ID associated with the items. |
merchant_feed_label
|
Optional. The Merchant Center feed label associated with the feed of the items. |
merchant_feed_language_code
|
Optional. The language code in ISO 639-1 associated with the Merchant Center feed of the items.where your items are uploaded. |
transaction_discount
|
Optional. The sum of all discounts associated with the transaction. |
items[]
|
Optional. The list of items associated with the event. |
Consent
Digital Markets Act (DMA) consent settings for the user.
| Fields | |
|---|---|
ad_user_data
|
Optional. Represents if the user consents to ad user data. |
ad_personalization
|
Optional. Represents if the user consents to ad personalization. |
ConsentStatus
Represents if the user granted, denied, or hasn't specified consent.
| Enums | |
|---|---|
CONSENT_STATUS_UNSPECIFIED
|
Not specified. |
CONSENT_GRANTED
|
Granted. |
CONSENT_DENIED
|
Denied. |
ContactIdInfo
Additional information when CONTACT_ID
is one of the upload_key_types
.
| Fields | |
|---|---|
match_rate_percentage
|
Output only. Match rate for customer match user lists. |
data_source_type
|
Optional. Immutable. Source of the upload data |
CreatePartnerLinkRequest
Request to create a PartnerLink
resource. Returns a PartnerLink
.
| Fields | |
|---|---|
parent
|
Required. The parent, which owns this collection of partner links. Format: accountTypes/{account_type}/accounts/{account} |
partner_link
|
Required. The partner link to create. |
CreateUserListDirectLicenseRequest
Request to create a UserListDirectLicense
resource.
| Fields | |
|---|---|
parent
|
Required. The account that owns the user list being licensed. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} |
user_list_direct_license
|
Required. The user list direct license to create. |
CreateUserListGlobalLicenseRequest
Request to create a UserListGlobalLicense
resource.
| Fields | |
|---|---|
parent
|
Required. The account that owns the user list being licensed. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} |
user_list_global_license
|
Required. The user list global license to create. |
CreateUserListRequest
Request message for CreateUserList.
| Fields | |
|---|---|
parent
|
Required. The parent account where this user list will be created. Format: accountTypes/{account_type}/accounts/{account} |
user_list
|
Required. The user list to create. |
validate_only
|
Optional. If true, the request is validated but not executed. |
CustomVariable
Custom variable for ads conversions.
| Fields | |
|---|---|
variable
|
Optional. The name of the custom variable to set. If the variable is not found for the given destination, it will be ignored. |
value
|
Optional. The value to store for the custom variable. |
destination_references[]
|
Optional. Reference string used to determine which of the |
CustomerType
Type of the customer associated with the event.
| Enums | |
|---|---|
CUSTOMER_TYPE_UNSPECIFIED
|
Unspecified CustomerType. Should never be used. |
NEW
|
The customer is new to the advertiser. |
RETURNING
|
The customer is returning to the advertiser. |
REENGAGED
|
The customer has re-engaged with the advertiser. |
CustomerValueBucket
The advertiser-assessed value of the customer.
| Enums | |
|---|---|
CUSTOMER_VALUE_BUCKET_UNSPECIFIED
|
Unspecified CustomerValueBucket. Should never be used. |
LOW
|
The customer is low value. |
MEDIUM
|
The customer is medium value. |
HIGH
|
The customer is high value. |
DataSourceType
Indicates source of upload data.
| Enums | |
|---|---|
DATA_SOURCE_TYPE_UNSPECIFIED
|
Not specified. |
DATA_SOURCE_TYPE_FIRST_PARTY
|
The uploaded data is first-party data. |
DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU
|
The uploaded data is from a third-party credit bureau. |
DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE
|
The uploaded data is from a third-party voter file. |
DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA
|
The uploaded data is third party partner data. |
DeletePartnerLinkRequest
Request to delete a PartnerLink
resource. Returns a google.protobuf.Empty
.
| Fields | |
|---|---|
name
|
Required. The resource name of the partner link to delete. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link} |
DeleteUserListRequest
Request message for DeleteUserList.
| Fields | |
|---|---|
name
|
Required. The name of the user list to delete. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} |
validate_only
|
Optional. If true, the request is validated but not executed. |
Destination
The Google product you're sending data to. For example, a Google Ads account.
| Fields | |
|---|---|
reference
|
Optional. ID for this |
login_account
|
Optional. The account used to make this API call. To add or remove data from the |
linked_account
|
Optional. An account that the calling user's |
operating_account
|
Required. The account to send the data to or remove the data from. |
product_destination_id
|
Required. The object within the product account to ingest into. For example, a Google Ads audience ID, a Display & Video 360 audience ID or a Google Ads conversion action ID. |
DeviceInfo
Information about the device being used (if any) when the event happened.
| Fields | |
|---|---|
user_agent
|
Optional. The user-agent string of the device for the given context. |
ip_address
|
Optional. The IP address of the device for the given context. Note:Google Ads does not support IP address matching for end users in the European Economic Area (EEA), United Kingdom (UK), or Switzerland (CH). Add logic to conditionally exclude sharing IP addresses from users from these regions and ensure that you provide users with clear and comprehensive information about the data you collect on your sites, apps, and other properties and get consent where required by law or any applicable Google policies. See the About offline conversion imports page for more details. |
Encoding
The encoding type of the hashed identifying information.
| Enums | |
|---|---|
ENCODING_UNSPECIFIED
|
Unspecified Encoding type. Should never be used. |
HEX
|
Hex encoding. |
BASE64
|
Base 64 encoding. |
EncryptionInfo
Encryption information for the data being ingested.
wrapped_key
. The wrapped key
used to encrypt the data. wrapped_key
can be only one of the following:gcp_wrapped_key_info
Google Cloud Platform wrapped key information.
aws_wrapped_key_info
Amazon Web Services wrapped key information.
ErrorCount
The error count for a given error reason.
| Fields | |
|---|---|
record_count
|
The count of records that failed to upload for a given reason. |
reason
|
The error reason of the failed records. |
ErrorInfo
Error counts for each type of error.
| Fields | |
|---|---|
error_counts[]
|
A list of errors and counts per error reason. May not be populated in all cases. |
ErrorReason
Error reasons for Data Manager API. NOTE: This enum is not frozen and new values may be added in the future.
| Enums | |
|---|---|
ERROR_REASON_UNSPECIFIED
|
Do not use this default value. |
INTERNAL_ERROR
|
An internal error has occurred. |
DEADLINE_EXCEEDED
|
The request took too long to respond. |
RESOURCE_EXHAUSTED
|
Too many requests. |
NOT_FOUND
|
Resource not found. |
PERMISSION_DENIED
|
The user does not have permission or the resource is not found. |
INVALID_ARGUMENT
|
There was a problem with the request. |
REQUIRED_FIELD_MISSING
|
Required field is missing. |
INVALID_FORMAT
|
Format is invalid. |
INVALID_HEX_ENCODING
|
The HEX encoded value is malformed. |
INVALID_BASE64_ENCODING
|
The base64 encoded value is malformed. |
INVALID_SHA256_FORMAT
|
The SHA256 encoded value is malformed. |
INVALID_POSTAL_CODE
|
Postal code is not valid. |
INVALID_COUNTRY_CODE
|
Country code is not valid. |
INVALID_ENUM_VALUE
|
Enum value cannot be used. |
INVALID_USER_LIST_TYPE
|
Type of the user list is not applicable for this request. |
INVALID_AUDIENCE_MEMBER
|
This audience member is not valid. |
TOO_MANY_AUDIENCE_MEMBERS
|
Maximum number of audience members allowed per request is 10,000. |
TOO_MANY_USER_IDENTIFIERS
|
Maximum number of user identifiers allowed per audience member is 10. |
TOO_MANY_DESTINATIONS
|
Maximum number of destinations allowed per request is 10. |
INVALID_DESTINATION
|
This Destination is not valid. |
DATA_PARTNER_USER_LIST_MUTATE_NOT_ALLOWED
|
Data Partner does not have access to the operating account owned userlist. |
INVALID_MOBILE_ID_FORMAT
|
Mobile ID format is not valid. |
INVALID_USER_LIST_ID
|
User list is not valid. |
MULTIPLE_DATA_TYPES_NOT_ALLOWED
|
Multiple data types are not allowed to be ingested in a single request. |
DIFFERENT_LOGIN_ACCOUNTS_NOT_ALLOWED_FOR_DATA_PARTNER
|
Destination configs containing a DataPartner login account must have the same login account across all destination configs. |
TERMS_AND_CONDITIONS_NOT_SIGNED
|
Required terms and conditions are not accepted. |
INVALID_NUMBER_FORMAT
|
Invalid number format. |
INVALID_CONVERSION_ACTION_ID
|
Conversion action ID is not valid. |
INVALID_CONVERSION_ACTION_TYPE
|
The conversion action type is not valid. |
INVALID_CURRENCY_CODE
|
The currency code is not supported. |
INVALID_EVENT
|
This event is not valid. |
TOO_MANY_EVENTS
|
Maximum number of events allowed per request is 10,000. |
DESTINATION_ACCOUNT_NOT_ENABLED_ENHANCED_CONVERSIONS_FOR_LEADS
|
The destination account is not enabled for enhanced conversions for leads. |
DESTINATION_ACCOUNT_DATA_POLICY_PROHIBITS_ENHANCED_CONVERSIONS
|
Enhanced conversions can't be used for the destination account because of Google customer data policies. Contact your Google representative.. |
DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED
|
The destination account hasn't agreed to the terms for enhanced conversions. |
DUPLICATE_DESTINATION_REFERENCE
|
Two or more destinations in the request have the same reference. |
UNSUPPORTED_OPERATING_ACCOUNT_FOR_DATA_PARTNER
|
Unsupported operating account for data partner authorization. |
UNSUPPORTED_LINKED_ACCOUNT_FOR_DATA_PARTNER
|
Unsupported linked account for data partner authorization. |
NO_IDENTIFIERS_PROVIDED
|
Events data contains no user identifiers or ad identifiers. |
INVALID_PROPERTY_TYPE
|
The property type is not supported. |
INVALID_STREAM_TYPE
|
The stream type is not supported. |
LINKED_ACCOUNT_ONLY_ALLOWED_WITH_DATA_PARTNER_LOGIN_ACCOUNT
|
Linked account is only supported when the login account is a DATA_PARTNER
account. |
OPERATING_ACCOUNT_LOGIN_ACCOUNT_MISMATCH
|
The login account must be the same as the operating account for the given use case. |
EVENT_TIME_INVALID
|
Event did not occur within the acceptable time window. |
RESERVED_NAME_USED
|
Parameter uses a reserved name. |
INVALID_EVENT_NAME
|
The event name is not supported. |
NOT_ALLOWLISTED
|
The account is not allowlisted for the given feature. |
INVALID_REQUEST_ID
|
The request ID used to retrieve the status of a request is not valid. Status can only be retrieved for requests that succeed and don't have validate_only=true
. |
MULTIPLE_DESTINATIONS_FOR_GOOGLE_ANALYTICS_EVENT
|
An event had 2 or more Google Analytics destinations. |
FIELD_VALUE_TOO_LONG
|
The field value is too long. |
TOO_MANY_ELEMENTS
|
Too many elements in a list in the request. |
ALREADY_EXISTS
|
The resource already exists. |
IMMUTABLE_FIELD_FOR_UPDATE
|
Attempted to set an immutable field for an update request. |
INVALID_RESOURCE_NAME
|
The resource name is invalid. |
INVALID_FILTER
|
The query filter is invalid. |
INVALID_UPDATE_MASK
|
The update mask is invalid. |
INVALID_PAGE_TOKEN
|
The page token is invalid. |
CANNOT_UPDATE_DISABLED_LICENSE
|
Cannot update a license that has been disabled. |
CANNOT_CREATE_LICENSE_FOR_SENSITIVE_USERLIST
|
Sensitive user lists cannot be licensed to this client. |
INSUFFICIENT_COST
|
Cost too low for this license. |
CANNOT_DISABLE_LICENSE
|
Reseller license cannot be disabled since it is in use. |
INVALID_CLIENT_ACCOUNT_ID
|
Invalid client account id. |
PRICING_ONLY_ZERO_COST_ALLOWED
|
Non-zero cost not allowed for this client account. |
PRICE_TOO_HIGH
|
Cost too high for this license. |
CUSTOMER_NOT_ALLOWED_TO_CREATE_LICENSE
|
Customer not allowed to create license. |
INVALID_PRICING_END_DATE
|
Pricing end date is invalid for this license. |
CANNOT_LICENSE_LOGICAL_LIST_WITH_LICENSED_OR_SHARED_SEGMENT
|
Logical user list with shared or licensed segment cannot be licensed. |
MISMATCHED_ACCOUNT_TYPE
|
Client customer's account type in the request does not match the customer's actual account type. |
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_LICENSE_TYPE
|
License type does not support media share cost. |
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_CLIENT_CUSTOMER
|
Client customer type does not support media share cost. |
INVALID_MEDIA_SHARE_COST
|
Invalid media share cost. |
INVALID_COST_TYPE
|
Invalid cost type. |
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_NON_COMMERCE_USER_LIST
|
UserList type does not support media share cost. |
MAX_COST_NOT_ALLOWED
|
Max cost is only allowed for cost_type MEDIA_SHARE. |
COMMERCE_AUDIENCE_CAN_ONLY_BE_DIRECTLY_LICENSED
|
Commerce audience can only be directly licensed. |
INVALID_DESCRIPTION
|
The description is not valid. |
INVALID_DISPLAY_NAME
|
The display name is not valid. |
DISPLAY_NAME_ALREADY_USED
|
The display name is already being used for another user list for the account. |
OWNERSHIP_REQUIRED_FOR_UPDATE
|
Ownership is required to modify the user list. |
USER_LIST_MUTATION_NOT_SUPPORTED
|
The user list type is read-only and does not support mutation. |
SENSITIVE_USER_LIST_IMMUTABLE
|
A user list which is privacy sensitive or legal rejected cannot be mutated by external users. |
BILLABLE_RECORD_COUNT_IMMUTABLE
|
The remarketing user list's billable record field cannot be modified once it is set. |
USER_LIST_NAME_RESERVED
|
The user list name is reserved for system lists. |
ADVERTISER_NOT_ALLOWLISTED_FOR_UPLOADED_DATA
|
The advertiser needs to be allowlisted to use remarketing lists created from advertiser uploaded data. |
UNSUPPORTED_PARTNER_AUDIENCE_SOURCE
|
The partner audience source is not supported for the user list type. |
COMMERCE_PARTNER_NOT_ALLOWED
|
Setting the commerce_partner
field is only supported if the partner_audience_source
is COMMERCE_AUDIENCE
. |
UNSUPPORTED_PARTNER_AUDIENCE_INFO
|
The partner_audience_info
field is not supported for the user list type. |
PARTNER_MATCH_FOR_MANAGER_ACCOUNT_DISALLOWED
|
Partner Match user lists cannot be created by manager accounts. |
DATA_PARTNER_NOT_ALLOWLISTED_FOR_THIRD_PARTY_PARTNER_DATA
|
The data partner is not allowlisted for THIRD_PARTY_PARTNER_DATA. |
ADVERTISER_TOS_NOT_ACCEPTED
|
The advertiser has not accepted the partner's terms of service. |
ADVERTISER_NOT_ALLOWLISTED_FOR_THIRD_PARTY_PARTNER_DATA
|
The advertiser is not allowlisted for THIRD_PARTY_PARTNER_DATA. |
USER_LIST_TYPE_NOT_SUPPORTED_FOR_ACCOUNT
|
This user list type is not supported for this account. |
INVALID_COMMERCE_PARTNER
|
The commerce_partner
field is invalid. |
CUSTOMER_NOT_ALLOWLISTED_FOR_COMMERCE_AUDIENCE
|
The data provider is not allowlisted to create commerce audiences. |
UNSUPPORTED_USER_LIST_UPLOAD_KEY_TYPES
|
The user list upload key types are not supported. |
UNSUPPORTED_INGESTED_USER_LIST_INFO_CONFIG
|
The ingested user list info config is not supported. |
UNSUPPORTED_ACCOUNT_TYPES_FOR_USER_LIST_TYPE
|
The account types are not supported for the user list type. |
UNSUPPORTED_ACCOUNT_TYPE_FOR_PARTNER_LINK
|
The account types are not supported for the partner link. |
Event
An event representing a user interaction with an advertiser's website or app.
| Fields | |
|---|---|
destination_references[]
|
Optional. Reference string used to determine the destination. If empty, the event will be sent to all |
transaction_id
|
Optional. The unique identifier for this event. Required for conversions using multiple data sources. |
event_timestamp
|
Required. The time the event occurred. |
last_updated_timestamp
|
Optional. The last time the event was updated. |
user_data
|
Optional. Pieces of user provided data, representing the user the event is associated with. |
consent
|
Optional. Information about whether the associated user has provided different types of consent. |
ad_identifiers
|
Optional. Identifiers and other information used to match the conversion event with other online activity (such as ad clicks). |
currency
|
Optional. The currency code associated with all monetary values within this event. |
event_source
|
Optional. Signal for where the event happened (web, app, in-store, etc.). |
event_device_info
|
Optional. Information gathered about the device being used (if any) when the event happened. |
cart_data
|
Optional. Information about the transaction and items associated with the event. |
custom_variables[]
|
Optional. Additional key/value pair information to send to the conversion containers (conversion action or FL activity). |
experimental_fields[]
|
Optional. A list of key/value pairs for experimental fields that may eventually be promoted to be part of the API. |
user_properties
|
Optional. Advertiser-assessed information about the user at the time that the event happened. |
event_name
|
Optional. The name of the event. Required for GA4 events. |
client_id
|
Optional. A unique identifier for the user instance of a web client for this GA4 web stream. |
user_id
|
Optional. A unique identifier for a user, as defined by the advertiser. |
additional_event_parameters[]
|
Optional. A bucket of any event parameters to be included within the event that were not already specified using other structured fields. |
conversion_value
|
Optional. The conversion value associated with the event, for value-based conversions. |
EventParameter
Event parameter for GA4 events.
| Fields | |
|---|---|
parameter_name
|
Required. The name of the parameter to use. |
value
|
Required. The string representation of the value of the parameter to set. |
EventSource
The source of the event.
| Enums | |
|---|---|
EVENT_SOURCE_UNSPECIFIED
|
Unspecified EventSource. Should never be used. |
WEB
|
The event was generated from a web browser. |
APP
|
The event was generated from an app. |
IN_STORE
|
The event was generated from an in-store transaction. |
PHONE
|
The event was generated from a phone call. |
OTHER
|
The event was generated from other sources. |
ExperimentalField
Experimental field representing unofficial fields.
| Fields | |
|---|---|
field
|
Optional. The name of the field to use. |
value
|
Optional. The value the field to set. |
GcpWrappedKeyInfo
Information about the Google Cloud Platform wrapped key.
| Fields | |
|---|---|
key_type
|
Required. The type of algorithm used to encrypt the data. |
wip_provider
|
Required. The Workload Identity pool provider required to use KEK. |
kek_uri
|
Required. Google Cloud Platform Cloud Key Management Service resource ID
. Should be in the format of |
encrypted_dek
|
Required. The base64 encoded encrypted data encryption key. |
KeyType
The type of algorithm used to encrypt the data.
| Enums | |
|---|---|
KEY_TYPE_UNSPECIFIED
|
Unspecified key type. Should never be used. |
XCHACHA20_POLY1305
|
Algorithm XChaCha20-Poly1305 |
Gender
The type of demographic genders (for example, female).
| Enums | |
|---|---|
GENDER_UNSPECIFIED
|
Not specified. |
GENDER_UNKNOWN
|
Unknown. |
GENDER_MALE
|
Male. |
GENDER_FEMALE
|
Female. |
GetUserListDirectLicenseRequest
Request to get a UserListDirectLicense
resource.
| Fields | |
|---|---|
name
|
Required. The resource name of the user list direct license. |
GetUserListGlobalLicenseRequest
Request to get a UserListGlobalLicense
resource.
| Fields | |
|---|---|
name
|
Required. The resource name of the user list global license. |
GetUserListRequest
Request message for GetUserList.
| Fields | |
|---|---|
name
|
Required. The resource name of the UserList to retrieve. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} |
IngestAudienceMembersRequest
Request to upload audience members to the provided destinations. Returns an IngestAudienceMembersResponse
.
| Fields | |
|---|---|
destinations[]
|
Required. The list of destinations to send the audience members to. |
audience_members[]
|
Required. The list of users to send to the specified destinations. At most 10000 |
consent
|
Optional. Request-level consent to apply to all users in the request. User-level consent overrides request-level consent, and can be specified in each |
validate_only
|
Optional. For testing purposes. If |
encoding
|
Optional. Required for |
encryption_info
|
Optional. Encryption information for |
terms_of_service
|
Optional. The terms of service that the user has accepted/rejected. |
IngestAudienceMembersResponse
Response from the IngestAudienceMembersRequest
.
| Fields | |
|---|---|
request_id
|
The auto-generated ID of the request. |
IngestEventsRequest
Request to upload audience members to the provided destinations. Returns an IngestEventsResponse
.
| Fields | |
|---|---|
destinations[]
|
Required. The list of destinations to send the events to. |
events[]
|
Required. The list of events to send to the specified destinations. At most 2000 |
consent
|
Optional. Request-level consent to apply to all users in the request. User-level consent overrides request-level consent, and can be specified in each |
validate_only
|
Optional. For testing purposes. If |
encoding
|
Optional. Required for |
encryption_info
|
Optional. Encryption information for |
IngestEventsResponse
Response from the IngestEventsRequest
.
| Fields | |
|---|---|
request_id
|
The auto-generated ID of the request. |
IngestedUserListInfo
Represents a user list that is populated by user provided data.
| Fields | |
|---|---|
upload_key_types[]
|
Required. Immutable. Upload key types of this user list. |
contact_id_info
|
Optional. Additional information when |
mobile_id_info
|
Optional. Additional information when |
user_id_info
|
Optional. Additional information when |
pair_id_info
|
Optional. Additional information when This feature is only available to data partners. |
pseudonymous_id_info
|
Optional. Additional information for |
partner_audience_info
|
Optional. Additional information for partner audiences. This feature is only available to data partners. |
UploadKeyType
Enum containing the possible upload key types of a user list.
| Enums | |
|---|---|
UPLOAD_KEY_TYPE_UNSPECIFIED
|
Not specified. |
CONTACT_ID
|
Customer info such as email address, phone number or physical address. |
MOBILE_ID
|
Mobile advertising ids. |
USER_ID
|
Third party provided user ids. |
PAIR_ID
|
Publisher advertiser identity reconciliation ids. |
PSEUDONYMOUS_ID
|
Data Management Platform IDs: - Google User ID - Partner Provided ID - Publisher Provided ID - iOS IDFA - Android advertising ID - Roku ID - Amazon Fire TV ID - Xbox or Microsoft ID |
Item
Represents an item in the cart associated with the event.
| Fields | |
|---|---|
merchant_product_id
|
Optional. The product ID within the Merchant Center account. |
quantity
|
Optional. The number of this item associated with the event. |
unit_price
|
Optional. The unit price excluding tax, shipping, and any transaction level discounts. |
item_id
|
Optional. A unique identifier to reference the item. |
additional_item_parameters[]
|
Optional. A bucket of any event parameters related to an item to be included within the event that were not already specified using other structured fields. |
ItemParameter
A bucket of any event parameters related to an item to be included within the event that were not already specified using other structured fields.
| Fields | |
|---|---|
parameter_name
|
Required. The name of the parameter to use. |
value
|
Required. The string representation of the value of the parameter to set. |
ListUserListDirectLicensesRequest
Request to list all UserListDirectLicense
resources for a given account.
parent
string
Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
filter
string
Optional. Filters to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123).
Supported Operations:
-
AND -
= -
!= -
> -
>= -
< -
<=
Unsupported Fields:
-
name(use get method instead) -
historical_pricingsand all its subfields -
pricing.start_time -
pricing.end_time
page_size
int32
Optional. The maximum number of licenses to return per page. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token
string
Optional. A page token, received from a previous ListUserListDirectLicense
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListUserListDirectLicense
must match the call that provided the page token.
ListUserListDirectLicensesResponse
Response from the ListUserListDirectLicensesRequest
.
| Fields | |
|---|---|
user_list_direct_licenses[]
|
The licenses for the given user list in the request. |
next_page_token
|
A token, which can be sent as |
ListUserListGlobalLicenseCustomerInfosRequest
Request to list all UserListGlobalLicenseCustomerInfo
resources for a given user list global license.
parent
string
Required. The global license whose customer info are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}
. To list all global license customer info under an account, replace the user list global license id with a '-' (for example, accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-
)
filter
string
Optional. Filters to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123).
Supported Operations:
-
AND -
= -
!= -
> -
>= -
< -
<=
Unsupported Fields:
-
name(use get method instead) -
historical_pricingsand all its subfields -
pricing.start_time -
pricing.end_time
page_size
int32
Optional. The maximum number of licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token
string
Optional. A page token, received from a previous ListUserListDirectLicense
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListUserListDirectLicense
must match the call that provided the page token.
ListUserListGlobalLicenseCustomerInfosResponse
Response from the [ListUserListGlobalLicensesCustomerInfoRequest][google.ads.datamanager.v1.ListUserListGlobalLicensesCustomerInfoRequest].
| Fields | |
|---|---|
user_list_global_license_customer_infos[]
|
The customer information for the given license in the request. |
next_page_token
|
A token, which can be sent as |
ListUserListGlobalLicensesRequest
Request to list all UserListGlobalLicense
resources for a given account.
parent
string
Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
filter
string
Optional. Filters to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123).
Supported Operations:
-
AND -
= -
!= -
> -
>= -
< -
<=
Unsupported Fields:
-
name(use get method instead) -
historical_pricingsand all its subfields -
pricing.start_time -
pricing.end_time
page_size
int32
Optional. The maximum number of licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token
string
Optional. A page token, received from a previous ListUserListGlobalLicense
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListUserListDirectLicense
must match the call that provided the page token.
ListUserListGlobalLicensesResponse
Response from the ListUserListGlobalLicensesRequest
.
| Fields | |
|---|---|
user_list_global_licenses[]
|
The licenses for the given user list in the request. |
next_page_token
|
A token, which can be sent as |
ListUserListsRequest
Request message for ListUserLists.
parent
string
Required. The parent account which owns this collection of user lists. Format: accountTypes/{account_type}/accounts/{account}
page_size
int32
Optional. The maximum number of user lists to return. The service may return fewer than this value. If unspecified, at most 50 user lists will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token
string
Optional. A page token, received from a previous ListUserLists
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListUserLists
must match the call that provided the page token.
filter
string
Optional. A filter string
. All fields need to be on the left hand side of each condition (for example: display_name = "list 1"
).
Supported operations:
-
AND -
= -
!= -
> -
>= -
< -
<= -
:(has)
Supported fields:
-
id -
display_name -
description -
membership_status -
integration_code -
access_reason -
ingested_user_list_info.upload_key_types
ListUserListsResponse
Response message for ListUserLists.
| Fields | |
|---|---|
user_lists[]
|
The user lists from the specified account. |
next_page_token
|
A token, which can be sent as |
MatchRateRange
The match rate range of the upload or userlist.
| Enums | |
|---|---|
MATCH_RATE_RANGE_UNKNOWN
|
The match rate range is unknown. |
MATCH_RATE_RANGE_NOT_ELIGIBLE
|
The match rate range is not eligible. |
MATCH_RATE_RANGE_LESS_THAN_20
|
The match rate range is less than 20% (in the interval [0, 20)
). |
MATCH_RATE_RANGE_20_TO_30
|
The match rate range is between 20% and 30% (in the interval [20, 31)
). |
MATCH_RATE_RANGE_31_TO_40
|
The match rate range is between 31% and 40% (in the interval [31, 41)
). |
MATCH_RATE_RANGE_41_TO_50
|
The match rate range is between 41% and 50% (in the interval [41, 51)
). |
MATCH_RATE_RANGE_51_TO_60
|
The match rate range is between 51% and 60% (in the interval [51, 61)
. |
MATCH_RATE_RANGE_61_TO_70
|
The match rate range is between 61% and 70% (in the interval [61, 71)
). |
MATCH_RATE_RANGE_71_TO_80
|
The match rate range is between 71% and 80% (in the interval [71, 81)
). |
MATCH_RATE_RANGE_81_TO_90
|
The match rate range is between 81% and 90% (in the interval [81, 91)
). |
MATCH_RATE_RANGE_91_TO_100
|
The match rate range is between 91% and 100% (in the interval |
MobileData
Mobile IDs for the audience. At least one mobile ID is required.
| Fields | |
|---|---|
mobile_ids[]
|
Required. The list of mobile device IDs (advertising ID/IDFA). At most 10 |
MobileIdInfo
Additional information when MOBILE_ID
is one of the upload_key_types
.
| Fields | |
|---|---|
data_source_type
|
Optional. Immutable. Source of the upload data. |
key_space
|
Required. Immutable. The key space of mobile IDs. |
app_id
|
Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected. |
KeySpace
Key space for mobile ID.
| Enums | |
|---|---|
KEY_SPACE_UNSPECIFIED
|
Not specified. |
IOS
|
The iOS keyspace. |
ANDROID
|
The Android keyspace. |
PairData
PAIR IDs for the audience. At least one PAIR ID is required.
This feature is only available to data partners.
| Fields | |
|---|---|
pair_ids[]
|
Required. Cleanroom-provided PII data, hashed with SHA256, and encrypted with an EC commutative cipher using publisher key for the PAIR
user list. At most 10 |
PairIdInfo
Additional information when PAIR_ID
is one of the upload_key_types
.
This feature is only available to data partners.
| Fields | |
|---|---|
match_rate_percentage
|
Output only. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive. |
advertiser_identifier_count
|
Output only. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list. |
publisher_id
|
Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms. |
publisher_name
|
Optional. Descriptive name of the publisher to be displayed in the UI for a better targeting experience. |
clean_room_identifier
|
Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers. |
PartnerAudienceInfo
Additional information for partner audiences.
This feature is only available to data partners.
| Fields | |
|---|---|
partner_audience_source
|
Required. Immutable. The source of the partner audience. |
commerce_partner
|
Optional. The commerce partner name. Only allowed if |
PartnerAudienceSource
Partner audience source.
| Enums | |
|---|---|
PARTNER_AUDIENCE_SOURCE_UNSPECIFIED
|
Not specified. |
COMMERCE_AUDIENCE
|
Partner Audience source is commerce audience. |
LINEAR_TV_AUDIENCE
|
Partner Audience source is linear TV audience. |
AGENCY_PROVIDER_AUDIENCE
|
Partner Audience source is agency/provider audience. |
PartnerLink
A partner link between an owning account and a partner account.
| Fields | |
|---|---|
name
|
Identifier. The name of the partner link. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link} |
partner_link_id
|
Output only. The partner link ID. |
owning_account
|
Required. The owning account granting access to the partner account. |
partner_account
|
Required. The partner account granted access by the owning account. |
PpidData
Publisher provided identifiers data holding the ppids. At least one ppid is required.
This feature is only available to data partners.
| Fields | |
|---|---|
ppids[]
|
Required. The list of publisher provided identifiers for a user. |
ProcessingErrorReason
The processing error reason.
| Enums | |
|---|---|
PROCESSING_ERROR_REASON_UNSPECIFIED
|
The processing error reason is unknown. |
PROCESSING_ERROR_REASON_INVALID_CUSTOM_VARIABLE
|
The custom variable is invalid. |
PROCESSING_ERROR_REASON_CUSTOM_VARIABLE_NOT_ENABLED
|
The status of the custom variable is not enabled. |
PROCESSING_ERROR_REASON_EVENT_TOO_OLD
|
The conversion is older than max supported age. |
PROCESSING_ERROR_REASON_DENIED_CONSENT
|
The ad user data is denied, either by the user or in the advertiser default settings. |
PROCESSING_ERROR_REASON_NO_CONSENT
|
Advertiser did not give 3P consent for the Ads core platform services. |
PROCESSING_ERROR_REASON_UNKNOWN_CONSENT
|
The overall consent (determined from row level consent, request level consent, and account settings) could not be determined for this user |
PROCESSING_ERROR_REASON_DUPLICATE_GCLID
|
A conversion with the same GCLID and conversion time already exists in the system. |
PROCESSING_ERROR_REASON_DUPLICATE_TRANSACTION_ID
|
A conversion with the same order id and conversion action combination was already uploaded. |
PROCESSING_ERROR_REASON_INVALID_GBRAID
|
The gbraid could not be decoded. |
PROCESSING_ERROR_REASON_INVALID_GCLID
|
The google click ID could not be decoded. |
PROCESSING_ERROR_REASON_INVALID_MERCHANT_ID
|
Merchant id contains non-digit characters. |
PROCESSING_ERROR_REASON_INVALID_WBRAID
|
The wbraid could not be decoded. |
PROCESSING_ERROR_REASON_INTERNAL_ERROR
|
Internal error. |
PROCESSING_ERROR_REASON_DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED
|
Enhanced conversions terms are not signed in the destination account. |
PROCESSING_ERROR_REASON_INVALID_EVENT
|
The event is invalid. |
PROCESSING_ERROR_REASON_INSUFFICIENT_MATCHED_TRANSACTIONS
|
The matched transactions are less than the minimum threshold. |
PROCESSING_ERROR_REASON_INSUFFICIENT_TRANSACTIONS
|
The transactions are less than the minimum threshold. |
PROCESSING_ERROR_REASON_INVALID_FORMAT
|
The event has format error. |
PROCESSING_ERROR_REASON_DECRYPTION_ERROR
|
The event has a decryption error. |
PROCESSING_ERROR_REASON_DEK_DECRYPTION_ERROR
|
The DEK failed to be decrypted. |
PROCESSING_ERROR_REASON_INVALID_WIP
|
The WIP is formatted incorrectly or the WIP does not exist. |
PROCESSING_ERROR_REASON_INVALID_KEK
|
The KEK cannot decrypt data because it is the wrong KEK, or it does not exist. |
PROCESSING_ERROR_REASON_WIP_AUTH_FAILED
|
The WIP could not be used because it was rejected by its attestation condition. |
PROCESSING_ERROR_REASON_KEK_PERMISSION_DENIED
|
The system did not have the permissions needed to access the KEK. |
PROCESSING_ERROR_REASON_AWS_AUTH_FAILED
|
The system failed to authenticate with AWS. |
PROCESSING_ERROR_REASON_USER_IDENTIFIER_DECRYPTION_ERROR
|
Failed to decrypt the UserIdentifier
data using the DEK. |
PROCESSING_ERROR_OPERATING_ACCOUNT_MISMATCH_FOR_AD_IDENTIFIER
|
The user attempted to ingest events with an ad identifier that isn't from the operating account's ads. |
ProcessingWarningReason
The processing warning reason.
| Enums | |
|---|---|
PROCESSING_WARNING_REASON_UNSPECIFIED
|
The processing warning reason is unknown. |
PROCESSING_WARNING_REASON_KEK_PERMISSION_DENIED
|
The system did not have the permissions needed to access the KEK. |
PROCESSING_WARNING_REASON_DEK_DECRYPTION_ERROR
|
The DEK failed to be decrypted. |
PROCESSING_WARNING_REASON_DECRYPTION_ERROR
|
The event has a decryption error. |
PROCESSING_WARNING_REASON_WIP_AUTH_FAILED
|
The WIP could not be used because it was rejected by its attestation condition. |
PROCESSING_WARNING_REASON_INVALID_WIP
|
The WIP is formatted incorrectly or the WIP does not exist. |
PROCESSING_WARNING_REASON_INVALID_KEK
|
The KEK cannot decrypt data because it is the wrong KEK, or it does not exist. |
PROCESSING_WARNING_REASON_USER_IDENTIFIER_DECRYPTION_ERROR
|
Failed to decrypt th UserIdentifier
data using the DEK. |
PROCESSING_WARNING_REASON_INTERNAL_ERROR
|
Internal error. |
PROCESSING_WARNING_REASON_AWS_AUTH_FAILED
|
The system failed to authenticate with AWS. |
Product
Deprecated. Use
instead. Represents a specific Google product.AccountType
| Enums | |
|---|---|
PRODUCT_UNSPECIFIED
|
Unspecified product. Should never be used. |
GOOGLE_ADS
|
Google Ads. |
DISPLAY_VIDEO_PARTNER
|
Display & Video 360 partner. |
DISPLAY_VIDEO_ADVERTISER
|
Display & Video 360 advertiser. |
DATA_PARTNER
|
Data Partner. |
ProductAccount
Represents a specific account.
| Fields | |
|---|---|
product
|
Deprecated. Use |
account_id
|
Required. The ID of the account. For example, your Google Ads account ID. |
account_type
|
Optional. The type of the account. For example, |
AccountType
Represents Google account types. Used to locate accounts and destinations.
| Enums | |
|---|---|
ACCOUNT_TYPE_UNSPECIFIED
|
Unspecified product. Should never be used. |
GOOGLE_ADS
|
Google Ads. |
DISPLAY_VIDEO_PARTNER
|
Display & Video 360 partner. |
DISPLAY_VIDEO_ADVERTISER
|
Display & Video 360 advertiser. |
DATA_PARTNER
|
Data Partner. |
GOOGLE_ANALYTICS_PROPERTY
|
Google Analytics. |
GOOGLE_AD_MANAGER_AUDIENCE_LINK
|
Google Ad Manager audience link. |
PseudonymousIdInfo
Additional information when PSEUDONYMOUS_ID
is one of the upload_key_types
.
| Fields | |
|---|---|
sync_status
|
Output only. Sync status of the user list. |
billable_record_count
|
Optional. Immutable. The number of billable records (e.g. uploaded or matched). |
SyncStatus
Sync status of the user list.
| Enums | |
|---|---|
SYNC_STATUS_UNSPECIFIED
|
Not specified. |
CREATED
|
The user list has been created as a placeholder. List contents and/or metadata are still being synced. The user list is not ready for use. |
READY_FOR_USE
|
The user list is ready for use. Contents and cookies have been synced correctly. |
FAILED
|
An error has occurred syncing user list contents and/or metadata. The user list cannot be used. |
RemoveAudienceMembersRequest
Request to remove users from an audience in the provided destinations. Returns a RemoveAudienceMembersResponse
.
| Fields | |
|---|---|
destinations[]
|
Required. The list of destinations to remove the users from. |
audience_members[]
|
Required. The list of users to remove. |
validate_only
|
Optional. For testing purposes. If |
encoding
|
Optional. Required for |
encryption_info
|
Optional. Encryption information for |
RemoveAudienceMembersResponse
Response from the RemoveAudienceMembersRequest
.
| Fields | |
|---|---|
request_id
|
The auto-generated ID of the request. |
RequestStatusPerDestination
A request status per destination.
destination
A destination within a DM API request.
request_status
The request status of the destination.
error_info
An error info error containing the error reason and error counts related to the upload.
warning_info
A warning info containing the warning reason and warning counts related to the upload.
status
. The status of the destination. status
can be only one of the following:audience_members_ingestion_status
The status of the ingest audience members request.
events_ingestion_status
The status of the ingest events request.
audience_members_removal_status
The status of the remove audience members request.
IngestAudienceMembersStatus
The status of the ingest audience members request.
status
. The status of the audience members ingestion to the destination. status
can be only one of the following:user_data_ingestion_status
The status of the user data ingestion to the destination.
mobile_data_ingestion_status
The status of the mobile data ingestion to the destination.
pair_data_ingestion_status
The status of the pair data ingestion to the destination.
user_id_data_ingestion_status
The status of the user id data ingestion to the destination.
ppid_data_ingestion_status
The status of the ppid data ingestion to the destination.
IngestEventsStatus
The status of the events ingestion to the destination.
| Fields | |
|---|---|
record_count
|
The total count of events sent in the upload request. Includes all events in the request, regardless of whether they were successfully ingested or not. |
IngestMobileDataStatus
The status of the mobile data ingestion to the destination containing stats related to the ingestion.
| Fields | |
|---|---|
record_count
|
The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. |
mobile_id_count
|
The total count of mobile ids sent in the upload request for the destination. Includes all mobile ids in the request, regardless of whether they were successfully ingested or not. |
IngestPairDataStatus
The status of the pair data ingestion to the destination containing stats related to the ingestion.
| Fields | |
|---|---|
record_count
|
The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. |
pair_id_count
|
The total count of pair ids sent in the upload request for the destination. Includes all pair ids in the request, regardless of whether they were successfully ingested or not. |
IngestPpidDataStatus
The status of the ppid data ingestion to the destination containing stats related to the ingestion.
| Fields | |
|---|---|
record_count
|
The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. |
ppid_count
|
The total count of ppids sent in the upload request for the destination. Includes all ppids in the request, regardless of whether they were successfully ingested or not. |
IngestUserDataStatus
The status of the user data ingestion to the destination containing stats related to the ingestion.
| Fields | |
|---|---|
record_count
|
The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. |
user_identifier_count
|
The total count of user identifiers sent in the upload request for the destination. Includes all user identifiers in the request, regardless of whether they were successfully ingested or not. |
upload_match_rate_range
|
The match rate range of the upload. |
IngestUserIdDataStatus
The status of the user id data ingestion to the destination containing stats related to the ingestion.
| Fields | |
|---|---|
record_count
|
The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. |
user_id_count
|
The total count of user ids sent in the upload request for the destination. Includes all user ids in the request, regardless of whether they were successfully ingested or not. |
RemoveAudienceMembersStatus
The status of the remove audience members request.
status
. The status of the audience members removal from the destination. status
can be only one of the following:user_data_removal_status
The status of the user data removal from the destination.
mobile_data_removal_status
The status of the mobile data removal from the destination.
pair_data_removal_status
The status of the pair data removal from the destination.
user_id_data_removal_status
The status of the user id data removal from the destination.
ppid_data_removal_status
The status of the ppid data removal from the destination.
RemoveMobileDataStatus
The status of the mobile data removal from the destination.
| Fields | |
|---|---|
record_count
|
The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. |
mobile_id_count
|
The total count of mobile Ids sent in the removal request. Includes all mobile ids in the request, regardless of whether they were successfully removed or not. |
RemovePairDataStatus
The status of the pair data removal from the destination.
| Fields | |
|---|---|
record_count
|
The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. |
pair_id_count
|
The total count of pair ids sent in the removal request. Includes all pair ids in the request, regardless of whether they were successfully removed or not. |
RemovePpidDataStatus
The status of the ppid data removal from the destination.
| Fields | |
|---|---|
record_count
|
The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. |
ppid_count
|
The total count of ppids sent in the removal request. Includes all ppids in the request, regardless of whether they were successfully removed or not. |
RemoveUserDataStatus
The status of the user data removal from the destination.
| Fields | |
|---|---|
record_count
|
The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. |
user_identifier_count
|
The total count of user identifiers sent in the removal request. Includes all user identifiers in the request, regardless of whether they were successfully removed or not. |
RemoveUserIdDataStatus
The status of the user id data removal from the destination.
| Fields | |
|---|---|
record_count
|
The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. |
user_id_count
|
The total count of user ids sent in the removal request. Includes all user ids in the request, regardless of whether they were successfully removed or not. |
RequestStatus
The request status.
| Enums | |
|---|---|
REQUEST_STATUS_UNKNOWN
|
The request status is unknown. |
SUCCESS
|
The request succeeded. |
PROCESSING
|
The request is processing. |
FAILED
|
The request failed. |
PARTIAL_SUCCESS
|
The request partially succeeded. |
RetrieveInsightsRequest
Request message for DM API MarketingDataInsightsService.RetrieveInsights
| Fields | |
|---|---|
parent
|
Required. The parent account that owns the user list. Format: |
baseline
|
Required. Baseline for the insights requested. |
user_list_id
|
Required. The user list ID for which insights are requested. |
RetrieveInsightsResponse
Response message for DM API MarketingDataInsightsService.RetrieveInsights
| Fields | |
|---|---|
marketing_data_insights[]
|
Contains the insights for the marketing data. |
MarketingDataInsight
Insights for marketing data.
This feature is only available to data partners.
| Fields | |
|---|---|
dimension
|
The dimension to which the insight belongs. |
attributes[]
|
Insights for values of a given dimension. |
AudienceInsightsDimension
Possible dimensions for use in generating insights.
| Enums | |
|---|---|
AUDIENCE_INSIGHTS_DIMENSION_UNSPECIFIED
|
Not specified. |
AUDIENCE_INSIGHTS_DIMENSION_UNKNOWN
|
The value is unknown in this version. |
AFFINITY_USER_INTEREST
|
An Affinity UserInterest. |
IN_MARKET_USER_INTEREST
|
An In-Market UserInterest. |
AGE_RANGE
|
An age range. |
GENDER
|
A gender. |
MarketingDataInsightsAttribute
Insights for a collection of related attributes of the same dimension.
| Fields | |
|---|---|
user_interest_id
|
The user interest ID. |
lift
|
Measure of lift that the audience has for the attribute value as compared to the baseline. Range [0-1]. |
age_range
|
Age range of the audience for which the lift is provided. |
gender
|
Gender of the audience for which the lift is provided. |
RetrieveRequestStatusRequest
Request to get the status of request made to the DM API for a given request ID. Returns a RetrieveRequestStatusResponse
.
| Fields | |
|---|---|
request_id
|
Required. Required. The request ID of the Data Manager API request. |
RetrieveRequestStatusResponse
Response from the RetrieveRequestStatusRequest
.
| Fields | |
|---|---|
request_status_per_destination[]
|
A list of request statuses per destination. The order of the statuses matches the order of the destinations in the original request. |
SearchPartnerLinksRequest
Request to search for PartnerLink
resources. Returns a SearchPartnerLinksResponse
.
parent
string
Required. Account to search for partner links. If no filter
is specified, all partner links where this account is either the owning_account
or partner_account
are returned.
Format: accountTypes/{account_type}/accounts/{account}
page_size
int32
The maximum number of partner links to return. The service may return fewer than this value. If unspecified, at most 10 partner links will be returned. The maximum value is 100; values above 100 will be coerced to 100.
page_token
string
A page token, received from a previous SearchPartnerLinks
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to SearchPartnerLinks
must match the call that provided the page token.
filter
string
Optional. A filter string
. All fields need to be on the left hand side of each condition (for example: partner_link_id = 123456789
).
Supported operations:
-
AND -
= -
!=
Supported fields:
-
partner_link_id -
owning_account.account_type -
owning_account.account_id -
partner_account.account_type -
partner_account.account_id
Example: owning_account.account_type = "GOOGLE_ADS" OR partner_account.account_id =
987654321
SearchPartnerLinksResponse
Response from the SearchPartnerLinksRequest
.
| Fields | |
|---|---|
partner_links[]
|
The partner links for the given account. |
next_page_token
|
A token, which can be sent as |
SizeInfo
Estimated number of members in this user list in different target networks.
| Fields | |
|---|---|
display_network_members_count
|
Output only. Estimated number of members in this user list, on the Google Display Network. |
search_network_members_count
|
Output only. Estimated number of members in this user list in the google.com domain. These are the members available for targeting in Search campaigns. |
TargetNetworkInfo
Eligibility information for different target networks.
| Fields | |
|---|---|
eligible_for_display
|
Output only. Indicates this user list is eligible for Google Display Network. |
eligible_for_search
|
Optional. Indicates if this user list is eligible for Google Search Network. |
TermsOfService
The terms of service that the user has accepted/rejected.
| Fields | |
|---|---|
customer_match_terms_of_service_status
|
Optional. The Customer Match terms of service: https://support.google.com/adspolicy/answer/6299717
. This must be accepted when ingesting |
TermsOfServiceStatus
Represents the caller's decision to accept or reject the terms of service.
| Enums | |
|---|---|
TERMS_OF_SERVICE_STATUS_UNSPECIFIED
|
Not specified. |
ACCEPTED
|
Status indicating the caller has chosen to accept the terms of service. |
REJECTED
|
Status indicating the caller has chosen to reject the terms of service. |
UpdateUserListDirectLicenseRequest
Request to update a UserListDirectLicense
resource.
| Fields | |
|---|---|
user_list_direct_license
|
Required. The licenses' |
update_mask
|
Optional. The list of fields to update. The special character |
UpdateUserListGlobalLicenseRequest
Request to update a UserListGlobalLicense
resource.
| Fields | |
|---|---|
user_list_global_license
|
Required. The licenses' |
update_mask
|
Optional. The list of fields to update. The special character |
UpdateUserListRequest
Request message for UpdateUserList.
| Fields | |
|---|---|
user_list
|
Required. The user list to update. The user list's |
update_mask
|
Optional. The list of fields to update. |
validate_only
|
Optional. If true, the request is validated but not executed. |
UserData
Data that identifies the user. At least one identifier is required.
| Fields | |
|---|---|
user_identifiers[]
|
Required. The identifiers for the user. It's possible to provide multiple instances of the same type of data (for example, multiple email addresses). To increase the likelihood of a match, provide as many identifiers as possible. At most 10 |
UserIdData
User id data holding the user id.
| Fields | |
|---|---|
user_id
|
Required. A unique identifier for a user, as defined by the advertiser. |
UserIdInfo
Additional information when USER_ID
is one of the upload_key_types
.
| Fields | |
|---|---|
data_source_type
|
Optional. Immutable. Source of the upload data. |
UserIdentifier
A single identifier for the user.
identifier
. Exactly one must be specified. identifier
can be only one of the following:email_address
string
Hashed email address using SHA-256 hash function after normalization.
phone_number
string
Hashed phone number using SHA-256 hash function after normalization (E164 standard).
address
The known components of a user's address. Holds a grouping of identifiers that are matched all at once.
UserList
A user list resource.
name
string
Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
id
int64
Output only. The unique ID of the user list.
read_only
bool
Output only. An option that indicates if a user may edit a list.
membership_duration
Optional. The duration a user remains in the user list. Valid durations are exact multiples of 24 hours (86400 seconds). Providing a value that is not an exact multiple of 24 hours will result in an INVALID_ARGUMENT error.
access_reason
Output only. The reason this account has been granted access to the list.
size_info
Output only. Estimated number of members in this user list in different target networks.
target_network_info
Optional. Eligibility information for different target networks.
display_name
string
Required. The display name of the user list.
description
string
Optional. A description of the user list.
membership_status
Optional. Membership status of this user list.
integration_code
string
Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems.
closing_reason
Output only. The reason why this user list membership status is closed.
account_access_status
Optional. Indicates if this share is still enabled. When a user list is shared with the account this field is set to ENABLED
. Later the user list owner can decide to revoke the share and make it DISABLED
.
user_list_info
. Additional information about the user list. user_list_info
can be only one of the following:ingested_user_list_info
Optional. Represents a user list that is populated by user ingested data.
AccessReason
Enum describing possible access reasons.
| Enums | |
|---|---|
ACCESS_REASON_UNSPECIFIED
|
Not specified. |
OWNED
|
The resource is owned by the user. |
SHARED
|
The resource is shared to the user. |
LICENSED
|
The resource is licensed to the user. |
SUBSCRIBED
|
The user subscribed to the resource. |
AFFILIATED
|
The resource is accessible to the user. |
AccessStatus
Indicates if this client still has access to the list.
| Enums | |
|---|---|
ACCESS_STATUS_UNSPECIFIED
|
Not specified. |
ENABLED
|
The access is enabled. |
DISABLED
|
The access is disabled. |
ClosingReason
Indicates the reason why the user list was closed. This enum is only used when a list is auto-closed by the system.
| Enums | |
|---|---|
CLOSING_REASON_UNSPECIFIED
|
Not specified. |
UNUSED
|
The user list was closed because it has not been used in targeting recently. See https://support.google.com/google-ads/answer/2472738 for details. |
MembershipStatus
Status of the user list.
| Enums | |
|---|---|
MEMBERSHIP_STATUS_UNSPECIFIED
|
Not specified. |
OPEN
|
Open status - User list is accruing members and can be targeted to. |
CLOSED
|
Closed status - No new members being added. |
UserListDirectLicense
A user list direct license.
This feature is only available to data partners.
| Fields | |
|---|---|
name
|
Identifier. The resource name of the user list direct license. |
user_list_display_name
|
Output only. Name of the user list being licensed. This field is read-only. |
client_account_display_name
|
Output only. Name of client customer which the user list is being licensed to. This field is read-only. |
pricing
|
Optional. UserListDirectLicense pricing. |
historical_pricings[]
|
Output only. Pricing history of this user list license. This field is read-only. |
metrics
|
Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call |
user_list_id
|
Immutable. ID of the user list being licensed. |
client_account_type
|
Immutable. Account type of client customer which the user list is being licensed to. |
client_account_id
|
Immutable. ID of client customer which the user list is being licensed to. |
status
|
Optional. Status of UserListDirectLicense - ENABLED or DISABLED. |
UserListGlobalLicense
A user list global license.
This feature is only available to data partners.
| Fields | |
|---|---|
name
|
Identifier. The resource name of the user list global license. |
user_list_display_name
|
Output only. Name of the user list being licensed. This field is read-only. |
pricing
|
Optional. UserListGlobalLicense pricing. |
historical_pricings[]
|
Output only. Pricing history of this user list license. This field is read-only. |
metrics
|
Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListGlobalLicenses call |
user_list_id
|
Immutable. ID of the user list being licensed. |
license_type
|
Immutable. Product type of client customer which the user list is being licensed to. |
status
|
Optional. Status of UserListGlobalLicense - ENABLED or DISABLED. |
UserListGlobalLicenseCustomerInfo
Information about a customer of a user list global license. This will automatically be created by the system when a customer purchases a global license.
| Fields | |
|---|---|
name
|
Identifier. The resource name of the user list global license customer. |
user_list_id
|
Output only. ID of the user list being licensed. |
user_list_display_name
|
Output only. Name of the user list being licensed. |
license_type
|
Output only. Product type of client customer which the user list is being licensed to. |
status
|
Output only. Status of UserListDirectLicense - ENABLED or DISABLED. |
pricing
|
Output only. UserListDirectLicense pricing. |
client_account_type
|
Output only. Product type of client customer which the user list is being licensed to. |
client_account_id
|
Output only. ID of client customer which the user list is being licensed to. |
client_account_display_name
|
Output only. Name of client customer which the user list is being licensed to. |
historical_pricings[]
|
Output only. Pricing history of this user list license. |
metrics
|
Output only. Metrics related to this license This field is only populated if the start and end dates are set in the ListUserListGlobalLicenseCustomerInfos call. |
UserListGlobalLicenseType
User list global license types.
| Enums | |
|---|---|
USER_LIST_GLOBAL_LICENSE_TYPE_UNSPECIFIED
|
UNSPECIFIED. |
USER_LIST_GLOBAL_LICENSE_TYPE_RESELLER
|
Reseller license. |
USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_SELL_SIDE
|
DataMart Sell Side license. |
USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_BUY_SIDE
|
DataMart Buy Side license. |
UserListLicenseClientAccountType
Possible product of a client account for a user list license.
| Enums | |
|---|---|
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_UNKNOWN
|
Unknown. |
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_ADS
|
Google Ads customer. |
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_PARTNER
|
Display & Video 360 partner. |
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_ADVERTISER
|
Display & Video 360 advertiser. |
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_AD_MANAGER_AUDIENCE_LINK
|
Google Ad Manager audience link. |
UserListLicenseMetrics
Metrics related to a user list license.
| Fields | |
|---|---|
click_count
|
Output only. The number of clicks for the user list license. |
impression_count
|
Output only. The number of impressions for the user list license. |
revenue_usd_micros
|
Output only. The revenue for the user list license in USD micros. |
start_date
|
Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If |
end_date
|
Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If |
UserListLicensePricing
A user list license pricing.
| Fields | |
|---|---|
pricing_id
|
Output only. The ID of this pricing. |
start_time
|
Output only. Start time of the pricing. |
end_time
|
Optional. End time of the pricing. |
pricing_active
|
Output only. Whether this pricing is active. |
buyer_approval_state
|
Output only. The buyer approval state of this pricing. This field is read-only. |
cost_micros
|
Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if |
currency_code
|
Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. |
cost_type
|
Immutable. The cost type of this pricing. Can be set only in the |
max_cost_micros
|
Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to |
UserListPricingBuyerApprovalState
User list pricing buyer approval state.
| Enums | |
|---|---|
USER_LIST_PRICING_BUYER_APPROVAL_STATE_UNSPECIFIED
|
UNSPECIFIED. |
PENDING
|
User list client has not yet accepted the pricing terms set by the user list owner. |
APPROVED
|
User list client has accepted the pricing terms set by the user list owner. |
REJECTED
|
User list client has rejected the pricing terms set by the user list owner. |
UserListPricingCostType
User list pricing cost type.
| Enums | |
|---|---|
USER_LIST_PRICING_COST_TYPE_UNSPECIFIED
|
Unspecified. |
CPC
|
Cost per click. |
CPM
|
Cost per mille (thousand impressions). |
MEDIA_SHARE
|
Media share. |
UserListLicenseStatus
User list license status.
| Enums | |
|---|---|
USER_LIST_LICENSE_STATUS_UNSPECIFIED
|
Unknown. |
USER_LIST_LICENSE_STATUS_ENABLED
|
Active status - user list is still being licensed. |
USER_LIST_LICENSE_STATUS_DISABLED
|
Inactive status - user list is no longer being licensed. |
UserProperties
Advertiser-assessed information about the user at the time that the event happened. See https://support.google.com/google-ads/answer/14007601 for more details.
| Fields | |
|---|---|
customer_type
|
Optional. Type of the customer associated with the event. |
customer_value_bucket
|
Optional. The advertiser-assessed value of the customer. |
additional_user_properties[]
|
Optional. A bucket of any additional user properties for the user associated with this event. |
UserProperty
A bucket of any additional user properties for the user associated with this event.
| Fields | |
|---|---|
property_name
|
Required. The name of the user property to use. |
value
|
Required. The string representation of the value of the user property to use. |
WarningCount
The warning count for a given warning reason.
| Fields | |
|---|---|
record_count
|
The count of records that have a warning. |
reason
|
The warning reason. |
WarningInfo
Warning counts for each type of warning.
| Fields | |
|---|---|
warning_counts[]
|
A list of warnings and counts per warning reason. |
