AudienceMember

  • Audience members are operated on and can optionally include destination references and consent settings.

  • Audience member data can be identified by user-provided data, PAIR IDs, or mobile device IDs.

  • PairData requires at least one PAIR ID, which are hashed and encrypted PII data.

  • MobileData requires at least one mobile ID, which are advertising ID/IDFA.

The audience member to be operated on.

JSON representation
 { 
 "destinationReferences" 
 : 
 [ 
 string 
 ] 
 , 
 "consent" 
 : 
 { 
 object (  Consent 
 
) 
 } 
 , 
 // Union field data 
can be only one of the following: 
 "userData" 
 : 
 { 
 object (  UserData 
 
) 
 } 
 , 
 "pairData" 
 : 
 { 
 object (  PairData 
 
) 
 } 
 , 
 "mobileData" 
 : 
 { 
 object (  MobileData 
 
) 
 } 
 , 
 "userIdData" 
 : 
 { 
 object (  UserIdData 
 
) 
 } 
 , 
 "ppidData" 
 : 
 { 
 object (  PpidData 
 
) 
 } 
 , 
 "compositeData" 
 : 
 { 
 object (  CompositeData 
 
) 
 } 
 // End of list of possible types for union field data 
. 
 } 
Fields
destinationReferences[]

string

Optional. Defines which Destination to send the audience member to.

consent

object ( Consent )

Optional. The consent setting for the user.

Union field data . The type of identifying data to be operated on. data can be only one of the following:
userData

object ( UserData )

User-provided data that identifies the user.

pairData

object ( PairData )

Publisher Advertiser Identity Reconciliation (PAIR) IDs .

This feature is only available to data partners.

mobileData

object ( MobileData )

Data identifying the user's mobile devices.

userIdData

object ( UserIdData )

Data related to unique identifiers for a user, as defined by the advertiser.

ppidData

object ( PpidData )

Data related to publisher provided identifiers.

This feature is only available to data partners.

compositeData

object ( CompositeData )

Group of multiple identifier types.

PairData

PAIR IDs for the audience. At least one PAIR ID is required.

This feature is only available to data partners.

JSON representation
 { 
 "pairIds" 
 : 
 [ 
 string 
 ] 
 } 
Fields
pairIds[]

string

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 pairIds can be provided in a single AudienceMember .

MobileData

Mobile IDs for the audience. At least one mobile ID is required.

JSON representation
 { 
 "mobileIds" 
 : 
 [ 
 string 
 ] 
 } 
Fields
mobileIds[]

string

Required. The list of mobile device IDs (advertising ID/IDFA). At most 10 mobileIds can be provided in a single AudienceMember .

UserIdData

User id data holding the user id.

JSON representation
 { 
 "userId" 
 : 
 string 
 } 
Fields
userId

string

Required. A unique identifier for a user, as defined by the advertiser.

PpidData

Publisher provided identifiers data holding the ppids. At least one ppid is required.

This feature is only available to data partners.

JSON representation
 { 
 "ppids" 
 : 
 [ 
 string 
 ] 
 } 
Fields
ppids[]

string

Required. The list of publisher provided identifiers for a user.

CompositeData

Composite data holding identifiers and associated data for a user. At least one of userData or ipData is required.

JSON representation
 { 
 "userData" 
 : 
 { 
 object (  UserData 
 
) 
 } 
 , 
 "ipData" 
 : 
 [ 
 { 
 object (  IpData 
 
) 
 } 
 ] 
 } 
Fields
userData

object ( UserData )

Optional. User-provided data that identifies the user.

ipData[]

object ( IpData )

Optional. IP address data representing customer interaction used to build the audience.

IpData

IP address information for a user. We recommend including observeStartTime and observeEndTime to help improve Customer Match match rates.

JSON representation
 { 
 "ipAddress" 
 : 
 string 
 , 
 "observeStartTime" 
 : 
 string 
 , 
 "observeEndTime" 
 : 
 string 
 } 
Fields
ipAddress

string

Required. IP address captured at the time of customer interaction. Accepts standard string formats for both IPv4 and IPv6.

observeStartTime

string ( Timestamp format)

Optional. First recorded interaction time from this IP address in a session.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

observeEndTime

string ( Timestamp format)

Optional. Last recorded interaction time from this IP address in a session.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

Create a Mobile Website
View Site in Mobile | Classic
Share by: