REST Resource: guaranteedOrders

L'

Ressource : GuaranteedOrder

Une commande garantie.

Les ordres garantis sont l'entité parente des sources d'inventaire garanti. Lorsque vous créez une source d'inventaire garanti, vous devez lui attribuer un ID d'ordre garanti.

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 l'ordre garanti.
legacyGuaranteedOrderId

string

Uniquement en sortie. Ancien identifiant de l'ordre garanti. Attribué par la place boursière 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 commandes garanties. Cet ID est utilisé dans le fichier SDF et l'UI.
exchange

enum (Exchange)

Obligatoire. Immuable. Place de marché d'où provient l'ordre garanti.
guaranteedOrderId

string

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

string

Obligatoire. Nom à afficher de l'ordre garanti.

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

object (GuaranteedOrderStatus)

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

string (Timestamp format)

Uniquement en sortie. Code temporel de la dernière mise à jour de la commande garantie. 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é au format UTF-8 et ne pas dépasser 240 octets.
readAccessInherited

boolean

Indique si tous les annonceurs de readWritePartnerId ont 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)

ID des annonceurs ayant un accès en lecture à l'ordre garanti.

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 l'ordre garanti.

L'annonceur par défaut est soit readWriteAdvertiserId, soit, si ce paramètre 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 à 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 à l'ordre garanti. 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 commande garantie. Il s'agit également de l'annonceur par défaut de la commande garantie.

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 acceptables 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 suspension de cette commande garantie.

Doit être encodé au format 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 la commande garantie.

Les valeurs acceptables sont PENDING et COMPLETED.

Avant de pouvoir diffuser une commande garantie, vous devez la 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'interface utilisateur.

GuaranteedOrderConfigStatus

États de configuration possibles pour une commande garantie.

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

Méthodes

create

 Crée une commande garantie.

editGuaranteedOrderReadAccessors

 Modifie les annonceurs d'une campagne garantie.

get

 Obtient une commande garantie.

list

 Liste les commandes garanties accessibles à l'utilisateur actuel.

patch

 Met à jour une commande garantie existante.