REST Resource: advertisers.insertionOrders

Ressource: InsertionOrder

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. Wird 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)

Optional. Der Typ des Anzeigenauftrags.

Wenn dieses Feld bei der Erstellung nicht angegeben wird, wird standardmäßig der Wert RTB verwendet.
entityStatus

enum (EntityStatus)

Erforderlich. Hiermit wird festgelegt, ob das Budget des Anzeigenauftrags ausgegeben und auf Inventar geboten werden kann.

  • 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 nicht von einem anderen Status in den Status „ENTITY_STATUS_DRAFT“ zurückgeändert werden.
  • Ein Anzeigenauftrag kann nicht auf ENTITY_STATUS_ACTIVE gesetzt werden, wenn die übergeordnete Kampagne nicht aktiv ist.
updateTime

string (Timestamp format)

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

object (PartnerCost)

Optional. Die mit dem Anzeigenauftrag verbundenen Partnerkosten.

Wenn die Partnerkosten in der Methode insertionOrders.create nicht vorhanden oder leer sind, werden sie für den neu erstellten Anzeigenauftrag aus den Partnereinstellungen übernommen.
pacing

object (Pacing)

Erforderlich. Die Einstellung für die Budgetausgabegeschwindigkeit des Anzeigenauftrags.

pacingType PACING_TYPE_ASAP ist nicht mit pacingPeriod PACING_PERIOD_FLIGHT kompatibel.
frequencyCap

object (FrequencyCap)

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

object (IntegrationDetails)

Optional. Zusätzliche Integrationsdetails des Anzeigenauftrags.
kpi

object (Kpi)

Erforderlich. Die Leistungskennzahl (KPI) des Anzeigenauftrags.

In der Display & Video 360-Oberfläche wird dies als „Ziel“ bezeichnet.
budget

object (InsertionOrderBudget)

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

object (BiddingStrategy)

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

Wenn das Feld budget (automationType) auf INSERTION_ORDER_AUTOMATION_TYPE_BUDGET oder INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET festgelegt ist, wird diese Gebotsstrategie für die Werbebuchungen des Anzeigenauftrags verwendet. Wenn eine vorgegebene Gebotsstrategie nicht mit der Einstellung enableOptimizedTargeting einer Werbebuchung kompatibel ist, wird die Einstellung für das optimierte Targeting aktualisiert.
reservationType

enum (ReservationType)

Nur Ausgabe. Der Reservierungstyp des Anzeigenauftrags.
optimizationObjective

enum (OptimizationObjective)

Erforderlich. Das Optimierungsziel des Anzeigenauftrags.

InsertionOrderType

Mögliche Typen eines Anzeigenauftrags.

Der Typ des Anzeigenauftrags bestimmt, welche Einstellungen und Optionen verfügbar 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.
OUT_OF_HOME Außenwerbung

KPI

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "kpiAmountMicros": string,
  "kpiPercentageMicros": string,
  "kpiString": string
  // End of mutually exclusive fields.
}
Felder
kpiType

enum (KpiType)

Erforderlich. Der Typ des KPI.
kpiAlgorithmId

string (int64 format)

Optional. ID des benutzerdefinierten Gebotsalgorithmus, der mit KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST verknüpft ist. Dieses Feld wird ignoriert, wenn der richtige KPI nicht ausgewählt ist.
Erforderlich. Der Wert des KPI. Das relevante Feld entspricht dem kpi_type. Im Folgenden finden Sie eine Liste der Felder, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
kpiAmountMicros

string (int64 format)

Der Zielbetrag in Mikroeinheiten 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 entspricht 1,5 Standardeinheiten der Währung.
kpiPercentageMicros

string (int64 format)

Die Dezimaldarstellung 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: 70000 steht für 7% (Dezimalzahl 0,07).
kpiString

string

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

