GuaranteedOrder

import type { GuaranteedOrder } from "https://googleapis.deno.dev/v1/displayvideo:v3.ts";

A guaranteed order. Guaranteed orders are parent entity of guaranteed inventory sources. When creating a guaranteed inventory source, a guaranteed order ID must be assigned to the inventory source.

interface GuaranteedOrder {

readonly defaultAdvertiserId?: bigint;

defaultCampaignId?: bigint;

displayName?: string;

exchange?:

| "EXCHANGE_UNSPECIFIED"

| "EXCHANGE_GOOGLE_AD_MANAGER"

| "EXCHANGE_APPNEXUS"

| "EXCHANGE_BRIGHTROLL"

| "EXCHANGE_ADFORM"

| "EXCHANGE_ADMETA"

| "EXCHANGE_ADMIXER"

| "EXCHANGE_ADSMOGO"

| "EXCHANGE_ADSWIZZ"

| "EXCHANGE_BIDSWITCH"

| "EXCHANGE_BRIGHTROLL_DISPLAY"

| "EXCHANGE_CADREON"

| "EXCHANGE_DAILYMOTION"

| "EXCHANGE_FIVE"

| "EXCHANGE_FLUCT"

| "EXCHANGE_FREEWHEEL"

| "EXCHANGE_GENIEE"

| "EXCHANGE_GUMGUM"

| "EXCHANGE_IMOBILE"

| "EXCHANGE_IBILLBOARD"

| "EXCHANGE_IMPROVE_DIGITAL"

| "EXCHANGE_INDEX"

| "EXCHANGE_KARGO"

| "EXCHANGE_MICROAD"

| "EXCHANGE_MOPUB"

| "EXCHANGE_NEND"

| "EXCHANGE_ONE_BY_AOL_DISPLAY"

| "EXCHANGE_ONE_BY_AOL_MOBILE"

| "EXCHANGE_ONE_BY_AOL_VIDEO"

| "EXCHANGE_OOYALA"

| "EXCHANGE_OPENX"

| "EXCHANGE_PERMODO"

| "EXCHANGE_PLATFORMONE"

| "EXCHANGE_PLATFORMID"

| "EXCHANGE_PUBMATIC"

| "EXCHANGE_PULSEPOINT"

| "EXCHANGE_REVENUEMAX"

| "EXCHANGE_RUBICON"

| "EXCHANGE_SMARTCLIP"

| "EXCHANGE_SMARTRTB"

| "EXCHANGE_SMARTSTREAMTV"

| "EXCHANGE_SOVRN"

| "EXCHANGE_SPOTXCHANGE"

| "EXCHANGE_STROER"

| "EXCHANGE_TEADSTV"

| "EXCHANGE_TELARIA"

| "EXCHANGE_TVN"

| "EXCHANGE_UNITED"

| "EXCHANGE_YIELDLAB"

| "EXCHANGE_YIELDMO"

| "EXCHANGE_UNRULYX"

| "EXCHANGE_OPEN8"

| "EXCHANGE_TRITON"

| "EXCHANGE_TRIPLELIFT"

| "EXCHANGE_TABOOLA"

| "EXCHANGE_INMOBI"

| "EXCHANGE_SMAATO"

| "EXCHANGE_AJA"

| "EXCHANGE_SUPERSHIP"

| "EXCHANGE_NEXSTAR_DIGITAL"

| "EXCHANGE_WAZE"

| "EXCHANGE_SOUNDCAST"

| "EXCHANGE_SHARETHROUGH"

| "EXCHANGE_FYBER"

| "EXCHANGE_RED_FOR_PUBLISHERS"

| "EXCHANGE_MEDIANET"

| "EXCHANGE_TAPJOY"

| "EXCHANGE_VISTAR"

| "EXCHANGE_DAX"

| "EXCHANGE_JCD"

| "EXCHANGE_PLACE_EXCHANGE"

| "EXCHANGE_APPLOVIN"

| "EXCHANGE_CONNATIX"

| "EXCHANGE_RESET_DIGITAL"

| "EXCHANGE_HIVESTACK"

| "EXCHANGE_DRAX"

| "EXCHANGE_APPLOVIN_GBID"

| "EXCHANGE_FYBER_GBID"

| "EXCHANGE_UNITY_GBID"

| "EXCHANGE_CHARTBOOST_GBID"

| "EXCHANGE_ADMOST_GBID"

| "EXCHANGE_TOPON_GBID";

readonly guaranteedOrderId?: string;

readonly legacyGuaranteedOrderId?: string;

readonly name?: string;

publisherName?: string;

readAccessInherited?: boolean;

readAdvertiserIds?: bigint[];

readWriteAdvertiserId?: bigint;

readWritePartnerId?: bigint;

status?: GuaranteedOrderStatus;

readonly updateTime?: Date;

}

§Properties

readonly defaultAdvertiserId?: bigint

[src]

Output only. The ID of default advertiser of the guaranteed order. The default advertiser is either the read_write_advertiser_id or, if that is not set, the first advertiser listed in read_advertiser_ids. Otherwise, there is no default advertiser.

defaultCampaignId?: bigint

[src]

The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser.

displayName?: string

[src]

Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.

[src]

Required. Immutable. The exchange where the guaranteed order originated.

readonly guaranteedOrderId?: string

[src]

Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format {exchange}-{legacy_guaranteed_order_id}.

readonly legacyGuaranteedOrderId?: string

[src]

Output only. The legacy ID of the guaranteed order. Assigned by the original exchange. The legacy ID is unique within one exchange, but is not guaranteed to be unique across all guaranteed orders. This ID is used in SDF and UI.

readonly name?: string

[src]

Output only. The resource name of the guaranteed order.

publisherName?: string

[src]

Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.

readAccessInherited?: boolean

[src]

Whether all advertisers of read_write_partner_id have read access to the guaranteed order. Only applicable if read_write_partner_id is set. If True, overrides read_advertiser_ids.

readAdvertiserIds?: bigint[]

[src]

The IDs of advertisers with read access to the guaranteed order. This field must not include the advertiser assigned to read_write_advertiser_id if it is set. All advertisers in this field must belong to read_write_partner_id or the same partner as read_write_advertiser_id.

readWriteAdvertiserId?: bigint

[src]

The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.

readWritePartnerId?: bigint

[src]

The partner with read/write access to the guaranteed order.

status?: GuaranteedOrderStatus

[src]

The status settings of the guaranteed order.

readonly updateTime?: Date

[src]

Output only. The timestamp when the guaranteed order was last updated. Assigned by the system.