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 für die Inventarquelle eine garantierte oder nicht garantierte Auslieferung festgelegt ist.
deliveryMethod

enum (InventorySourceDeliveryMethod)

Die Auslieferungsmethode der Inventarquelle.

  • Bei nicht garantierten Inventarquellen ist INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC der einzige zulässige Wert.
  • Zulässige Werte für garantierte Inventarquellen sind INVENTORY_SOURCE_DELIVERY_METHOD_TAG und INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC.
dealId

string

Die ID im Bereich der Anzeigenplattform, mit der die Inventarquelle eindeutig identifiziert wird.

Sie müssen für alle Käufer innerhalb der Anzeigenplattform eindeutig, aber nicht unbedingt für alle Plattformen eindeutig sein.
status

object (InventorySourceStatus)

Die Statuseinstellungen der Inventarquelle.
exchange

enum (Exchange)

Die Anzeigenplattform, zu der die Inventarquelle gehört.
updateTime

string (Timestamp format)

Nur Ausgabe Zeitstempel der letzten Aktualisierung der Inventarquelle. Vom System zugewiesen.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung 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 die Bereitstellung dieser Inventarquelle beginnt und endet.
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 den Wert INVENTORY_SOURCE_COMMITMENT_GUARANTEED hat.
readWriteAccessors

object (InventorySourceAccessors)

Der 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-/Schreibzugriffe von der übergeordneten garantierten Reihenfolge übernommen.

Erforderlich, wenn commitment den Wert INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED hat.

Wenn commitment den Wert INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED hat und in diesem Feld ein Partner festgelegt ist, haben alle Werbetreibenden unter diesem Partner automatisch Lesezugriff auf die Inventarquelle. Diese Werbetreibenden werden in readAdvertiserIds nicht berücksichtigt.
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 der Partner in diesem Feld erhalten Lesezugriff auf die Inventarquelle.

InventorySourceType

Mögliche Typen von Inventarquellen.

Enums
INVENTORY_SOURCE_TYPE_UNSPECIFIED Der Typ der Inventarquelle ist nicht angegeben oder in dieser Version 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. Inventarquellen dieses Produkttyps können nicht über die API geändert werden.
PREFERRED_DEAL Über die Inventarquelle wird Inventar über einen Preferred Deal verkauft.
PRIVATE_AUCTION Über die Inventarquelle wird Inventar über eine private Auktion verkauft.
PROGRAMMATIC_GUARANTEED Über die Inventarquelle wird Inventar über programmatisch garantierte Deals verkauft.
TAG_GUARANTEED Über die Inventarquelle wird Inventar über Tag-Garantie verkauft.
YOUTUBE_RESERVE Über die Inventarquelle wird Inventar über YouTube Reserve verkauft.
INSTANT_RESERVE Die Inventarquelle verkauft Inventar über die Direktreservierung. Inventarquellen dieses Produkttyps können nicht über die API geändert werden.
GUARANTEED_PACKAGE Über die Inventarquelle wird Inventar über das Paket mit garantiertem Anzeigeninventar verkauft. Inventarquellen dieses Produkttyps können nicht über die API geändert werden.
PROGRAMMATIC_TV Die Inventarquelle verkauft Inventar über Programmtic TV. Inventarquellen dieses Produkttyps können nicht über die API geändert werden.
AUCTION_PACKAGE Über die Inventarquelle wird Inventar über das Auktionspaket verkauft. Inventarquellen dieses Produkttyps können nicht über die API geändert werden.

InventorySourceCommitment

Mögliche Zusicherungsarten für eine Inventarquelle.

Enums
INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED Die Zusicherung ist nicht angegeben oder in dieser Version unbekannt.
INVENTORY_SOURCE_COMMITMENT_GUARANTEED Die Zusicherung ist eine garantierte Auslieferung.
INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED Bei der Zusicherung handelt es sich um eine nicht garantierte Auslieferung.

InventorySourceDeliveryMethod

Mögliche Auslieferungsmethoden für eine Inventarquelle.

Enums
INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED Die Übermittlungsmethode ist nicht angegeben oder in dieser Version 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 nicht länger als 100 Zeichen sein.

Gilt nur, wenn entityStatus auf ENTITY_STATUS_PAUSED gesetzt 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 gesetzt 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, damit sie ausgeliefert werden kann. Füllen Sie dazu die Pflichtfelder aus, wählen Sie Creatives und eine Standardkampagne aus.

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 Startstatus einer garantierten Inventarquelle. Die Inventarquelle mit diesem Status muss konfiguriert werden.
INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED Der Status, nach dem 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 sich der Käufer verpflichtet hat, im Voraus für die Inventarquelle auszugeben.

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 CPM (fest).
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 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. Beispiel: Wenn currencyCode "USD" ist, dann 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. Beispiel: -1,75 € wird mit 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 Nanosekundenauflösung 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 Nanosekundenauflösung 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. Anwendbar, wenn creative_type einen der folgenden Werte hat:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

Die Konfiguration der 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. Anwendbar, wenn creativeType den Wert CREATIVE_TYPE_STANDARD hat.
videoCreativeConfig

object (InventorySourceVideoCreativeConfig)

Die Konfiguration für Video-Creatives. Anwendbar, wenn creativeType den Wert CREATIVE_TYPE_VIDEO hat.

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.

Eine Dauer in Sekunden mit bis zu neun Nachkommastellen, die auf „s“ endet. Beispiel: "3.5s".

InventorySourceAccessors

Der Partner oder die Werbetreibenden 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 die Werbetreibenden 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 angehö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

 Damit wird eine neue Inventarquelle erstellt.

editInventorySourceReadWriteAccessors

 Bearbeitungszugriff auf Lese-/Schreibzugriffe einer Inventarquelle.

get

 Ruft eine Inventarquelle ab.

list

 Listet Inventarquellen auf, auf die der aktuelle Nutzer zugreifen kann.

patch

 Aktualisiert eine vorhandene Inventarquelle.