REST Resource: guaranteedOrders

Zasób: gwarantowane zamówienie

Zamówienie gwarantowane.

Zamówienia gwarantowane są nadrzędnym elementem źródeł zasobów reklamowych gwarantowanych. Podczas tworzenia źródła gwarantowanych zasobów reklamowych należy do niego przypisać gwarantowany 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 gwarantowanego zamówienia.
legacyGuaranteedOrderId

string

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

enum (Exchange)

Wymagane. Stała. Giełda, z której pochodzi zamówienie gwarantowane.
guaranteedOrderId

string

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

string

Wymagane. Wyświetlana nazwa zamówienia gwarantowanego.

Musi być zakodowany w standardzie UTF-8 i 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 RFC3339 UTC „Zulu” 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

Wymagane. Nazwa wydawcy zamówienia gwarantowanego.

Musi być zakodowany w standardzie UTF-8 i maksymalnym rozmiarze 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 skonfigurowano ustawienie readWritePartnerId. Jeśli ma wartość Prawda, zastępuje ustawienie readAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

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

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ślnym reklamodawcą jest readWriteAdvertiserId lub pierwszy reklamodawca wymieniony w polu readAdvertiserIds, jeśli ta zasada nie jest ustawiona. W przeciwnym razie nie będzie żadnego domyślnego reklamodawcy.
defaultCampaignId

string (int64 format)

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

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

Pole sumy read_write_accessor. Wymagane.

Partner lub reklamodawca z dostępem do zamówienia gwarantowanego na potrzeby odczytu/zapisu. 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)

Wskazuje, czy zamówienie gwarantowane może być wyświetlane.

Akceptowane wartości to ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED i ENTITY_STATUS_PAUSED. Wartość domyślna to 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ć maksymalną długość 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.

Zanim zamówienie gwarantowane zacznie się wyświetlać, musi zostać skonfigurowane (musisz wypełnić wymagane pola, wybrać kreacje i wybrać kampanię domyślną). Obecnie działanie konfiguracyjne można wykonywać tylko w interfejsie użytkownika.

GuaranteedOrderConfigStatus

Możliwe stany konfiguracji gwarantowanego zamówienia.

Wartości w polu enum
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED Stan zatwierdzenia nie jest określony lub nieznany w tej wersji.
PENDING Stan początkowy gwarantowanego zamówienia. Zamówienie gwarantowane w tym stanie trzeba skonfigurować, aby mogło być wyświetlane.
COMPLETED Stan, który pojawia się, gdy kupujący skonfiguruje zamówienie gwarantowane.

Metody

create

 Tworzy nowe zamówienie z gwarancją.

editGuaranteedOrderReadAccessors

 Edytuje odczyt reklamodawców w zamówieniu gwarantowanym.

get

 Pobiera zamówienie gwarantowane.

list

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

patch

 Aktualizuje istniejące zamówienie gwarantowane.