REST Resource: advertisers.insertionOrders

{
  "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)
}

string

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

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

string

Wymagane. Wyświetlana nazwa zamówienia reklamowego.

Musi być zakodowany w standardzie UTF-8 i maksymalnym rozmiarze 240 bajtów.

enum (InsertionOrderType)

Typ zamówienia reklamowego.

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

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.

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".

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.

object (Pacing)

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

object (FrequencyCap)

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

object (IntegrationDetails)

Dodatkowe szczegóły integracji zamówienia reklamowego.

object (Kpi)

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

W interfejsie Display & Video 360 jest to nazywane „celem”.

object (InsertionOrderBudget)

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

object (BiddingStrategy)

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

enum (ReservationType)

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

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 ustawienia go spowoduje zwrócenie błędu.

{
  "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.
}

enum (KpiType)

Wymagane. Typ KPI.

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.

string (int64 format)

Kwota docelowa 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

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

string (int64 format)

Wartość dziesiętna określająca odsetek celu w mikro.

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

• 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 formacie dziesiętnym).

string

Ciąg KPI, który może być pusty. Musi być zakodowany w formacie UTF-8 i nie może być dłuższy niż 100 znaków.

Obowiązuje, gdy kpiType ma wartość KPI_TYPE_OTHER.

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

enum (BudgetUnit)

Wymagane. Stała. Jednostka budżetu określa, czy budżet jest oparty na walucie, czy na wyświetleniach.

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.

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.

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

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.

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.

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.

string (int64 format)

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