REST Resource: firstPartyAndPartnerAudiences

Resource: FirstPartyAndPartnerAudience

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

JSON representation 
{
  "name": string,
  "firstPartyAndPartnerAudienceId": string,
  "displayName": string,
  "description": string,
  "firstPartyAndPartnerAudienceType": enum (FirstPartyAndPartnerAudienceType),
  "audienceType": enum (AudienceType),
  "audienceSource": enum (AudienceSource),
  "membershipDurationDays": string,
  "displayAudienceSize": string,
  "activeDisplayAudienceSize": string,
  "youtubeAudienceSize": string,
  "gmailAudienceSize": string,
  "displayMobileAppAudienceSize": string,
  "displayMobileWebAudienceSize": string,
  "displayDesktopAudienceSize": string,
  "appId": string
}
Fields
name

string

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

string (int64 format)

Identifier. The unique ID of the first party and partner audience. Assigned by the system.
displayName

string

Optional. The display name of the first party and partner audience.
description

string

Optional. The user-provided description of the audience.

Only applicable to first party audiences.
firstPartyAndPartnerAudienceType

enum (FirstPartyAndPartnerAudienceType)

Output only. Whether the audience is a first party and partner audience.
audienceType

enum (AudienceType)

Immutable. The type of the audience.
audienceSource

enum (AudienceSource)

Output only. The source of the audience.
membershipDurationDays

string (int64 format)

Optional. The duration in days that an entry remains in the audience after the qualifying event. 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

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

Only applicable to audienceType CUSTOMER_MATCH_DEVICE_ID

FirstPartyAndPartnerAudienceType

Possible types of a first party and partner audience resource.

Enums
FIRST_PARTY_AND_PARTNER_AUDIENCE_TYPE_UNSPECIFIED Default value when type is not specified or is unknown.
TYPE_FIRST_PARTY Audience that is created via usage of client data.
TYPE_PARTNER 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

Deprecated: Audience was created based on campaign activity.
FREQUENCY_CAP

Deprecated: 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.
THIRD_PARTY Audience has been licensed for use from a third party.
COMMERCE Audience provided by commerce partners for a fee.
LINEAR Audience for Linear TV content.
AGENCY Audience provided by an agency.

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.

Methods

get

 Gets a first party or partner audience.

list

 Lists first party and partner audiences.