REST Resource: exchanges.inventorySources

Resource: InventorySource

Execution model of a DV360 inventory source.

JSON representation 
{
  "name": string,
  "buyerStatus": enum (BuyerStatus),
  "sellerStatus": enum (SellerStatus),
  "transactionType": enum (TransactionType),
  "pricingType": enum (PricingType),
  "rateDetails": {
    object (RateDetails)
  },
  "startTime": string,
  "endTime": string,
  "exchangeVolumeForecast": {
    object (InventorySourceVolumeForecast)
  },
  "audienceMatchRate": number,
  "makegoodRequested": boolean,
  "makegoodRequestedReason": string,
  "percentFrequencyCapExcludedTraffic": string,
  "dv360WseatId": [
    string
  ],
  "lastModifiedTime": string
}
Fields
name

string

Output only. Relative resource name for order. Generated by server. Example: "exchanges/1234/inventorySources/5678".
buyerStatus

enum (BuyerStatus)

Output only. Buyer status.
sellerStatus

enum (SellerStatus)

Seller status.
transactionType

enum (TransactionType)

Output only. Product transaction type.
pricingType

enum (PricingType)

Output only. Pricing type for product.
rateDetails

object (RateDetails)

Output only. Rate details.
startTime

string (Timestamp format)

Output only. Time when this product becomes active. Must be earlier than endTime. Start time cannot be more than 1 year in the future.

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)

Output only. Time when this product becomes inactive.

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".
exchangeVolumeForecast
(deprecated)

object (InventorySourceVolumeForecast)

Exchange provided daily volume forecast. Used to determine pacing and enable buyer choice. This field is deprecated.
audienceMatchRate

number

Output only. Forecasted audience match rate for programmatic guaranteed deals with audience targeting, used by exchange to determine how many additional requests should be sent. This is a decimal between 0 and 1, whose inverse should be used as a multiplier for the impressions. 0 indicates that the field is unset, and therefore has no audience targeting. Example: "0.125". This indicates 12.5% of the requests matches the audience targeting, and the amount of requests sent should be 8x the negotiated impressions.
makegoodRequested

boolean

Output only. Indicates whether a Makegood has been requested from the buyer.
makegoodRequestedReason

string

Output only. Reason why Makegood is requested provided by the buyer.
percentFrequencyCapExcludedTraffic

string (int64 format)

Percent of traffic excluded from frequency cap for a programmatic guaranteed deal. This is an integer between 0 and 100. 0 (also the default value) indicates no exclusion and therefore all traffic is eligible for frequency cap. 100 indicates complete exclusion and therefore no frequency cap wil be applied. Values between 0 and 100 will result in partial exclusion. For example a value of 20 will result in 20% of the traffic to be excluded from frequency cap.
dv360WseatId[]

string (int64 format)

Output only. The wseats that are currently permissioned to the inventory source.
lastModifiedTime

string (Timestamp format)

Output only. Last time the inventory source was updated. Note some DV3 internal updates will change the last modified time.

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

BuyerStatus

Buyer status.

Enums
BUYER_STATUS_UNSPECIFIED Buyer status is not specified. Not valid input value.
BUYER_STATUS_ACTIVE Buyer status active. Line item assigned, valid creative assigned.
BUYER_STATUS_PENDING Buyer status pending. This status means deal is not active and there are certain action needed for buyer.
BUYER_STATUS_PAUSED Buyer status of paused by buyer.

SellerStatus

Seller status.

Enums
SELLER_STATUS_UNSPECIFIED Seller status unspecified. Unexpected, it indicates the negotiation status is unknown. Not valid input value.
SELLER_STATUS_ACTIVE Seller status active. Inventory source is active on exchange side.
SELLER_STATUS_PAUSED Seller status paused.

InventorySourceVolumeForecast

Daily request volume forecast for an inventory source. The following validation rules apply: - an entry must be provided for each day of the week - the volume mast be non-negative - the timeZoneId is required and must be valid

JSON representation 
{
  "dailyVolumes": [
    {
      object (DailyVolume)
    }
  ],
  "timeZoneId": string
}
Fields
dailyVolumes[]

object (DailyVolume)

Daily volumes forecast.
timeZoneId

string

IANA Time Zone Database time zone, e.g. "America/New_York", that is used for the daily volumes.

DailyVolume

Request volume for an inventory source for a given day.

JSON representation 
{
  "day": enum (DayOfWeek),
  "volume": string
}
Fields
day

enum (DayOfWeek)

Day of the week the request volume applies to.
volume

string (int64 format)

The forecasted request volume for the given day of the week.

DayOfWeek

Represents a day of the week.

Enums
DAY_OF_WEEK_UNSPECIFIED The day of the week is unspecified.
MONDAY Monday
TUESDAY Tuesday
WEDNESDAY Wednesday
THURSDAY Thursday
FRIDAY Friday
SATURDAY Saturday
SUNDAY Sunday

Methods

get

 Gets an inventory source.

list

 Lists inventory sources.

patch

 Updates an inventory source.