REST Resource: guaranteedOrders

Zasób: GuaranteedOrder

gwarantowane zamówienie,

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "readWritePartnerId": string,
  "readWriteAdvertiserId": string
  // End of mutually exclusive fields.
}
Pola
name

string

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

string

Tylko dane wyjściowe. Identyfikator starszej wersji gwarantowanego zamówienia. Przypisany przez pierwotną giełdę. Stary identyfikator jest unikalny w obrębie 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. Wartość niezmienna. Giełda, z której pochodzi gwarantowane zamówienie.
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 formacie UTF-8 i mieć maksymalny rozmiar 240 bajtów.
status

object (GuaranteedOrderStatus)

Ustawienia stanu gwarantowanego zamówienia.
updateTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa określająca, kiedy zamówienie gwarantowane zostało ostatnio zaktualizowane. 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 gwarantowanego zamówienia.

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

boolean

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

string (int64 format)

Identyfikatory reklamodawców z dostępem do odczytu do 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 partnera 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 wymieniony w readAdvertiserIds. W przeciwnym razie nie ma domyślnego reklamodawcy.
defaultCampaignId

string (int64 format)

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

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

Wymagane.

Partner lub reklamodawca z uprawnieniami do zapisu i odczytu zamówienia gwarantowanego. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
readWritePartnerId

string (int64 format)

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

string (int64 format)

Reklamodawca z uprawnieniami do zapisu i odczytu w przypadku zamówienia gwarantowanego. Jest to też domyślny reklamodawca zamówienia gwarantowanego.
Koniec pól wykluczających się wzajemnie.

GuaranteedOrderStatus

Ustawienia stanu gwarantowanego zamówienia.

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

enum (EntityStatus)

Określa, czy gwarantowane zamówienie może się wyświetlać.

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

Musi być zakodowana w formacie UTF-8 i mieć maksymalną długość 100 bajtów.

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

Aby zamówienie gwarantowane mogło wyświetlać reklamy, musisz je skonfigurować (wypełnić wymagane pola, wybrać kreacje i wybrać kampanię domyślną). Obecnie działanie konfiguracji można wykonać tylko za pomocą interfejsu 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 jest nieznany w tej wersji.
PENDING Początkowy stan gwarantowanego zamówienia. Zamówienie gwarantowane w tym stanie musi zostać skonfigurowane, zanim będzie mogło się wyświetlać.
COMPLETED Stan po skonfigurowaniu zamówienia gwarantowanego przez kupującego.

Metody

create

 Tworzy nowe zamówienie gwarantowane.

editGuaranteedOrderReadAccessors

 Edytuje reklamodawców z dostępem do odczytu w zamówieniu gwarantowanym.

get

 Pobiera zamówienie gwarantowane.

list

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

patch

 Aktualizuje istniejące zamówienie gwarantowane.