REST Resource: advertisers.inventorySources

Ressource: InventorySource

Eine Inventarquelle.

JSON-Darstellung
{
  "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
  ]
}
Felder
name

string

Nur Ausgabe. Der Ressourcenname der Inventarquelle.

inventorySourceId

string (int64 format)

Nur Ausgabe. Die eindeutige ID der Inventarquelle. Wird vom System zugewiesen.

displayName

string

Der Anzeigename der Inventarquelle.

Muss UTF-8-codiert sein und darf maximal 240 Byte groß sein.

inventorySourceType

enum (InventorySourceType)

Gibt den Typ der Inventarquelle an.

inventorySourceProductType

enum (InventorySourceProductType)

Nur Ausgabe. Der Produkttyp der Inventarquelle, der angibt, wie Inventar verkauft wird.

commitment

enum (InventorySourceCommitment)

Gibt an, ob die Inventarquelle eine garantierte oder nicht garantierte Auslieferung hat.

deliveryMethod

enum (InventorySourceDeliveryMethod)

Die Auslieferungsmethode der Inventarquelle.

  • Für nicht garantierte Inventarquellen ist der einzige zulässige Wert INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC.
  • Für garantierte Inventarquellen sind die Werte INVENTORY_SOURCE_DELIVERY_METHOD_TAG und INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC zulässig.
dealId

string

Die ID im Anzeigenplattformbereich, die die Inventarquelle eindeutig identifiziert.

Muss für jeden Käufer innerhalb einer Anzeigenplattform eindeutig sein, aber nicht unbedingt für alle Anzeigenplattformen.

status

object (InventorySourceStatus)

Die Statuseinstellungen der Inventarquelle.

exchange

enum (Exchange)

Die Anzeigenplattform, zu der die Inventarquelle gehört.

updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel, der angibt, wann die Inventarquelle zuletzt aktualisiert wurde. Wird vom System zugewiesen.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"

rateDetails

object (RateDetails)

Erforderlich. Die Preisdetails der Inventarquelle.

publisherName

string

Der Name des Publishers/Verkäufers der Inventarquelle.

timeRange

object (TimeRange)

Der Zeitraum, in dem die Auslieferung dieser Inventarquelle beginnt und endet.

creativeConfigs[]

object (CreativeConfig)

Die Creative-Anforderungen der Inventarquelle.

Nicht zutreffend für Auktionspakete.

guaranteedOrderId

string

Nicht veränderbar. Die ID des garantierten Deals, zu dem diese Inventarquelle gehört.

Gilt nur, wenn commitment INVENTORY_SOURCE_COMMITMENT_GUARANTEED ist.

readWriteAccessors

object (InventorySourceAccessors)

Der Partner oder die Werbetreibenden, die Lese-/Schreibzugriff auf die Inventarquelle haben.

Wird nur ausgegeben, wenn commitment den Wert INVENTORY_SOURCE_COMMITMENT_GUARANTEED hat. In diesem Fall werden die Lese-/Schreibzugriffsfunktionen vom übergeordneten garantierten Auftrag übernommen.

Erforderlich, wenn der commitment INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED ist.

Wenn commitment auf INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED festgelegt ist und in diesem Feld ein Partner angegeben ist, haben alle Werbetreibenden unter diesem Partner automatisch Lesezugriff auf die Inventarquelle. Diese Werbetreibenden werden nicht in readAdvertiserIds aufgenommen.

readAdvertiserIds[]

string (int64 format)

Nur Ausgabe. Die IDs der Werbetreibenden mit Lesezugriff auf die Inventarquelle.

readPartnerIds[]

string (int64 format)

Nur Ausgabe. Die IDs der Partner mit Lesezugriff auf die Inventarquelle.

Alle Werbetreibenden von Partnern in diesem Feld erhalten Lesezugriff auf die Inventarquelle.

InventorySourceType

Mögliche Arten von Inventarquellen.

Enums
INVENTORY_SOURCE_TYPE_UNSPECIFIED Der Typ der Inventarquelle ist in dieser Version nicht angegeben oder unbekannt.
INVENTORY_SOURCE_TYPE_PRIVATE Private Inventarquelle.
INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE Auktionspaket

InventorySourceProductType

Mögliche Produkttypen einer Inventarquelle.

