REST Resource: firstAndThirdPartyAudiences

    Resource: FirstAndThirdPartyAudience

    Describes a first or third party audience list used for targeting. First party audiences are created via usage of client data. Third party audiences are provided by Third Party data providers and can only be licensed to customers.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "firstAndThirdPartyAudienceId" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "firstAndThirdPartyAudienceType" 
 : 
 enum (  FirstAndThirdPartyAudienceType 
 
) 
 , 
 "audienceType" 
 : 
 enum (  AudienceType 
 
) 
 , 
 "audienceSource" 
 : 
 enum (  AudienceSource 
 
) 
 , 
 "membershipDurationDays" 
 : 
 string 
 , 
 "displayAudienceSize" 
 : 
 string 
 , 
 "activeDisplayAudienceSize" 
 : 
 string 
 , 
 "youtubeAudienceSize" 
 : 
 string 
 , 
 "gmailAudienceSize" 
 : 
 string 
 , 
 "displayMobileAppAudienceSize" 
 : 
 string 
 , 
 "displayMobileWebAudienceSize" 
 : 
 string 
 , 
 "displayDesktopAudienceSize" 
 : 
 string 
 , 
 "appId" 
 : 
 string 
 , 
 // Union field members 
can be only one of the following: 
 "contactInfoList" 
 : 
 { 
 object (  ContactInfoList 
 
) 
 } 
 , 
 "mobileDeviceIdList" 
 : 
 { 
 object (  MobileDeviceIdList 
 
) 
 } 
 // End of list of possible types for union field members 
