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),
  "optimizationObjective": enum (OptimizationObjective)
}
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 bei der Erstellung nicht angegeben wird, wird standardmäßig RTB verwendet.
entityStatus

enum (EntityStatus)

Erforderlich. Damit wird gesteuert, ob für den Anzeigenauftrag das zugehörige Budget ausgegeben und Gebote für Inventar abgegeben werden können.

  • Für die Methode insertionOrders.create ist nur ENTITY_STATUS_DRAFT zulässig. Wenn Sie einen Anzeigenauftrag aktivieren möchten, verwenden Sie die Methode insertionOrders.patch und aktualisieren Sie den Status nach dem Erstellen auf ENTITY_STATUS_ACTIVE.
  • Ein Anzeigenauftrag kann von keinem anderen Status in den ENTITY_STATUS_DRAFT-Status zurückversetzt werden.
  • Ein Anzeigenauftrag kann nicht auf ENTITY_STATUS_ACTIVE festgelegt werden, wenn die übergeordnete Kampagne nicht aktiv ist.
updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel, der angibt, wann der Anzeigenauftrag 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".
partnerCosts[]

object (PartnerCost)

Die Partnerkosten, die mit dem Anzeigenauftrag verknüpft sind.

Falls in der Methode insertionOrders.create fehlt oder leer ist, werden die Partnerkosten für den neu erstellten Anzeigenauftrag aus den Partnereinstellungen übernommen.
pacing

object (Pacing)

Erforderlich. Die Einstellung für die Budgetausgabegeschwindigkeit 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 als „Ziel“ bezeichnet. im Bereich Display- und Video 360-Benutzeroberfläche.
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.
optimizationObjective

enum (OptimizationObjective)

Optional. Das Optimierungsziel des Anzeigenauftrags.

Dieses Feld ist nur für Kunden auf der Zulassungsliste verfügbar. Wenn ein Kunde nicht auf der Zulassungsliste steht, hat dieses Feld den Wert null und wenn versucht wird, es festzulegen, wird ein Fehler zurückgegeben.

InsertionOrderType

Mögliche Arten eines Anzeigenauftrags.

Der Typ des Anzeigenauftrags bestimmt, welche Einstellungen und Optionen anwendbar sind, z. B. das Format der Anzeigen 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 gesteuert 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. Die Art 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 dem kpi_type. Für kpi_value ist nur einer der folgenden Werte zulässig:
kpiAmountMicros

string (int64 format)

Der Zielbetrag in Mikros der Währung des Werbetreibenden.

Anwendbar, wenn kpiType einer der folgenden Werte ist:

  • KPI_TYPE_CPM
  • KPI_TYPE_CPC
  • KPI_TYPE_CPA
  • KPI_TYPE_CPIAVC
  • KPI_TYPE_VCPM

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

string (int64 format)

Die dezimale Darstellung des Zielprozentsatzes in Mikros.

Anwendbar, wenn kpiType einer der folgenden Werte ist:

  • 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% (Dezimalzahl 0,07).
kpiString

string

Ein KPI-String, der leer sein kann. Muss UTF-8-codiert sein und maximal 100 Zeichen lang sein.

Anwendbar, wenn kpiType den Wert KPI_TYPE_OTHER hat.

KpiType

Mögliche Leistungskennzahlen (KPIs).

