FirstPartyAndPartnerAudience

import type { FirstPartyAndPartnerAudience } from "https://googleapis.deno.dev/v1/displayvideo:v4.ts";

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.

interface FirstPartyAndPartnerAudience {

readonly activeDisplayAudienceSize?: bigint;

appId?: string;

readonly audienceSource?:

| "AUDIENCE_SOURCE_UNSPECIFIED"

| "DISPLAY_VIDEO_360"

| "CAMPAIGN_MANAGER"

| "AD_MANAGER"

| "SEARCH_ADS_360"

| "YOUTUBE"

| "ADS_DATA_HUB";

readonly audienceType?:

| "AUDIENCE_TYPE_UNSPECIFIED"

| "CUSTOMER_MATCH_CONTACT_INFO"

| "CUSTOMER_MATCH_DEVICE_ID"

| "CUSTOMER_MATCH_USER_ID"

| "ACTIVITY_BASED"

| "FREQUENCY_CAP"

| "TAG_BASED"

| "YOUTUBE_USERS"

| "THIRD_PARTY"

| "COMMERCE"

| "LINEAR";

contactInfoList?: ContactInfoList;

readonly description?: string;

readonly displayAudienceSize?: bigint;

readonly displayDesktopAudienceSize?: bigint;

readonly displayMobileAppAudienceSize?: bigint;

readonly displayMobileWebAudienceSize?: bigint;

readonly displayName?: string;

firstPartyAndPartnerAudienceId?: bigint;

readonly firstPartyAndPartnerAudienceType?: "FIRST_PARTY_AND_PARTNER_AUDIENCE_TYPE_UNSPECIFIED" | "TYPE_FIRST_PARTY" | "TYPE_PARTNER";

readonly gmailAudienceSize?: bigint;

readonly membershipDurationDays?: bigint;

mobileDeviceIdList?: MobileDeviceIdList;

readonly name?: string;

readonly youtubeAudienceSize?: bigint;

}

§Properties

readonly activeDisplayAudienceSize?: bigint

[src]

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.

appId?: string

[src]

Optional. The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type CUSTOMER_MATCH_DEVICE_ID

[src]

Output only. The source of the audience.

[src]

Output only. The type of the audience.

contactInfoList?: ContactInfoList

[src]

Input only. A list of contact information to define the initial audience members. Only applicable to audience_type CUSTOMER_MATCH_CONTACT_INFO

readonly description?: string

[src]

Output only. The user-provided description of the audience. Only applicable to first party audiences.

readonly displayAudienceSize?: bigint

[src]

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.

readonly displayDesktopAudienceSize?: bigint

[src]

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.

readonly displayMobileAppAudienceSize?: bigint

[src]

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.

readonly displayMobileWebAudienceSize?: bigint

[src]

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.

readonly displayName?: string

[src]

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

firstPartyAndPartnerAudienceId?: bigint

[src]

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

readonly firstPartyAndPartnerAudienceType?: "FIRST_PARTY_AND_PARTNER_AUDIENCE_TYPE_UNSPECIFIED" | "TYPE_FIRST_PARTY" | "TYPE_PARTNER"

[src]

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

readonly gmailAudienceSize?: bigint

[src]

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.

readonly membershipDurationDays?: bigint

[src]

Output only. 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 audience_type is used: * CUSTOMER_MATCH_CONTACT_INFO * CUSTOMER_MATCH_DEVICE_ID Warning: Starting on April 7, 2025, audiences will no longer be able to have infinite membership duration. This field will no longer accept the value 10000 and all audiences with membership durations greater than 540 days will be updated to a membership duration of 540 days. Read more about this announced change.

mobileDeviceIdList?: MobileDeviceIdList

[src]

Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type CUSTOMER_MATCH_DEVICE_ID

readonly name?: string

[src]

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

readonly youtubeAudienceSize?: bigint

[src]

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.