REST Resource: advertisers.insertionOrders

Ressource: Anzeigenauftrag

Ein einzelner Anzeigenauftrag.

JSON-Darstellung 
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "insertionOrderId": string,
  "displayName": string,
  "insertionOrderType": enum (InsertionOrderType),
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "partnerCosts": [
    {
      object (PartnerCost)
    }
  ],
  "pacing": {
    object (Pacing)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "kpi": {
    object (Kpi)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType)
}
Felder
name

string

Nur Ausgabe. Der Ressourcenname des Anzeigenauftrags.
advertiserId

string (int64 format)

Nur Ausgabe. Die eindeutige ID des Werbetreibenden, zu dem der Anzeigenauftrag gehört.
campaignId

string (int64 format)

Erforderlich. Nicht veränderbar. Die eindeutige ID der Kampagne, zu der der Anzeigenauftrag gehört.
insertionOrderId

string (int64 format)

Nur Ausgabe. Die eindeutige ID des Anzeigenauftrags. Vom System zugewiesen.
displayName

string

Erforderlich. Der Anzeigename des Anzeigenauftrags.

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

enum (InsertionOrderType)

Der Typ des Anzeigenauftrags.

Wenn dieses Feld beim Erstellen nicht angegeben ist, wird standardmäßig RTB verwendet.
entityStatus

enum (EntityStatus)

Erforderlich. Steuert, ob der Anzeigenauftrag sein Budget ausgeben und auf Inventar bieten kann.

  • Für die Methode insertionOrders.create ist nur ENTITY_STATUS_DRAFT zulässig. Verwenden Sie zum Aktivieren eines Anzeigenauftrags die Methode insertionOrders.patch und aktualisieren Sie den Status nach dem Erstellen auf ENTITY_STATUS_ACTIVE.
  • Der Status eines Anzeigenauftrags kann nicht von einem anderen Status in den Status "ENTITY_STATUS_DRAFT" geändert werden.
  • Ein Anzeigenauftrag kann nicht auf ENTITY_STATUS_ACTIVE festgelegt werden, wenn die zugehörige übergeordnete Kampagne nicht aktiv ist.
updateTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der letzten Aktualisierung des Anzeigenauftrags. 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".
partnerCosts[]

object (PartnerCost)

Die mit dem Anzeigenauftrag verbundenen Partnerkosten.

Ist diese Angabe in der insertionOrders.create-Methode nicht vorhanden oder leer, übernimmt der neu erstellte Anzeigenauftrag die Partnerkosten aus den Partnereinstellungen.
pacing

object (Pacing)

Erforderlich. Die Einstellung für die Geschwindigkeit der Budgetausgaben des Anzeigenauftrags.
frequencyCap

object (FrequencyCap)

Erforderlich. Die Einstellung für das Frequency Capping des Anzeigenauftrags.
integrationDetails

object (IntegrationDetails)

Zusätzliche Integrationsdetails des Anzeigenauftrags.
kpi

object (Kpi)

Erforderlich. Die Leistungskennzahl (KPI) des Anzeigenauftrags.

Dies wird auf der Display & Video 360-Benutzeroberfläche als „Zielvorhaben“ dargestellt.
budget

object (InsertionOrderBudget)

Erforderlich. Die Einstellungen für die Budgetzuweisung des Anzeigenauftrags.
bidStrategy

object (BiddingStrategy)

Die Gebotsstrategie des Anzeigenauftrags. Standardmäßig ist fixedBid festgelegt.
reservationType

enum (ReservationType)

Nur Ausgabe. Der Reservierungstyp des Anzeigenauftrags.

InsertionOrderType

Mögliche Typen von Anzeigenaufträgen.

Der Typ des Anzeigenauftrags bestimmt, welche Einstellungen und Optionen verwendet werden, etwa das Anzeigenformat oder die Targeting-Optionen.

Enums
INSERTION_ORDER_TYPE_UNSPECIFIED Der Typ des Anzeigenauftrags ist nicht angegeben oder unbekannt.
RTB Echtzeitgebote.
OVER_THE_TOP Over-the-Top.

KPI

Einstellungen, mit denen die Leistungskennzahl (KPI) eines Anzeigenauftrags festgelegt wird.

JSON-Darstellung 
{
  "kpiType": enum (KpiType),
  "kpiAlgorithmId": string,

  // Union field kpi_value can be only one of the following:
  "kpiAmountMicros": string,
  "kpiPercentageMicros": string,
  "kpiString": string
  // End of list of possible types for union field kpi_value.
}
Felder
kpiType

enum (KpiType)

