REST Resource: advertisers.campaigns

Ressource: Kampagne

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. 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. Steuert, ob die Anzeigenaufträge in dieser Kampagne ihr Budget ausgeben und auf Inventar bieten 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, zu dem die Kampagne zuletzt aktualisiert wurde 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".
campaignGoal

object (CampaignGoal)

Erforderlich. Das Zielvorhaben der Kampagne.
campaignFlight

object (CampaignFlight)

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

object (FrequencyCap)

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

object (CampaignBudget)

Die Liste der Budgets, die für diese Kampagne verfügbar sind.

Wenn dieses Feld nicht festgelegt ist, verwendet die Kampagne ein unbegrenztes Budget.

CampaignGoal

Einstellungen, mit denen das Zielvorhaben einer Kampagne gesteuert wird.

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

enum (CampaignGoalType)

Erforderlich. Der Typ des Zielvorhabens der Kampagne.
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 Arten von Kampagnenzielen.

Enums
CAMPAIGN_GOAL_TYPE_UNSPECIFIED Der Zielwert 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 Offline- bzw. Ladenverkäufe fördern
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION Mehr Onlineaktionen oder -besuche

PerformanceGoal

Einstellungen, mit denen das Leistungsziel einer Kampagne gesteuert wird.

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

  // Union field performance_goal_value can be only one of the following:
  "performanceGoalAmountMicros": string,
  "performanceGoalPercentageMicros": string,
  "performanceGoalString": string
  // End of list of possible types for union field performance_goal_value.
}
Felder
performanceGoalType

enum (PerformanceGoalType)

Erforderlich. Die Art des Leistungsziels.
Union-Feld performance_goal_value. Erforderlich. Der Wert des Leistungsziels, das einem bestimmten performance_goal_type entspricht. Für performance_goal_value ist nur einer der folgenden Werte zulässig:
performanceGoalAmountMicros

string (int64 format)

Der Zielbetrag in "micros", millionstel Einheiten der Währung des Werbetreibenden.

Anwendbar, wenn performanceGoalType einen der folgenden Werte hat:

  • PERFORMANCE_GOAL_TYPE_CPM
  • PERFORMANCE_GOAL_TYPE_CPC
  • PERFORMANCE_GOAL_TYPE_CPA
  • PERFORMANCE_GOAL_TYPE_CPIAVC
  • PERFORMANCE_GOAL_TYPE_VCPM

Beispiel: 1.500.000 steht für 1,5 Standardeinheiten der Währung.
performanceGoalPercentageMicros

string (int64 format)

Die dezimale Darstellung des Zielprozentsatzes in Mikroeinheiten.

Anwendbar, wenn performanceGoalType einen der folgenden Werte hat:

  • 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

Beispiel: 70.000 steht für 7% (Dezimal 0, 07).
performanceGoalString

string

Ein String für die Leistungskennzahl (Key Performance Indicator, KPI), der leer sein kann. Er muss UTF-8-codiert sein und darf höchstens 100 Zeichen lang sein.

