REST Resource: advertisers.campaigns

Zasób: kampania

Jedna 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

Wymagane. Wyświetlana nazwa kampanii.

Musi być zakodowany w standardzie UTF-8 i maksymalnym rozmiarze 240 bajtów.
entityStatus

enum (EntityStatus)

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

  • Akceptowane wartości to ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED i ENTITY_STATUS_PAUSED.
  • W metodzie 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 RFC3339 UTC „Zulu” 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)

Wymagane. Cel kampanii.
campaignFlight

object (CampaignFlight)

Wymagane. Planowane wydatki i czas trwania kampanii.
frequencyCap

object (FrequencyCap)

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 używa nieograniczonego budżetu.

CampaignGoal

Ustawienia, które pozwalają określić cel kampanii.

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

enum (CampaignGoalType)

Wymagane. Typ celu kampanii.
performanceGoal

object (PerformanceGoal)

Wymagane. Docelowa skuteczność kampanii.

Akceptowane wartości w polu 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

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 Zwiększenie świadomości marki lub produktu.
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION Zwiększenie sprzedaży offline lub sprzedaży w sklepie stacjonarnym.
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION Zwiększenie liczby działań online lub wizyt.

CampaignFlight

Ustawienia do śledzenia planowanych wydatków i czasu trwania kampanii.

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

string (int64 format)

Kwota, jaką kampania ma wydać w ramach określonego plannedDates. Nie ograniczy to wyświetlania, ale będzie służyć do śledzenia wydatków w interfejsie DV360.

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

object (DateRange)

Wymagane. Przewidywane daty trwania kampanii. Są one ustalane według strefy czasowej reklamodawcy nadrzędnego.

  • Podane tu daty nie wpłyną na wyświetlanie reklam. Służą do generowania alertów i ostrzeżeń. Jeśli na przykład data wyświetlania jakiegokolwiek podrzędnego zamówienia reklamowego wykracza poza zakres tych dat, w interfejsie pojawi się ostrzeżenie.
  • Pole startDate jest wymagane i musi być bieżącą lub późniejszą datą.
  • Pole endDate jest opcjonalne. Jeśli została określona, musi to być startDate lub nowsza.
  • Każda podana data musi przypadać przed rokiem 2037.

CampaignBudget

Ustawienia, które określają 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.

Trzeba go uwzględnić przy aktualizowaniu lub dodawaniu budżetów do kampanii campaignBudgets. W przeciwnym razie zostanie wygenerowany i przypisany nowy identyfikator.
displayName

string

Wymagane. Wyświetlana nazwa budżetu.

Musi być zakodowany w standardzie UTF-8 i maksymalnym rozmiarze 240 bajtów.
budgetUnit

enum (BudgetUnit)

Wymagane. Stała. Określa, czy budżet jest mierzony w walucie czy w wyświetleniach.
budgetAmountMicros

string (int64 format)

Wymagane. Łączna kwota, jaką mogą budżetować powiązane segmenty zamówienia reklamowego.

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

object (DateRange)

Wymagane. Zakres dat dla budżetu kampanii. Połączone segmenty budżetu mogą mieć inny zakres dat. Są one ustalane według strefy czasowej reklamodawcy nadrzędnego.

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

enum (ExternalBudgetSource)

Wymagane. Zewnętrzne źródło budżetu.
externalBudgetId

string

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

Jeśli to pole jest określone, 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ły ten identyfikator na fakturze.

Nie może się powtarzać w ramach kampanii.
invoiceGroupingId

string

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

Jeśli to pole jest skonfigurowane, a poziom faktury w odpowiednim profilu płatności jest ustawiony na „Identyfikator grupowania faktur na poziomie budżetu”, wszystkie identyfikatory externalBudgetId korzystające z tego samego elementu invoiceGroupingId zostaną zgrupowane na tej samej fakturze.
prismaConfig

object (PrismaConfig)

Dodatkowe metadane do wykorzystania przez narzędzie Mediaocean Prisma.

Wymagany w przypadku budżetów Mediaocean.

Dotyczy tylko reklamodawców prismaEnabled.

ExternalBudgetSource

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

Wartości w polu enum
EXTERNAL_BUDGET_SOURCE_UNSPECIFIED Wartość zewnętrznego źródła budżetu nie jest określona lub nieznana w tej wersji.
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 właściwe dla narzędzia Mediaocean Prisma.

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

enum (PrismaType)

Wymagane. Typ Prisma.
prismaCpeCode

object (PrismaCpeCode)

Wymagane. Odpowiednie kody dotyczące klientów, usług i szacunków pochodzą z narzędzia Mediaocean Prisma.
supplier

string

Wymagane. Jednostka przeznaczyła ten budżet (DSP, witryna itp.).

PrismaType

Możliwe typy budżetu Prisma.

Wartości w polu enum
PRISMA_TYPE_UNSPECIFIED W tej wersji typ nie jest określony lub 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

Szacowany kod aplikacji Prisma.

Metody

create

 Tworzy nową kampanię.

delete

 powoduje trwałe usunięcie kampanii,

get

 Pobiera kampanię.

list

 Wyświetla listę kampanii reklamodawcy.

listAssignedTargetingOptions

 Wyświetla listę przypisanych opcji kierowania kampanii z różnymi typami kierowania.

patch

 Aktualizuje istniejącą kampanię.