REST Resource: guaranteedOrders

Zasób: RecommendeddOrder

Zamówienie gwarantowane.

Zamówienia gwarantowane są elementem nadrzędnym w przypadku gwarantowanych źródeł zasobów reklamowych. Podczas tworzenia źródła gwarantowanych zasobów reklamowych musisz przypisać do niego identyfikator zamówienia.

Zapis JSON 
{
  "name": string,
  "legacyGuaranteedOrderId": string,
  "exchange": enum (Exchange),
  "guaranteedOrderId": string,
  "displayName": string,
  "status": {
    object (GuaranteedOrderStatus)
  },
  "updateTime": string,
  "publisherName": string,
  "readAccessInherited": boolean,
  "readAdvertiserIds": [
    string
  ],
  "defaultAdvertiserId": string,
  "defaultCampaignId": string,

  // Union field read_write_accessor can be only one of the following:
  "readWritePartnerId": string,
  "readWriteAdvertiserId": string
  // End of list of possible types for union field read_write_accessor.
}
Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu zamówienia gwarantowanego.
legacyGuaranteedOrderId

string

Tylko dane wyjściowe. Starszy identyfikator zamówienia gwarantowanego. Przypisana przez pierwotną giełdę. Starszy identyfikator jest unikalny w obrębie jednej giełdy, ale nie musi być niepowtarzalny we wszystkich gwarantowanych zamówieniach. Ten identyfikator jest używany w plikach SDF i interfejsie.
exchange

enum (Exchange)

To pole jest wymagane. Stałe. Giełda, z której pochodzi zamówienie gwarantowane.
guaranteedOrderId

string

Tylko dane wyjściowe. Unikalny identyfikator zamówienia gwarantowanego. Identyfikatory zamówień gwarantowanych mają format {exchange}-{legacyGuaranteedOrderId}.
displayName

string

To pole jest wymagane. Wyświetlana nazwa zamówienia gwarantowanego.

Musi być zakodowany w formacie UTF-8 o maksymalnym rozmiarze 240 bajtów.
status

object (GuaranteedOrderStatus)

Ustawienia stanu zamówienia gwarantowanego.
updateTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa ostatniej aktualizacji zamówienia gwarantowanego. Przypisana przez system.

Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
publisherName

string

To pole jest wymagane. Nazwa wydawcy zamówienia gwarantowanego.

Musi być zakodowany w formacie UTF-8 o maksymalnym rozmiarze 240 bajtów.
readAccessInherited

boolean

Określa, czy wszyscy reklamodawcy w organizacji readWritePartnerId mają dostęp do odczytu zamówienia gwarantowanego. Ma zastosowanie tylko wtedy, gdy ustawiona jest wartość readWritePartnerId. Jeśli ma wartość Prawda, zastępuje readAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

Identyfikatory reklamodawców z dostępem do odczytu do zamówienia gwarantowanego.

To pole nie może zawierać reklamodawcy przypisanego do readWriteAdvertiserId, jeśli jest ustawione. Wszyscy reklamodawcy w tym polu muszą należeć do firmy readWritePartnerId lub tego samego partnera co readWriteAdvertiserId.
defaultAdvertiserId

string (int64 format)

Tylko dane wyjściowe. Identyfikator domyślnego reklamodawcy zamówienia gwarantowanego.

Reklamodawca domyślny to readWriteAdvertiserId lub, jeśli ta wartość nie jest skonfigurowana, jako pierwszy reklamodawca wymieniony w zasadzie readAdvertiserIds. W przeciwnym razie nie ma domyślnego reklamodawcy.
defaultCampaignId

string (int64 format)

Identyfikator domyślnej kampanii przypisanej do zamówienia gwarantowanego.

Kampania domyślna musi należeć do reklamodawcy domyślnego.

Pole sumy read_write_accessor. To pole jest wymagane.

Partner lub reklamodawca z uprawnieniami do odczytu i zapisu w ramach gwarantowanego zamówienia. read_write_accessor może być tylko jedną z tych wartości:
readWritePartnerId

string (int64 format)

Partner z uprawnieniami do zapisu i odczytu w zamówieniu gwarantowanym.
readWriteAdvertiserId

string (int64 format)

Reklamodawca z uprawnieniami do zapisu i odczytu w zamówieniu gwarantowanym. Jest to też domyślny reklamodawca zamówienia gwarantowanego.

GuaranteedOrderStatus

Ustawienia stanu zamówienia gwarantowanego.

Zapis JSON 
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "configStatus": enum (GuaranteedOrderConfigStatus)
}
Pola
entityStatus

enum (EntityStatus)

Wskazuje, czy zamówienie gwarantowane może zostać wyświetlone.

Akceptowane wartości to ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED i ENTITY_STATUS_PAUSED. Wartość domyślna to ENTITY_STATUS_ACTIVE.
entityPauseReason

string

Podana przez użytkownika przyczyna wstrzymania tego zamówienia gwarantowanego.

Musi być zakodowany w formacie UTF-8 o maksymalnej długości 100 bajtów.

Ma zastosowanie tylko wtedy, gdy zasada entityStatus ma wartość ENTITY_STATUS_PAUSED.
configStatus

enum (GuaranteedOrderConfigStatus)

Tylko dane wyjściowe. Stan konfiguracji zamówienia gwarantowanego.

Akceptowane wartości to PENDING i COMPLETED.

Przed wyświetleniem gwarantowanego zamówienia musisz je skonfigurować (wypełnij wymagane pola, wybierz kreacje i wybierz kampanię domyślną). Obecnie działanie konfiguracyjne można wykonywać tylko przez interfejs użytkownika.

GuaranteedOrderConfigStatus

Możliwe stany konfiguracji zamówienia gwarantowanego.

Wartości w polu enum
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED W tej wersji stan zatwierdzenia nie jest określony lub jest nieznany.
PENDING Stan początkowy zamówienia gwarantowanego. Zanim reklama będzie mogła się wyświetlać, musisz skonfigurować kolejność gwarantowaną w tym stanie.
COMPLETED Stan po skonfigurowaniu zamówienia gwarantowanego przez kupującego.

Metody

create

 Tworzy nowe zamówienie gwarantowane.

editGuaranteedOrderReadAccessors

 Zmiany odczytują reklamodawców zamówienia gwarantowanego.

get

 Otrzymuje zamówienie gwarantowane.

list

 Wyświetla listę gwarantowanych zamówień, które są dostępne dla bieżącego użytkownika.

patch

 Aktualizuje istniejące zamówienie gwarantowane.