REST Resource: advertisers.campaigns

Zasób: Kampania

Pojedyncza kampania.

Zapis JSON 
{
  "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)
    }
  ]
}
Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu kampanii.
advertiserId

string (int64 format)

Tylko dane wyjściowe. Unikalny identyfikator reklamodawcy, do którego należy kampania.
campaignId

string (int64 format)

Tylko dane wyjściowe. Unikalny identyfikator kampanii. Przypisana przez system.
displayName

string

To pole jest wymagane. Wyświetlana nazwa kampanii.

Musi być zakodowany w formacie UTF-8 o maksymalnym rozmiarze 240 bajtów.
entityStatus

enum (EntityStatus)

To pole jest wymagane. Określa, czy zamówienia reklamowe w ramach tej kampanii mogą wydawać swoje budżety i ustalać stawki za zasoby reklamowe.

  • Akceptowane wartości to ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED i ENTITY_STATUS_PAUSED.
  • W przypadku metody campaigns.create wartość ENTITY_STATUS_ARCHIVED jest niedozwolona.
updateTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa ostatniej aktualizacji kampanii. Przypisana przez system.

Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
campaignGoal

object (CampaignGoal)

To pole jest wymagane. Cel kampanii.
campaignFlight

object (CampaignFlight)

To pole jest wymagane. Planowane wydatki i czas trwania kampanii.
frequencyCap

object (FrequencyCap)

To pole jest wymagane. Ustawienie limitu wyświetleń na użytkownika w kampanii.
campaignBudgets[]

object (CampaignBudget)

Lista budżetów dostępnych w tej kampanii.

Jeśli to pole nie jest skonfigurowane, kampania będzie używać nieograniczonego budżetu.

CampaignGoal

Ustawienia, które kontrolują cel kampanii.

Zapis JSON 
{
  "campaignGoalType": enum (CampaignGoalType),
  "performanceGoal": {
    object (PerformanceGoal)
  }
}
Pola
campaignGoalType

enum (CampaignGoalType)

To pole jest wymagane. Typ celu kampanii.
performanceGoal

object (PerformanceGoal)

To pole jest wymagane. Docelowa skuteczność kampanii.

Akceptowane wartości dla parametru performanceGoalType to:

  • 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

Możliwe typy celów kampanii.

Wartości w polu enum
CAMPAIGN_GOAL_TYPE_UNSPECIFIED Wartość celu nie jest określona lub nieznana w tej wersji.
CAMPAIGN_GOAL_TYPE_APP_INSTALL Zwiększanie liczby instalacji aplikacji lub zaangażowania.
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS Podnoszenie świadomości marki lub produktu.
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION Zwiększ sprzedaż offline lub sprzedaż w sklepie stacjonarnym.
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION Zwiększ liczbę działań online lub wizyt w internecie.

CampaignFlight

Ustawienia, które śledzą planowane wydatki i czas trwania kampanii.

Zapis JSON 
{
  "plannedSpendAmountMicros": string,
  "plannedDates": {
    object (DateRange)
  }
}
Pola
plannedSpendAmountMicros

string (int64 format)

Przewidywana kwota wydatków kampanii w wybranym przedziale czasu (plannedDates). Nie ograniczy to wyświetlania, ale będzie służyć do śledzenia wydatków w interfejsie DV360.

Kwota jest wyrażona w mikro. Wartość nie może być mniejsza niż 0. Na przykład 500000000 oznacza 500 jednostek standardowych waluty.
plannedDates

object (DateRange)

To pole jest wymagane. Przewidywane daty trwania kampanii. Rozwiązuje się je w zależności od strefy czasowej reklamodawcy nadrzędnego.

  • Podane tu daty nie będą miały wpływu na wyświetlanie reklam. Służą one do generowania alertów i ostrzeżeń. Jeśli np. data wyświetlania reklam w podrzędnym zamówieniu reklamowym wykracza poza zakres tych dat, w interfejsie pojawi się ostrzeżenie.
  • Pole startDate jest wymagane. Musi to być data bieżąca lub późniejsza.
  • Pole endDate jest opcjonalne. Jeśli zostanie podany, musi to być typ startDate lub nowszy.
  • Każda podana data musi być wcześniejsza niż 2037 r.

CampaignBudget

Ustawienia określające sposób przydzielania budżetu kampanii.

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

string (int64 format)

Unikalny identyfikator budżetu kampanii. Przypisana przez system. Nie ustawiaj dla nowych budżetów.

Musi być uwzględniona podczas aktualizowania lub dodawania budżetów do campaignBudgets. W przeciwnym razie zostanie wygenerowany i przypisany nowy identyfikator.
displayName

string

