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. Damit wird festgelegt, ob die Anzeigenaufträge für diese Kampagne ihr Budget ausgeben und auf Inventar bieten können.

  • Zulässige Werte sind ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED und ENTITY_STATUS_PAUSED.
  • Bei der Methode campaigns.create ist ENTITY_STATUS_ARCHIVED nicht zulässig.
updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel für den Zeitpunkt, zu dem die Kampagne zuletzt aktualisiert wurde. Vom System zugewiesen.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. 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)

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 Ziel einer Kampagne gesteuert 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:

  • 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 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),

  // 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. Der Typ des Leistungsziels.
Union-Feld performance_goal_value. Erforderlich. Der Wert des Leistungsziels, der 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“, also Millionenstel der Währung des Werbetreibenden.

Gilt, 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

1500000 steht beispielsweise für 1,5 Standardeinheiten der Währung.
performanceGoalPercentageMicros

string (int64 format)

Die Dezimaldarstellung des Zielprozentsatzes in Micros.

Gilt, 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

70.000 steht beispielsweise für 7% (dezimal 0, 07).
performanceGoalString

string

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

Gültig, 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 in dieser Version nicht angegeben oder unbekannt.
PERFORMANCE_GOAL_TYPE_CPM Das Leistungsziel wird in CPM (Cost-per-Mille) 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 der Klickrate (Click-through-Rate, CTR) 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 in 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 nach Impression (Conversions pro Impression) festgelegt.
PERFORMANCE_GOAL_TYPE_VCPM Das Leistungsziel wird in vCPM (Cost-per-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ä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. Das hat keinen Einfluss auf die Anzeigenbereitstellung, wird aber zum Erfassen der Ausgaben in der DV360-Benutzeroberfläche verwendet.

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

object (DateRange)

Erforderlich. Die voraussichtliche Laufzeit der Kampagne. Sie werden relativ zur Zeitzone des übergeordneten Werbetreibenden aufgelöst.

  • Er hat keinen Einfluss auf die Anzeigenbereitstellung. Sie werden verwendet, um Benachrichtigungen und Warnungen zu generieren. Wenn das Auslieferungsdatum eines untergeordneten Anzeigenauftrags beispielsweise außerhalb dieses Zeitraums liegt, wird auf der Benutzeroberfläche eine Warnung angezeigt.
  • startDate ist erforderlich und muss dem aktuellen Datum entsprechen oder später liegen.
  • endDate ist optional. Falls angegeben, muss es startDate oder höher sein.
  • Das angegebene Datum darf nicht nach dem Jahr 2037 liegen.

CampaignBudget

Einstellungen, mit denen die Zuweisung des Kampagnenbudgets gesteuert 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 angegeben werden, wenn Budgets für campaignBudgets aktualisiert oder hinzugefügt werden. 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 in Impressionen gemessen wird.
budgetAmountMicros

string (int64 format)

Erforderlich. Der Gesamtbetrag, der für die verknüpften Anzeigenauftragssegmente budgetiert werden kann.

Der Betrag wird in Micros angegeben. Muss größer als 0 sein. 500000000 steht beispielsweise für 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 „Auftragsbudgetebene“ gesetzt ist, wird diese ID auf der Rechnung für alle Impressionen angegeben, die über dieses Budget erzielt wurden.

Darf innerhalb der Kampagne nur einmal vorkommen.
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“ gesetzt ist, werden alle externalBudgetId mit derselben invoiceGroupingId in derselben Rechnung gruppiert.
prismaConfig

object (PrismaConfig)

Zusätzliche Metadaten für 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 für die externe Budgetquelle ist in dieser Version nicht angegeben oder unbekannt.
EXTERNAL_BUDGET_SOURCE_NONE Das Budget hat keine externe Quelle.
EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN Budgetquelle ist Mediaocean.

PrismaConfig

Einstellungen, die speziell für das Mediaocean Prisma-Tool gelten.

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ätzcodes 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 Art der sozialen Interaktion.
PRISMA_TYPE_FEE Gebührenart.

PrismaCpeCode

Die Google Payments Center-Suche 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

 Eine Kampagne wird endgültig gelöscht.

get

 Ruft eine Kampagne ab.

list

 Liste der Kampagnen eines Werbetreibenden.

listAssignedTargetingOptions

 Hier werden die zugewiesenen Targeting-Optionen einer Kampagne nach Targeting-Typ aufgelistet.

patch

 Aktualisiert eine vorhandene Kampagne.