REST Resource: advertisers.insertionOrders

Zasób: AdOrder

Jedno zamówienie reklamowe.

Zapis JSON 
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "insertionOrderId": string,
  "displayName": string,
  "insertionOrderType": enum (InsertionOrderType),
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "partnerCosts": [
    {
      object (PartnerCost)
    }
  ],
  "pacing": {
    object (Pacing)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "kpi": {
    object (Kpi)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType)
}
Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu zamówienia reklamowego.
advertiserId

string (int64 format)

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

string (int64 format)

Wymagane. Stałe. Unikalny identyfikator kampanii, do której należy zamówienie reklamowe.
insertionOrderId

string (int64 format)

Tylko dane wyjściowe. Unikalny identyfikator zamówienia reklamowego. Przypisana przez system.
displayName

string

Wymagane. Wyświetlana nazwa zamówienia reklamowego.

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

enum (InsertionOrderType)

Typ zamówienia reklamowego.

Jeśli podczas tworzenia tego pola nie określono tego pola, domyślnie przyjmuje się wartość RTB.
entityStatus

enum (EntityStatus)

Wymagane. Określa, czy zamówienie reklamowe może wydawać budżet i ustalać stawki za zasoby reklamowe.

  • W przypadku metody insertionOrders.create dozwolona jest tylko wartość ENTITY_STATUS_DRAFT. Aby aktywować zamówienie reklamowe, użyj metody insertionOrders.patch i po utworzeniu zamówienia zmień jego stan na ENTITY_STATUS_ACTIVE.
  • Nie można zmienić stanu zamówienia reklamowego z innego na ENTITY_STATUS_DRAFT.
  • Nie można ustawić zamówienia reklamowego na ENTITY_STATUS_ACTIVE, jeśli jego kampania nadrzędna jest nieaktywna.
updateTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa ostatniej aktualizacji zamówienia reklamowego. 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".
partnerCosts[]

object (PartnerCost)

Koszty partnera związane z zamówieniem reklamowym.

Jeśli w metodzie insertionOrders.create nie będzie tego elementu lub będzie ono puste, nowo utworzone zamówienie reklamowe odziedziczy koszty partnera z ustawień partnera.
pacing

object (Pacing)

Wymagane. Ustawienie szybkości wydatków pod kątem budżetu w zamówieniu reklamowym.
frequencyCap

object (FrequencyCap)

Wymagane. Ustawienie ograniczenia liczby wyświetleń w zamówieniu reklamowym.
integrationDetails

object (IntegrationDetails)

Dodatkowe szczegóły integracji zamówienia reklamowego.
kpi

object (Kpi)

Wymagane. Kluczowy wskaźnik wydajności (KPI) zamówienia reklamowego.

W interfejsie Display & Video 360 jest to tzw. „Cel”.
budget

object (InsertionOrderBudget)

Wymagane. Ustawienia alokacji budżetu zamówienia reklamowego.
bidStrategy

object (BiddingStrategy)

Strategia ustalania stawek zamówienia reklamowego. Domyślnie ustawiona jest wartość fixedBid.
reservationType

enum (ReservationType)

Tylko dane wyjściowe. Typ rezerwacji zamówienia reklamowego.

InsertionOrderType

Możliwe typy zamówienia reklamowego.

Typ zamówienia reklamowego określa, które ustawienia i opcje, takie jak format reklam czy opcje kierowania, są odpowiednie.

Wartości w polu enum
INSERTION_ORDER_TYPE_UNSPECIFIED Nie określono typu zamówienia reklamowego lub jest on nieznany.
RTB Określanie stawek w czasie rzeczywistym.
OVER_THE_TOP Over-The-Top.

KPI

Ustawienia, które kontrolują kluczowy wskaźnik wydajności (KPI) zamówienia reklamowego.

Zapis JSON 
{
  "kpiType": enum (KpiType),
  "kpiAlgorithmId": string,

  // Union field kpi_value can be only one of the following:
  "kpiAmountMicros": string,
  "kpiPercentageMicros": string,
  "kpiString": string
  // End of list of possible types for union field kpi_value.
}
Pola
kpiType

enum (KpiType)

Wymagane. Typ KPI.
kpiAlgorithmId

string (int64 format)

