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 formacie UTF-8 i mieć maksymalny rozmiar 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 przypadku metody campaigns.create wartość ENTITY_STATUS_ARCHIVED jest niedozwolona.
updateTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa określająca, kiedy kampania została ostatnio zaktualizowana. Przypisany przez system.

Sygnatura czasowa w formacie UTC „Zulu” zdefiniowanym w dokumencie RFC 3339, z dokładnością do nanosekund i maksymalnie 9 miejsc 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 dla 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. Cel skuteczności 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ększanie ś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ększ liczbę działań online lub wizyt w witrynie.

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)

Wymagane. Typ docelowej skuteczności.
Pole sumy performance_goal_value. Wymagane. Wartość docelowej skuteczności odpowiadającej danej wartości performance_goal_type. performance_goal_value może być tylko jednym z tych elementów:
performanceGoalAmountMicros

string (int64 format)

Kwota docelowa w milionowych częściach waluty reklamodawcy.

Dotyczy, gdy performanceGoalType jest jedną z tych wartości:

  • PERFORMANCE_GOAL_TYPE_CPM
  • PERFORMANCE_GOAL_TYPE_CPC
  • PERFORMANCE_GOAL_TYPE_CPA
  • PERFORMANCE_GOAL_TYPE_CPIAVC
  • PERFORMANCE_GOAL_TYPE_VCPM

Na przykład 1500000 reprezentuje 1,5 standardowej jednostki waluty.
performanceGoalPercentageMicros

string (int64 format)

Ułamek dziesiętny odsetka celu w mikro.

Dotyczy, gdy performanceGoalType jest jedną z tych wartości:

  • 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 w formacie dziesiętnym).
performanceGoalString

string

Ciąg tekstowy kluczowego wskaźnika wydajności (KPI), który może być pusty. Musi być zakodowany w formacie UTF-8 i mieć maksymalnie 100 znaków.

Dotyczy to sytuacji, gdy wartość parametru performanceGoalType to 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 skuteczności nie jest określony lub jest nieznany w tej wersji.
PERFORMANCE_GOAL_TYPE_CPM Cel skuteczności jest ustawiany w CPM (kosztie tysiąca wyświetleń).
PERFORMANCE_GOAL_TYPE_CPC Cel skuteczności jest ustawiany w CPC (koszt kliknięcia).
PERFORMANCE_GOAL_TYPE_CPA Cel skuteczności jest ustawiany w CPA (koszt działania).
PERFORMANCE_GOAL_TYPE_CTR Docelowa skuteczność jest określana w sposób procentowy (CTR, współczynnik klikalności).
PERFORMANCE_GOAL_TYPE_VIEWABILITY Docelową skuteczność określa się jako wartość procentową widoczności.
PERFORMANCE_GOAL_TYPE_CPIAVC Cel skuteczności jest ustawiony jako CPIAVC (koszt pełnego wyświetlenia reklamy wideo z dźwiękiem).
PERFORMANCE_GOAL_TYPE_CPE Cel skuteczności jest ustawiany w CPE (koszt zaangażowania).
PERFORMANCE_GOAL_TYPE_CPV Cel skuteczności jest ustawiany w CPV (koszt obejrzenia).
PERFORMANCE_GOAL_TYPE_CLICK_CVR Cel skuteczności jest ustawiany w procentach współczynnika konwersji na kliknięcie (konwersje na kliknięcie).
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR Cel skuteczności jest ustawiany w procentach współczynnika konwersji na wyświetlenie (konwersje na wyświetlenie).
PERFORMANCE_GOAL_TYPE_VCPM Cel skuteczności jest ustawiany w VCPM (koszt tysiąca widocznych wyświetleń).
PERFORMANCE_GOAL_TYPE_VTR Cel dotyczący skuteczności jest ustawiany w procentach w sekcji współczynnik obejrzeń w YouTube (wyświetlenia w YouTube na wyświetlenie).
PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE Cel skuteczności jest ustawiany jako odsetek współczynnika pełnych odtworzeń (pełne odsłuchania na wyświetlenie).
PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE Docelową skuteczność określa się jako wartość procentową współczynnika pełnych obejrzeń (pełnego obejrzenia filmu na wyświetlenie).
PERFORMANCE_GOAL_TYPE_OTHER Cel skuteczności ma wartość Inne.

