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 beim Erstellen nicht angegeben ist, wird standardmäßig RTB verwendet.
entityStatus

enum (EntityStatus)

Erforderlich. Steuert, ob der Anzeigenauftrag sein Budget ausgeben und auf Inventar bieten kann.

  • Für die Methode insertionOrders.create ist nur ENTITY_STATUS_DRAFT zulässig. Verwenden Sie zum Aktivieren eines Anzeigenauftrags die Methode insertionOrders.patch und aktualisieren Sie den Status nach dem Erstellen auf ENTITY_STATUS_ACTIVE.
  • Der Status eines Anzeigenauftrags kann nicht von einem anderen Status in den Status "ENTITY_STATUS_DRAFT" geändert werden.
  • Ein Anzeigenauftrag kann nicht auf ENTITY_STATUS_ACTIVE festgelegt werden, wenn die zugehörige übergeordnete Kampagne nicht aktiv ist.
updateTime

string (Timestamp format)

Nur Ausgabe Zeitstempel der letzten Aktualisierung des Anzeigenauftrags. Vom System zugewiesen.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
partnerCosts[]

object (PartnerCost)

Die mit dem Anzeigenauftrag verbundenen Partnerkosten.

Ist diese Angabe in der insertionOrders.create-Methode nicht vorhanden oder leer, übernimmt der neu erstellte Anzeigenauftrag die Partnerkosten aus den Partnereinstellungen.
pacing

object (Pacing)

Erforderlich. Die Einstellung für die Geschwindigkeit der Budgetausgaben 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 Typen von Anzeigenaufträgen.

Der Typ des Anzeigenauftrags bestimmt, welche Einstellungen und Optionen verwendet werden, etwa das Anzeigenformat 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 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 beim Erstellen nicht angegeben ist, wird standardmäßig INSERTION_ORDER_AUTOMATION_TYPE_NONE verwendet.
budgetSegments[]

object (InsertionOrderBudgetSegment)

Erforderlich. Die Liste der Budgetsegmente. Mit einem Budgetsegment können Sie ein spezifisches Budget für einen bestimmten Zeitraum festlegen, für das ein Anzeigenauftrag ausgeführt wird.

InsertionOrderAutomationType

Mögliche Optionen zum Automatisieren von Gebot und Budget für Anzeigenaufträge.

Enums
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED Die Option zur Automatisierung des Anzeigenauftrags ist nicht angegeben oder in dieser Version unbekannt.
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET Automatische Budgetzuweisung. Erlauben Sie dem System, das Budget automatisch auf die eigenen Werbebuchungen umzuverteilen, um die durch performanceGoal definierte Leistung zu optimieren. Keine Automatisierung der Gebotseinstellungen.
INSERTION_ORDER_AUTOMATION_TYPE_NONE Gebote oder Budgets auf Ebene des Anzeigenauftrags sind nicht automatisiert. Gebot und Budget müssen auf Werbebuchungsebene manuell konfiguriert werden.
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET Lassen Sie zu, dass das System Gebote automatisch anpasst und das Budget auf die Werbebuchungen des Eigentümers 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, den der Anzeigenauftrag für den angegebenen dateRange ausgibt. 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 Damit können Sie Auftragsinformationen für jedes Budgetsegment eingeben und diese Informationen auf die Rechnungen drucken.

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.

  • Wenn Sie ein neues Budgetsegment erstellen, müssen startDate und 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 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 Impression.
BILLABLE_OUTCOME_PAY_PER_CLICK

Pay-per-Click.
BILLABLE_OUTCOME_PAY_PER_VIEWABLE_IMPRESSION

Sie zahlen pro Active View.

Methoden

create

 Erstellt einen neuen Anzeigenauftrag.

delete

 Löscht einen Anzeigenauftrag.

get

 Ruft einen Anzeigenauftrag ab.

list

 Listet die Anzeigenaufträge eines Werbetreibenden auf.

listAssignedTargetingOptions

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

patch

 Aktualisiert einen vorhandenen Anzeigenauftrag.