Opcjonalnie. Identyfikator algorytmu ustalania stawek niestandardowych powiązany z KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. Jeśli nie wybierzesz odpowiedniego KPI, pole jest ignorowane.
Pole sumy kpi_value. Wymagane. Wartość KPI. Odpowiednie pole odpowiada kolumnie kpi_type. kpi_value może być tylko jedną z tych wartości:
kpiAmountMicros

string (int64 format)

Kwota celu w milionowej walucie reklamodawcy.

Ma zastosowanie, gdy kpiType należy do:

  • KPI_TYPE_CPM
  • KPI_TYPE_CPC
  • KPI_TYPE_CPA
  • KPI_TYPE_CPIAVC
  • KPI_TYPE_VCPM

Na przykład: 1500000 oznacza 1,5 standardowej jednostki waluty.
kpiPercentageMicros

string (int64 format)

Wartości dziesiętne procentowe celu w mikro.

Ma zastosowanie, gdy kpiType należy do:

  • KPI_TYPE_CTR
  • KPI_TYPE_VIEWABILITY
  • KPI_TYPE_CLICK_CVR
  • KPI_TYPE_IMPRESSION_CVR
  • KPI_TYPE_VTR
  • KPI_TYPE_AUDIO_COMPLETION_RATE
  • KPI_TYPE_VIDEO_COMPLETION_RATE

Na przykład: 70 000 oznacza 7% (0,07 w zapisie dziesiętnym).
kpiString

string

Ciąg KPI, który może być pusty. Musi być zakodowany w formacie UTF-8 o długości nie większej niż 100 znaków.

Ma zastosowanie, gdy kpiType ma wartość KPI_TYPE_OTHER.

KpiType

Możliwe typy kluczowych wskaźników wydajności (KPI).

Wartości w polu enum
KPI_TYPE_UNSPECIFIED Typ KPI nie został określony lub jest nieznany w tej wersji.
KPI_TYPE_CPM KPI to CPM (koszt tysiąca wyświetleń).
KPI_TYPE_CPC KPI to CPC (koszt kliknięcia).
KPI_TYPE_CPA KPI to CPA (koszt działania).
KPI_TYPE_CTR KPI to procentowy CTR (współczynnik klikalności).
KPI_TYPE_VIEWABILITY KPI to wartość procentowa widoczności.
KPI_TYPE_CPIAVC KPI to CPIAVC (koszt wyświetlenia, w którym w chwili zakończenia odtwarzania reklamy były widoczne i z włączonym dźwiękiem).
KPI_TYPE_CPE KPI to CPE (koszt zaangażowania).
KPI_TYPE_CPV KPI określa się w ramach CPV (kosztu obejrzenia).
KPI_TYPE_CLICK_CVR KPI to procentowy współczynnik konwersji po kliknięciu (konwersje na kliknięcie).
KPI_TYPE_IMPRESSION_CVR KPI to procentowy współczynnik konwersji po wyświetleniu (liczba konwersji na wyświetlenie).
KPI_TYPE_VCPM KPI to vCPM (koszt tysiąca widocznych wyświetleń).
KPI_TYPE_VTR Wskaźnik KPI to procentowy współczynnik obejrzeń w YouTube (obejrzenia w YouTube na wyświetlenie).
KPI_TYPE_AUDIO_COMPLETION_RATE KPI to odsetek współczynnika pełnych obejrzeń (odsłuchanie całego dźwięku na wyświetlenie).
KPI_TYPE_VIDEO_COMPLETION_RATE Wskaźnikiem KPI jest wartość procentowa współczynnika pełnych obejrzeń (pełne obejrzenia filmu na wyświetlenie).
KPI_TYPE_CPCL KPI określa się w CPCL (kosztu odsłuchania w całości).
KPI_TYPE_CPCV KPI określa się w modelu CPCV (kosztu pełnego wyświetlenia filmu).
KPI_TYPE_TOS10 KPI określa się w czasie, gdy na ekranie trwało co najmniej 10 sekund (odsetek wymiernych, niemożliwych do pominięcia wyświetleń, które były widoczne na ekranie przez co najmniej 10 sekund).
KPI_TYPE_MAXIMIZE_PACING Wskaźnik KPI jest ustawiony tak, aby zmaksymalizować wpływ marki, a jednocześnie traktować priorytetowo wykorzystanie całego budżetu.
KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST KPI ustawia się jako niestandardowa wartość wyświetlenia podzielona przez koszt.
KPI_TYPE_OTHER KPI to inna wartość.

