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 RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy 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 ustawione, kampania korzysta z nieograniczonego budżetu.

CampaignGoal

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

  • 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ększ liczbę instalacji aplikacji lub zaangażowanie.
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS Podnoszenie świadomości marki lub produktu.
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION Zwiększ sprzedaż offline lub sprzedaż w sklepie.
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION Zachęcaj do działań online lub wizyt.

PerformanceGoal

Ustawienia, które kontrolują cel skuteczności kampanii.

Zapis JSON 
{
  "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.
}
Pola
performanceGoalType

enum (PerformanceGoalType)

To pole jest wymagane. Typ celu dotyczącego skuteczności.
Pole sumy performance_goal_value. To pole jest wymagane. Wartość celu skuteczności odpowiadająca danej wartości performance_goal_type. performance_goal_value może mieć tylko jedną z tych wartości:
performanceGoalAmountMicros

string (int64 format)

Kwota celu w milionach waluty reklamodawcy.

Ma zastosowanie, gdy performanceGoalType należy do:

  • PERFORMANCE_GOAL_TYPE_CPM
  • PERFORMANCE_GOAL_TYPE_CPC
  • PERFORMANCE_GOAL_TYPE_CPA
  • PERFORMANCE_GOAL_TYPE_CPIAVC
  • PERFORMANCE_GOAL_TYPE_VCPM

Na przykład 1500 000 oznacza 1,5 standardowej jednostki waluty.
performanceGoalPercentageMicros

string (int64 format)

Wartość dziesiętna celu w mikro.

Ma zastosowanie, gdy performanceGoalType należy do:

  • 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

Na przykład 70 000 oznacza 7% (0, 07 – dziesiętny).
performanceGoalString

string

Ciąg kluczowych wskaźników wydajności (KPI), który może być pusty. Musi być zakodowany w formacie UTF-8 i nie może mieć więcej niż 100 znaków.

Ma zastosowanie, gdy zasada performanceGoalType ma wartość PERFORMANCE_GOAL_TYPE_OTHER.

PerformanceGoalType

Możliwe typy celów związanych ze skutecznością.

Wartości w polu enum
PERFORMANCE_GOAL_TYPE_UNSPECIFIED Typ celu dotyczącego skuteczności nie jest określony lub nieznany w tej wersji.
PERFORMANCE_GOAL_TYPE_CPM Docelową skuteczność określa się jako CPM (koszt tysiąca wyświetleń).
PERFORMANCE_GOAL_TYPE_CPC Docelową skuteczność określa się w postaci CPC (kosztu kliknięcia).
PERFORMANCE_GOAL_TYPE_CPA Docelową skuteczność określa się jako CPA (koszt działania).
PERFORMANCE_GOAL_TYPE_CTR Docelową skuteczność określa się jako procent CTR (współczynnika klikalności).
PERFORMANCE_GOAL_TYPE_VIEWABILITY Docelową skuteczność można ustawić jako wartość procentową widoczności.
PERFORMANCE_GOAL_TYPE_CPIAVC Jako cel skuteczności ustawiono CPIAVC (koszt wyświetlenia z włączonym dźwiękiem i widocznym w momencie zakończenia).
PERFORMANCE_GOAL_TYPE_CPE Docelową skuteczność określa się jako CPE (koszt zaangażowania).
PERFORMANCE_GOAL_TYPE_CLICK_CVR Cel skuteczności jest ustawiany pod postacią procentowej wartości współczynnika konwersji po kliknięciu (konwersji na kliknięcie).
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR Cel skuteczności jest określany jako procent współczynnika konwersji po wyświetleniu (liczba konwersji na wyświetlenie).
PERFORMANCE_GOAL_TYPE_VCPM Docelową skuteczność określa się w wartości VCPM (kosztu tysiąca widocznych wyświetleń).
PERFORMANCE_GOAL_TYPE_VTR Docelową skuteczność określa się za pomocą procentowej wartości współczynnika obejrzeń w YouTube (obejrzeń w YouTube na wyświetlenie).
PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE Docelową skuteczność określa się jako procent współczynnika pełnych obejrzeń (odsłuchanie całej ścieżki audio na wyświetlenie).
PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE Docelową skuteczność określa się jako procent współczynnika pełnych obejrzeń (pełne obejrzenia filmu na wyświetlenie).
PERFORMANCE_GOAL_TYPE_OTHER Docelowa skuteczność to Inne.

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 okresie (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. Nie może być mniejsza niż 0. Na przykład 500000000 oznacza 500 standardowych jednostek waluty.
plannedDates

object (DateRange)

To pole jest wymagane. Przewidywane daty trwania kampanii. Są one ustalane względem strefy czasowej reklamodawcy nadrzędnego.

  • Podane tu daty nie wpłyną na wyświetlanie. Służą 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.
  • Wymagana jest data startDate. Musi to być bieżąca lub późniejsza data.
  • Pole endDate jest opcjonalne. Jeśli została określona, należy podać wartość startDate lub późniejszą.
  • Każda podana data musi być wcześniejsza niż rok 2037.

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. Niezmienne. 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 standardowych jednostek waluty.
dateRange

object (DateRange)

To pole jest wymagane. Zakres dat budżetu kampanii. Połączone segmenty budżetu mogą mieć inny zakres dat. Są one ustalane względem strefy czasowej reklamodawcy nadrzędnego.

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

enum (ExternalBudgetSource)

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

string

Niezmienne. Identyfikator określający ten budżet w źródle zewnętrznym.

Jeśli to pole jest ustawione, a poziom szczegółów faktury w odpowiednim profilu płatności ma ustawienie „Zamówienie na poziomie budżetu”, na fakturze będą uwzględnione wszystkie wyświetlenia zrealizowane w ramach tego budżetu.

Musi być niepowtarzalna w ramach kampanii.
invoiceGroupingId

string

Niezmienne. 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 w odpowiednim profilu płatności ma ustawienie „Identyfikator grupowania faktur pod kątem budżetu”, wszystkie externalBudgetId mające taką samą wartość invoiceGroupingId zostaną zgrupowane na tej samej fakturze.
prismaConfig

object (PrismaConfig)

Dodatkowe metadane do wykorzystania 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łem budżetu jest 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 aplikacji Prisma.
prismaCpeCode

object (PrismaCpeCode)

To pole jest wymagane. Odpowiednie kody klientów, produktów i szacunków z narzędzia Mediaocean Prisma.
supplier

string

To pole jest wymagane. Podmiot przydzielonych tym budżetem (DSP, witryna itp.).

PrismaType

Możliwe typy 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świetlacza.
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

Orientacyjny 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 kampanii według różnych typów kierowania.

patch

 Aktualizuje istniejącą kampanię.