REST Resource: inventorySources

Resource: InventorySource

An inventory source.

JSON representation
{
  "name": string,
  "inventorySourceId": string,
  "displayName": string,
  "inventorySourceType": enum (InventorySourceType),
  "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)
    }
  ],
  "subSitePropertyId": string,
  "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.

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.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

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.

subSitePropertyId

string (int64 format)

Immutable. The unique ID of the sub-site property assigned to this inventory source.

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.

InventorySourceType

Possible inventory source types.

Enums
INVENTORY_SOURCE_TYPE_UNSPECIFIED The inventory source type is not specified or is unknown in this version.
INVENTORY_SOURCE_TYPE_PRIVATE Private inventory source.
INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE Auction package.

InventorySourceCommitment

Possible commitment types for an inventory source.

Enums
INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED The commitment is not specified or is unknown in this version.
INVENTORY_SOURCE_COMMITMENT_GUARANTEED The commitment is guaranteed delivery.
INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED The commitment is non-guaranteed delivery.

InventorySourceDeliveryMethod

Possible delivery methods for an inventory source.

Enums
INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED The delivery method is not specified or is unknown in this version.
INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC The delivery method is programmatic.
INVENTORY_SOURCE_DELIVERY_METHOD_TAG The delivery method is tag.

InventorySourceStatus

The status related settings of the inventory source.

JSON representation
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "sellerStatus": enum (EntityStatus),
  "sellerPauseReason": string,
  "configStatus": enum (InventorySourceConfigStatus)
}
Fields
entityStatus

enum (EntityStatus)

Whether or not the inventory source is servable.

Acceptable values are ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED, and ENTITY_STATUS_PAUSED. Default value is ENTITY_STATUS_ACTIVE.

entityPauseReason

string

The user-provided reason for pausing this inventory source.

Must not exceed 100 characters.

Only applicable when entityStatus is set to ENTITY_STATUS_PAUSED.

sellerStatus

enum (EntityStatus)

Output only. The status set by the seller for the inventory source.

Only applicable for inventory sources synced directly from the publishers. Acceptable values are ENTITY_STATUS_ACTIVE and ENTITY_STATUS_PAUSED.

sellerPauseReason

string

Output only. The seller-provided reason for pausing this inventory source.

Only applicable for inventory sources synced directly from the publishers and when sellerStatus is set to ENTITY_STATUS_PAUSED.

configStatus

enum (InventorySourceConfigStatus)

Output only. The configuration status of the inventory source.

Only applicable for guaranteed inventory sources. Acceptable values are INVENTORY_SOURCE_CONFIG_STATUS_PENDING and INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED.

An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve.

InventorySourceConfigStatus

Possible configuration states for a guaranteed inventory source.

Enums
INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED The approval status is not specified or is unknown in this version.
INVENTORY_SOURCE_CONFIG_STATUS_PENDING The beginning state of a guaranteed inventory source. The inventory source in this state needs to be configured.
INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED The state after the buyer configures a guaranteed inventory source.

RateDetails

The rate related settings of the inventory source.

JSON representation
{
  "inventorySourceRateType": enum (InventorySourceRateType),
  "rate": {
    object (Money)
  },
  "unitsPurchased": string,
  "minimumSpend": {
    object (Money)
  }
}
Fields
inventorySourceRateType

enum (InventorySourceRateType)

The rate type.

Acceptable values are INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED, INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR, and INVENTORY_SOURCE_RATE_TYPE_CPD.

rate

object (Money)

The rate for the inventory source.

unitsPurchased

string (int64 format)

Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.

minimumSpend

object (Money)

Output only. The amount that the buyer has committed to spending on the inventory source up front.

Only applicable for guaranteed inventory sources.

InventorySourceRateType

Possible rate types for an inventory source.

Enums
INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED The rate type is not specified or is unknown in this version.
INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED The rate type is CPM (Fixed).
INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR The rate type is CPM (Floor).
INVENTORY_SOURCE_RATE_TYPE_CPD The rate type is Cost per Day.
INVENTORY_SOURCE_RATE_TYPE_FLAT The rate type is Flat.

Money

Represents an amount of money with its currency type.

JSON representation
{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}
Fields
currencyCode

string

The 3-letter currency code defined in ISO 4217.

units

string (int64 format)

The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

nanos

integer

Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

TimeRange

A time range.

JSON representation
{
  "startTime": string,
  "endTime": string
}
Fields
startTime

string (Timestamp format)

Required. The lower bound of a time range, inclusive.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

Required. The upper bound of a time range, inclusive.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

CreativeConfig

Creative requirements configuration for the inventory source.

JSON representation
{
  "creativeType": enum (CreativeType),

  // Union field creative_config_scheme can be only one of the following:
  "displayCreativeConfig": {
    object (InventorySourceDisplayCreativeConfig)
  },
  "videoCreativeConfig": {
    object (InventorySourceVideoCreativeConfig)
  }
  // End of list of possible types for union field creative_config_scheme.
}
Fields
creativeType

enum (CreativeType)

The type of creative that can be assigned to the inventory source.

Union field creative_config_scheme. Applicable when creative_type is one of:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

The configuration for the creatives that can be assigned to the inventory source. creative_config_scheme can be only one of the following:

displayCreativeConfig

object (InventorySourceDisplayCreativeConfig)

The configuration for display creatives. Applicable when creativeType is CREATIVE_TYPE_STANDARD.

videoCreativeConfig

object (InventorySourceVideoCreativeConfig)

The configuration for video creatives. Applicable when creativeType is CREATIVE_TYPE_VIDEO.

InventorySourceDisplayCreativeConfig

The configuration for display creatives.

JSON representation
{
  "creativeSize": {
    object (Dimensions)
  }
}
Fields
creativeSize

object (Dimensions)

The size requirements for display creatives that can be assigned to the inventory source.

InventorySourceVideoCreativeConfig

The configuration for video creatives.

JSON representation
{
  "duration": string
}
Fields
duration

string (Duration format)

The duration requirements for the video creatives that can be assigned to the inventory source.

A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

InventorySourceAccessors

The partner or advertisers with access to the inventory source.

JSON representation
{

  // Union field accessors can be only one of the following:
  "partner": {
    object (PartnerAccessor)
  },
  "advertisers": {
    object (AdvertiserAccessors)
  }
  // End of list of possible types for union field accessors.
}
Fields
Union field accessors. The partner or advertisers with access to the inventory source. accessors can be only one of the following:
partner

object (PartnerAccessor)

The partner with access to the inventory source.

advertisers

object (AdvertiserAccessors)

The advertisers with access to the inventory source. All advertisers must belong to the same partner.

PartnerAccessor

The partner with access to the inventory source.

JSON representation
{
  "partnerId": string
}
Fields
partnerId

string (int64 format)

The ID of the partner.

AdvertiserAccessors

The advertisers with access to the inventory source.

JSON representation
{
  "advertiserIds": [
    string
  ]
}
Fields
advertiserIds[]

string (int64 format)

The IDs of the advertisers.

Methods

create

Creates a new inventory source.

editInventorySourceReadWriteAccessors

Edits read/write accessors of an inventory source.

get

Gets an inventory source.

list

Lists inventory sources that are accessible to the current user.

patch

Updates an existing inventory source.