REST Resource: advertisers.insertionOrders

Zasób: InsertionOrder

pojedyncze 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),
  "optimizationObjective": enum (OptimizationObjective)
}
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 na wstawianie reklam.
campaignId

string (int64 format)

Wymagane. Niezmienna. 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 standardzie UTF-8 i maksymalnym rozmiarze 240 bajtów.
insertionOrderType

enum (InsertionOrderType)

Typ zamówienia reklamowego.

Jeśli podczas tworzenia nie określono tego pola, domyślna wartość to RTB.
entityStatus

enum (EntityStatus)

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

  • W metodzie insertionOrders.create dozwolona jest tylko wartość ENTITY_STATUS_DRAFT. Aby aktywować zamówienie reklamowe, użyj metody insertionOrders.patch i po utworzeniu zmień jego stan na ENTITY_STATUS_ACTIVE.
  • Nie można zmienić stanu zamówienia reklamowego z żadnego innego stanu na ENTITY_STATUS_DRAFT.
  • Zamówienia reklamowego nie można ustawić jako 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 na wstawione treści. 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".
partnerCosts[]

object (PartnerCost)

Koszty partnera powiązane z zamówieniem reklamowym.

Jeśli nie ma podanej wartości lub nie ma podanej wartości w metodzie insertionOrders.create, nowo utworzone zamówienie reklamowe odziedziczy koszty partnera z ustawień partnera.
pacing

object (Pacing)

Wymagane. Ustawienie szybkości wydawania budżetu w zamówieniu reklamowym.

Opcja PACING_TYPE_ASAP usługi pacingType nie jest zgodna z opcją PACING_PERIOD_FLIGHT usługi pacingPeriod.
frequencyCap

object (FrequencyCap)

Wymagane. Ustawienie ograniczenia liczby wyświetleń zamówienia reklamowego.
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 nazywane „celem”.
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.
optimizationObjective

enum (OptimizationObjective)

Opcjonalnie: Cel optymalizacji zamówienia reklamowego.

To pole jest dostępne tylko dla klientów z listy dozwolonych. Jeśli klient nie znajduje się na liście dozwolonych, to pole będzie mieć wartość null, a próba jego ustawienia spowoduje zwrócenie błędu.

InsertionOrderType

Możliwe typy zamówienia reklamowego.

Typ zamówienia reklamowego określa, które ustawienia i opcje mają zastosowanie, np. format reklam czy opcje kierowania.

Wartości w polu enum
INSERTION_ORDER_TYPE_UNSPECIFIED Typ zamówienia reklamowego nie został określony lub nieznany.
RTB Określanie stawek w czasie rzeczywistym.
OVER_THE_TOP Over-The-Top.

KPI

Ustawienia sterujące kluczowym wskaźnikiem 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, to pole zostanie zignorowane.
Pole unii kpi_value. Wymagane. Wartość KPI. Odpowiednie pole odpowiada kpi_type. kpi_value może być tylko jednym z tych elementów:
kpiAmountMicros

string (int64 format)

Wartość celu w milionowych częściach waluty reklamodawcy.

Ma zastosowanie, gdy kpiType należy do jednej z tych kategorii:

  • KPI_TYPE_CPM
  • KPI_TYPE_CPC
  • KPI_TYPE_CPA
  • KPI_TYPE_CPIAVC
  • KPI_TYPE_VCPM

Przykład: 1500000 to 1,5 standardowych jednostek waluty.
kpiPercentageMicros

string (int64 format)

Ułamek dziesiętny odsetka celu w mikro.

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

  • 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

Przykład: 70000 oznacza 7% (cyfra dziesiętna 0,07).
kpiString

string

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

Dotyczy to sytuacji, 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 W tej wersji nie podano typu KPI lub jest on nieznany.
KPI_TYPE_CPM KPI to CPM (koszt tysiąca wyświetleń).
KPI_TYPE_CPC Wskaźnik KPI to CPC (koszt kliknięcia).
KPI_TYPE_CPA Wskaźnik KPI to CPA (koszt działania).
KPI_TYPE_CTR Wskaźnik KPI to procentowy CTR (współczynnik klikalności).
KPI_TYPE_VIEWABILITY KPI to współczynnik widoczności.
KPI_TYPE_CPIAVC Wskaźnik KPI to CPIAVC (koszt wyświetlenia z włączonym dźwiękiem, widocznego w momencie zakończenia).
KPI_TYPE_CPE Wskaźnik KPI to CPE (koszt zaangażowania).
KPI_TYPE_CPV Wskaźnik KPI jest ustawiany w sekcji CPV (koszt obejrzenia).
KPI_TYPE_CLICK_CVR Wskaźnik KPI to współczynnik konwersji po kliknięciu (konwersje na kliknięcie) wyrażony w procentach.
KPI_TYPE_IMPRESSION_CVR KPI to procentowy współczynnik konwersji wyświetleń (konwersje na wyświetlenie).
KPI_TYPE_VCPM KPI to vCPM (koszt tysiąca widocznych wyświetleń).
KPI_TYPE_VTR Wskaźnik KPI to odsetek wyświetleń w YouTube (wyświetlenia w YouTube na wyświetlenie).
KPI_TYPE_AUDIO_COMPLETION_RATE Wskaźnik KPI to odsetek odtworzeń w całości (pełne odsłuchania reklamy audio na wyświetlenie).
KPI_TYPE_VIDEO_COMPLETION_RATE KPI to współczynnik pełnych obejrzeń (pełne obejrzenia filmu na wyświetlenie).
KPI_TYPE_CPCL Wskaźnik KPI jest ustawiany w CPCL (koszt odsłuchania w całości).
KPI_TYPE_CPCV KPI określa się według CPCV (kosztu pełnego wyświetlenia filmu).
KPI_TYPE_TOS10 KPI określa się jako czas, przez jaki ekran był widoczny na ekranie przez 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 KPI jest ustawiony tak, aby maksymalizować wpływ marki, nadając priorytet wykorzystaniu całego budżetu.
KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST Wskaźnik KPI jest ustawiany na podstawie niestandardowej wartości wyświetlenia podzielonej przez koszt.
KPI_TYPE_OTHER Wskaźnik KPI ma inną wartość.