CampaignFlight

Ustawienia, które śledzą planowany wydatek i długość trwania kampanii.

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

string (int64 format)

Kwota, którą prawdopodobnie wyda kampania w danym plannedDates. Nie ograniczy to wyświetlania, ale posł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 reprezentuje 500 standardowych jednostek waluty.
plannedDates

object (DateRange)

Wymagane. Przewidywane daty trwania kampanii. Są one rozwiązywane w zależności od strefy czasowej reklamodawcy nadrzędnego.

  • Podane tu daty nie wpłyną na wyświetlanie. Służy do generowania alertów i ostrzeżeń. Jeśli na przykład data lotu dowolnego zamówienia reklamowego podrzędnego wykracza poza ten zakres, w interfejsie pojawi się ostrzeżenie.
  • startDate jest wymagany i musi być datą bieżącą lub późniejszą.
  • endDate jest opcjonalny. Jeśli jest określony, musi być równy co najmniej startDate.
  • 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. Przypisany przez system. Nie ustawiaj w przypadku nowych budżetów.

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

string

Wymagane. Wyświetlana nazwa budżetu.

Musi być zakodowany w formacie UTF-8 i mieć maksymalny rozmiar 240 bajtów.
budgetUnit

enum (BudgetUnit)

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

string (int64 format)

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

Kwota 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 budżetu kampanii. Połączone segmenty budżetu mogą mieć inny zakres dat. Są one rozwiązywane w zależności od strefy czasowej reklamodawcy nadrzędnego.

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

enum (ExternalBudgetSource)

Wymagane. Źródło zewnętrzne budżetu.
externalBudgetId

string

Niezmienna. Identyfikator identyfikujący ten budżet w źródle zewnętrznym.

Jeśli to pole jest wypełnione, a poziom szczegółów faktury w odpowiednim profilu płatności to „Numer zamówienia na poziomie budżetu”, wszystkie wyświetlenia zrealizowane w ramach tego budżetu będą zawierać ten identyfikator na fakturze.

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

string

Niezmienna. Identyfikator używany do grupowania budżetów, które mają być uwzględnione na tej samej fakturze.

Jeśli to pole jest ustawione, a poziom faktury odpowiadającego profilu płatności to „Identyfikator grupowania faktur w budżecie”, wszystkie externalBudgetId o tym samym invoiceGroupingId zostaną pogrupowane na tej samej fakturze.
prismaConfig

object (PrismaConfig)

dodatkowe metadane do użycia przez narzędzie Prisma Mediaocean.

Wymagany w przypadku budżetów Mediaocean.

Dotyczy to tylko reklamodawców prismaEnabled.

ExternalBudgetSource

Źródło zewnętrzne 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 jest nieznana w tej wersji.
EXTERNAL_BUDGET_SOURCE_NONE Budżet nie ma źródła zewnętrznego.
EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN Źródło budżetu to Mediaocean.

PrismaConfig

Ustawienia dotyczące narzędzia Prisma w Mediaocean.

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

enum (PrismaType)

Wymagane. Typ aplikacji Prisma.
prismaCpeCode

object (PrismaCpeCode)

Wymagane. odpowiednie kody klienta, produktu i szacowania z narzędzia Prisma firmy Mediaocean;
supplier

string

Wymagane. Identyfikator podmiotu, któremu przypisano ten budżet (platforma DSP, witryna itp.).

PrismaType

Możliwe typy budżetu Prisma.

Wartości w polu enum
PRISMA_TYPE_UNSPECIFIED Typ nie jest określony lub jest nieznany w tej wersji.
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 Google Payments obsługuje wyszukiwanie i filtrowanie według pól komponentów 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 przypisane opcje kierowania kampanii według typów kierowania.

patch

 Aktualizuje istniejącą kampanię.