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

UserIdentifier

User identifying information.

JSON representation
{
  "userIdentifierSource": enum (UserIdentifierSource),

  // Union field identifier can be only one of the following:
  "hashedEmail": string,
  "hashedPhoneNumber": string,
  "mobileId": string,
  "thirdPartyUserId": string,
  "addressInfo": {
    object (OfflineUserAddressInfo)
  }
  // End of list of possible types for union field identifier.
}
Fields
userIdentifierSource

enum (UserIdentifierSource)

Source of the user identifier when the upload is from Store Sales, ConversionUploadService, or ConversionAdjustmentUploadService. For ConversionUploadService and ConversionAdjustmentUploadService, the source of the user identifier must be specified as FIRST_PARTY, otherwise an error will be returned.

Union field identifier. Exactly one must be specified. For OfflineUserDataJobService, Customer Match accepts hashed_email, hashed_phone_number, mobile_id, third_party_user_id, and address_info; Store Sales accepts hashed_email, hashed_phone_number, third_party_user_id, and address_info. ConversionUploadService accepts hashed_email and hashed_phone_number. ConversionAdjustmentUploadService accepts hashed_email, hashed_phone_number, and address_info. identifier can be only one of the following:
hashedEmail

string

Hashed email address using SHA-256 hash function after normalization. Accepted for Customer Match, Store Sales, ConversionUploadService, and ConversionAdjustmentUploadService.

hashedPhoneNumber

string

Hashed phone number using SHA-256 hash function after normalization (E164 standard). Accepted for Customer Match, Store Sales, ConversionUploadService, and ConversionAdjustmentUploadService.

mobileId

string

Mobile device ID (advertising ID/IDFA). Accepted only for Customer Match.

thirdPartyUserId

string

Advertiser-assigned user ID for Customer Match upload, or third-party-assigned user ID for Store Sales. Accepted only for Customer Match and Store Sales.

addressInfo

object (OfflineUserAddressInfo)

Address information. Accepted only for Customer Match, Store Sales, and ConversionAdjustmentUploadService.

UserIdentifierSource

The type of user identifier source for offline Store Sales, click conversion, and conversion adjustment uploads.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version
FIRST_PARTY Indicates that the user identifier was provided by the first party (advertiser).
THIRD_PARTY Indicates that the user identifier was provided by the third party (partner).

OfflineUserAddressInfo

Address identifier of offline data.

JSON representation
{
  "hashedFirstName": string,
  "hashedLastName": string,
  "city": string,
  "state": string,
  "countryCode": string,
  "postalCode": string,
  "hashedStreetAddress": string
}
Fields
hashedFirstName

string

First name of the user, which is hashed as SHA-256 after normalized (Lowercase all characters; Remove any extra spaces before, after, and in between).

hashedLastName

string

Last name of the user, which is hashed as SHA-256 after normalized (lower case only and no punctuation).

city

string

City of the address. Only accepted for Store Sales and ConversionAdjustmentUploadService.

state

string

State code of the address. Only accepted for Store Sales and ConversionAdjustmentUploadService.

countryCode

string

2-letter country code in ISO-3166-1 alpha-2 of the user's address.

postalCode

string

Postal code of the user's address.

hashedStreetAddress

string

The street address of the user hashed using SHA-256 hash function after normalization (lower case only). Only accepted for ConversionAdjustmentUploadService.