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 Auftrags.
advertiserId

string (int64 format)

Nur Ausgabe. Die eindeutige ID des Werbetreibenden, zu dem der Auftrag 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 Auftrags. Vom System zugewiesen.
displayName

string

Erforderlich. Der Anzeigename des Anzeigenauftrags.

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

enum (InsertionOrderType)

Optional. Der Typ des Anzeigenauftrags.

Wenn dieses Feld bei der Erstellung nicht angegeben wird, ist der Standardwert RTB.
entityStatus

enum (EntityStatus)

Erforderlich. Legt fest, 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. Verwenden Sie zum Aktivieren eines Auftrags die Methode insertionOrders.patch und aktualisieren Sie den Status nach der Erstellung auf ENTITY_STATUS_ACTIVE.
  • Ein Anzeigenauftrag kann aus keinem anderen Status in den Status ENTITY_STATUS_DRAFT zurückgeändert werden.
  • Ein Anzeigenauftrag kann nicht auf ENTITY_STATUS_ACTIVE gesetzt werden, wenn die zugehörige Kampagne nicht aktiv ist.
updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel, der angibt, wann die Einfügeauftrag zuletzt aktualisiert wurde. 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 Partnerkosten, die dem Anzeigenauftrag zugeordnet sind.

Wenn sie in der Methode insertionOrders.create fehlt oder leer ist, werden die Partnerkosten des neu erstellten Anzeigenauftrags aus den Partnereinstellungen übernommen.
pacing

object (Pacing)

Erforderlich. Die Einstellung für die Ausgabengeschwindigkeit des Budgets des Anzeigenauftrags.

pacingType PACING_TYPE_ASAP ist nicht mit pacingPeriod PACING_PERIOD_FLIGHT kompatibel.
frequencyCap

object (FrequencyCap)

Erforderlich. Die Frequency Capping-Einstellung des Anzeigenauftrags.
integrationDetails

object (IntegrationDetails)

Optional. Zusätzliche Integrationsdetails des Anzeigenauftrags.
kpi

object (Kpi)

Erforderlich. Der Leistungsindikator (KPI) des Anzeigenauftrags.

In der Display & Video 360-Benutzeroberfläche wird dies als „Zielvorhaben“ 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.
reservationType

enum (ReservationType)

Nur Ausgabe. Der Reservierungstyp des Anzeigenauftrags.
optimizationObjective

enum (OptimizationObjective)

Erforderlich. Das Optimierungsziel des Anzeigenauftrags.

InsertionOrderType

Mögliche Typen von Anzeigenaufträgen.

Der Typ des Anzeigenauftrags bestimmt, welche Einstellungen und Optionen gelten, z. B. das Format der Anzeigen oder Ausrichtungsoptionen.

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 der Leistungsindikator (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. Der KPI-Typ.
kpiAlgorithmId

string (int64 format)

Optional. Die 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.
Union-Feld kpi_value. Erforderlich. Der Wert des KPI. Das entsprechende Feld entspricht kpi_type. Für kpi_value ist nur einer der folgenden Werte zulässig:
kpiAmountMicros

string (int64 format)

Der Zielbetrag in Mikroeinheiten der Währung des Werbetreibenden.

Gilt, 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 Dezimaldarstellung des Zielprozentsatzes in Mikros.

Gilt, 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.

Gilt, wenn kpiType KPI_TYPE_OTHER ist.

KpiType

Mögliche KPI-Typen (Leistungsindikator).

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 der CPC (Cost-per-Click).
KPI_TYPE_CPA Der KPI ist der CPA (Cost-per-Action).
KPI_TYPE_CTR Der KPI ist der Prozentsatz der Klickrate (CTR).
KPI_TYPE_VIEWABILITY Der KPI ist der Prozentsatz für die Sichtbarkeit.
KPI_TYPE_CPIAVC Der KPI ist CPIAVC (Cost-per-Impression (hörbar und sichtbar bis zum 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 die Klick-Conversion-Rate (Conversions pro Klick) in Prozent.
KPI_TYPE_IMPRESSION_CVR Der KPI ist die Impressions-Conversion-Rate (Conversions pro Impression) in Prozent.
KPI_TYPE_VCPM Der KPI ist der sichtbare CPM (Cost-per-1000-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 (vollständige Audiowiedergaben pro Impression).
KPI_TYPE_VIDEO_COMPLETION_RATE Der KPI ist der Prozentsatz der Video-Abschlussrate (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-Video-View) festgelegt.
KPI_TYPE_TOS10 Der KPI wird als Prozentsatz der messbaren, nicht überspringbaren Impressionen festgelegt, die mindestens 10 Sekunden lang auf dem Bildschirm zu sehen waren.
KPI_TYPE_MAXIMIZE_PACING Der KPI ist so festgelegt, dass die Markenwirkung maximiert wird, während 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 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 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, ist der Standardwert INSERTION_ORDER_AUTOMATION_TYPE_NONE.
budgetSegments[]

object (InsertionOrderBudgetSegment)

Erforderlich. Die Liste der Budgetsegmente. Verwenden Sie ein Budgetsegment, um ein bestimmtes Budget für einen bestimmten Zeitraum festzulegen, in dem ein Anzeigenauftrag läuft.

InsertionOrderAutomationType

Mögliche Optionen zum Automatisieren von Geboten und Budgets für Anzeigenaufträge.

Enums
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED Die Automatisierungsoption für die Einfügereihenfolge ist in dieser Version nicht angegeben oder unbekannt.
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET Automatische Budgetzuweisung Das System kann das Budget automatisch auf die zugehörigen Werbebuchungen übertragen, um die Leistung zu optimieren, die durch kpi definiert wird. Keine Automatisierung bei Gebotseinstellungen.
INSERTION_ORDER_AUTOMATION_TYPE_NONE Keine Automatisierung von Gebot oder Budget auf Anzeigenauftragsebene. Gebote und Budgets müssen manuell auf Ebene der Werbebuchung konfiguriert werden.
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET Das System kann Gebote automatisch anpassen und das Budget auf die entsprechenden Werbebuchungen übertragen, um die Leistung zu optimieren, die durch kpi definiert wird.

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 die angegebene dateRange ausgegeben wird. Der Betrag wird in Micros angegeben. Muss größer als 0 sein. Beispiel: 500000000 steht für 500 Standardeinheiten der Währung.
description

string

Optional. Die Beschreibung des Budgetsegments. Hier können Sie Auftragsinformationen für jedes Budgetsegment eingeben, die dann auf den Rechnungen aufgeführt werden.

Muss UTF-8-codiert sein.
dateRange

object (DateRange)

Erforderlich. Die Einstellungen für das Start- und Enddatum des Budgetsegments. Sie werden in Bezug auf die 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 ein veränderliches endDate, aber ein unveränderliches startDate.
  • endDate muss startDate oder höher sein, jeweils vor dem Jahr 2037.
campaignBudgetId

string (int64 format)

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

OptimizationObjective

Mögliche Typen der Optimierungsziele.

Enums
OPTIMIZATION_OBJECTIVE_UNSPECIFIED Der Typwert ist in dieser Version nicht angegeben oder unbekannt.
CONVERSION Impressionen priorisieren, mit denen Umsatz und Conversions gesteigert werden
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 die benutzerdefinierte Gebotseinstellung 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.

listAssignedTargetingOptions

 Listet die zugewiesenen Targeting-Optionen eines Anzeigenauftrags nach Targeting-Typen auf.

patch

 Aktualisiert einen vorhandenen Anzeigenauftrag.