com.google.api.services.displayvideo.v3.model

Class GuaranteedOrder

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.v3.model.GuaranteedOrder

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A guaranteed order. Guaranteed orders are parent entity of guaranteed inventory sources. When creating a guaranteed inventory source, a guaranteed order ID must be assigned to the inventory source.

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
GuaranteedOrder()

Method Summary

Modifier and Type	Method and Description
GuaranteedOrder	clone()
Long	getDefaultAdvertiserId() Output only.
Long	getDefaultCampaignId() The ID of the default campaign that is assigned to the guaranteed order.
String	getDisplayName() Required.
String	getExchange() Required.
String	getGuaranteedOrderId() Output only.
String	getLegacyGuaranteedOrderId() Output only.
String	getName() Output only.
String	getPublisherName() Required.
Boolean	getReadAccessInherited() Whether all advertisers of read_write_partner_id have read access to the guaranteed order.
List<Long>	getReadAdvertiserIds() The IDs of advertisers with read access to the guaranteed order.
Long	getReadWriteAdvertiserId() The advertiser with read/write access to the guaranteed order.
Long	getReadWritePartnerId() The partner with read/write access to the guaranteed order.
GuaranteedOrderStatus	getStatus() The status settings of the guaranteed order.
String	getUpdateTime() Output only.
GuaranteedOrder	set(String fieldName, Object value)
GuaranteedOrder	setDefaultAdvertiserId(Long defaultAdvertiserId) Output only.
GuaranteedOrder	setDefaultCampaignId(Long defaultCampaignId) The ID of the default campaign that is assigned to the guaranteed order.
GuaranteedOrder	setDisplayName(String displayName) Required.
GuaranteedOrder	setExchange(String exchange) Required.
GuaranteedOrder	setGuaranteedOrderId(String guaranteedOrderId) Output only.
GuaranteedOrder	setLegacyGuaranteedOrderId(String legacyGuaranteedOrderId) Output only.
GuaranteedOrder	setName(String name) Output only.
GuaranteedOrder	setPublisherName(String publisherName) Required.
GuaranteedOrder	setReadAccessInherited(Boolean readAccessInherited) Whether all advertisers of read_write_partner_id have read access to the guaranteed order.
GuaranteedOrder	setReadAdvertiserIds(List<Long> readAdvertiserIds) The IDs of advertisers with read access to the guaranteed order.
GuaranteedOrder	setReadWriteAdvertiserId(Long readWriteAdvertiserId) The advertiser with read/write access to the guaranteed order.
GuaranteedOrder	setReadWritePartnerId(Long readWritePartnerId) The partner with read/write access to the guaranteed order.
GuaranteedOrder	setStatus(GuaranteedOrderStatus status) The status settings of the guaranteed order.
GuaranteedOrder	setUpdateTime(String updateTime) 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

GuaranteedOrder

public GuaranteedOrder()

Method Detail

getDefaultAdvertiserId

public Long getDefaultAdvertiserId()

Output only. The ID of default advertiser of the guaranteed order. The default advertiser is either the read_write_advertiser_id or, if that is not set, the first advertiser listed in read_advertiser_ids. Otherwise, there is no default advertiser.

Returns:

value or null for none

setDefaultAdvertiserId

public GuaranteedOrder setDefaultAdvertiserId(Long defaultAdvertiserId)

Output only. The ID of default advertiser of the guaranteed order. The default advertiser is either the read_write_advertiser_id or, if that is not set, the first advertiser listed in read_advertiser_ids. Otherwise, there is no default advertiser.

Parameters:

defaultAdvertiserId - defaultAdvertiserId or null for none

getDefaultCampaignId

public Long getDefaultCampaignId()

The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser.

Returns:

value or null for none

setDefaultCampaignId

public GuaranteedOrder setDefaultCampaignId(Long defaultCampaignId)

The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser.

Parameters:

defaultCampaignId - defaultCampaignId or null for none

getDisplayName

public String getDisplayName()

Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.

Returns:

value or null for none

setDisplayName

public GuaranteedOrder setDisplayName(String displayName)

Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.

Parameters:

displayName - displayName or null for none

getExchange

public String getExchange()

Required. Immutable. The exchange where the guaranteed order originated.

Returns:

value or null for none

setExchange

public GuaranteedOrder setExchange(String exchange)

Required. Immutable. The exchange where the guaranteed order originated.

Parameters:

