REST Resource: guaranteedOrders

Zasób: GuaranteedOrder

gwarantowane zamówienie;

Zamówienia gwarantowane są jednostką nadrzędną źródeł gwarantowanych zasobów reklamowych. Podczas tworzenia źródła gwarantowanych zasobów reklamowych należy 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 zamówienia gwarantowanego.
legacyGuaranteedOrderId

string

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

enum (Exchange)

Wymagane. Niezmienne. 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

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.

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".
publisherName

string

Wymagane. Nazwa wydawcy zamówienia gwarantowanego.

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

boolean

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

string (int64 format)

Identyfikatory reklamodawców, którzy mają uprawnienia do odczytu zamówienia gwarantowanego.

Jeśli pole readWriteAdvertiserId jest ustawione, nie może ono zawierać reklamodawcy przypisanego do tego pola. 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, jeśli nie jest on ustawiony, pierwszy reklamodawca wymieniony w 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 zbiorcze read_write_accessor. Wymagane.

Partner lub reklamodawca z dostępem do odczytu i zapisu w przypadku zamówienia gwarantowanego. Pole 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 w przypadku zamówienia gwarantowanego. Jest to również 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 może się wyświetlać.

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ć maksymalną długość 100 bajtów.

Ma zastosowanie tylko wtedy, 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.

Aby można było wyświetlać zamówienie gwarantowane, musisz je skonfigurować (wypełnić wymagane pola, wybrać kreacje i kampanię domyślną). Obecnie działanie konfiguracyjne można wykonać tylko za pomocą interfejsu użytkownika.

GuaranteedOrderConfigStatus

Możliwe stany konfiguracji zamówienia gwarantowanego.

Wartości w polu enum
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED Stan zatwierdzenia w tej wersji nie jest określony lub jest nieznany.
PENDING Stan początkowy zamówienia gwarantowanego. Aby zamówienie gwarantowane w tym stanie mogło się wyświetlać, musisz je skonfigurować.
COMPLETED Stan po skonfigurowaniu przez kupującego zamówienia gwarantowanego.

Metody

create

 Tworzy nowe zamówienie z gwarancją.

editGuaranteedOrderReadAccessors

 Edytuje reklamodawców w ramach gwarantowanego zamówienia.

get

 uzyskuje gwarancję zamówienia;

list

 Wyświetla listę zamówień gwarantowanych, do których obecny użytkownik ma dostęp.

patch

 Aktualizuje istniejące zamówienie gwarantowane.