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. Przypisany 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 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 parametr ENTITY_STATUS_ARCHIVED jest niedozwolony.
updateTime

string (Timestamp format)

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

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
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 ustawione, kampania korzysta z nieograniczonego budżetu.

CampaignGoal

Ustawienia, które kontrolują 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 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 jest nieznana w tej wersji.
CAMPAIGN_GOAL_TYPE_APP_INSTALL Zwiększ liczbę instalacji aplikacji lub zaangażowanie.
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS Zwiększanie świadomości marki lub produktu.
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION Zwiększ sprzedaż offline lub sprzedaż w sklepie tradycyjnym.
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),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "performanceGoalAmountMicros": string,
  "performanceGoalPercentageMicros": string,
  "performanceGoalString": string
  // End of mutually exclusive fields.
}
Pola
performanceGoalType

enum (PerformanceGoalType)

Wymagane. Typ celu skuteczności.
Wymagane. Wartość celu skuteczności odpowiadająca danemu elementowi performance_goal_type. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
performanceGoalAmountMicros

string (int64 format)

Kwota docelowa w mikrowalucie reklamodawcy.

Ma zastosowanie, gdy performanceGoalType to jedna 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 oznacza 1,5 standardowej jednostki waluty.
performanceGoalPercentageMicros

string (int64 format)

Dziesiętna reprezentacja wartości procentowej celu w milionowych częściach jednostki.

Ma zastosowanie, gdy performanceGoalType to jedna 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 70000 oznacza 7% (0, 07).
performanceGoalString

string

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

Ma zastosowanie, gdy właściwość performanceGoalType jest ustawiona na PERFORMANCE_GOAL_TYPE_OTHER.
Koniec pól wykluczających się wzajemnie.

PerformanceGoalType

Możliwe typy celów skuteczności.

Wartości w polu enum
PERFORMANCE_GOAL_TYPE_UNSPECIFIED Typ celu skuteczności jest nieokreślony lub nieznany w tej wersji.
PERFORMANCE_GOAL_TYPE_CPM Cel skuteczności jest ustawiony w CPM (koszt tysiąca wyświetleń).
PERFORMANCE_GOAL_TYPE_CPC Cel skuteczności jest ustawiony w CPC (koszt kliknięcia).
PERFORMANCE_GOAL_TYPE_CPA Cel skuteczności jest ustawiony w CPA (koszt działania).
PERFORMANCE_GOAL_TYPE_CTR Cel skuteczności jest ustawiany jako wartość procentowa CTR (współczynnika klikalności).
PERFORMANCE_GOAL_TYPE_VIEWABILITY Cel skuteczności jest ustawiony jako procent 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 ustawiony w CPE (koszt zaangażowania).
PERFORMANCE_GOAL_TYPE_CPV Cel skuteczności jest ustawiony na CPV (koszt obejrzenia).
PERFORMANCE_GOAL_TYPE_CLICK_CVR Cel skuteczności jest ustawiany jako wartość procentowa współczynnika konwersji po kliknięciu (konwersje na kliknięcie).
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR Cel skuteczności jest ustawiany jako współczynnik konwersji po wyświetleniu (liczba konwersji na wyświetlenie) wyrażony w procentach.
PERFORMANCE_GOAL_TYPE_VCPM Cel skuteczności jest ustawiony w VCPM (koszt tysiąca widocznych wyświetleń).
PERFORMANCE_GOAL_TYPE_VTR Cel skuteczności jest ustawiany jako wartość procentowa współczynnika obejrzeń na YouTube (liczba wyświetleń na YouTube na wyświetlenie reklamy).
PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE Cel skuteczności jest ustawiany jako odsetek współczynnika pełnych odtworzeń (odsłuchania reklamy audio w całości na wyświetlenie).
PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE Cel skuteczności jest ustawiany jako odsetek współczynnika pełnych obejrzeń filmów (pełne wyświetlenia filmów na wyświetlenie).
PERFORMANCE_GOAL_TYPE_OTHER Cel skuteczności jest ustawiony na „Inny”.

CampaignFlight

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

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

string (int64 format)

Kwota, jaką kampania powinna wydać w danym okresie (plannedDates). Nie ograniczy to wyświetlania, ale będzie służyć do śledzenia wydatków w interfejsie DV360.

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

object (DateRange)

Wymagane. Daty, w których kampania ma być aktywna. Są one rozwiązywane względem strefy czasowej reklamodawcy nadrzędnego.

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

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 dla nowych budżetów.

Należy go uwzględnić podczas aktualizowania lub dodawania budżetów reklamowych 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. Wartość niezmienna. Określa, czy budżet jest mierzony w walucie czy w wyświetleniach.
budgetAmountMicros

string (int64 format)

Wymagane. Łączna kwota, którą można przeznaczyć na połączone segmenty zamówienia reklamowego.

Kwota jest podana w mikrowalucie. 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 względem strefy czasowej reklamodawcy nadrzędnego.

Wartości startDate i endDate muszą być wcześniejsze niż rok 2037.
externalBudgetSource

enum (ExternalBudgetSource)

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

string

Wartość niezmienna. Identyfikator, który identyfikuje 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 jest ustawiony na „Numer zamówienia na poziomie budżetu”, wszystkie wyświetlenia zrealizowane w ramach tego budżetu będą zawierać ten identyfikator na fakturze.

Musi być unikalna w obrębie kampanii.
invoiceGroupingId

string

Wartość 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 w odpowiednim profilu płatności jest ustawiony na „Identyfikator grupowania faktur w budżecie”, wszystkie externalBudgetId, które mają ten sam invoiceGroupingId, będą grupowane na tej samej fakturze.
prismaConfig

object (PrismaConfig)

Dodatkowe metadane do wykorzystania przez narzędzie Mediaocean Prisma.

Wymagane w przypadku budżetów Mediaocean.

Dotyczy to 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 jest nieokreś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łem budżetu jest Mediaocean.

PrismaConfig

Ustawienia dotyczące 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 klienta, usługi i wartości szacunkowych z narzędzia Mediaocean Prisma.
supplier

string

Wymagane. Encja, która przydzieliła 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 płatności Google obsługuje wyszukiwanie i filtrowanie w polach komponentów tego kodu.

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

string

Kod klienta aplikacji Prisma.
prismaProductCode

string

Kod produktu w aplikacji 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.

patch

 Aktualizuje istniejącą kampanię.