REST Resource: guaranteedOrders

Zasób: RecommendeddOrder

Zamówienie gwarantowane.

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

string

Tylko dane wyjściowe. Starszy identyfikator zamówienia gwarantowanego. Przypisana przez pierwotną giełdę. Starszy identyfikator jest unikalny w obrębie jednej giełdy, ale nie ma gwarancji, że będzie unikalny we wszystkich gwarantowanych zamówieniach. Jest on używany w plikach SDF i interfejsie użytkownika.
exchange

enum (Exchange)

To pole jest 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

To pole jest wymagane. Wyświetlana nazwa zamówienia gwarantowanego.

Musi być zakodowany w formacie UTF-8 o 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 formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
publisherName

string

To pole jest wymagane. Nazwa wydawcy zamówienia gwarantowanego.

Musi być zakodowany w formacie UTF-8 o maksymalnym rozmiarze 240 bajtów.
readAccessInherited

boolean

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

string (int64 format)

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

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

string (int64 format)

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

Reklamodawca domyślny to readWriteAdvertiserId lub, jeśli ta wartość nie jest skonfigurowana, jako pierwszy reklamodawca wymieniony w zasadzie 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 sumy read_write_accessor. To pole jest wymagane.

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

string (int64 format)

Partner z uprawnieniami do zapisu i odczytu w zamówieniu gwarantowanym.
readWriteAdvertiserId

string (int64 format)

Reklamodawca z uprawnieniami do odczytu i zapisu w zamówieniu gwarantowanym. 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 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 gwarantowanego zamówienia.

Musi być zakodowany w formacie 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.

Zamówienie gwarantowane musi zostać skonfigurowane (wypełnij wymagane pola, wybierz kreacje i wybierz kampanię domyślną), aby mogło się wyświetlać. 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 nie jest określony lub nieznany w tej wersji.
PENDING Stan początkowy zamówienia gwarantowanego. Przed rozpoczęciem wyświetlania reklam musisz skonfigurować zamówienie gwarantowane w tym stanie.
COMPLETED Stan po skonfigurowaniu zamówienia gwarantowanego przez kupującego.

Metody

create

 Tworzy nowe zamówienie gwarantowane.

editGuaranteedOrderReadAccessors

 Zmiany odczytują informacje o reklamodawcach zamówienia gwarantowanego.

get

 Uzyskuje zamówienie gwarantowane.

list

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

patch

 Aktualizuje istniejące zamówienie gwarantowane.