REST Resource: guaranteedOrders

Zasób: gwarantowane zamówienie

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 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ę. Starszy identyfikator jest unikalny w ramach jednej giełdy, ale nie może być niepowtarzalny wśród wszystkich zamówień gwarantowanych. Ten identyfikator jest używany w plikach SDF i interfejsie użytkownika.
exchange

enum (Exchange)

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

string

Tylko dane wyjściowe. Unikalny identyfikator gwarantowanego zamówienia. Identyfikatory gwarantowanych zamówień 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 gwarantowanego zamówienia.

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

boolean

Określa, czy wszyscy reklamodawcy w organizacji readWritePartnerId mają dostęp z możliwością odczytu gwarantowanego zamówienia. 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 readWriteAdvertiserId, jeśli jest ustawiony. Wszyscy reklamodawcy w tym polu muszą należeć do readWritePartnerId lub 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 domyślnego reklamodawcy.

Pole sumy read_write_accessor. Wymagane.

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

string (int64 format)

Partner z uprawnieniami do odczytu i zapisu zamówienia gwarantowanego.
readWriteAdvertiserId

string (int64 format)

Reklamodawca z uprawnieniami do odczytu i zapisu gwarantowanego zamówienia. Jest to także domyślny reklamodawca gwarantowanego zamówienia.

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

Przyczyna wstrzymania tego gwarantowanego zamówienia podana przez użytkownika.

Musi być zakodowany w standardzie 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 gwarantowanego zamówienia.

Akceptowane wartości to PENDING i COMPLETED.

Zanim zamówienie gwarantowane będzie mogło się wyświetlać, musisz je skonfigurować (wypełnij wymagane pola, wybierz kreacje i wybierz 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 gwarantowane.

editGuaranteedOrderReadAccessors

 Zmiany odczytują reklamodawców zamówienia gwarantowanego.

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.