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)
  },
  "performanceGoal": {
    object (PerformanceGoal)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "billableOutcome": enum (BillableOutcome)
}
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.

Wenn diese Angabe in der Methode insertionOrders.create fehlt oder leer ist, werden für den neu erstellten Anzeigenauftrag die Partnerkosten 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.
performanceGoal

object (PerformanceGoal)

Erforderlich. Leistungsziel des Anzeigenauftrags.
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.
billableOutcome

enum (BillableOutcome)

Nicht veränderbar. Das abrechenbare Ergebnis des Anzeigenauftrags.

Ergebnisbasierte Käufe wurden eingestellt. BILLABLE_OUTCOME_PAY_PER_IMPRESSION ist der einzige gültige Wert.

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.

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 performanceGoal definierte Leistung zu optimieren. Keine Automatisierung für 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 performanceGoal 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 steht für 500 Standardeinheiten der Währung.
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.

BillableOutcome

Mögliche abrechenbare Ergebnisse für einen Anzeigenauftrag.

Enums
BILLABLE_OUTCOME_UNSPECIFIED Nicht angegebenes abrechenbares Ergebnis.
BILLABLE_OUTCOME_PAY_PER_IMPRESSION Sie zahlen pro Impressionen.
BILLABLE_OUTCOME_PAY_PER_CLICK

Sie zahlen pro Klick.
BILLABLE_OUTCOME_PAY_PER_VIEWABLE_IMPRESSION

Sie zahlen pro Active View.

Methoden

bulkListInsertionOrderAssignedTargetingOptions

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

create

 Erstellt einen neuen Anzeigenauftrag.

delete

 Löscht einen Anzeigenauftrag.

get

 Ruft einen Anzeigenauftrag ab.

list

 Listet die Anzeigenaufträge eines Werbetreibenden auf.

patch

 Aktualisiert einen vorhandenen Anzeigenauftrag.