REST Resource: advertisers.insertionOrders

Ressource: Insertion-Order

Einen einzelnen 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)

Optional. Der Typ des Anzeigenauftrags.

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

enum (EntityStatus)

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

  • Für die insertionOrders.create-Methode ist nur ENTITY_STATUS_DRAFT zulässig. Verwenden Sie die Methode insertionOrders.patch, um einen Anzeigenauftrag zu aktivieren, und aktualisieren Sie den Status nach der Erstellung auf ENTITY_STATUS_ACTIVE.
  • Ein Anzeigenauftrag kann nicht von einem anderen Status in den Status ENTITY_STATUS_DRAFT zurückversetzt 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 für den Zeitpunkt, zu dem der Anzeigenauftrag zuletzt aktualisiert wurde. Vom System zugewiesen.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. 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 in der insertionOrders.create-Methode kein Wert angegeben oder das Feld leer ist, werden die Partnerkosten aus den Partnereinstellungen in den neu erstellten Anzeigenauftrag übernommen.
pacing

object (Pacing)

Erforderlich. Die Einstellung für die Geschwindigkeit der Budgetausgaben 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 Display & Video 360 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)

Optional. Das Optimierungsziel des Anzeigenauftrags.

InsertionOrderType

Mögliche Typen eines Anzeigenauftrags.

Der Anzeigenauftragstyp bestimmt, welche Einstellungen und Optionen gelten, z. B. das Anzeigenformat oder die Ausrichtungsoptionen.

Enums
INSERTION_ORDER_TYPE_UNSPECIFIED Der Anzeigenauftragstyp 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. Der KPI-Typ.
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 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 „micros“, millionstel Einheiten der Währung des Werbetreibenden.

Gilt, wenn kpiType einen der folgenden Werte hat:

  • 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 Micros.

Gilt, 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 auch 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 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 der CPC (Cost-per-Click).
KPI_TYPE_CPA Die KPI ist der 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 Die Leistungskennzahl 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 Die KPI ist in CPV (Cost-per-View) festgelegt.
KPI_TYPE_CLICK_CVR Die KPI ist die Klick-Conversion-Rate (Conversions pro Klick) in Prozent.
KPI_TYPE_IMPRESSION_CVR Die Leistungskennzahl ist die Impressions-Conversion-Rate (Conversions pro Impression) in Prozent.
KPI_TYPE_VCPM Die Leistungskennzahl ist der vCPM (Cost-per-1000-Impressions).
KPI_TYPE_VTR Die 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 Videowiedergaberate (vollständige Videowiedergaben pro Impression).
KPI_TYPE_CPCL Der KPI wird in CPCL (Cost-per-Complete-Audio-Listen) festgelegt.
KPI_TYPE_CPCV Die KPI wird in CPCV (Cost-per-Complete-Video-View) festgelegt.
KPI_TYPE_TOS10 Die KPI wird in der Rate der Zeit auf dem Bildschirm (10 Sekunden oder mehr) angegeben (Prozentsatz der messbaren, nicht überspringbaren Impressionen, die mindestens 10 Sekunden lang auf dem Bildschirm zu sehen waren).
KPI_TYPE_MAXIMIZE_PACING Die KPI ist so festgelegt, dass die Markenwirkung maximiert wird und gleichzeitig das gesamte Budget ausgegeben wird.
KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST Die KPI wird als benutzerdefinierter Impressionswert geteilt durch die Kosten festgelegt.
KPI_TYPE_OTHER Der KPI ist ein anderer Wert.

InsertionOrderBudget

Einstellungen, mit denen die Zuweisung des Budgets für Anzeigenaufträge gesteuert 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 impressionbasiert ist.
automationType

enum (InsertionOrderAutomationType)

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

Wenn dieses Feld beim Erstellen 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 für die Automatisierung von Gebot und Budget für Anzeigenaufträge.

Enums
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED Die Option für die Automatisierung von Anzeigenaufträgen 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 umverteilen, um die mit kpi definierte Leistung zu optimieren. Keine Automatisierung der Gebotseinstellungen.
INSERTION_ORDER_AUTOMATION_TYPE_NONE Keine Automatisierung von Gebot oder Budget auf Anzeigenauftragsebene. Gebot und Budget müssen manuell auf Werbebuchungsebene konfiguriert werden.
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET Erlauben Sie dem System, Gebote automatisch anzupassen und das Budget auf die zugehörigen Werbebuchungen umzuverteilen, um die mit 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 die angegebene dateRange ausgegeben wird. Der Betrag wird in Micros angegeben. Muss größer als 0 sein. 500000000 steht beispielsweise für 500 Standardeinheiten der Währung.
description

string

Optional. Die Beschreibung des Budgetsegments. Sie können damit Informationen zu Bestellungen für jedes Budgetsegment eingeben und diese Informationen auf den Rechnungen drucken 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 veränderlichen endDate, aber einen unveränderlichen startDate.
  • endDate muss das Jahr startDate oder ein späteres Jahr sein, das vor dem Jahr 2037 liegt.
campaignBudgetId

string (int64 format)

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

OptimizationObjective

Mögliche Arten von Optimierungszielen.

Enums
OPTIMIZATION_OBJECTIVE_UNSPECIFIED Der Typwert ist in dieser Version nicht angegeben oder unbekannt.
CONVERSION Priorisieren Sie Impressionen, mit denen sich Umsätze und Conversions steigern lassen.
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 vom zugewiesenen Algorithmus für die benutzerdefinierte Gebotseinstellung definiert.
NO_OBJECTIVE Zielvorhaben nicht definiert. Es kann jeder KPI oder jede Gebotsstrategie 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

 Hier werden die zugewiesenen Targeting-Optionen eines Anzeigenauftrags nach Targeting-Typ aufgelistet.

patch

 Aktualisiert einen vorhandenen Anzeigenauftrag.