. 
 }
    Fields
    name

    string

    Output only. The resource name of the first and third party audience.

    firstAndThirdPartyAudienceId

    string ( int64 format)

    Output only. The unique ID of the first and third party audience. Assigned by the system.

    displayName

    string

    The display name of the first and third party audience.

    description

    string

    The user-provided description of the audience.

    Only applicable to first party audiences.

    firstAndThirdPartyAudienceType

    enum ( FirstAndThirdPartyAudienceType )

    Whether the audience is a first or third party audience.

    audienceType

    enum ( AudienceType )

    The type of the audience.

    audienceSource

    enum ( AudienceSource )

    Output only. The source of the audience.

    membershipDurationDays

    string ( int64 format)

    The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540.

    Only applicable to first party audiences.

    This field is required if one of the following audienceType is used:

    • CUSTOMER_MATCH_CONTACT_INFO
    • CUSTOMER_MATCH_DEVICE_ID
    displayAudienceSize

    string ( int64 format)

    Output only. The estimated audience size for the Display network.

    If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits.

    Only returned in GET request.

    activeDisplayAudienceSize

    string ( int64 format)

    Output only. The estimated audience size for the Display network in the past month.

    If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits.

    Only returned in GET request.

    youtubeAudienceSize

    string ( int64 format)

    Output only. The estimated audience size for YouTube network.

    If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits.

    Only applicable to first party audiences.

    Only returned in GET request.

    gmailAudienceSize

    string ( int64 format)

    Output only. The estimated audience size for Gmail network.

    If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits.

    Only applicable to first party audiences.

    Only returned in GET request.

    displayMobileAppAudienceSize

    string ( int64 format)

    Output only. The estimated mobile app audience size in Display network.

    If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits.

    Only applicable to first party audiences.

    Only returned in GET request.

    displayMobileWebAudienceSize

    string ( int64 format)

    Output only. The estimated mobile web audience size in Display network.

    If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits.

    Only applicable to first party audiences.

    Only returned in GET request.

    displayDesktopAudienceSize

    string ( int64 format)

    Output only. The estimated desktop audience size in Display network.

    If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits.

    Only applicable to first party audiences.

    Only returned in GET request.

    appId

    string

    The appId matches with the type of the mobileDeviceIds being uploaded.

    Only applicable to audienceType CUSTOMER_MATCH_DEVICE_ID

    Union field members . The initial members of the Customer Match audience. members can be only one of the following:
    contactInfoList

    object ( ContactInfoList )

    Input only. A list of contact information to define the initial audience members.

    Only applicable to audienceType CUSTOMER_MATCH_CONTACT_INFO

    mobileDeviceIdList

    object ( MobileDeviceIdList )

    Input only. A list of mobile device IDs to define the initial audience members.

    Only applicable to audienceType CUSTOMER_MATCH_DEVICE_ID

    FirstAndThirdPartyAudienceType

    Possible types of a first and third party audience resource.

    Enums
    FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_UNSPECIFIED Default value when type is not specified or is unknown.
    FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_FIRST_PARTY Audience that is created via usage of client data.
    FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_THIRD_PARTY Audience that is provided by Third Party data providers.

    AudienceType

    Possible types of audiences.

    Enums
    AUDIENCE_TYPE_UNSPECIFIED Default value when type is not specified or is unknown.
    CUSTOMER_MATCH_CONTACT_INFO Audience was generated through matching customers to known contact information.
    CUSTOMER_MATCH_DEVICE_ID Audience was generated through matching customers to known Mobile device IDs.
    CUSTOMER_MATCH_USER_ID Audience was generated through matching customers to known User IDs.
    ACTIVITY_BASED

    Audience was created based on campaign activity.
    FREQUENCY_CAP

    Audience was created based on excluding the number of impressions they were served.
    TAG_BASED Audience was created based on custom variables attached to pixel.
    YOUTUBE_USERS Audience was created based on past interactions with videos, YouTube ads, or YouTube channel.
    LICENSED Subtype of third party audience type.

    AudienceSource

    Possible audience sources.

    Enums
    AUDIENCE_SOURCE_UNSPECIFIED Default value when audience source is not specified or is unknown.
    DISPLAY_VIDEO_360 Originated from Display & Video 360.
    CAMPAIGN_MANAGER Originated from Campaign Manager 360.
    AD_MANAGER Originated from Google Ad Manager.
    SEARCH_ADS_360 Originated from Search Ads 360.
    YOUTUBE Originated from Youtube.
    ADS_DATA_HUB Originated from Ads Data Hub.

    ContactInfoList

    Wrapper message for a list of contact information defining Customer Match audience members.

    JSON representation 
     { 
 "contactInfos" 
 : 
 [ 
 { 
 object (  ContactInfo 
 
) 
 } 
 ] 
 }
    Fields
    contactInfos[]

    object ( ContactInfo )

    A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contactInfos mustn't be greater than 500,000.

    ContactInfo

    Contact information defining a Customer Match audience member.

    JSON representation 
     { 
 "hashedEmails" 
 : 
 [ 
 string 
 ] 
 , 
 "hashedPhoneNumbers" 
 : 
 [ 
 string 
 ] 
 , 
 "zipCodes" 
 : 
 [ 
 string 
 ] 
 , 
 "hashedFirstName" 
 : 
 string 
 , 
 "hashedLastName" 
 : 
 string 
 , 
 "countryCode" 
 : 
 string 
 }
    Fields
    hashedEmails[]

    string

    A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.

    hashedPhoneNumbers[]

    string

    A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the E.164 format and include the country calling code.

    zipCodes[]

    string

    A list of zip codes of the member.

    Must also be set with the following fields:

    hashedFirstName

    string

    SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.

    Must also be set with the following fields:

    hashedLastName

    string

    SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.

    Must also be set with the following fields:

    countryCode

    string

    Country code of the member.

    Must also be set with the following fields:

    MobileDeviceIdList

    Wrapper message for a list of mobile device IDs defining Customer Match audience members.

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

    string

    A list of mobile device IDs defining Customer Match audience members. The size of mobileDeviceIds mustn't be greater than 500,000.

    Methods

    create

    		Creates a FirstAndThirdPartyAudience.

    editCustomerMatchMembers

    		Updates the member list of a Customer Match audience.

    get

    		Gets a first and third party audience.

    list

    		Lists first and third party audiences.

    patch

    		Updates an existing FirstAndThirdPartyAudience.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: