REST Resource: 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. 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.

  • Bei nicht garantierten Inventarquellen ist nur der Wert INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC zulässig.
  • Für Quellen mit garantiertem Inventar sind die zulässigen Werte INVENTORY_SOURCE_DELIVERY_METHOD_TAG und INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC.
dealId

string

Die ID im Anzeigenplattformbereich, die die Inventarquelle eindeutig identifiziert.

Muss für alle Käufer innerhalb der jeweiligen Exchange eindeutig sein, aber nicht unbedingt für alle Exchanges.
status

object (InventorySourceStatus)

Die Statuseinstellungen der Inventarquelle.
exchange

enum (Exchange)

Die Börse, zu der die Inventarquelle gehört.
updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel, der angibt, wann die Inventarquelle zuletzt aktualisiert wurde. 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 Rateninformationen der Inventarquelle.
publisherName

string

Der Name des Publishers/Verkäufers der Inventarquelle.
timeRange

object (TimeRange)

Der Zeitraum, in dem Anzeigen über diese Inventarquelle ausgeliefert werden.
creativeConfigs[]

object (CreativeConfig)

Die Creative-Anforderungen der Inventarquelle.

Gilt nicht für Auktionspakete.
guaranteedOrderId

string

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

Gilt nur, wenn commitment INVENTORY_SOURCE_COMMITMENT_GUARANTEED ist.
readWriteAccessors

object (InventorySourceAccessors)

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

Ausgabe nur, wenn commitment gleich INVENTORY_SOURCE_COMMITMENT_GUARANTEED ist. In diesem Fall werden die Lese-/Schreibzugriffsmethoden von der garantierten Reihenfolge des übergeordneten Elements ü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 von Werbetreibenden mit Lesezugriff auf die Inventarquelle.
readPartnerIds[]

string (int64 format)

Nur Ausgabe. Die IDs von Partnern mit Lesezugriff auf die Inventarquelle.

Alle Werbetreibenden von Partnern in diesem Feld erben 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 in dieser Version nicht angegeben oder unbekannt. Das Ändern von Inventarquellen dieses Produkttyps wird über die API nicht unterstützt.
PREFERRED_DEAL Über die Inventarquelle wird Inventar über Preferred Deals verkauft.
PRIVATE_AUCTION Über die Inventarquelle wird Inventar über private Auktionen verkauft.
PROGRAMMATIC_GUARANTEED Über die Inventarquelle wird Inventar über programmatisch garantierte Deals verkauft.
TAG_GUARANTEED Über die Inventarquelle wird Inventar über Tag Guaranteed verkauft.
YOUTUBE_RESERVE Über YouTube Reserve wird Inventar aus der Inventarquelle verkauft.
INSTANT_RESERVE Über die Inventarquelle wird Inventar über die Direktreservierung verkauft. Das Ändern von Inventarquellen dieses Produkttyps wird über die API nicht unterstützt.
GUARANTEED_PACKAGE Über die Inventarquelle wird Inventar über garantierte Pakete verkauft. Das Ändern von Inventarquellen dieses Produkttyps wird über die API nicht unterstützt.
PROGRAMMATIC_TV Über die Inventarquelle wird Inventar über Programmatic TV verkauft. Das Ändern von Inventarquellen dieses Produkttyps wird über die API nicht unterstützt.
AUCTION_PACKAGE Die Inventarquelle verkauft Inventar über Auktionspakete. 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 Zusage 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 Übermittlungsmethoden für eine Inventarquelle.

Enums
INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED Die Zustellungsmethode 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 ausgeliefert 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. Zulässige Werte sind ENTITY_STATUS_ACTIVE und ENTITY_STATUS_PAUSED.
sellerPauseReason

string

Nur Ausgabe. Der vom Verkäufer angegebene Grund für das Pausieren 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. Zulässige Werte sind INVENTORY_SOURCE_CONFIG_STATUS_PENDING und INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED.

Eine Inventarquelle muss konfiguriert werden, bevor sie ausgeliefert werden kann. Dazu müssen Sie die erforderlichen Felder ausfüllen, Creatives auswählen und eine Standardkampagne festlegen.

InventorySourceConfigStatus

Mögliche Konfigurationszustände für eine Inventarquelle mit garantiertem Inventar.

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 Inventarquelle für garantiertes Inventar konfiguriert hat.

RateDetails

Die ratenbezogenen 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 Quellen mit garantiertem Inventar. Die Anzahl der Impressionen, die der Verkäufer garantiert.
minimumSpend

object (Money)

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

Gilt nur für garantierte Inventarquellen.

InventorySourceRateType

Mögliche Preistypen für eine Inventarquelle.

Enums
INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED Der Raten-Typ ist in dieser Version nicht angegeben oder unbekannt.
INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED Der Preistyp ist „CPM (Festpreis)“.
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 Raten-Typ ist „Cost per Hour“ (Kosten pro Stunde).
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 1 $.
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 $ werden 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 Zeitbereichs (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 Zeitbereichs (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

Gilt, 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 von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
displayCreativeConfig

object (InventorySourceDisplayCreativeConfig)

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

object (InventorySourceVideoCreativeConfig)

Die Konfiguration für Video-Creatives. Gilt, 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

Die Partner oder Werbetreibenden, die Zugriff auf die Inventarquelle haben.

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
Die Partner oder Werbetreibenden, die Zugriff auf die Inventarquelle haben. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. 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 demselben Partner angehö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

create

 Erstellt eine neue Inventarquelle.

editInventorySourceReadWriteAccessors

 Bearbeitet Lese-/Schreibzugriffsmethoden einer Inventarquelle.

get

 Ruft eine Inventarquelle ab.

list

 Listet Inventarquellen auf, auf die der aktuelle Nutzer Zugriff hat.

patch

 Aktualisiert eine vorhandene Inventarquelle.