Erforderlich. Der Typ des KPI.
kpiAlgorithmId

string (int64 format)

Optional. Die ID des benutzerdefinierten Gebotsalgorithmus, die mit KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST verknüpft ist. Dieses Feld wird ignoriert, wenn nicht der richtige KPI ausgewählt ist.
Union-Feld kpi_value. Erforderlich. Der Wert des KPI. Das entsprechende Feld entspricht der kpi_type. Für kpi_value ist nur einer der folgenden Werte zulässig:
kpiAmountMicros

string (int64 format)

Der Zielbetrag in Mikros in der Währung des Werbetreibenden.

Anwendbar, wenn kpiType einen der folgenden Werte hat:

  • KPI_TYPE_CPM
  • KPI_TYPE_CPC
  • KPI_TYPE_CPA
  • KPI_TYPE_CPIAVC
  • KPI_TYPE_VCPM

Beispiel: 1.500.000 steht für 1,5 Standardeinheiten der Währung.
kpiPercentageMicros

string (int64 format)

Die Dezimaldarstellung des Zielprozentsatzes in Mikroeinheiten

Anwendbar, wenn kpiType einen der folgenden Werte hat:

  • KPI_TYPE_CTR
  • KPI_TYPE_VIEWABILITY
  • KPI_TYPE_CLICK_CVR
  • KPI_TYPE_IMPRESSION_CVR
  • KPI_TYPE_VTR
  • KPI_TYPE_AUDIO_COMPLETION_RATE
  • KPI_TYPE_VIDEO_COMPLETION_RATE

Beispiel: 70.000 steht für 7% (Dezimal 0,07).
kpiString

string

Ein KPI-String, der leer sein kann. Muss UTF-8-codiert sein und darf nicht mehr als 100 Zeichen umfassen.

Anwendbar, wenn kpiType den Wert KPI_TYPE_OTHER hat.

KpiType

Mögliche Typen von Leistungskennzahlen (KPIs).

Enums
KPI_TYPE_UNSPECIFIED Der KPI-Typ ist nicht angegeben oder in dieser Version unbekannt.
KPI_TYPE_CPM Der Leistungsindikator ist CPM (Cost-per-1000-Impressions).
KPI_TYPE_CPC Der Leistungsindikator ist der CPC (Cost-per-Click).
KPI_TYPE_CPA Der Leistungsindikator ist der CPA (Cost-per-Action).
KPI_TYPE_CTR Der Leistungsindikator ist der Prozentsatz der Klickrate (Click-through-Rate, CTR).
KPI_TYPE_VIEWABILITY Der KPI ist der Prozentsatz der Sichtbarkeit.
KPI_TYPE_CPIAVC Der KPI ist CPIAVC (Cost-per-Impression hörbar und sichtbar am Ende).
KPI_TYPE_CPE Der KPI ist CPE (Cost-per-Engagement).
KPI_TYPE_CPV Der KPI wird in CPV (Cost-per-View) festgelegt.
KPI_TYPE_CLICK_CVR Der Leistungsindikator ist der Prozentsatz der Klick-Conversion-Rate (Conversions pro Klick).
KPI_TYPE_IMPRESSION_CVR Der KPI ist der Prozentsatz der Impressions-Conversion-Rate (Conversions pro Impression).
KPI_TYPE_VCPM Der KPI ist der VCPM (Cost-per-1000-viewable-Impressions).
KPI_TYPE_VTR Der KPI ist der Prozentsatz der YouTube-Aufrufrate (YouTube-Aufrufe pro Impression).
KPI_TYPE_AUDIO_COMPLETION_RATE Der KPI ist der Prozentsatz der Audioabschlussrate (Audiowiedergaben pro Impression).
KPI_TYPE_VIDEO_COMPLETION_RATE Der KPI ist der Prozentsatz der Videoabschlussrate (vollständige Videoaufrufe pro Impression).
KPI_TYPE_CPCL Der KPI wird in CPCL (Cost-per-Complete-Audio-Listen) festgelegt.
KPI_TYPE_CPCV Der KPI wird in CPCV (Cost-per-complete-Videoaufruf) festgelegt.
KPI_TYPE_TOS10 Der KPI ist eine Zeit auf dem Bildschirm mindestens 10 Sekunden lang (Prozentsatz der messbaren, nicht überspringbaren Impressionen, die mindestens 10 Sekunden lang auf dem Bildschirm zu sehen waren).
KPI_TYPE_MAXIMIZE_PACING Der KPI ist so eingestellt, dass die Markenwirkung maximiert und gleichzeitig das gesamte Budget ausgegeben wird.
KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST Der KPI wird als benutzerdefinierter Impressionswert geteilt durch Kosten festgelegt.
KPI_TYPE_OTHER Der Leistungsindikator ist ein anderer Wert.

