InventorySource (Display & Video 360 API v4-rev20260505-2.0.0)

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.InventorySource

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class InventorySource
extends com.google.api.client.json.GenericJson
```
An 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

InventorySource()

Constructors
Constructor and Description
`InventorySource()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InventorySource`	`clone()`
`String`	`getCommitment()` Whether the inventory source has a guaranteed or non-guaranteed delivery.
`List<CreativeConfig>`	`getCreativeConfigs()` The creative requirements of the inventory source.
`String`	`getDealId()` The ID in the exchange space that uniquely identifies the inventory source.
`String`	`getDeliveryMethod()` The delivery method of the inventory source.
`String`	`getDisplayName()` The display name of the inventory source.
`String`	`getExchange()` The exchange to which the inventory source belongs.
`String`	`getGuaranteedOrderId()` Immutable.
`Long`	`getInventorySourceId()` Output only.
`String`	`getInventorySourceProductType()` Output only.
`String`	`getInventorySourceType()` Denotes the type of the inventory source.
`String`	`getName()` Output only.
`String`	`getPublisherName()` The publisher/seller name of the inventory source.
`RateDetails`	`getRateDetails()` Required.
`List<Long>`	`getReadAdvertiserIds()` Output only.
`List<Long>`	`getReadPartnerIds()` Output only.
`InventorySourceAccessors`	`getReadWriteAccessors()` The partner or advertisers that have read/write access to the inventory source.
`InventorySourceStatus`	`getStatus()` The status settings of the inventory source.
`TimeRange`	`getTimeRange()` The time range when this inventory source starts and stops serving.
`String`	`getUpdateTime()` Output only.
`InventorySource`	`set(String fieldName, Object value)`
`InventorySource`	`setCommitment(String commitment)` Whether the inventory source has a guaranteed or non-guaranteed delivery.
`InventorySource`	`setCreativeConfigs(List<CreativeConfig> creativeConfigs)` The creative requirements of the inventory source.
`InventorySource`	`setDealId(String dealId)` The ID in the exchange space that uniquely identifies the inventory source.
`InventorySource`	`setDeliveryMethod(String deliveryMethod)` The delivery method of the inventory source.
`InventorySource`	`setDisplayName(String displayName)` The display name of the inventory source.
`InventorySource`	`setExchange(String exchange)` The exchange to which the inventory source belongs.
`InventorySource`	`setGuaranteedOrderId(String guaranteedOrderId)` Immutable.
`InventorySource`	`setInventorySourceId(Long inventorySourceId)` Output only.
`InventorySource`	`setInventorySourceProductType(String inventorySourceProductType)` Output only.
`InventorySource`	`setInventorySourceType(String inventorySourceType)` Denotes the type of the inventory source.
`InventorySource`	`setName(String name)` Output only.
`InventorySource`	`setPublisherName(String publisherName)` The publisher/seller name of the inventory source.
`InventorySource`	`setRateDetails(RateDetails rateDetails)` Required.
`InventorySource`	`setReadAdvertiserIds(List<Long> readAdvertiserIds)` Output only.
`InventorySource`	`setReadPartnerIds(List<Long> readPartnerIds)` Output only.
`InventorySource`	`setReadWriteAccessors(InventorySourceAccessors readWriteAccessors)` The partner or advertisers that have read/write access to the inventory source.
`InventorySource`	`setStatus(InventorySourceStatus status)` The status settings of the inventory source.
`InventorySource`	`setTimeRange(TimeRange timeRange)` The time range when this inventory source starts and stops serving.
`InventorySource`	`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
  - InventorySource
```
public InventorySource()
```
- Method Detail
  - getCommitment
```
public String getCommitment()
```
    Whether the inventory source has a guaranteed or non-guaranteed delivery.
    
    Returns:
    
    value or null for none
  - setCommitment
```
public InventorySource setCommitment(String commitment)
```
    Whether the inventory source has a guaranteed or non-guaranteed delivery.
    
    Parameters:
    
    commitment - commitment or null for none
  - getCreativeConfigs