Enums
INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED Der Produkttyp ist nicht angegeben oder in dieser Version unbekannt. Das Ändern von Inventarquellen dieses Produkttyps wird über die API nicht unterstützt.
PREFERRED_DEAL Die Inventarquelle verkauft Inventar über Preferred Deals.
PRIVATE_AUCTION Die Inventarquelle verkauft Inventar über eine private Auktion.
PROGRAMMATIC_GUARANTEED Die Inventarquelle verkauft Inventar über programmatisch garantierte Deals.
TAG_GUARANTEED Die Inventarquelle verkauft Inventar über Tag-Garantie.
YOUTUBE_RESERVE Die Inventarquelle verkauft Inventar über YouTube Reserve.
INSTANT_RESERVE Die Inventarquelle verkauft Inventar über die Direktreservierung. Das Ändern von Inventarquellen dieses Produkttyps wird über die API nicht unterstützt.
GUARANTEED_PACKAGE Die Inventarquelle verkauft Inventar über ein garantiertes Paket. Das Ändern von Inventarquellen dieses Produkttyps wird über die API nicht unterstützt.
PROGRAMMATIC_TV Die Inventarquelle verkauft Inventar über Programmatic TV. Das Ändern von Inventarquellen dieses Produkttyps wird über die API nicht unterstützt.
AUCTION_PACKAGE Die Inventarquelle verkauft Inventar über ein Auktionspaket. Das Ändern von Inventarquellen dieses Produkttyps wird über die API nicht unterstützt.

InventorySourceCommitment

Mögliche Zusicherungstypen für eine Inventarquelle.

Enums
INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED Die Zusicherung ist in dieser Version nicht angegeben oder unbekannt.
INVENTORY_SOURCE_COMMITMENT_GUARANTEED Die Zusicherung ist die garantierte Auslieferung.
INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED Die Vereinbarung ist eine nicht garantierte Auslieferung.

InventorySourceDeliveryMethod

Mögliche Auslieferungsmethoden für eine Inventarquelle.

Enums
INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED Die Liefermethode ist in dieser Version nicht angegeben oder unbekannt.
INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC Die Auslieferungsmethode ist programmatisch.
INVENTORY_SOURCE_DELIVERY_METHOD_TAG Die Auslieferungsmethode ist „Tag“.

InventorySourceStatus

Die statusbezogenen Einstellungen der Inventarquelle.

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

enum (EntityStatus)

Gibt an, ob die Inventarquelle bereitgestellt werden kann.

Zulässige Werte sind ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED und ENTITY_STATUS_PAUSED. Der Standardwert ist ENTITY_STATUS_ACTIVE.

entityPauseReason

string

Der vom Nutzer angegebene Grund für das Pausieren dieser Inventarquelle.

Darf 100 Zeichen nicht überschreiten.

Gilt nur, wenn entityStatus auf ENTITY_STATUS_PAUSED festgelegt ist.

sellerStatus

enum (EntityStatus)

Nur Ausgabe. Der vom Verkäufer für die Inventarquelle festgelegte Status.

Gilt nur für Inventarquellen, die direkt von den Publishern synchronisiert werden. Die zulässigen Werte sind ENTITY_STATUS_ACTIVE und ENTITY_STATUS_PAUSED.

sellerPauseReason

string

Nur Ausgabe. Der vom Verkäufer angegebene Grund für die Pausierung dieser Inventarquelle.

Gilt nur für Inventarquellen, die direkt von den Publishern synchronisiert werden, und wenn sellerStatus auf ENTITY_STATUS_PAUSED festgelegt ist.

configStatus

enum (InventorySourceConfigStatus)

Nur Ausgabe. Der Konfigurationsstatus der Inventarquelle.

Gilt nur für garantierte Inventarquellen. Die zulässigen Werte sind INVENTORY_SOURCE_CONFIG_STATUS_PENDING und INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED.

Eine Inventarquelle muss konfiguriert werden (erforderliche Felder ausfüllen, Creatives auswählen und eine Standardkampagne auswählen), bevor sie ausgeliefert werden kann.

InventorySourceConfigStatus

Mögliche Konfigurationsstatus für eine garantierte Inventarquelle.

Enums
INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED Der Freigabestatus ist in dieser Version nicht angegeben oder unbekannt.
INVENTORY_SOURCE_CONFIG_STATUS_PENDING Der Anfangsstatus einer garantierten Inventarquelle. Die Inventarquelle in diesem Status muss konfiguriert werden.
INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED Der Status, nachdem der Käufer eine garantierte Inventarquelle konfiguriert hat.

RateDetails

Die preisbezogenen Einstellungen der Inventarquelle.

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

enum (InventorySourceRateType)

Der Preistyp.

Zulässige Werte sind INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED, INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR und INVENTORY_SOURCE_RATE_TYPE_CPD.

rate

object (Money)

Der Preis für die Inventarquelle.

unitsPurchased

string (int64 format)

Erforderlich für garantierte Inventarquellen. Die Anzahl der vom Verkäufer garantierten Impressionen.

minimumSpend

object (Money)

Nur Ausgabe. Der Betrag, den der Käufer im Voraus für die Inventarquelle zugesagt hat.

Gilt nur für garantierte Inventarquellen.

InventorySourceRateType

Mögliche Preistypen für eine Inventarquelle.