Enums
KPI_TYPE_UNSPECIFIED Der KPI-Typ ist in dieser Version nicht angegeben oder unbekannt.
KPI_TYPE_CPM Der KPI ist CPM (Cost-per-1000-Impressions).
KPI_TYPE_CPC Der KPI ist CPC (Cost-per-Click).
KPI_TYPE_CPA Der KPI ist CPA (Cost-per-Action).
KPI_TYPE_CTR Der KPI 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 KPI 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 VCPM (Cost-per-1000-sichtbare Impressionen).
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 (vollständige Audiowiedergabe 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 (Kosten pro vollständiger Audiowiedergabe) festgelegt.
KPI_TYPE_CPCV Der KPI wird in CPCV (Kosten pro vollständigem Videoaufruf) festgelegt.
KPI_TYPE_TOS10 Der KPI wird als Zeitdauer auf dem Bildschirm festgelegt, die mindestens 10 Sekunden dauert. Dies ist der 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 festgelegt, indem der benutzerdefinierte Impressionswert durch die Kosten geteilt wird.
KPI_TYPE_OTHER Der KPI ist ein anderer Wert.

InsertionOrderBudget

Einstellungen, mit denen gesteuert wird, wie 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 bei der Erstellung nicht angegeben wird, wird standardmäßig INSERTION_ORDER_AUTOMATION_TYPE_NONE verwendet.
budgetSegments[]

object (InsertionOrderBudgetSegment)

Erforderlich. Die Liste der Budgetsegmente. Mit einem Budgetsegment können Sie ein bestimmtes Budget für einen bestimmten Zeitraum angeben, in dem ein Anzeigenauftrag aktiv ist.

InsertionOrderAutomationType

Mögliche Optionen zur Automatisierung von Gebot und Budget für Anzeigenaufträge

Enums
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED Die Automatisierungsoption für Anzeigenaufträge ist in dieser Version nicht angegeben oder unbekannt.
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET Automatische Budgetzuweisung Lassen Sie das System das Budget automatisch auf die Inhaber der Werbebuchungen umverteilen, um die durch kpi definierte Leistung zu optimieren. Keine Automatisierung der Gebotseinstellungen.
INSERTION_ORDER_AUTOMATION_TYPE_NONE Gebote oder Budgets werden auf Anzeigenauftragsebene nicht automatisiert. Gebot und Budget müssen manuell auf Werbebuchungsebene konfiguriert werden.
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET Lassen Sie zu, dass das System automatisch Gebote anpasst und das Budget auf eigene Werbebuchungen 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, der für den Anzeigenauftrag für den angegebenen dateRange ausgegeben wird. Der Betrag wird in Mikros angegeben. Muss größer als 0 sein. Beispiel: 500000000 stellt 500 Standardeinheiten der Währung dar.
description

string

Die Beschreibung des Budgetsegments. Sie können damit Auftragsinformationen für jedes Budgetsegment eingeben und auf die Rechnungen gedruckt lassen.

Muss UTF-8-codiert sein.
dateRange

object (DateRange)

Erforderlich. Die Einstellungen für das Start- und Enddatum des Budgetsegments. Sie werden in Abhängigkeit von der Zeitzone des übergeordneten Werbetreibenden aufgelöst.

  • Wenn Sie ein neues Budgetsegment erstellen, müssen sowohl startDate als auch 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 das 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.

OptimizationObjective

Mögliche Arten der Optimierungsziele

Enums
OPTIMIZATION_OBJECTIVE_UNSPECIFIED Der Typwert ist in dieser Version nicht angegeben oder unbekannt.
CONVERSION Priorisieren Sie Impressionen, die Umsatz und Conversions steigern.
CLICK Priorisieren Sie Impressionen, mit denen mehr Websitezugriffe, Apps und App-Shops erzielt werden.
BRAND_AWARENESS Impressionen bestimmter Qualität priorisieren
CUSTOM Das Ziel wird durch den zugewiesenen Algorithmus für die benutzerdefinierte Gebotseinstellung definiert.
NO_OBJECTIVE Ziel ist nicht definiert. Jeder KPI oder jede Gebotsstrategie kann verwendet werden.

Methoden

create

 Erstellt einen neuen Anzeigenauftrag.

delete

 Löscht einen Anzeigenauftrag.

get

 Ruft einen Anzeigenauftrag ab.

list

 Hier werden Anzeigenaufträge für einen Werbetreibenden aufgelistet.

listAssignedTargetingOptions

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

patch

 Aktualisiert einen vorhandenen Anzeigenauftrag.