InsertionOrderBudget

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

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

enum (BudgetUnit)

Wymagane. Niezmienna. Jednostka budżetu określa, czy budżet jest oparty na walucie, czy na wyświetleniach.
automationType

enum (InsertionOrderAutomationType)

Rodzaj automatyzacji używanej do zarządzania stawkami i budżetem zamówienia reklamowego.

Jeśli to pole nie zostanie określone podczas tworzenia, domyślna wartość to INSERTION_ORDER_AUTOMATION_TYPE_NONE.
budgetSegments[]

object (InsertionOrderBudgetSegment)

Wymagane. Lista segmentów budżetu. Segment budżetu służy do określania określonego budżetu na dany okres wyświetlania 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 W tej wersji opcja automatyzacji zamówienia reklamowego nie jest określona lub jest nieznana.
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET Automatyczne przydzielanie budżetu. Zezwalaj systemowi na automatyczne przenoszenie budżetu do elementów zamówienia, które je obejmują, aby optymalizować skuteczność określoną przez kpi. Brak automatyzacji ustawień stawek.
INSERTION_ORDER_AUTOMATION_TYPE_NONE Brak automatyzacji stawek ani budżetu na poziomie zamówienia reklamowego. Stawka i budżet muszą być skonfigurowane ręcznie na poziomie elementu zamówienia.
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET Pozwól systemowi automatycznie dostosowywać stawki i przenosić budżet do własnych elementów zamówienia, aby zoptymalizować skuteczność określoną przez zasadę kpi.

InsertionOrderBudgetSegment

Ustawienia sterujące budżetem pojedynczego segmentu budżetu.

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

string (int64 format)

Wymagane. Kwota budżetu, jaką zamówienie reklamowe wyda na dany dateRange. Ilość jest wyrażona w mikro. Musi być większy niż 0. Na przykład 500000000 oznacza 500 standardowych jednostek waluty.
description

string

Opis segmentu budżetu. Można go wykorzystać do wpisania informacji o zamówieniu dla każdego segmentu budżetu i umieścić te informacje na fakturach.

Musi być zakodowany w formacie UTF-8.
dateRange

object (DateRange)

Wymagane. Ustawienia daty rozpoczęcia i zakończenia segmentu budżetu. Są one rozwiązywane w zależności od strefy czasowej reklamodawcy nadrzędnego.

  • Podczas tworzenia nowego segmentu budżetu zarówno startDate, jak i endDate muszą być w przyszłości.
  • Istniejący segment budżetu z wartością startDate w przeszłości ma zmienną wartość endDate, ale niezmienną wartość startDate.
  • Wartość endDate musi być równa startDate lub wyższa i nie może przekraczać 2037 roku.
campaignBudgetId

string (int64 format)

budgetId budżetu kampanii, którego częścią jest ten segment budżetu zamówienia reklamowego.

OptimizationObjective

Możliwe typy celów optymalizacji.

Wartości w polu enum
OPTIMIZATION_OBJECTIVE_UNSPECIFIED Wartość typu nie została określona lub jest nieznana w tej wersji.
CONVERSION Nadawanie priorytetu wyświetleniom, które zwiększają sprzedaż i liczbę konwersji.
CLICK Nadawanie priorytetu wyświetleniom, które zwiększają ruch w witrynie, aplikacji lub sklepie z aplikacjami.
BRAND_AWARENESS nadawać priorytet wyświetleniom o określonej jakości;
CUSTOM Cel jest definiowany przez przypisany algorytm ustalania stawek niestandardowych.
NO_OBJECTIVE Nie zdefiniowano celu. Możesz użyć dowolnego KPI lub dowolnej strategii ustalania stawek.

Metody

create

 Tworzy nowe zamówienie reklamowe.

delete

 Usuwa zamówienie reklamowe.

get

 Pobiera zamówienie reklamowe.

list

 Wyświetla zamówienia reklamowe w reklamodawcy.

listAssignedTargetingOptions

 Wyświetla przypisane opcje kierowania zamówienia reklamowego według typów kierowania.

patch

 Aktualizuje dotychczasowe zamówienie reklamowe.