```
public List<CreativeConfig> getCreativeConfigs()
```
    The creative requirements of the inventory source. Not applicable for auction packages.
    
    Returns:
    
    value or null for none
  - setCreativeConfigs
```
public InventorySource setCreativeConfigs(List<CreativeConfig> creativeConfigs)
```
    The creative requirements of the inventory source. Not applicable for auction packages.
    
    Parameters:
    
    creativeConfigs - creativeConfigs or null for none
  - getDealId
```
public String getDealId()
```
    The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges.
    
    Returns:
    
    value or null for none
  - setDealId
```
public InventorySource setDealId(String dealId)
```
    The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges.
    
    Parameters:
    
    dealId - dealId or null for none
  - getDeliveryMethod
```
public String getDeliveryMethod()
```
    The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`.
    
    Returns:
    
    value or null for none
  - setDeliveryMethod
```
public InventorySource setDeliveryMethod(String deliveryMethod)
```
    The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`.
    
    Parameters:
    
    deliveryMethod - deliveryMethod or null for none
  - getDisplayName
```
public String getDisplayName()
```
    The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public InventorySource setDisplayName(String displayName)
```
    The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
    
    Parameters:
    
    displayName - displayName or null for none
  - getExchange
```
public String getExchange()
```
    The exchange to which the inventory source belongs.
    
    Returns:
    
    value or null for none
  - setExchange
```
public InventorySource setExchange(String exchange)
```
    The exchange to which the inventory source belongs.
    
    Parameters:
    
    exchange - exchange or null for none
  - getGuaranteedOrderId
```
public String getGuaranteedOrderId()
```
    Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.
    
    Returns:
    
    value or null for none
  - setGuaranteedOrderId
```
public InventorySource setGuaranteedOrderId(String guaranteedOrderId)
```
    Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.
    
    Parameters:
    
    guaranteedOrderId - guaranteedOrderId or null for none
  - getInventorySourceId
```
public Long getInventorySourceId()
```
    Output only. The unique ID of the inventory source. Assigned by the system.
    
    Returns:
    
    value or null for none
  - setInventorySourceId
```
public InventorySource setInventorySourceId(Long inventorySourceId)
```
    Output only. The unique ID of the inventory source. Assigned by the system.
    
    Parameters:
    
    inventorySourceId - inventorySourceId or null for none
  - getInventorySourceProductType
```
public String getInventorySourceProductType()
```
    Output only. The product type of the inventory source, denoting the way through which it sells inventory.
    
    Returns:
    
    value or null for none
  - setInventorySourceProductType
```
public InventorySource setInventorySourceProductType(String inventorySourceProductType)
```
    Output only. The product type of the inventory source, denoting the way through which it sells inventory.
    
    Parameters:
    
    inventorySourceProductType - inventorySourceProductType or null for none
  - getInventorySourceType
```
public String getInventorySourceType()
```
    Denotes the type of the inventory source.
    
    Returns:
    
    value or null for none
  - setInventorySourceType
```
public InventorySource setInventorySourceType(String inventorySourceType)
```
    Denotes the type of the inventory source.
    
    Parameters:
    
    inventorySourceType - inventorySourceType or null for none
  - getName
```
public String getName()
```
    Output only. The resource name of the inventory source.
    
    Returns:
    
    value or null for none
  - setName
```
public InventorySource setName(String name)
```
    Output only. The resource name of the inventory source.
    
    Parameters:
    
    name - name or null for none
  - getPublisherName
```
public String getPublisherName()
```
    The publisher/seller name of the inventory source.
    
    Returns:
    
    value or null for none
  - setPublisherName
```
public InventorySource setPublisherName(String publisherName)
```
    The publisher/seller name of the inventory source.
    
    Parameters:
    
    publisherName - publisherName or null for none
  - getRateDetails
```
public RateDetails getRateDetails()
```
    Required. The rate details of the inventory source.
    
    Returns:
    
    value or null for none
  - setRateDetails
```
public InventorySource setRateDetails(RateDetails rateDetails)
```
    Required. The rate details of the inventory source.
    
    Parameters:
    
    rateDetails - rateDetails or null for none
  - getReadAdvertiserIds
```
public List<Long> getReadAdvertiserIds()
```
    Output only. The IDs of advertisers with read-only access to the inventory source.
    
    Returns:
    
    value or null for none
  - setReadAdvertiserIds
```
public InventorySource setReadAdvertiserIds(List<Long> readAdvertiserIds)
```
    Output only. The IDs of advertisers with read-only access to the inventory source.
    
    Parameters:
    
    readAdvertiserIds - readAdvertiserIds or null for none
  - getReadPartnerIds
```
public List<Long> getReadPartnerIds()
```
    Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source.
    
    Returns:
    
    value or null for none
  - setReadPartnerIds
```
public InventorySource setReadPartnerIds(List<Long> readPartnerIds)
```
    Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source.
    
    Parameters:
    
    readPartnerIds - readPartnerIds or null for none
  - getReadWriteAccessors
```
public InventorySourceAccessors getReadWriteAccessors()
```
    The partner or advertisers that have read/write access to the inventory source. Output only when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`, in which case the read/write accessors are inherited from the parent guaranteed order. Required when commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED`. If commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED` and a partner is set in this field, all advertisers under this partner will automatically have read-only access to the inventory source. These advertisers will not be included in read_advertiser_ids.
    
    Returns:
    
    value or null for none
  - setReadWriteAccessors
