REST Resource: guaranteedOrders

Ressource : GuaranteedOrder

Un ordre garanti.

Les ordres garantis sont l'entité parente des sources d'inventaire garanti. Lorsque vous créez une source d'inventaire garanti, un ID de commande (Order ID) garanti doit lui être attribué.

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,

  // 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.
}
Champs
name

string

Uniquement en sortie. Nom de ressource de l'ordre garanti.
legacyGuaranteedOrderId

string

Uniquement en sortie. Ancien ID de la commande garantie. Attribué par la place de marché d'origine. L'ancien ID est unique au sein d'une place de marché, mais il n'est pas garanti qu'il soit unique pour toutes les commandes garanties. Cet ID est utilisé dans les fichiers de données structurées et l'UI.
exchange

enum (Exchange)

Obligatoire. Immuable. Place de marché d'où provient la commande garantie.
guaranteedOrderId

string

Uniquement en sortie. Identifiant unique de l'ordre garanti. Les ID de commande garantie sont au format {exchange}-{legacyGuaranteedOrderId}.
displayName

string

Obligatoire. Nom à afficher de l'ordre garanti.

Doit être encodé en UTF-8 avec une taille maximale de 240 octets.
status

object (GuaranteedOrderStatus)

Paramètres d'état de l'ordre garanti.
updateTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la dernière mise à jour de l'ordre garanti. Attribué par le système.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
publisherName

string

Obligatoire. Nom de l'éditeur de l'ordre garanti.

Doit être encodé en UTF-8 avec une taille maximale de 240 octets.
readAccessInherited

boolean

Indique si tous les annonceurs de readWritePartnerId disposent d'un accès en lecture à l'ordre garanti. S'applique uniquement si readWritePartnerId est défini. Si la valeur est "True", remplace readAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

ID des annonceurs disposant d'un accès en lecture à la commande garantie.

Ce champ ne doit pas inclure l'annonceur attribué à readWriteAdvertiserId s'il est défini. Tous les annonceurs de 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 la commande garantie.

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

string (int64 format)

ID de la campagne par défaut attribuée à la commande garantie.

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

Obligatoire.

Partenaire ou annonceur disposant d'un accès en lecture/écriture à l'ordre garanti. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
readWritePartnerId

string (int64 format)

Partenaire disposant d'un accès en lecture/écriture à l'ordre garanti.
readWriteAdvertiserId

string (int64 format)

Annonceur disposant d'un accès en lecture/écriture à l'ordre garanti. Il s'agit également de l'annonceur par défaut de la commande garantie.
Fin des champs mutuellement exclusifs.

GuaranteedOrderStatus

Paramètres d'état de l'ordre garanti.

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

enum (EntityStatus)

Indique si l'ordre garanti peut être diffusé.

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 mettre en veille cet ordre garanti.

Doit être encodé en UTF-8 et ne 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 l'ordre garanti.

Les valeurs acceptées sont PENDING et COMPLETED.

Pour qu'un ordre garanti puisse être diffusé, vous devez le configurer (remplir les champs obligatoires, choisir des créations et sélectionner une campagne par défaut). Actuellement, l'action de configuration ne peut être effectuée que via l'UI.

GuaranteedOrderConfigStatus

États de configuration possibles pour un ordre garanti.

Enums
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED L'état d'approbation n'est pas spécifié ou est inconnu dans cette version.
PENDING État initial d'un ordre garanti. L'ordre garanti dans cet état doit être configuré avant de pouvoir être diffusé.
COMPLETED État après la configuration d'un ordre garanti par l'acheteur.

Méthodes

create

 Crée un ordre garanti.

editGuaranteedOrderReadAccessors

 Modifie les annonceurs en lecture d'un ordre garanti.

get

 Récupère une commande garantie.

list

 Répertorie les ordres garantis accessibles à l'utilisateur actuel.

patch

 Met à jour un ordre garanti existant.