REST Resource: guaranteedOrders

Zasób: GuaranteedOrder

Zamówienie gwarantowane.

Zamówienia gwarantowane to nadrzędny element źródeł gwarantowanych zasobów reklamowych. Podczas tworzenia źródła gwarantowanych zasobów reklamowych musisz przypisać do niego identyfikator zamówienia gwarantowanego.

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 gwarantowanego zamówienia.
legacyGuaranteedOrderId

string

Tylko dane wyjściowe. Stary identyfikator zamówienia gwarantowanego. Przypisano je przez pierwotną giełdę. Stary identyfikator jest unikalny na jednej giełdzie, ale nie ma gwarancji, że będzie unikalny w przypadku wszystkich zamówień gwarantowanych. Ten identyfikator jest używany w SDF i UI.
exchange

enum (Exchange)

Wymagane. Niezmienna. Giełda, na której powstało zamówienie gwarantowane.
guaranteedOrderId

string

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

string

Wymagane. Wyświetlana nazwa zamówienia gwarantowanego.

Musi być zakodowany w formacie UTF-8 i mieć maksymalny rozmiar 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. Przypisany przez system.

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Akceptowane są również 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".
publisherName

string

Wymagane. Nazwa wydawcy zamówienia gwarantowanego.

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

boolean

Określ, czy wszyscy reklamodawcy w readWritePartnerId mają dostęp w trybie odczytu do zamówienia gwarantowanego. Ma zastosowanie tylko wtedy, gdy ustawiono opcję readWritePartnerId. Jeśli wartość to Prawda, zastępuje wartość readAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

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

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

string (int64 format)

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

Domyślny reklamodawca to readWriteAdvertiserId lub, jeśli nie jest ustawiony, pierwszy reklamodawca podany w sekcji readAdvertiserIds. W przeciwnym razie nie ma reklamodawcy domyślnego.
defaultCampaignId

string (int64 format)

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

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

Pole unii read_write_accessor. Wymagane.

Partner lub reklamodawca z dostępem do odczytu/zapisu do zamówienia gwarantowanego. read_write_accessor może być tylko jednym z tych elementów:
readWritePartnerId

string (int64 format)

Partner z dostępem do odczytu i zapisu do zamówienia gwarantowanego.
readWriteAdvertiserId

string (int64 format)

Reklamodawca z dostępem do odczytu i zapisu do zamówienia gwarantowanego. 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)

Określa, czy zamówienie gwarantowane jest dostępne do wyświetlenia.

Akceptowane wartości to ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED i ENTITY_STATUS_PAUSED. Wartością domyślną jest ENTITY_STATUS_ACTIVE.
entityPauseReason

string

Podany przez użytkownika powód wstrzymania tego zamówienia gwarantowanego.

Musi być zakodowany w formacie UTF-8 i mieć maksymalnie 100 bajtów.

Dotyczy tylko sytuacji, gdy 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.

Zanim zamówienie gwarantowane będzie mogło się wyświetlać, musi zostać skonfigurowane (wypełnij wymagane pola, wybierz kreacje i kampanię domyślną). Obecnie działanie konfiguracyjne można wykonać tylko w interfejsie użytkownika.

GuaranteedOrderConfigStatus

Możliwe stany konfiguracji zamówienia gwarantowanego.

Wartości w polu enum
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED Stan zatwierdzenia nie jest określony lub jest nieznany w tej wersji.
PENDING Początkowy stan zamówienia gwarantowanego. Zanim zamówienie gwarantowane będzie mogło się wyświetlać, musi zostać skonfigurowane w tym stanie.
COMPLETED Stan po skonfigurowaniu przez kupującego zamówienia gwarantowanego.

Metody

create

 Tworzy nowe zamówienie z gwarancją.

editGuaranteedOrderReadAccessors

 Edytuje odczyt reklamodawców w zamówieniu gwarantowanym.

get

 Otrzymuje zamówienie gwarantowane.

list

 Wyświetla zamówienia z gwarancją dostępności, które są dostępne dla bieżącego użytkownika.

patch

 Aktualizuje istniejące zamówienie gwarantowane.