InsertionOrderBudget

Ustawienia określające sposób przydzielania budżetu zamówienia reklamowego.

Zapis JSON 
{
  "budgetUnit": enum (BudgetUnit),
  "automationType": enum (InsertionOrderAutomationType),
  "budgetSegments": [
    {
      object (InsertionOrderBudgetSegment)
    }
  ]
}
Pola
budgetUnit

enum (BudgetUnit)

Wymagane. Stałe. Jednostka budżetu określa, czy budżet zależy od waluty, czy od wyświetleń.
automationType

enum (InsertionOrderAutomationType)

Typ automatyzacji służący do zarządzania stawką i budżetem zamówienia reklamowego.

Jeśli podczas tworzenia tego pola nie określono tego pola, domyślnie przyjmuje się wartość INSERTION_ORDER_AUTOMATION_TYPE_NONE.
budgetSegments[]

object (InsertionOrderBudgetSegment)

Wymagane. Lista segmentów budżetu. Segment budżetu pozwala określić konkretny budżet w wybranym okresie aktywności zamówienia reklamowego.

InsertionOrderAutomationType

Możliwe opcje automatyzacji stawki i budżetu zamówienia reklamowego.

Wartości w polu enum
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED Opcja automatyzacji zamówienia reklamowego nie jest określona lub jest w tej wersji nieznana.
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET Automatyczne przydzielanie budżetu. Pozwól systemowi na automatyczne przenoszenie budżetu do właściciela elementu zamówienia, by zoptymalizować skuteczność określoną przez zasadę kpi. Brak automatyzacji w ustawieniach stawek.
INSERTION_ORDER_AUTOMATION_TYPE_NONE Brak automatyzacji ustalania stawek i budżetów na poziomie zamówienia reklamowego. Stawki i budżet trzeba skonfigurować ręcznie na poziomie elementu zamówienia.
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET Pozwól systemowi na automatyczne dostosowywanie stawek i przenoszenie budżetu do właściciela elementów zamówienia w celu optymalizacji skuteczności zdefiniowanej przez zasadę kpi.

InsertionOrderBudgetSegment

Ustawienia, które kontrolują budżet pojedynczego segmentu budżetu.

Zapis JSON 
{
  "budgetAmountMicros": string,
  "description": string,
  "dateRange": {
    object (DateRange)
  },
  "campaignBudgetId": string
}
Pola
budgetAmountMicros

string (int64 format)

Wymagane. Kwota budżetu, którą zamówienie reklamowe wyda w danym okresie (dateRange). Kwota jest wyrażona w mikro. Musi być większy niż 0. Na przykład 500000000 oznacza 500 jednostek standardowych waluty.
description

string

Opis segmentu budżetu. Można za jego pomocą wprowadzić informacje o zamówieniu zakupu dla każdego segmentu budżetu i wydrukować je na fakturach.

Musi być zakodowany w formacie UTF-8.
dateRange

object (DateRange)

Wymagane. Ustawienia daty rozpoczęcia i zakończenia segmentu budżetu. Rozwiązuje się je w zależności od strefy czasowej reklamodawcy nadrzędnego.

  • Podczas tworzenia nowego segmentu budżetu zarówno startDate, jak i endDate muszą przypadać w przyszłości.
  • Istniejący segment budżetu z wartością startDate w przeszłości ma zmienną wartość endDate, ale stałą wartość startDate.
  • endDate musi mieć wartość startDate lub późniejszą – zarówno przed 2037 rokiem, jak i później.
campaignBudgetId

string (int64 format)

budgetId budżetu kampanii, do którego należy ten segment budżetu zamówienia reklamowego.

Metody

create

 Tworzy nowe zamówienie reklamowe.

delete

 Usuwa zamówienie reklamowe.

get

 Pobiera zamówienie reklamowe.

list

 Wyświetla listę zamówień reklamowych na poziomie reklamodawcy.

listAssignedTargetingOptions

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

patch

 Aktualizuje istniejące zamówienie reklamowe.