To pole jest wymagane. Wyświetlana nazwa budżetu.

Musi być zakodowany w formacie UTF-8 o maksymalnym rozmiarze 240 bajtów.
budgetUnit

enum (BudgetUnit)

To pole jest wymagane. Stałe. Określa, czy budżet jest mierzony w walucie czy w liczbie wyświetleń.
budgetAmountMicros

string (int64 format)

To pole jest wymagane. Łączna kwota, jaką mogą przeznaczyć na to połączone segmenty zamówień reklamowych.

Kwota jest wyrażona w mikro. Musi być większy niż 0. Na przykład 500000000 oznacza 500 jednostek standardowych waluty.
dateRange

object (DateRange)

To pole jest wymagane. Zakres dat budżetu kampanii. Połączone segmenty budżetu mogą mieć inny zakres dat. Rozwiązuje się je w zależności od strefy czasowej reklamodawcy nadrzędnego.

Zarówno pola startDate, jak i endDate muszą przypadać przed rokiem 2037.
externalBudgetSource

enum (ExternalBudgetSource)

To pole jest wymagane. Zewnętrzne źródło budżetu.
externalBudgetId

string

Stałe. Identyfikator określający ten budżet do źródła zewnętrznego.

Jeśli to pole jest skonfigurowane, a poziom szczegółów faktury w odpowiednim profilu płatności jest ustawiony na „Zamówienie na poziomie budżetu”, wszystkie wyświetlenia realizowane w ramach tego budżetu będą zawierać ten identyfikator na fakturze.

Musi być niepowtarzalna w ramach kampanii.
invoiceGroupingId

string

Stałe. Identyfikator służący do grupowania budżetów, które mają zostać uwzględnione na tej samej fakturze.

Jeśli to pole jest ustawione, a poziom faktury dla odpowiedniego profilu płatności jest ustawiony na „Identyfikator grupowania faktur pod kątem budżetu”, wszystkie externalBudgetId korzystające z tego samego elementu invoiceGroupingId zostaną zgrupowane na tej samej fakturze.
prismaConfig

object (PrismaConfig)

Dodatkowe metadane do użytku przez narzędzie Mediaocean Prisma.

Wymagane w przypadku budżetów Mediaocean.

Dotyczy tylko prismaEnabled reklamodawców.

ExternalBudgetSource

Zewnętrzne źródło segmentu budżetu kampanii.

Wartości w polu enum
EXTERNAL_BUDGET_SOURCE_UNSPECIFIED W tej wersji wartość zewnętrznego źródła budżetu nie jest określona lub jest nieznana.
EXTERNAL_BUDGET_SOURCE_NONE Budżet nie ma zewnętrznego źródła.
EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN Źródło budżetu to Mediaocean.

PrismaConfig

Ustawienia specyficzne dla narzędzia Mediaocean Prisma.

Zapis JSON 
{
  "prismaType": enum (PrismaType),
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "supplier": string
}
Pola
prismaType

enum (PrismaType)

To pole jest wymagane. Typ usługi Prisma.
prismaCpeCode

object (PrismaCpeCode)

To pole jest wymagane. Odpowiednie kody klienta, usług i szacunków z narzędzia Mediaocean Prisma.
supplier

string

To pole jest wymagane. Podmiot przydzielonych do tego budżetu (platforma DSP, witryna itp.).

PrismaType

Możliwe rodzaje budżetu w aplikacji Prisma.

Wartości w polu enum
PRISMA_TYPE_UNSPECIFIED W tej wersji nie określono typu lub jest on nieznany.
PRISMA_TYPE_DISPLAY Typ wyświetlania.
PRISMA_TYPE_VIDEO Typ filmu.
PRISMA_TYPE_AUDIO Typ audio.
PRISMA_TYPE_SOCIAL Typ społecznościowy.
PRISMA_TYPE_FEE Typ opłaty.

PrismaCpeCode

Centrum płatności Google obsługuje wyszukiwanie i filtrowanie pól składowych tego kodu.

Zapis JSON 
{
  "prismaClientCode": string,
  "prismaProductCode": string,
  "prismaEstimateCode": string
}
Pola
prismaClientCode

string

Kod klienta aplikacji Prisma.
prismaProductCode

string

Kod produktu Prisma.
prismaEstimateCode

string

Szacunkowy kod aplikacji Prisma.

Metody

create

 Tworzy nową kampanię.

delete

 Trwale usuwa kampanię.

get

 Pobiera kampanię.

list

 Wyświetla listę kampanii reklamodawcy.

listAssignedTargetingOptions

 Wyświetla listę opcji kierowania przypisanych w kampanii według różnych typów kierowania.

patch

 Aktualizuje istniejącą kampanię.