REST Resource: partners.inventorySources

Resource: InventorySource

An inventory source.

JSON representation 
{
  "name": string,
  "inventorySourceId": string,
  "displayName": string,
  "inventorySourceType": enum (InventorySourceType),
  "inventorySourceProductType": enum (InventorySourceProductType),
  "commitment": enum (InventorySourceCommitment),
  "deliveryMethod": enum (InventorySourceDeliveryMethod),
  "dealId": string,
  "status": {
    object (InventorySourceStatus)
  },
  "exchange": enum (Exchange),
  "updateTime": string,
  "rateDetails": {
    object (RateDetails)
  },
  "publisherName": string,
  "timeRange": {
    object (TimeRange)
  },
  "creativeConfigs": [
    {
      object (CreativeConfig)
    }
  ],
  "guaranteedOrderId": string,
  "readWriteAccessors": {
    object (InventorySourceAccessors)
  },
  "readAdvertiserIds": [
    string
  ],
  "readPartnerIds": [
    string
  ]
}
Fields
name

string

Output only. The resource name of the inventory source.
inventorySourceId

string (int64 format)

Output only. The unique ID of the inventory source. Assigned by the system.
displayName

string

The display name of the inventory source.

Must be UTF-8 encoded with a maximum size of 240 bytes.
inventorySourceType

enum (InventorySourceType)

Denotes the type of the inventory source.
inventorySourceProductType

enum (InventorySourceProductType)

Output only. The product type of the inventory source, denoting the way through which it sells inventory.
commitment

enum (InventorySourceCommitment)

Whether the inventory source has a guaranteed or non-guaranteed delivery.
deliveryMethod

enum (InventorySourceDeliveryMethod)

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

string

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

object (InventorySourceStatus)

The status settings of the inventory source.
exchange

enum (Exchange)

The exchange to which the inventory source belongs.
updateTime

string (Timestamp format)

Output only. The timestamp when the inventory source was last updated. Assigned by the system.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
rateDetails

object (RateDetails)

Required. The rate details of the inventory source.
publisherName

string

The publisher/seller name of the inventory source.
timeRange

object (TimeRange)

The time range when this inventory source starts and stops serving.
creativeConfigs[]

object (CreativeConfig)

The creative requirements of the inventory source.

Not applicable for auction packages.
guaranteedOrderId

string

Immutable. The ID of the guaranteed order that this inventory source belongs to.

Only applicable when commitment is INVENTORY_SOURCE_COMMITMENT_GUARANTEED.
readWriteAccessors

object (InventorySourceAccessors)

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 readAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

Output only. The IDs of advertisers with read-only access to the inventory source.
readPartnerIds[]

string (int64 format)

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.

Methods

get

 Gets an inventory source deal.

list

 Lists inventory source deals.