REST Resource: advertisers.campaigns

Ressource: Campaign

Eine einzelne Kampagne

JSON-Darstellung 
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "campaignGoal": {
    object (CampaignGoal)
  },
  "campaignFlight": {
    object (CampaignFlight)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "campaignBudgets": [
    {
      object (CampaignBudget)
    }
  ]
}
Felder
name

string

Nur Ausgabe. Der Ressourcenname der Kampagne.
advertiserId

string (int64 format)

Nur Ausgabe. Die eindeutige ID des Werbetreibenden, zu dem die Kampagne gehört.
campaignId

string (int64 format)

Nur Ausgabe. Die eindeutige ID der Kampagne. Wird vom System zugewiesen.
displayName

string

Erforderlich. Der Anzeigename der Kampagne.

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

enum (EntityStatus)

Erforderlich. Hiermit wird festgelegt, ob die Anzeigenaufträge in dieser Kampagne ihre Budgets ausgeben und Gebote für Inventar abgeben können.

  • Zulässige Werte sind ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED und ENTITY_STATUS_PAUSED.
  • Für die Methode campaigns.create ist ENTITY_STATUS_ARCHIVED nicht zulässig.
updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel, der angibt, wann die Kampagne zuletzt aktualisiert wurde. Wird 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"
campaignGoal

object (CampaignGoal)

Erforderlich. Das Zielvorhaben der Kampagne
campaignFlight

object (CampaignFlight)

Erforderlich. Die geplanten Ausgaben und die Dauer der Kampagne.
frequencyCap

object (FrequencyCap)

Erforderlich. Die Einstellung für das Frequency Capping der Kampagne.
campaignBudgets[]

object (CampaignBudget)

Die Liste der für diese Kampagne verfügbaren Budgets.

Wenn dieses Feld nicht festgelegt ist, wird für die Kampagne ein unbegrenztes Budget verwendet.

CampaignGoal

Einstellungen, mit denen das Zielvorhaben einer Kampagne festgelegt wird.

JSON-Darstellung 
{
  "campaignGoalType": enum (CampaignGoalType),
  "performanceGoal": {
    object (PerformanceGoal)
  }
}
Felder
campaignGoalType

enum (CampaignGoalType)

Erforderlich. Der Typ des Kampagnenziels.
performanceGoal

object (PerformanceGoal)

Erforderlich. Das Leistungsziel der Kampagne.

Zulässige Werte für performanceGoalType sind:

  • PERFORMANCE_GOAL_TYPE_CPM
  • PERFORMANCE_GOAL_TYPE_CPC
  • PERFORMANCE_GOAL_TYPE_CPA
  • PERFORMANCE_GOAL_TYPE_CPIAVC
  • PERFORMANCE_GOAL_TYPE_CTR
  • PERFORMANCE_GOAL_TYPE_VIEWABILITY
  • PERFORMANCE_GOAL_TYPE_OTHER

CampaignGoalType

Mögliche Typen von Kampagnenzielen.

Enums
CAMPAIGN_GOAL_TYPE_UNSPECIFIED Der Zielvorhabenwert ist in dieser Version nicht angegeben oder unbekannt.
CAMPAIGN_GOAL_TYPE_APP_INSTALL Mehr App-Installationen oder -Interaktionen
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS Bekanntheit einer Marke oder eines Produkts steigern
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION Offlineumsatz bzw. Umsatz in Ladengeschäften steigern
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION Mehr Onlineaktionen oder -besuche

PerformanceGoal

Einstellungen, mit denen das Leistungsziel einer Kampagne gesteuert wird.

