com.google.api.services.displayvideo.v4.model

Class FirstPartyAndPartnerAudience

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.displayvideo.v4.model.FirstPartyAndPartnerAudience

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class FirstPartyAndPartnerAudience
extends com.google.api.client.json.GenericJson

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.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Display & Video 360 API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
FirstPartyAndPartnerAudience()

Method Summary

Modifier and Type	Method and Description
FirstPartyAndPartnerAudience	clone()
Long	getActiveDisplayAudienceSize() Output only.
String	getAppId() Optional.
String	getAudienceSource() Output only.
String	getAudienceType() Immutable.
ContactInfoList	getContactInfoList() Input only.
String	getDescription() Optional.
Long	getDisplayAudienceSize() Output only.
Long	getDisplayDesktopAudienceSize() Output only.
Long	getDisplayMobileAppAudienceSize() Output only.
Long	getDisplayMobileWebAudienceSize() Output only.
String	getDisplayName() Optional.
Long	getFirstPartyAndPartnerAudienceId() Identifier.
String	getFirstPartyAndPartnerAudienceType() Output only.
Long	getGmailAudienceSize() Output only.
Long	getMembershipDurationDays() Optional.
MobileDeviceIdList	getMobileDeviceIdList() Input only.
String	getName() Output only.
Long	getYoutubeAudienceSize() Output only.
FirstPartyAndPartnerAudience	set(String fieldName, Object value)
FirstPartyAndPartnerAudience	setActiveDisplayAudienceSize(Long activeDisplayAudienceSize) Output only.
FirstPartyAndPartnerAudience	setAppId(String appId) Optional.
FirstPartyAndPartnerAudience	setAudienceSource(String audienceSource) Output only.
FirstPartyAndPartnerAudience	setAudienceType(String audienceType) Immutable.
FirstPartyAndPartnerAudience	setContactInfoList(ContactInfoList contactInfoList) Input only.
FirstPartyAndPartnerAudience	setDescription(String description) Optional.
FirstPartyAndPartnerAudience	setDisplayAudienceSize(Long displayAudienceSize) Output only.
FirstPartyAndPartnerAudience	setDisplayDesktopAudienceSize(Long displayDesktopAudienceSize) Output only.
FirstPartyAndPartnerAudience	setDisplayMobileAppAudienceSize(Long displayMobileAppAudienceSize) Output only.
FirstPartyAndPartnerAudience	setDisplayMobileWebAudienceSize(Long displayMobileWebAudienceSize) Output only.
FirstPartyAndPartnerAudience	setDisplayName(String displayName) Optional.
FirstPartyAndPartnerAudience	setFirstPartyAndPartnerAudienceId(Long firstPartyAndPartnerAudienceId) Identifier.
FirstPartyAndPartnerAudience	setFirstPartyAndPartnerAudienceType(String firstPartyAndPartnerAudienceType) Output only.
FirstPartyAndPartnerAudience	setGmailAudienceSize(Long gmailAudienceSize) Output only.
FirstPartyAndPartnerAudience	setMembershipDurationDays(Long membershipDurationDays) Optional.
FirstPartyAndPartnerAudience	setMobileDeviceIdList(MobileDeviceIdList mobileDeviceIdList) Input only.
FirstPartyAndPartnerAudience	setName(String name) Output only.
FirstPartyAndPartnerAudience	setYoutubeAudienceSize(Long youtubeAudienceSize) Output only.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

FirstPartyAndPartnerAudience

public FirstPartyAndPartnerAudience()

Method Detail

getActiveDisplayAudienceSize

public Long getActiveDisplayAudienceSize()

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.

Returns:

value or null for none

setActiveDisplayAudienceSize

public FirstPartyAndPartnerAudience setActiveDisplayAudienceSize(Long activeDisplayAudienceSize)

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.

Parameters:

activeDisplayAudienceSize - activeDisplayAudienceSize or null for none

getAppId

public String getAppId()

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

Returns:

value or null for none

setAppId

public FirstPartyAndPartnerAudience setAppId(String appId)

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

Parameters:

appId - appId or null for none

getAudienceSource

public String getAudienceSource()

Output only. The source of the audience.

Returns:

value or null for none

setAudienceSource

public FirstPartyAndPartnerAudience setAudienceSource(String audienceSource)

Output only. The source of the audience.

Parameters:

audienceSource - audienceSource or null for none

getAudienceType

public String getAudienceType()

Immutable. The type of the audience.

Returns:

value or null for none

setAudienceType

public FirstPartyAndPartnerAudience setAudienceType(String audienceType)

Immutable. The type of the audience.

Parameters:

audienceType - audienceType or null for none

getContactInfoList

public ContactInfoList getContactInfoList()

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

