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 gesteuert, 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 der letzten Aktualisierung der Kampagne. 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".
campaignGoal

object (CampaignGoal)

Erforderlich. Das Zielvorhaben der Kampagne.
campaignFlight

object (CampaignFlight)

Erforderlich. Geplante Ausgaben und 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.

Ist dieses Feld nicht festgelegt, 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 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 Zielvorhaben der Kampagne

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 Die Bekanntheit einer Marke oder eines Produkts steigern
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION Offline- oder Ladenumsatz steigern
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION Steigern Sie die Anzahl der Onlineaktionen oder -besuche.

CampaignFlight

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

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

string (int64 format)

Der Betrag, der voraussichtlich für die Kampagne für die angegebene 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 Mikros angegeben. muss größer oder gleich 0 sein. Beispiel: 500000000 steht für 500 Standardeinheiten der Währung.
plannedDates

object (DateRange)

Erforderlich. Der Zeitraum, in dem die Kampagne voraussichtlich läuft. Sie werden in Abhängigkeit von der Zeitzone des übergeordneten Werbetreibenden aufgelöst.

  • Die hier angegebenen Termine 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 es angegeben wird, muss es das startDate oder ein späteres Datum sein.
  • Jedes 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. Vom System zugewiesen. Legen Sie keine neuen 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 der Währung oder in Impressionen gemessen wird.
budgetAmountMicros

string (int64 format)

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

Der Betrag wird in Mikros angegeben. Muss größer als 0 sein. Beispiel: 500000000 steht 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 Abhängigkeit von der 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 und die Rechnungsdetailebene des entsprechenden Abrechnungsprofils auf „Auftrag auf Budgetebene“ gesetzt ist, wird diese ID für alle Impressionen, die für dieses Budget erzielt wurden, auf der Rechnung verwendet.

Darf innerhalb der Kampagne nur einmal vorkommen.
invoiceGroupingId

string

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

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

object (PrismaConfig)

Zusätzliche Metadaten zur Verwendung durch das Tool Mediaocean Prisma.

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 Budgetquelle ist Mediaocean.

PrismaConfig

Spezifische Einstellungen für das Tool „Mediaocean Prisma“.

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, 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 Displaytyp.
PRISMA_TYPE_VIDEO Videotyp.
PRISMA_TYPE_AUDIO Audiotyp.
PRISMA_TYPE_SOCIAL Typ der sozialen Interaktion
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

Der Prisma-Clientcode.
prismaProductCode

string

Der Prisma-Produktcode
prismaEstimateCode

string

Der 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 Targeting-Optionen einer Kampagne für alle Targeting-Typen auf.

patch

 Aktualisiert eine bestehende Kampagne.