JSON-Darstellung 
{
  "performanceGoalType": enum (PerformanceGoalType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "performanceGoalAmountMicros": string,
  "performanceGoalPercentageMicros": string,
  "performanceGoalString": string
  // End of mutually exclusive fields.
}
Felder
performanceGoalType

enum (PerformanceGoalType)

Erforderlich. Der Typ des Leistungsziels.
Erforderlich. Der Wert des Leistungsziels, der einem bestimmten performance_goal_type entspricht. Im Folgenden finden Sie eine Liste der Felder, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
performanceGoalAmountMicros

string (int64 format)

Der Zielbetrag in Mikroeinheiten der Währung des Werbetreibenden.

Anwendbar, wenn performanceGoalType einer der folgenden Werte ist:

  • PERFORMANCE_GOAL_TYPE_CPM
  • PERFORMANCE_GOAL_TYPE_CPC
  • PERFORMANCE_GOAL_TYPE_CPA
  • PERFORMANCE_GOAL_TYPE_CPIAVC
  • PERFORMANCE_GOAL_TYPE_VCPM

Beispiel: 1500000 entspricht 1,5 Standardeinheiten der Währung.
performanceGoalPercentageMicros

string (int64 format)

Die Dezimaldarstellung des Zielprozentsatzes in Mikros.

Anwendbar, wenn performanceGoalType einer der folgenden Werte ist:

  • PERFORMANCE_GOAL_TYPE_CTR
  • PERFORMANCE_GOAL_TYPE_VIEWABILITY
  • PERFORMANCE_GOAL_TYPE_CLICK_CVR
  • PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR
  • PERFORMANCE_GOAL_TYPE_VTR
  • PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE
  • PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE

70000 steht beispielsweise für 7% (Dezimalzahl 0, 07).
performanceGoalString

string

Ein String für eine Leistungskennzahl (KPI), der leer sein kann. Muss UTF-8-codiert sein und darf maximal 100 Zeichen lang sein.

Anwendbar, wenn performanceGoalType auf PERFORMANCE_GOAL_TYPE_OTHER gesetzt ist.
Ende der sich gegenseitig ausschließenden Felder.

PerformanceGoalType

Mögliche Arten von Leistungszielen.

Enums
PERFORMANCE_GOAL_TYPE_UNSPECIFIED Der Typ des Leistungsziels ist nicht angegeben oder in dieser Version unbekannt.
PERFORMANCE_GOAL_TYPE_CPM Das Leistungsziel wird in CPM (Cost-per-1000-Impressions) festgelegt.
PERFORMANCE_GOAL_TYPE_CPC Das Leistungsziel wird als CPC (Cost-per-Click) festgelegt.
PERFORMANCE_GOAL_TYPE_CPA Das Leistungsziel wird als CPA (Cost-per-Action) festgelegt.
PERFORMANCE_GOAL_TYPE_CTR Das Leistungsziel wird als CTR-Prozentsatz (Klickrate) festgelegt.
PERFORMANCE_GOAL_TYPE_VIEWABILITY Das Leistungsziel wird als Prozentsatz der Sichtbarkeit festgelegt.
PERFORMANCE_GOAL_TYPE_CPIAVC Das Leistungsziel ist auf CPIAVC (Cost-per-Impression, hörbar und sichtbar bis zum Ende) festgelegt.
PERFORMANCE_GOAL_TYPE_CPE Das Leistungsziel wird in CPE (Cost-per-Engagement) festgelegt.
PERFORMANCE_GOAL_TYPE_CPV Das Leistungsziel wird als CPV (Cost-per-View) festgelegt.
PERFORMANCE_GOAL_TYPE_CLICK_CVR Das Leistungsziel wird als Prozentsatz der Klick-Conversion-Rate (Conversions pro Klick) festgelegt.
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR Das Leistungsziel wird als Prozentsatz der Conversion-Rate für Impressionen (Conversions pro Impression) festgelegt.
PERFORMANCE_GOAL_TYPE_VCPM Das Leistungsziel wird in vCPM (Cost-per-viewable-1000-Impressions) festgelegt.
PERFORMANCE_GOAL_TYPE_VTR Das Leistungsziel wird als Prozentsatz der YouTube-Aufrufrate (YouTube-Aufrufe pro Impression) festgelegt.
PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE Das Leistungsziel wird als Prozentsatz der Audioabschlussrate (vollständig angehörte Audioclips pro Impression) festgelegt.
PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE Das Leistungsziel wird als Prozentsatz der Videoabschlussrate (vollständige Videoaufrufe pro Impression) festgelegt.
PERFORMANCE_GOAL_TYPE_OTHER Das Leistungsziel ist auf „Sonstiges“ festgelegt.

CampaignFlight

Einstellungen, mit denen die geplanten Ausgaben und die Dauer einer Kampagne erfasst werden.

JSON-Darstellung 
{
  "plannedSpendAmountMicros": string,
  "plannedDates": {
    object (DateRange)
  }
}
Felder
plannedSpendAmountMicros

string (int64 format)

Der Betrag, der voraussichtlich für die Kampagne mit dem angegebenen plannedDates ausgegeben wird. Die Auslieferung wird dadurch nicht eingeschränkt, aber die Ausgaben werden in der DV360-Benutzeroberfläche erfasst.

Der Betrag wird in Micros angegeben. muss größer oder gleich 0 sein. Beispiel: 500000000 entspricht 500 Standardeinheiten der Währung.
plannedDates

object (DateRange)

Erforderlich. Der Zeitraum, in dem die Kampagne voraussichtlich laufen wird. Sie werden relativ zur Zeitzone des übergeordneten Werbetreibenden aufgelöst.

  • Die hier angegebenen Daten haben keinen Einfluss auf die Auslieferung. Sie werden verwendet, um Warnungen und Hinweise zu generieren. Wenn beispielsweise die Laufzeit eines untergeordneten Anzeigenauftrags außerhalb dieses Zeitraums liegt, wird auf der Benutzeroberfläche eine Warnung angezeigt.
  • startDate ist erforderlich und muss das aktuelle Datum oder ein Datum in der Zukunft sein.
  • endDate ist optional. Falls angegeben, muss es startDate oder höher sein.
  • Das angegebene Datum muss vor dem Jahr 2037 liegen.

CampaignBudget

Einstellungen, mit denen festgelegt wird, wie das Kampagnenbudget zugewiesen wird.

JSON-Darstellung 
{
  "budgetId": string,
  "displayName": string,
  "budgetUnit": enum (BudgetUnit),
  "budgetAmountMicros": string,
  "dateRange": {
    object (DateRange)
  },
  "externalBudgetSource": enum (ExternalBudgetSource),
  "externalBudgetId": string,
  "invoiceGroupingId": string,
  "prismaConfig": {
    object (PrismaConfig)
  }
}
Felder
budgetId

string (int64 format)

Die eindeutige ID des Kampagnenbudgets. Wird vom System zugewiesen. Legen Sie diesen Wert nicht für neue Budgets fest.

Muss beim Aktualisieren oder Hinzufügen von Budgets zu campaignBudgets enthalten sein. Andernfalls wird eine neue ID generiert und zugewiesen.
displayName

string

Erforderlich. Der Anzeigename des Budgets.

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

enum (BudgetUnit)

Erforderlich. Nicht veränderbar. Gibt an, ob das Budget in Währung oder Impressionen gemessen wird.
budgetAmountMicros

string (int64 format)

Erforderlich. Der Gesamtbetrag, der den verknüpften Anzeigenauftragssegmenten zugewiesen werden kann.

Der Betrag wird in Micros angegeben. Muss größer als 0 sein. Beispiel: 500000000 entspricht 500 Standardeinheiten der Währung.
dateRange

object (DateRange)

Erforderlich. Der Zeitraum für das Kampagnenbudget. Verknüpfte Budgetsegmente können einen anderen Zeitraum haben. Sie werden relativ zur Zeitzone des übergeordneten Werbetreibenden aufgelöst.

Sowohl startDate als auch endDate müssen vor dem Jahr 2037 liegen.
externalBudgetSource

enum (ExternalBudgetSource)

Erforderlich. Die externe Quelle des Budgets.
externalBudgetId

string

Nicht veränderbar. Die ID, mit der dieses Budget für die externe Quelle identifiziert wird.

Wenn dieses Feld festgelegt ist und die Rechnungsdetailebene des entsprechenden Abrechnungsprofils auf „Auftrag auf Budgetebene“ festgelegt ist, wird diese ID auf der Rechnung für alle Impressionen angegeben, die für dieses Budget ausgeliefert werden.

Muss in der Kampagne eindeutig sein.
invoiceGroupingId

string

Nicht veränderbar. Die ID, mit der Budgets gruppiert werden, die in derselben Rechnung enthalten sein sollen.

Wenn dieses Feld festgelegt ist und die Rechnungsebene des entsprechenden Abrechnungsprofils auf „ID der Rechnungsgruppe des Budgets“ festgelegt ist, werden alle externalBudgetId mit derselben invoiceGroupingId auf derselben Rechnung gruppiert.
prismaConfig

object (PrismaConfig)

Zusätzliche Metadaten für die Verwendung durch das Mediaocean Prisma-Tool.

Erforderlich für Mediaocean-Budgets.

Gilt nur für prismaEnabled-Werbetreibende.

ExternalBudgetSource

Externe Quelle für ein Kampagnenbudgetsegment.

Enums
EXTERNAL_BUDGET_SOURCE_UNSPECIFIED Der Wert der externen Budgetquelle ist in dieser Version nicht angegeben oder unbekannt.
EXTERNAL_BUDGET_SOURCE_NONE Das Budget hat keine externe Quelle.
EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN Die Budgetquelle ist Mediaocean.

PrismaConfig

Einstellungen speziell für das Mediaocean Prisma-Tool.

JSON-Darstellung 
{
  "prismaType": enum (PrismaType),
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "supplier": string
}
Felder
prismaType

enum (PrismaType)

Erforderlich. Der Prisma-Typ.
prismaCpeCode

object (PrismaCpeCode)

Erforderlich. Relevante Kunden-, Produkt- und Schätzungscodes aus dem Mediaocean Prisma-Tool.
supplier

string

Erforderlich. Die Entität, der dieses Budget zugewiesen wurde (DSP, Website usw.).

PrismaType

Mögliche Typen für ein Prisma-Budget.

Enums
PRISMA_TYPE_UNSPECIFIED Der Typ ist in dieser Version nicht angegeben oder unbekannt.
PRISMA_TYPE_DISPLAY Displaytyp.
PRISMA_TYPE_VIDEO Videotyp
PRISMA_TYPE_AUDIO Audiotyp.
PRISMA_TYPE_SOCIAL Sozialer Typ.
PRISMA_TYPE_FEE Gebührenart.

PrismaCpeCode

Das Google-Zahlungscenter unterstützt die Suche und Filterung nach den Komponentenfeldern dieses Codes.

JSON-Darstellung 
{
  "prismaClientCode": string,
  "prismaProductCode": string,
  "prismaEstimateCode": string
}
Felder
prismaClientCode

string

Der Prisma-Client-Code.
prismaProductCode

string

Der Prisma-Produktcode.
prismaEstimateCode

string

Der Prisma-Schätzungs-Code.

Methoden

create

 Erstellt eine neue Kampagne.

delete

 Löscht eine Kampagne endgültig.

get

 Ruft eine Kampagne ab.

list

 Listet Kampagnen eines Werbetreibenden auf.

patch

 Aktualisiert eine vorhandene Kampagne.