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

campaignId

string (int64 format)

Wymagane. Wartość 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. Przypisany przez system.

displayName

string

Wymagane. Wyświetlana nazwa zamówienia reklamowego.

Musi być zakodowany w formacie UTF-8 i mieć maksymalny rozmiar 240 bajtów.

insertionOrderType

enum (InsertionOrderType)

Opcjonalnie: Typ zamówienia reklamowego.

Jeśli to pole nie zostanie określone podczas tworzenia, domyślnie zostanie ustawiona wartość RTB.

entityStatus

enum (EntityStatus)

Wymagane. Określa, czy zamówienie reklamowe może wykorzystywać 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 dowolnego innego stanu na ENTITY_STATUS_DRAFT.
  • Nie można ustawić stanu zamówienia reklamowego na ENTITY_STATUS_ACTIVE, jeśli kampania nadrzędna jest nieaktywna.
updateTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa określająca, kiedy zamówienie reklamowe zostało ostatnio zaktualizowane. Przypisany przez system.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

partnerCosts[]

object (PartnerCost)

Opcjonalnie: Koszty partnera powiązane z zamówieniem reklamowym.

Jeśli w metodzie insertionOrders.create nie ma tej wartości lub jest ona pusta, 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.

pacingType PACING_TYPE_ASAP nie jest zgodny z: pacingPeriod PACING_PERIOD_FLIGHT.

frequencyCap

object (FrequencyCap)

Wymagane. Ustawienie limitu wyświetleń na użytkownika w zamówieniu reklamowym.

integrationDetails

object (IntegrationDetails)

Opcjonalnie: 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 on określany jako „Cel”.

budget

object (InsertionOrderBudget)

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

bidStrategy

object (BiddingStrategy)

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

Jeśli pole budget automationType ma wartość INSERTION_ORDER_AUTOMATION_TYPE_BUDGET lub INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET, zamówienie reklamowe narzuci tę strategię ustalania stawek swoim elementom zamówienia. Jeśli narzucona strategia ustalania stawek jest niezgodna z ustawieniem enableOptimizedTargeting elementu zamówienia, ustawienie kierowania zoptymalizowanego zostanie zaktualizowane.

reservationType

enum (ReservationType)

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

optimizationObjective

enum (OptimizationObjective)

Wymagane. Cel optymalizacji zamówienia reklamowego.

InsertionOrderType

Możliwe typy zamówienia reklamowego.

Typ zamówienia reklamowego określa, które ustawienia i opcje są dostępne, np. format reklam lub opcje kierowania.

Wartości w polu enum
INSERTION_ORDER_TYPE_UNSPECIFIED Typ zamówienia reklamowego jest nieokreślony lub nieznany.
RTB Określanie stawek w czasie rzeczywistym.
OVER_THE_TOP Over-The-Top.
OUT_OF_HOME Reklamy zewnętrzne.

KPI

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "kpiAmountMicros": string,
  "kpiPercentageMicros": string,
  "kpiString": string
  // End of mutually exclusive fields.
}
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 wskaźnika KPI, to pole zostanie zignorowane.

Wymagane. Wartość KPI. Odpowiednie pole odpowiada kpi_type. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
kpiAmountMicros

string (int64 format)

Kwota docelowa w mikrowalucie reklamodawcy.

Ma zastosowanie, gdy kpiType to jedna z tych wartości:

  • 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)

Dziesiętna reprezentacja wartości procentowej celu w milionowych częściach jednostki.

Ma zastosowanie, gdy kpiType to jedna 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

Na przykład: 70000 oznacza 7% (0,07).

kpiString

string

Ciąg znaków KPI, który może być pusty. Musi być zakodowana w formacie UTF-8 i nie może przekraczać 100 znaków.

Obowiązuje, gdy kpiType to KPI_TYPE_OTHER.

Koniec pól wykluczających się wzajemnie.

KpiType

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

