REST Resource: guaranteedOrders

Ressource: GuaranteedOrder

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 de commande 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 la 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 dans une 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'interface utilisateur.
exchange

enum (Exchange)

Obligatoire. Immuable. Place de marché d'où provient 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 l'ordre garanti.

Doit être encodé en 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 est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" 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 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 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 readWriteAdvertiserId ou, 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 à la commande garantie.

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 commande 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)

L'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 ou non.

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 suspendre cette commande garantie.

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 la commande garantie.

Les valeurs acceptables sont PENDING et COMPLETED.

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

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. L'ordre garanti dans cet état doit être configuré avant de pouvoir être diffusé.
COMPLETED État de la commande une fois que l'acheteur a configuré une commande garantie.

Méthodes

create

 Crée une commande garantie.

editGuaranteedOrderReadAccessors

 Modifie les annonceurs lus d'une campagne garantie.

get

 Récupère une commande garantie.

list

 Répertorie les commandes garanties auxquelles l'utilisateur actuel a accès.

patch

 Met à jour une commande garantie existante.