Anwendbar, wenn performanceGoalType auf PERFORMANCE_GOAL_TYPE_OTHER gesetzt ist.

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 in CPC (Cost-per-Click) festgelegt.
PERFORMANCE_GOAL_TYPE_CPA Das Leistungsziel wird in CPA (Cost-per-Action) festgelegt.
PERFORMANCE_GOAL_TYPE_CTR Das Leistungsziel wird als Prozentsatz für die Klickrate (Click-through-Rate, CTR) festgelegt.
PERFORMANCE_GOAL_TYPE_VIEWABILITY Das Leistungsziel wird unter „Prozentsatz für die Sichtbarkeit“ festgelegt.
PERFORMANCE_GOAL_TYPE_CPIAVC Als Leistungsziel wird CPIAVC (Cost-per-Impression hörbar und sichtbar am Ende) festgelegt.
PERFORMANCE_GOAL_TYPE_CPE Das Leistungsziel wird in CPE (Cost-per-Engagement) 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 Impressions-Conversion-Rate (Conversions pro Impression) festgelegt.
PERFORMANCE_GOAL_TYPE_VCPM Das Leistungsziel wird in vCPM (Cost-per-1000-viewable-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ändige Audiowiedergaben 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 für den angegebenen plannedDates ausgegeben wird. Dadurch wird die Auslieferung nicht eingeschränkt, aber zum Erfassen der Ausgaben auf der DV360-Benutzeroberfläche verwendet.

Der Betrag wird in Mikroeinheiten angegeben. muss größer oder gleich 0 sein. Beispielsweise steht 500000000 für 500 Standardeinheiten der Währung.
plannedDates

object (DateRange)

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

  • Die hier angegebenen Datumsangaben haben keinen Einfluss auf die Auslieferung. Sie werden verwendet, um Warnungen und Warnungen 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 späteres Datum sein.
  • endDate ist optional. Wenn er angegeben wird, muss er startDate oder ein späteres Datum sein.
  • Jedes angegebene Datum muss vor dem Jahr 2037 liegen.

CampaignBudget

Einstellungen, mit denen gesteuert 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. Vom System zugewiesen. Nicht für neue Budgets festlegen.

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 einer Währung oder in Impressionen gemessen wird.
budgetAmountMicros

string (int64 format)

Erforderlich. Der Gesamtbetrag, den die verknüpften Anzeigenauftragssegmente für ein Budget festlegen können.

Der Betrag wird in Mikroeinheiten angegeben. Muss größer als 0 sein. Beispielsweise steht 500000000 für 500 Standardeinheiten der Währung.
dateRange

object (DateRange)

Erforderlich. Der Zeitraum für das Kampagnenbudget. Verknüpfte Budgetsegmente haben möglicherweise einen anderen Zeitraum. Sie werden in Bezug auf die 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 gegenüber der externen Quelle identifiziert wird.

Wenn dieses Feld ausgefüllt und für die Rechnungsdetails des entsprechenden Abrechnungsprofils „Bestellung auf Budgetebene“ festgelegt ist, wird diese ID bei allen Impressionen, die für dieses Budget erzielt werden, in der Rechnung berücksichtigt.

Darf unter der Kampagne nur einmal vorkommen.
invoiceGroupingId

string

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

Wenn dieses Feld ausgefüllt und die Rechnungsebene des entsprechenden Abrechnungsprofils auf „ID der Rechnungsgruppe für das Budget“ festgelegt ist, werden alle externalBudgetId mit derselben invoiceGroupingId in derselben Rechnung gruppiert.
prismaConfig

object (PrismaConfig)

Zusätzliche Metadaten zur Verwendung mit dem 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 für das Mediaocean Prisma-Tool.

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

enum (PrismaType)

Erforderlich. Prisma-Typ.
prismaCpeCode

object (PrismaCpeCode)

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

string

Erforderlich. Die Entität, die dieses Budget zugewiesen hat (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 Anzeigetyp.
PRISMA_TYPE_VIDEO Videotyp.
PRISMA_TYPE_AUDIO Audiotyp.
PRISMA_TYPE_SOCIAL Typ des sozialen Netzwerks.
PRISMA_TYPE_FEE Gebührentyp.

PrismaCpeCode

Das Google-Zahlungscenter unterstützt das Suchen und Filtern der Komponentenfelder dieses Codes.

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

string

Prisma-Clientcode
prismaProductCode

string

Prisma-Produktcode
prismaEstimateCode

string

Prisma-Schätzungscode.

Methoden

create

 Erstellt eine neue Kampagne.

delete

 Löscht eine Kampagne endgültig.

get

 Ruft eine Kampagne ab.

list

 Listet die Kampagnen eines Werbetreibenden auf.

listAssignedTargetingOptions

 Listet die zugewiesenen Ausrichtungsoptionen einer Kampagne für verschiedene Ausrichtungstypen auf.

patch

 Aktualisiert eine bestehende Kampagne.