```
public InventorySource setReadWriteAccessors(InventorySourceAccessors readWriteAccessors)
```
    The partner or advertisers that have read/write access to the inventory source. Output only when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`, in which case the read/write accessors are inherited from the parent guaranteed order. Required when commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED`. If commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED` and a partner is set in this field, all advertisers under this partner will automatically have read-only access to the inventory source. These advertisers will not be included in read_advertiser_ids.
    
    Parameters:
    
    readWriteAccessors - readWriteAccessors or null for none
  - getStatus
```
public InventorySourceStatus getStatus()
```
    The status settings of the inventory source.
    
    Returns:
    
    value or null for none
  - setStatus
```
public InventorySource setStatus(InventorySourceStatus status)
```
    The status settings of the inventory source.
    
    Parameters:
    
    status - status or null for none
  - getTimeRange
```
public TimeRange getTimeRange()
```
    The time range when this inventory source starts and stops serving.
    
    Returns:
    
    value or null for none
  - setTimeRange
```
public InventorySource setTimeRange(TimeRange timeRange)
```
    The time range when this inventory source starts and stops serving.
    
    Parameters:
    
    timeRange - timeRange or null for none
  - getUpdateTime
```
public String getUpdateTime()
```
    Output only. The timestamp when the inventory source was last updated. Assigned by the system.
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public InventorySource setUpdateTime(String updateTime)
```
    Output only. The timestamp when the inventory source was last updated. Assigned by the system.
    
    Parameters:
    
    updateTime - updateTime or null for none
  - set
```
public InventorySource set(String fieldName,
                           Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public InventorySource clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class InventorySource

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

InventorySource

Method Detail

getCommitment

setCommitment

getCreativeConfigs

setCreativeConfigs

getDealId

setDealId

getDeliveryMethod

setDeliveryMethod

getDisplayName

setDisplayName

getExchange

setExchange

getGuaranteedOrderId

setGuaranteedOrderId

getInventorySourceId

setInventorySourceId

getInventorySourceProductType

setInventorySourceProductType

getInventorySourceType

setInventorySourceType

getName

setName

getPublisherName

setPublisherName

getRateDetails

setRateDetails

getReadAdvertiserIds

setReadAdvertiserIds

getReadPartnerIds

setReadPartnerIds

getReadWriteAccessors

setReadWriteAccessors

getStatus

setStatus

getTimeRange

setTimeRange

getUpdateTime

setUpdateTime

set

clone