Anwendbar, wenn kpiType KPI_TYPE_OTHER ist.
Ende der sich gegenseitig ausschließenden Felder.

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 KPI ist der CPM (Cost-per-1000-Impressions).
KPI_TYPE_CPC Der KPI ist der CPC (Cost-per-Click).
KPI_TYPE_CPA Der KPI ist der CPA (Cost-per-Action).
KPI_TYPE_CTR Der KPI ist die Klickrate (CTR) in Prozent.
KPI_TYPE_VIEWABILITY Der KPI ist der Sichtbarkeitsprozentsatz.
KPI_TYPE_CPIAVC Der KPI ist der CPIAVC (Cost-per-Impression, hörbar und sichtbar bis zum Ende).
KPI_TYPE_CPE Der KPI ist der CPE (Cost-per-Engagement).
KPI_TYPE_CPV Der KPI ist auf 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 Impression-Conversion-Rate (Conversions pro Impression).
KPI_TYPE_VCPM Der KPI ist der vCPM (Kosten pro tausend sichtbare Impressionen).
KPI_TYPE_VTR Der KPI ist die YouTube-Aufrufrate (YouTube-Aufrufe pro Impression) in Prozent.
KPI_TYPE_AUDIO_COMPLETION_RATE Der KPI ist die Audioabschlussrate (vollständig angehörte Audioclips pro Impression) in Prozent.
KPI_TYPE_VIDEO_COMPLETION_RATE Der KPI ist die Videoabschlussrate (vollständige Videoaufrufe pro Impression) in Prozent.
KPI_TYPE_CPCL Der KPI wird in CPCL (Cost-per-Complete-Audio-Listen) festgelegt.
KPI_TYPE_CPCV Der KPI ist auf CPCV (Cost-per-Completed-Video-View) festgelegt.
KPI_TYPE_TOS10 Der KPI ist auf die Rate der Zeit auf dem Bildschirm von mindestens 10 Sekunden festgelegt (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 festgelegt, dass die Wirkung auf die Markenbekanntheit maximiert wird, während gleichzeitig das gesamte Budget ausgegeben wird.
KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST Der KPI wird als benutzerdefinierter Impressionswert geteilt durch die Kosten festgelegt.
KPI_TYPE_OTHER Der KPI ist ein anderer Wert.

InsertionOrderBudget

Einstellungen, mit denen gesteuert wird, wie das Budget des Anzeigenauftrags 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 währungs- oder impressionsbasiert ist.
automationType

enum (InsertionOrderAutomationType)

Optional. Die Art der Automatisierung, die zum Verwalten von Gebot und Budget für den Anzeigenauftrag verwendet wird.

Wenn dieses Feld bei der Erstellung nicht angegeben wird, wird standardmäßig der Wert INSERTION_ORDER_AUTOMATION_TYPE_NONE verwendet.
budgetSegments[]

object (InsertionOrderBudgetSegment)

Erforderlich. Die Liste der Budgetsegmente. Verwenden Sie ein Budgetsegment, um für eine bestimmte Zeit, in der ein Anzeigenauftrag läuft, ein Budget festzulegen.

InsertionOrderAutomationType

Mögliche Optionen für die Automatisierung von Geboten und Budgets 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 Das System kann das Budget automatisch auf Werbebuchungen mit der besten Leistung verschieben, um die Leistung gemäß kpi zu optimieren. Keine Automatisierung der Gebotseinstellungen.
INSERTION_ORDER_AUTOMATION_TYPE_NONE Keine Automatisierung von Geboten oder Budgets auf Anzeigenauftragsebene. Gebote und Budgets müssen auf Ebene der Werbebuchung manuell konfiguriert werden.
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET Das System kann Gebote automatisch anpassen und das Budget auf Werbebuchungen mit der besten Leistung verschieben, um die Leistung gemäß bidStrategy 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 Micros angegeben. Muss größer als 0 sein. Beispiel: 500000000 entspricht 500 Standardeinheiten der Währung.
description

string

Optional. Die Beschreibung des Budgetsegments. Damit können Sie für jedes Budgetsegment Auftragsinformationen eingeben und diese Informationen auf den Rechnungen ausgeben lassen.

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.

  • Beim Erstellen eines neuen Budgetsegments 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 der startDate oder später sein, beide vor dem Jahr 2037.
campaignBudgetId

string (int64 format)

Optional. Die budgetId des Kampagnenbudgets, zu dem dieses Budgetsegment für Anzeigenaufträge gehört.

OptimizationObjective

Mögliche Typen der Optimierungsziele.

Enums
OPTIMIZATION_OBJECTIVE_UNSPECIFIED Der Typwert ist nicht angegeben oder in dieser Version unbekannt.
CONVERSION Impressionen priorisieren, die zu mehr Verkäufen und Conversions führen.
CLICK Impressionen priorisieren, mit denen die Anzahl der Websitezugriffe, App-Installationen und App-Shops erhöht wird
BRAND_AWARENESS Impressionen bestimmter Qualität priorisieren
CUSTOM Das Ziel wird durch den zugewiesenen Algorithmus für benutzerdefinierte Gebote definiert.
NO_OBJECTIVE Ziel ist nicht definiert. Es kann ein beliebiger KPI oder eine beliebige Gebotsstrategie verwendet werden.

Methoden

create

 Erstellt einen neuen Anzeigenauftrag.

delete

 Löscht einen Anzeigenauftrag.

get

 Ruft einen Anzeigenauftrag ab.

list

 Listet Anzeigenaufträge eines Werbetreibenden auf.

patch

 Aktualisiert einen vorhandenen Anzeigenauftrag.