REST Resource: advertisers.insertionOrders

Zasób: InsertionOrder

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)
  },
  "performanceGoal": {
    object (PerformanceGoal)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "billableOutcome": enum (BillableOutcome)
}
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ła. 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 jego utworzeniu zmień stan na ENTITY_STATUS_ACTIVE.
  • Zamówienia reklamowego nie można zmienić z powrotem na ENTITY_STATUS_DRAFT z innego stanu.
  • Zamówienie reklamowe nie może mieć ustawienia 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 RFC3339 UTC „Zulu” 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 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.
frequencyCap

object (FrequencyCap)

Wymagane. Ustawienie ograniczenia liczby wyświetleń zamówienia reklamowego.
integrationDetails

object (IntegrationDetails)

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

object (PerformanceGoal)

Wymagane. Docelowa skuteczność zamówienia reklamowego.
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.
billableOutcome

enum (BillableOutcome)

Stała. Wynik zamówienia reklamowego podlegający rozliczeniu.

Kupowanie na podstawie wyników zostało wycofane. BILLABLE_OUTCOME_PAY_PER_IMPRESSION jest jedyną prawidłową wartością.

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.

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. Stała. 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 podczas tworzenia nie określono tego pola, domyślna wartość to INSERTION_ORDER_AUTOMATION_TYPE_NONE.
budgetSegments[]

object (InsertionOrderBudgetSegment)

Wymagane. Lista segmentów budżetu. Użyj segmentu budżetu, aby określić konkretny budżet w wybranym okresie 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 Opcja automatyzacji zamówienia reklamowego nie została określona lub jest nieznana w tej wersji.
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET Automatyczne przydzielanie budżetu. Pozwól systemowi automatycznie przenieść budżet na elementy zamówienia będące ich właścicielem, aby zoptymalizować skuteczność zdefiniowaną przez performanceGoal. Brak automatyzacji ustawień stawek.
INSERTION_ORDER_AUTOMATION_TYPE_NONE Brak automatyzacji 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 automatycznie dostosowywać stawki i przenosić budżet do własnych elementów zamówienia, aby zoptymalizować skuteczność określoną przez zasadę performanceGoal.

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 w danym okresie (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 ustalane według strefy czasowej reklamodawcy nadrzędnego.

  • Gdy tworzysz nowy segment 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łe pole startDate.
  • endDate musi być datą startDate lub późniejszą, zarówno przed rokiem 2037, jak i nowszy.
campaignBudgetId

string (int64 format)

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

BillableOutcome

Możliwe rezultaty podlegające rozliczeniu związane z zamówieniem reklamowym.

Wartości w polu enum
BILLABLE_OUTCOME_UNSPECIFIED Nieokreślony wynik podlegający rozliczeniu.
BILLABLE_OUTCOME_PAY_PER_IMPRESSION Płatność za wyświetlenia.
BILLABLE_OUTCOME_PAY_PER_CLICK

Płatność za kliknięcie.
BILLABLE_OUTCOME_PAY_PER_VIEWABLE_IMPRESSION

Płatność za widok aktywny.

Metody

create

 Tworzy nowe zamówienie reklamowe.

delete

 Usuwa zamówienie reklamowe.

get

 Pobiera zamówienie reklamowe.

list

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

listAssignedTargetingOptions

 Wyświetla listę opcji kierowania przypisanych do zamówienia reklamowego w różnych typach kierowania.

patch

 Aktualizuje dotychczasowe zamówienie reklamowe.