Enums
INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED Der Preistyp ist nicht angegeben oder in dieser Version unbekannt.
INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED Der Preistyp ist „Fester CPM“.
INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR Der Preistyp ist „CPM (Mindestpreis)“.
INVENTORY_SOURCE_RATE_TYPE_CPD Der Preistyp ist „Cost-per-Day“.
INVENTORY_SOURCE_RATE_TYPE_CPH Der Preistyp ist „Cost-per-Hour“.
INVENTORY_SOURCE_RATE_TYPE_FLAT Der Preistyp ist „Pauschal“.

Geld

Stellt einen Geldbetrag mit Währungstyp dar.

JSON-Darstellung
{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}
Felder
currencyCode

string

Der aus drei Buchstaben bestehende Währungscode gemäß ISO 4217.

units

string (int64 format)

Die ganzen Einheiten des Betrags. Wenn currencyCode beispielsweise "USD" ist, entspricht 1 Einheit einem US-Dollar.

nanos

integer

Anzahl der Nanoeinheiten (10^-9) des Betrags. Der Wert muss im Bereich von -999.999.999 bis +999.999.999 liegen. Wenn units positiv ist, muss nanos positiv oder null sein. Wenn units null ist, kann nanos positiv, null oder negativ sein. Wenn units negativ ist, muss nanos negativ oder null sein. Beispiel: -1,75 $ wird als units=-1 und nanos=-750.000.000 dargestellt.

TimeRange

Ein Zeitraum.

JSON-Darstellung
{
  "startTime": string,
  "endTime": string
}
Felder
startTime

string (Timestamp format)

Erforderlich. Die Untergrenze eines Zeitraums, einschließlich.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"

endTime

string (Timestamp format)

Erforderlich. Die Obergrenze eines Zeitraums, einschließlich.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

CreativeConfig

Konfiguration der Creative-Anforderungen für die Inventarquelle.

JSON-Darstellung
{
  "creativeType": enum (CreativeType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "displayCreativeConfig": {
    object (InventorySourceDisplayCreativeConfig)
  },
  "videoCreativeConfig": {
    object (InventorySourceVideoCreativeConfig)
  }
  // End of mutually exclusive fields.
}
Felder
creativeType

enum (CreativeType)

Der Creative-Typ, der der Inventarquelle zugewiesen werden kann. Nur die folgenden Gebotstypen werden unterstützt:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

Anwendbar, wenn creative_type einer der folgenden Werte ist:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

Die Konfiguration für die Creatives, die der Inventarquelle zugewiesen werden können. Im Folgenden finden Sie eine Liste der Felder, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:

displayCreativeConfig

object (InventorySourceDisplayCreativeConfig)

Die Konfiguration für Display-Creatives. Anwendbar, wenn creativeType CREATIVE_TYPE_STANDARD ist.

videoCreativeConfig

object (InventorySourceVideoCreativeConfig)

Die Konfiguration für Video-Creatives. Anwendbar, wenn creativeType CREATIVE_TYPE_VIDEO ist.

Ende der sich gegenseitig ausschließenden Felder.

InventorySourceDisplayCreativeConfig

Die Konfiguration für Display-Creatives.

JSON-Darstellung
{
  "creativeSize": {
    object (Dimensions)
  }
}
Felder
creativeSize

object (Dimensions)

Die Größenanforderungen für Display-Creatives, die der Inventarquelle zugewiesen werden können.

InventorySourceVideoCreativeConfig

Die Konfiguration für Video-Creatives.

JSON-Darstellung
{
  "duration": string
}
Felder
duration

string (Duration format)

Die Anforderungen an die Dauer der Video-Creatives, die der Inventarquelle zugewiesen werden können.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „s“. Beispiel: "3.5s".

InventorySourceAccessors

Der Partner oder die Werbetreibenden mit Zugriff auf die Inventarquelle.

JSON-Darstellung
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "partner": {
    object (PartnerAccessor)
  },
  "advertisers": {
    object (AdvertiserAccessors)
  }
  // End of mutually exclusive fields.
}
Felder
Der Partner oder die Werbetreibenden mit Zugriff auf die Inventarquelle. Im Folgenden finden Sie eine Liste der Felder, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
partner

object (PartnerAccessor)

Der Partner mit Zugriff auf die Inventarquelle.

advertisers

object (AdvertiserAccessors)

Die Werbetreibenden mit Zugriff auf die Inventarquelle. Alle Werbetreibenden müssen zum selben Partner gehören.

Ende der sich gegenseitig ausschließenden Felder.

PartnerAccessor

Der Partner mit Zugriff auf die Inventarquelle.

JSON-Darstellung
{
  "partnerId": string
}
Felder
partnerId

string (int64 format)

Die ID des Partners.

AdvertiserAccessors

Die Werbetreibenden mit Zugriff auf die Inventarquelle.

JSON-Darstellung
{
  "advertiserIds": [
    string
  ]
}
Felder
advertiserIds[]

string (int64 format)

Die IDs der Werbetreibenden.

Methoden

get

Ruft einen Deal für eine Inventarquelle ab.

list

Listet Deals für Inventarquellen auf.