Returns:

value or null for none

setContactInfoList

public FirstPartyAndPartnerAudience setContactInfoList(ContactInfoList contactInfoList)

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

Parameters:

contactInfoList - contactInfoList or null for none

getDescription

public String getDescription()

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

Returns:

value or null for none

setDescription

public FirstPartyAndPartnerAudience setDescription(String description)

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

Parameters:

description - description or null for none

getDisplayAudienceSize

public Long getDisplayAudienceSize()

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.

Returns:

value or null for none

setDisplayAudienceSize

public FirstPartyAndPartnerAudience setDisplayAudienceSize(Long displayAudienceSize)

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.

Parameters:

displayAudienceSize - displayAudienceSize or null for none

getDisplayDesktopAudienceSize

public Long getDisplayDesktopAudienceSize()

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.

Returns:

value or null for none

setDisplayDesktopAudienceSize

public FirstPartyAndPartnerAudience setDisplayDesktopAudienceSize(Long displayDesktopAudienceSize)

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.

Parameters:

displayDesktopAudienceSize - displayDesktopAudienceSize or null for none

getDisplayMobileAppAudienceSize

public Long getDisplayMobileAppAudienceSize()

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.

Returns:

value or null for none

setDisplayMobileAppAudienceSize

public FirstPartyAndPartnerAudience setDisplayMobileAppAudienceSize(Long displayMobileAppAudienceSize)

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.

Parameters:

displayMobileAppAudienceSize - displayMobileAppAudienceSize or null for none

getDisplayMobileWebAudienceSize

public Long getDisplayMobileWebAudienceSize()

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.

Returns:

value or null for none

setDisplayMobileWebAudienceSize

public FirstPartyAndPartnerAudience setDisplayMobileWebAudienceSize(Long displayMobileWebAudienceSize)

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.

Parameters:

displayMobileWebAudienceSize - displayMobileWebAudienceSize or null for none

getDisplayName

public String getDisplayName()

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

Returns:

value or null for none

setDisplayName

public FirstPartyAndPartnerAudience setDisplayName(String displayName)

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

Parameters:

displayName - displayName or null for none

getFirstPartyAndPartnerAudienceId

public Long getFirstPartyAndPartnerAudienceId()

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

Returns:

value or null for none

setFirstPartyAndPartnerAudienceId

public FirstPartyAndPartnerAudience setFirstPartyAndPartnerAudienceId(Long firstPartyAndPartnerAudienceId)

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

Parameters:

firstPartyAndPartnerAudienceId - firstPartyAndPartnerAudienceId or null for none

getFirstPartyAndPartnerAudienceType

public String getFirstPartyAndPartnerAudienceType()

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

Returns:

value or null for none

setFirstPartyAndPartnerAudienceType

public FirstPartyAndPartnerAudience setFirstPartyAndPartnerAudienceType(String firstPartyAndPartnerAudienceType)

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

Parameters:

firstPartyAndPartnerAudienceType - firstPartyAndPartnerAudienceType or null for none

getGmailAudienceSize

public Long getGmailAudienceSize()

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.

Returns:

value or null for none

setGmailAudienceSize

public FirstPartyAndPartnerAudience setGmailAudienceSize(Long gmailAudienceSize)

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.

Parameters:

gmailAudienceSize - gmailAudienceSize or null for none

getMembershipDurationDays

public Long getMembershipDurationDays()

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 audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`

Returns:

value or null for none

setMembershipDurationDays

public FirstPartyAndPartnerAudience setMembershipDurationDays(Long membershipDurationDays)

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 audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`

Parameters:

membershipDurationDays - membershipDurationDays or null for none

getMobileDeviceIdList

public MobileDeviceIdList getMobileDeviceIdList()

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

Returns:

value or null for none

setMobileDeviceIdList

public FirstPartyAndPartnerAudience setMobileDeviceIdList(MobileDeviceIdList mobileDeviceIdList)

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

Parameters:

mobileDeviceIdList - mobileDeviceIdList or null for none

getName

public String getName()

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

Returns:

value or null for none

setName

public FirstPartyAndPartnerAudience setName(String name)

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

Parameters:

name - name or null for none

getYoutubeAudienceSize

public Long getYoutubeAudienceSize()

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.

Returns:

value or null for none

setYoutubeAudienceSize

public FirstPartyAndPartnerAudience setYoutubeAudienceSize(Long youtubeAudienceSize)

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.

Parameters:

youtubeAudienceSize - youtubeAudienceSize or null for none

set

public FirstPartyAndPartnerAudience set(String fieldName,
                                        Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public FirstPartyAndPartnerAudience clone()

Overrides:

clone in class com.google.api.client.json.GenericJson