The Data Manager API is in closed beta. To express interest in joining the closed beta, fill out
this form.
UserData
Stay organized with collections
Save and categorize content based on your preferences.
Data that identifies the user. At least one identifier is required.
| JSON representation |
{
"userIdentifiers": [
{
object (UserIdentifier)
}
]
} |
| Fields |
userIdentifiers[] |
object (UserIdentifier)
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 userIdentifiers can be provided in a single AudienceMember or Event.
|
UserIdentifier
A single identifier for the user.
| JSON representation |
{
// Union field identifier can be only one of the following:
"emailAddress": string,
"phoneNumber": string,
"address": {
object (AddressInfo)
}
// End of list of possible types for union field identifier.
} |
| Fields |
Union field identifier. Exactly one must be specified. identifier can be only one of the following: |
emailAddress |
string
Hashed email address using SHA-256 hash function after normalization.
|
phoneNumber |
string
Hashed phone number using SHA-256 hash function after normalization (E164 standard).
|
address |
object (AddressInfo)
The known components of a user's address. Holds a grouping of identifiers that are matched all at once.
|
AddressInfo
Address information for the user.
| JSON representation |
{
"givenName": string,
"familyName": string,
"regionCode": string,
"postalCode": string
} |
| Fields |
givenName |
string
Required. Given (first) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.
|
familyName |
string
Required. Family (last) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.
|
regionCode |
string
Required. The 2-letter region code in ISO-3166-1 alpha-2 of the user's address.
|
postalCode |
string
Required. The postal code of the user's address.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-24 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-24 UTC."],[],[],null,["# UserData\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [UserIdentifier](#UserIdentifier)\n - [JSON representation](#UserIdentifier.SCHEMA_REPRESENTATION)\n- [AddressInfo](#AddressInfo)\n - [JSON representation](#AddressInfo.SCHEMA_REPRESENTATION)\n\nData that identifies the user. At least one identifier is required.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------|\n| ``` { \"userIdentifiers\": [ { object (/data-manager/api/reference/rest/v1/UserData#UserIdentifier) } ] } ``` |\n\n| Fields ||\n|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `userIdentifiers[]` | `object (`[UserIdentifier](/data-manager/api/reference/rest/v1/UserData#UserIdentifier)`)` 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 `userIdentifiers` can be provided in a single [AudienceMember](/data-manager/api/reference/rest/v1/AudienceMember) or [Event](/data-manager/api/reference/rest/v1/events/ingest#Event). |\n\nUserIdentifier\n--------------\n\nA single identifier for the user.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { // Union field `identifier` can be only one of the following: \"emailAddress\": string, \"phoneNumber\": string, \"address\": { object (/data-manager/api/reference/rest/v1/UserData#AddressInfo) } // End of list of possible types for union field `identifier`. } ``` |\n\n| Fields ||\n|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Union field `identifier`. Exactly one must be specified. `identifier` can be only one of the following: ||\n| `emailAddress` | `string` Hashed email address using SHA-256 hash function after normalization. |\n| `phoneNumber` | `string` Hashed phone number using SHA-256 hash function after normalization (E164 standard). |\n| `address` | `object (`[AddressInfo](/data-manager/api/reference/rest/v1/UserData#AddressInfo)`)` The known components of a user's address. Holds a grouping of identifiers that are matched all at once. |\n\nAddressInfo\n-----------\n\nAddress information for the user.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------|\n| ``` { \"givenName\": string, \"familyName\": string, \"regionCode\": string, \"postalCode\": string } ``` |\n\n| Fields ||\n|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------|\n| `givenName` | `string` Required. Given (first) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256. |\n| `familyName` | `string` Required. Family (last) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256. |\n| `regionCode` | `string` Required. The 2-letter region code in ISO-3166-1 alpha-2 of the user's address. |\n| `postalCode` | `string` Required. The postal code of the user's address. |"]]