Wartości w polu enum
KPI_TYPE_UNSPECIFIED Typ KPI nie jest 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 współczynnik klikalności (CTR).
KPI_TYPE_VIEWABILITY KPI to procent widoczności.
KPI_TYPE_CPIAVC KPI to CPIAVC (koszt pełnego wyświetlenia reklamy wideo z dźwiękiem).
KPI_TYPE_CPE KPI to CPE (koszt zaangażowania).
KPI_TYPE_CPV Wskaźnik KPI jest ustawiony na CPV (koszt obejrzenia).
KPI_TYPE_CLICK_CVR KPI to współczynnik konwersji po kliknięciu (konwersje na kliknięcie) wyrażony w procentach.
KPI_TYPE_IMPRESSION_CVR KPI to współczynnik konwersji po wyświetleniu (konwersje na wyświetlenie) wyrażony w procentach.
KPI_TYPE_VCPM KPI to vCPM (koszt tysiąca widocznych wyświetleń).
KPI_TYPE_VTR KPI to współczynnik obejrzeń w YouTube (wyświetlenia w YouTube na wyświetlenie reklamy) wyrażony w procentach.
KPI_TYPE_AUDIO_COMPLETION_RATE KPI to współczynnik pełnych odtworzeń (reklamy audio) (odsłuchania reklamy audio w całości na wyświetlenie) wyrażony w procentach.
KPI_TYPE_VIDEO_COMPLETION_RATE KPI to współczynnik pełnych obejrzeń (liczba pełnych wyświetleń filmów na wyświetlenie) wyrażony w procentach.
KPI_TYPE_CPCL Wskaźnik KPI jest ustawiony na CPCL (koszt pełnego odsłuchania reklamy audio).
KPI_TYPE_CPCV KPI jest ustawiony na CPCV (koszt pełnego obejrzenia filmu).
KPI_TYPE_TOS10 KPI jest ustawiony na współczynnik czasu na ekranie wynoszący co najmniej 10 sekund (odsetek wymiernych wyświetleń reklam niemożliwych do pominięcia, które były widoczne na ekranie przez co najmniej 10 sekund).
KPI_TYPE_MAXIMIZE_PACING Wskaźnik KPI jest ustawiony na maksymalizację wpływu kampanii na markę przy priorytetowym traktowaniu wykorzystania całego budżetu.
KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST KPI jest ustawiany jako niestandardowa wartość wyświetlenia podzielona przez koszt.
KPI_TYPE_OTHER 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. Wartość niezmienna. Jednostka budżetu określa, czy budżet jest oparty na walucie czy na wyświetleniach.

automationType

enum (InsertionOrderAutomationType)

Opcjonalnie: Typ automatyzacji używanej do zarządzania stawkami i budżetem w przypadku zamówienia reklamowego.

Jeśli to pole nie zostanie określone podczas tworzenia, domyślnie zostanie ustawiona wartość INSERTION_ORDER_AUTOMATION_TYPE_NONE.

budgetSegments[]

object (InsertionOrderBudgetSegment)

Wymagane. Lista segmentów budżetu. Możesz wykorzystać segment budżetu, aby przeznaczyć określoną kwotę do wydania 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 jest określona lub jest nieznana w tej wersji.
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET Automatyczne przydzielanie budżetu. Zezwalaj systemowi na automatyczne przenoszenie budżetu do elementów zamówienia, które są właścicielami, aby optymalizować skuteczność określoną przez: kpi. Brak automatyzacji ustawień stawek.
INSERTION_ORDER_AUTOMATION_TYPE_NONE Brak automatyzacji stawek i budżetu na poziomie zamówienia reklamowego. Stawkę i budżet trzeba skonfigurować ręcznie na poziomie elementu zamówienia.
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET Zezwalaj systemowi na automatyczne dostosowywanie stawek i przenoszenie budżetu do elementów zamówienia, które mają go na własność, aby optymalizować skuteczność określoną przez: bidStrategy.

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 podana w mikrowalucie. Musi być większy niż 0. Na przykład 500000000 oznacza 500 standardowych jednostek waluty.

description

string

Opcjonalnie: Opis segmentu budżetu. Można go użyć do wpisania informacji o zamówieniu dla każdego segmentu budżetu i wydrukowania tych informacji 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 względem 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 startDate w przeszłości ma zmienne pole endDate, ale niezmienne pole startDate.
  • endDate musi być startDate lub późniejsza, obie przed rokiem 2037.
campaignBudgetId

string (int64 format)

Opcjonalnie: 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 jest 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 Nadawanie priorytetu wyświetleniom o określonej jakości.
CUSTOM Cel jest określany przez przypisany algorytm ustalania stawek niestandardowych.
NO_OBJECTIVE Cel nie jest zdefiniowany. 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 listę zamówień reklamowych u reklamodawcy.

patch

Aktualizuje istniejące zamówienie reklamowe.