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)

To pole jest wymagane. Niezmienne. 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

To pole jest 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 inaczej, domyślnie przyjmuje się wartość RTB.
entityStatus

enum (EntityStatus)

To pole jest wymagane. Określa, czy zamówienie reklamowe może wydać budżet i ustalać stawki na 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 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 reklamowego. Przypisana przez system.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy 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 ma ich lub jest ona pusta, nowo utworzone zamówienie reklamowe odziedziczy koszty partnera z ustawień partnera.
pacing

object (Pacing)

To pole jest wymagane. Ustawienie szybkości wydawania budżetu zamówienia reklamowego.
frequencyCap

object (FrequencyCap)

To pole jest wymagane. Ustawienie ograniczenia liczby wyświetleń zamówienia reklamowego.
integrationDetails

object (IntegrationDetails)

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

object (PerformanceGoal)

To pole jest wymagane. Cel skuteczności zamówienia reklamowego.
budget

object (InsertionOrderBudget)

To pole jest wymagane. Ustawienia alokacji budżetu zamówienia reklamowego.
bidStrategy

object (BiddingStrategy)

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

enum (ReservationType)

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

enum (BillableOutcome)

Niezmienne. Wynik zamówienia reklamowego podlegającego rozliczeniu.

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

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, mają zastosowanie.

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.

InsertionOrderBudget

Ustawienia kontrolujące sposób przydzielania budżetu zamówienia reklamowego.

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

enum (BudgetUnit)

To pole jest wymagane. Niezmienne. Jednostka budżetowa określa, czy budżet jest oparty na walucie, czy na wyświetleniach.
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 inaczej, domyślnie przyjmuje się wartość INSERTION_ORDER_AUTOMATION_TYPE_NONE.
budgetSegments[]

object (InsertionOrderBudgetSegment)

To pole jest wymagane. Lista segmentów budżetu. Segment budżetu pozwala określić konkretny budżet w czasie trwania 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 automatycznie przenosić budżet na własność elementów zamówienia, aby optymalizować skuteczność określoną przez performanceGoal. Brak automatyzacji w ustawieniach stawek.
INSERTION_ORDER_AUTOMATION_TYPE_NONE Brak automatyzacji ustalania stawek i budżetu 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 na własność elementów zamówienia, co pozwala optymalizować skuteczność określoną przez performanceGoal.

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)

To pole jest wymagane. Kwota budżetu, którą wydarzy zamówienie reklamowe w danym okresie (dateRange). Kwota 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. Pozwala wprowadzić informacje o zamówieniu dla każdego segmentu budżetu i wyświetlać je na fakturach.

Musi być zakodowany w formacie UTF-8.
dateRange

object (DateRange)

To pole jest wymagane. Ustawienia daty rozpoczęcia i zakończenia segmentu budżetu. Są one ustalane względem strefy czasowej reklamodawcy nadrzędnego.

  • Gdy tworzysz nowy segment budżetu, daty startDate i endDate muszą przypadać w przyszłości.
  • Istniejący segment budżetu z elementem startDate w przeszłości ma zmienną endDate, ale stałą wartość startDate.
  • endDate musi być wartością startDate lub późniejszą – obydwa przed 2037 rokiem.
campaignBudgetId

string (int64 format)

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

BillableOutcome

Skutki zamówienia reklamowego podlegające rozliczeniu.

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

bulkListInsertionOrderAssignedTargetingOptions

 Wyświetla listę opcji kierowania przypisanych do zamówienia reklamowego według różnych typów kierowania.

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.

patch

 Aktualizuje istniejące zamówienie reklamowe.