exchange - exchange or null for none

getGuaranteedOrderId

public String getGuaranteedOrderId()

Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.

Returns:

value or null for none

setGuaranteedOrderId

public GuaranteedOrder setGuaranteedOrderId(String guaranteedOrderId)

Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.

Parameters:

guaranteedOrderId - guaranteedOrderId or null for none

getLegacyGuaranteedOrderId

public String getLegacyGuaranteedOrderId()

Output only. The legacy ID of the guaranteed order. Assigned by the original exchange. The legacy ID is unique within one exchange, but is not guaranteed to be unique across all guaranteed orders. This ID is used in SDF and UI.

Returns:

value or null for none

setLegacyGuaranteedOrderId

public GuaranteedOrder setLegacyGuaranteedOrderId(String legacyGuaranteedOrderId)

Output only. The legacy ID of the guaranteed order. Assigned by the original exchange. The legacy ID is unique within one exchange, but is not guaranteed to be unique across all guaranteed orders. This ID is used in SDF and UI.

Parameters:

legacyGuaranteedOrderId - legacyGuaranteedOrderId or null for none

getName

public String getName()

Output only. The resource name of the guaranteed order.

Returns:

value or null for none

setName

public GuaranteedOrder setName(String name)

Output only. The resource name of the guaranteed order.

Parameters:

name - name or null for none

getPublisherName

public String getPublisherName()

Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.

Returns:

value or null for none

setPublisherName

public GuaranteedOrder setPublisherName(String publisherName)

Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.

Parameters:

publisherName - publisherName or null for none

getReadAccessInherited

public Boolean getReadAccessInherited()

Whether all advertisers of read_write_partner_id have read access to the guaranteed order. Only applicable if read_write_partner_id is set. If True, overrides read_advertiser_ids.

Returns:

value or null for none

setReadAccessInherited

public GuaranteedOrder setReadAccessInherited(Boolean readAccessInherited)

Whether all advertisers of read_write_partner_id have read access to the guaranteed order. Only applicable if read_write_partner_id is set. If True, overrides read_advertiser_ids.

Parameters:

readAccessInherited - readAccessInherited or null for none

getReadAdvertiserIds

public List<Long> getReadAdvertiserIds()

The IDs of advertisers with read access to the guaranteed order. This field must not include the advertiser assigned to read_write_advertiser_id if it is set. All advertisers in this field must belong to read_write_partner_id or the same partner as read_write_advertiser_id.

Returns:

value or null for none

setReadAdvertiserIds

public GuaranteedOrder setReadAdvertiserIds(List<Long> readAdvertiserIds)

The IDs of advertisers with read access to the guaranteed order. This field must not include the advertiser assigned to read_write_advertiser_id if it is set. All advertisers in this field must belong to read_write_partner_id or the same partner as read_write_advertiser_id.

Parameters:

readAdvertiserIds - readAdvertiserIds or null for none

getReadWriteAdvertiserId

public Long getReadWriteAdvertiserId()

The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.

Returns:

value or null for none

setReadWriteAdvertiserId

public GuaranteedOrder setReadWriteAdvertiserId(Long readWriteAdvertiserId)

The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.

Parameters:

readWriteAdvertiserId - readWriteAdvertiserId or null for none

getReadWritePartnerId

public Long getReadWritePartnerId()

The partner with read/write access to the guaranteed order.

Returns:

value or null for none

setReadWritePartnerId

public GuaranteedOrder setReadWritePartnerId(Long readWritePartnerId)

The partner with read/write access to the guaranteed order.

Parameters:

readWritePartnerId - readWritePartnerId or null for none

getStatus

public GuaranteedOrderStatus getStatus()

The status settings of the guaranteed order.

Returns:

value or null for none

setStatus

public GuaranteedOrder setStatus(GuaranteedOrderStatus status)

The status settings of the guaranteed order.

Parameters:

status - status or null for none

getUpdateTime

public String getUpdateTime()

Output only. The timestamp when the guaranteed order was last updated. Assigned by the system.

Returns:

value or null for none

setUpdateTime

public GuaranteedOrder setUpdateTime(String updateTime)

Output only. The timestamp when the guaranteed order was last updated. Assigned by the system.

Parameters:

updateTime - updateTime or null for none

set

public GuaranteedOrder set(String fieldName,
                           Object value)

Overrides:

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

clone

public GuaranteedOrder clone()

Overrides:

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