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)

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 INVENTORY_SOURCE_DELIVERY_METHOD_TAG und INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC zulässige Werte.
dealId

string

Die ID im Anzeigenplattform-Bereich, die die Inventarquelle eindeutig identifiziert.

Sie müssen für Käufer innerhalb jeder 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. Vom System zugewiesen.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
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 Anzeigen aus dieser Inventarquelle ausgeliefert werden.
creativeConfigs[]

object (CreativeConfig)

Die Creative-Anforderungen der Inventarquelle.

Gilt nicht für Auktionspakete.
guaranteedOrderId

string

Nicht veränderbar. Die ID der garantierten Bestellung, zu der diese Inventarquelle gehört.

Gilt nur, wenn commitment INVENTORY_SOURCE_COMMITMENT_GUARANTEED ist.
readWriteAccessors

object (InventorySourceAccessors)

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

Die Ausgabe erfolgt nur, wenn commitment = INVENTORY_SOURCE_COMMITMENT_GUARANTEED ist. In diesem Fall werden die Lese-/Schreibzugriffsobjekte von der übergeordneten garantierten Reihenfolge übernommen.

Erforderlich, wenn commitment INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED ist.

Wenn commitment INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED ist und in diesem Feld ein Partner festgelegt ist, erhalten 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 Bereich erhalten Lesezugriff auf die Inventarquelle.

InventorySourceType

Mögliche Inventarquellentypen.

Enums
INVENTORY_SOURCE_TYPE_UNSPECIFIED Der Inventarquellentyp 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 Die Inventarquelle verkauft Inventar über einen Preferred Deal.
PRIVATE_AUCTION Die Inventarquelle verkauft Inventar über private Auktionen.
PROGRAMMATIC_GUARANTEED Die Inventarquelle verkauft Inventar über programmatisch garantierte Deals.
TAG_GUARANTEED Die Inventarquelle verkauft Inventar über Tag-basiertes Targeting.
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 programmatisches Fernsehen. 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 Verpflichtung ist in dieser Version nicht angegeben oder unbekannt.
INVENTORY_SOURCE_COMMITMENT_GUARANTEED Die Zustellung ist garantiert.
INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED Die Zustellung ist nicht garantiert.

InventorySourceDeliveryMethod

Mögliche Auslieferungsmethoden 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 die Pausierung dieser Inventarquelle.

Darf 100 Zeichen nicht überschreiten.

Gilt nur, wenn entityStatus auf ENTITY_STATUS_PAUSED eingestellt 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 gesetzt ist.
configStatus

enum (InventorySourceConfigStatus)

Nur Ausgabe. Der Konfigurationsstatus der Inventarquelle.

Gilt nur für Quellen mit garantiertem Inventar. Die zulässigen Werte sind INVENTORY_SOURCE_CONFIG_STATUS_PENDING und INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED.

Eine Inventarquelle muss konfiguriert werden, indem die erforderlichen Felder ausgefüllt, Creatives ausgewählt und eine Standardkampagne ausgewählt werden, bevor Anzeigen ausgeliefert werden können.

InventorySourceConfigStatus

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

Enums
INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED Der Genehmigungsstatus ist für diese Version nicht angegeben oder unbekannt.
INVENTORY_SOURCE_CONFIG_STATUS_PENDING Der Anfangsstatus einer Quelle für garantiertes Inventar. Die Inventarquelle in diesem Status muss konfiguriert werden.
INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED Der Status, nachdem der Käufer eine Quelle für garantiertes Inventar 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 Quellen mit garantiertem Inventar. Die vom Verkäufer garantierte Anzahl von Impressionen.
minimumSpend

object (Money)

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

Gilt nur für Quellen mit garantiertem Inventar.

InventorySourceRateType

Mögliche Preistypen für eine Inventarquelle.

Enums
INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED Der Preistyp ist in dieser Version nicht angegeben oder 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 „Kosten pro Tag“.
INVENTORY_SOURCE_RATE_TYPE_FLAT Der Preistyp ist „Pauschalpreis“.

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. Beispiel: Wenn currencyCode "USD" ist, entspricht eine Einheit 1 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. -1,75 $ wird z. B. als units = −1 und nanos = −750.000.000 dargestellt.

TimeRange

Einen Zeitraum.

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

string (Timestamp format)

Erforderlich. Die Untergrenze eines Zeitraums (einschließlich).

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Erforderlich. Die Obergrenze eines Zeitraums, einschließlich.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

CreativeConfig

Konfiguration der Creative-Anforderungen für die Inventarquelle.

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

Union-Feld creative_config_scheme. Gilt, wenn creative_type einen der folgenden Werte hat:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

Die Konfiguration für die Creatives, die der Inventarquelle zugewiesen werden können. Für creative_config_scheme ist nur einer der folgenden Werte zulässig:
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.

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 Werbetreibende mit Zugriff auf die Inventarquelle.

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld accessors. Der Partner oder Werbetreibende mit Zugriff auf die Inventarquelle. Für accessors ist nur einer der folgenden Werte zulässig:
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 gehören.

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-/Schreibzugriffsrechte einer Inventarquelle.

get

 Ruft eine Inventarquelle ab.

list

 Hier werden Inventarquellen aufgeführt, auf die der aktuelle Nutzer zugreifen kann.

patch

 Aktualisiert eine vorhandene Inventarquelle.