REST Resource: inventorySources

{
  "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
  ]
}

string

Output only. The resource name of the inventory source.

string (int64 format)

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

string

The display name of the inventory source.

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

enum (InventorySourceType)

Denotes the type of the inventory source.

enum (InventorySourceProductType)

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

enum (InventorySourceCommitment)

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

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.

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.

object (InventorySourceStatus)

The status settings of the inventory source.

enum (Exchange)

The exchange to which the inventory source belongs.

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

object (RateDetails)

Required. The rate details of the inventory source.

string

The publisher/seller name of the inventory source.

object (TimeRange)

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

object (CreativeConfig)

The creative requirements of the inventory source.

Not applicable for auction packages.

string

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

Only applicable when commitment is INVENTORY_SOURCE_COMMITMENT_GUARANTEED.

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.

string (int64 format)

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

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.

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

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.

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.

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.

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.

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.

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

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.

object (Money)

The rate for the inventory source.

string (int64 format)

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

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.

{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}

string

The three-letter currency code defined in ISO 4217.

string (int64 format)

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

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.

{
  "startTime": string,
  "endTime": string
}

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

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

{
  "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.
}

enum (CreativeType)

The type of creative that can be assigned to the inventory source. Only the following types are supported:

• CREATIVE_TYPE_STANDARD
• CREATIVE_TYPE_VIDEO

object (InventorySourceDisplayCreativeConfig)

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

object (InventorySourceVideoCreativeConfig)

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

{
  "creativeSize": {
    object (Dimensions)
  }
}

object (Dimensions)

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

{
  "duration": string
}

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, ending with 's'. Example: "3.5s".

{

  // 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.
}

object (PartnerAccessor)

The partner with access to the inventory source.

object (AdvertiserAccessors)

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

{
  "partnerId": string
}

string (int64 format)

The ID of the partner.

{
  "advertiserIds": [
    string
  ]
}

string (int64 format)

The IDs of the advertisers.