REST Resource: guaranteedOrders

Ressource: GarantidOrder

Une commande garantie.

Les campagnes garanties sont l'entité parente des sources d'inventaire garanti. Lorsque vous créez une source d'inventaire garanti, un ID de campagne garanti doit être attribué à la source d'inventaire.

Représentation 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.
}
Champs
name

string

Uniquement en sortie. Nom de ressource de la commande garantie.
legacyGuaranteedOrderId

string

Uniquement en sortie. Ancien ID de la commande garantie. Il est attribué par l'échange d'origine. L'ancien ID est unique au sein d'une même place de marché, mais il n'est pas garanti qu'il le soit pour toutes les campagnes garanties. Cet ID est utilisé dans les fichiers SDF et dans l'interface utilisateur.
exchange

enum (Exchange)

Obligatoire. Immuable. Place de marché à l'origine de la commande garantie.
guaranteedOrderId

string

Uniquement en sortie. Identifiant unique de la commande garantie. Les ID de commande garantis sont au format {exchange}-{legacyGuaranteedOrderId}.
displayName

string

Obligatoire. Nom à afficher de la commande garantie.

Il doit être encodé au format UTF-8 et ne doit pas dépasser 240 octets.
status

object (GuaranteedOrderStatus)

Paramètres d'état de la commande garantie.
updateTime

string (Timestamp format)

Uniquement en sortie. Horodatage de la dernière mise à jour de la commande garantie. Attribué par le système.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
publisherName

string

Obligatoire. Nom de l'éditeur de la campagne garantie.

Il doit être encodé au format UTF-8 et ne doit pas dépasser 240 octets.
readAccessInherited

boolean

Indique si tous les annonceurs de readWritePartnerId disposent d'un accès en lecture à la campagne garantie. Ne s'applique que si readWritePartnerId est défini. Si la valeur est "True", remplace readAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

Identifiants des annonceurs disposant d'un accès en lecture à la campagne garantie.

Ce champ ne doit pas inclure l'annonceur affecté à readWriteAdvertiserId s'il est défini. Tous les annonceurs dans ce champ doivent appartenir à readWritePartnerId ou au même partenaire que readWriteAdvertiserId.
defaultAdvertiserId

string (int64 format)

Uniquement en sortie. ID de l'annonceur par défaut de l'ordre garanti.

L'annonceur par défaut est readWriteAdvertiserId ou, s'il n'est pas défini, le premier annonceur listé dans readAdvertiserIds. Sinon, il n'existe pas d'annonceur par défaut.
defaultCampaignId

string (int64 format)

ID de la campagne par défaut attribuée à l'ordre garanti.

La campagne par défaut doit appartenir à l'annonceur par défaut.

Champ d'union read_write_accessor. Obligatoire.

Partenaire ou annonceur disposant d'un accès en lecture/écriture à la campagne garantie. read_write_accessor ne peut être qu'un des éléments suivants :
readWritePartnerId

string (int64 format)

Partenaire disposant d'un accès en lecture/écriture à la commande garantie.
readWriteAdvertiserId

string (int64 format)

Annonceur disposant d'un accès en lecture/écriture à la campagne garantie. Il s'agit également de l'annonceur par défaut de l'ordre garanti.

GuaranteedOrderStatus

Paramètres d'état de la commande garantie.

Représentation JSON 
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "configStatus": enum (GuaranteedOrderConfigStatus)
}
Champs
entityStatus

enum (EntityStatus)

Indique si la commande garantie peut être diffusée.

Les valeurs acceptées sont ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED et ENTITY_STATUS_PAUSED. La valeur par défaut est ENTITY_STATUS_ACTIVE.
entityPauseReason

string

Motif fourni par l'utilisateur pour la mise en veille de cette commande garantie.

Il doit être encodé au format UTF-8 et ne doit pas dépasser 100 octets.

Ne s'applique que lorsque entityStatus est défini sur ENTITY_STATUS_PAUSED.
configStatus

enum (GuaranteedOrderConfigStatus)

Uniquement en sortie. État de la configuration de la commande garantie.

Les valeurs acceptables sont PENDING et COMPLETED.

Une campagne garantie doit être configurée (renseignez les champs obligatoires, choisissez des créations et sélectionnez une campagne par défaut) avant de pouvoir la diffuser. Actuellement, l'action de configuration ne peut être effectuée que via l'interface utilisateur.

GuaranteedOrderConfigStatus

États de configuration possibles pour une commande garantie.

Enums
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED L'état d'approbation n'est pas spécifié ou est inconnu dans cette version.
PENDING État de début d'une commande garantie. L'ordre garanti dans cet état doit être configuré avant de pouvoir être diffusé.
COMPLETED État une fois que l'acheteur a configuré une commande garantie.

Méthodes

create

 Crée une commande garantie.

editGuaranteedOrderReadAccessors

 Les modifications lisent les annonceurs d'un ordre garanti.

get

 Récupère une commande garantie.

list

 Répertorie les commandes garanties accessibles à l'utilisateur actuel.

patch

 Met à jour une commande garantie existante.