InsertionOrderBudget

Einstellungen, mit denen das Budget für Anzeigenaufträge zugewiesen wird.

JSON-Darstellung 
{
  "budgetUnit": enum (BudgetUnit),
  "automationType": enum (InsertionOrderAutomationType),
  "budgetSegments": [
    {
      object (InsertionOrderBudgetSegment)
    }
  ]
}
Felder
budgetUnit

enum (BudgetUnit)

Erforderlich. Nicht veränderbar. Die Budgeteinheit gibt an, ob das Budget auf einer Währung oder auf Impressionen basiert.
automationType

enum (InsertionOrderAutomationType)

Die Art der Automatisierung, die zur Verwaltung von Gebot und Budget für den Anzeigenauftrag verwendet wird.

Wenn dieses Feld beim Erstellen nicht angegeben ist, wird standardmäßig INSERTION_ORDER_AUTOMATION_TYPE_NONE verwendet.
budgetSegments[]

object (InsertionOrderBudgetSegment)

Erforderlich. Die Liste der Budgetsegmente. Mit einem Budgetsegment können Sie ein spezifisches Budget für einen bestimmten Zeitraum festlegen, für das ein Anzeigenauftrag ausgeführt wird.

InsertionOrderAutomationType

Mögliche Optionen zum Automatisieren von Gebot und Budget für Anzeigenaufträge.

Enums
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED Die Option zur Automatisierung des Anzeigenauftrags ist nicht angegeben oder in dieser Version unbekannt.
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET Automatische Budgetzuweisung. Erlauben Sie dem System, das Budget automatisch auf die eigenen Werbebuchungen umzuverteilen, um die durch kpi definierte Leistung zu optimieren. Keine Automatisierung der Gebotseinstellungen.
INSERTION_ORDER_AUTOMATION_TYPE_NONE Gebote oder Budgets auf Ebene des Anzeigenauftrags sind nicht automatisiert. Gebot und Budget müssen auf Werbebuchungsebene manuell konfiguriert werden.
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET Lassen Sie zu, dass das System Gebote automatisch anpasst und das Budget auf die Werbebuchungen des Eigentümers verlagert, um die durch kpi definierte Leistung zu optimieren.

InsertionOrderBudgetSegment

Einstellungen, mit denen das Budget eines einzelnen Budgetsegments gesteuert wird.

JSON-Darstellung 
{
  "budgetAmountMicros": string,
  "description": string,
  "dateRange": {
    object (DateRange)
  },
  "campaignBudgetId": string
}
Felder
budgetAmountMicros

string (int64 format)

Erforderlich. Der Budgetbetrag, den der Anzeigenauftrag für den angegebenen dateRange ausgibt. Der Betrag wird in Mikros angegeben. Muss größer als 0 sein. Beispiel: 500000000 steht für 500 Standardeinheiten der Währung.
description

string

Die Beschreibung des Budgetsegments Damit können Sie Auftragsinformationen für jedes Budgetsegment eingeben und diese Informationen auf die Rechnungen drucken.

Muss UTF-8-codiert sein.
dateRange

object (DateRange)

Erforderlich. Die Einstellungen für das Start- und Enddatum des Budgetsegments. Sie werden relativ zur Zeitzone des übergeordneten Werbetreibenden aufgelöst.

  • Wenn Sie ein neues Budgetsegment erstellen, müssen startDate und endDate in der Zukunft liegen.
  • Ein vorhandenes Budgetsegment mit einem startDate in der Vergangenheit hat einen änderbaren endDate, aber einen unveränderlichen startDate.
  • endDate muss startDate oder ein späteres Datum sein, beide vor dem Jahr 2037.
campaignBudgetId

string (int64 format)

Die budgetId des Kampagnenbudgets, zu dem dieses Budgetsegment des Anzeigenauftrags gehört.

Methoden

create

 Erstellt einen neuen Anzeigenauftrag.

delete

 Löscht einen Anzeigenauftrag.

get

 Ruft einen Anzeigenauftrag ab.

list

 Listet die Anzeigenaufträge eines Werbetreibenden auf.

listAssignedTargetingOptions

 Listet die zugewiesenen Targeting-Optionen eines Anzeigenauftrags für verschiedene Targeting-Typen auf.

patch

 Aktualisiert einen vorhandenen Anzeigenauftrag.