REST Resource: advertisers.insertionOrders

{
  "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)
}

string

Nur Ausgabe. Der Ressourcenname des Anzeigenauftrags.

string (int64 format)

Nur Ausgabe. Die eindeutige ID des Werbetreibenden, zu dem der Anzeigenauftrag gehört.

string (int64 format)

Erforderlich. Nicht veränderbar. Die eindeutige ID der Kampagne, zu der der Anzeigenauftrag gehört.

string (int64 format)

Nur Ausgabe. Die eindeutige ID des Anzeigenauftrags. Vom System zugewiesen.

string

Erforderlich. Der Anzeigename des Anzeigenauftrags.

Muss UTF-8-codiert sein und darf maximal 240 Byte groß sein.

enum (InsertionOrderType)

Der Typ des Anzeigenauftrags.

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

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.

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".

object (PartnerCost)

Die Partnerkosten, die mit dem Anzeigenauftrag verknüpft sind.

Falls in der Methode insertionOrders.create fehlt oder leer ist, werden die Partnerkosten für den neu erstellten Anzeigenauftrag aus den Partnereinstellungen übernommen.

object (Pacing)

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

object (FrequencyCap)

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

object (IntegrationDetails)

Zusätzliche Integrationsdetails des Anzeigenauftrags.

object (Kpi)

Erforderlich. Die Leistungskennzahl (KPI) des Anzeigenauftrags.

In Display & Video 360 wird dies als „Zielvorhaben“ bezeichnet.

object (InsertionOrderBudget)

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

object (BiddingStrategy)

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

enum (ReservationType)

Nur Ausgabe. Der Reservierungstyp des Anzeigenauftrags.

enum (OptimizationObjective)

Optional. Das Optimierungsziel des Anzeigenauftrags.

Dieses Feld ist nur für Kunden auf der Zulassungsliste verfügbar. Wenn ein Kunde nicht auf der Zulassungsliste steht, hat dieses Feld den Wert null und wenn versucht wird, es festzulegen, wird ein Fehler zurückgegeben.

{
  "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.
}

enum (KpiType)

Erforderlich. Die Art des KPI.

string (int64 format)

Optional. Die ID des Algorithmus für die benutzerdefinierte Gebotseinstellung, die mit KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST verknüpft ist. Dieses Feld wird ignoriert, wenn nicht der richtige KPI ausgewählt ist.

string (int64 format)

Der Zielbetrag in Mikros 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 steht für 1,5 Standardeinheiten der Währung.

string (int64 format)

Die dezimale Darstellung 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: 70.000 steht für 7% (Dezimalzahl 0,07).

string

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

Anwendbar, wenn kpiType den Wert KPI_TYPE_OTHER hat.

{
  "budgetUnit": enum (BudgetUnit),
  "automationType": enum (InsertionOrderAutomationType),
  "budgetSegments": [
    {
      object (InsertionOrderBudgetSegment)
    }
  ]
}

enum (BudgetUnit)

Erforderlich. Nicht veränderbar. Die Budgeteinheit gibt an, ob das Budget auf einer Währung oder auf Impressionen basiert.

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.

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.

{
  "budgetAmountMicros": string,
  "description": string,
  "dateRange": {
    object (DateRange)
  },
  "campaignBudgetId": string
}

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 stellt 500 Standardeinheiten der Währung dar.

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.

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.

string (int64 format)

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