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 ( |
Champs | |
---|---|
name |
Uniquement en sortie. Nom de ressource de la commande garantie. |
legacyGuaranteedOrderId |
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 |
Obligatoire. Immuable. Place de marché à l'origine de la commande garantie. |
guaranteedOrderId |
Uniquement en sortie. Identifiant unique de la commande garantie. Les ID de commande garantis sont au format |
displayName |
Obligatoire. Nom à afficher de la commande garantie. Il doit être encodé au format UTF-8 et ne doit pas dépasser 240 octets. |
status |
Paramètres d'état de la commande garantie. |
updateTime |
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: |
publisherName |
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 |
Indique si tous les annonceurs de |
readAdvertiserIds[] |
Identifiants des annonceurs disposant d'un accès en lecture à la campagne garantie. Ce champ ne doit pas inclure l'annonceur affecté à |
defaultAdvertiserId |
Uniquement en sortie. ID de l'annonceur par défaut de l'ordre garanti. L'annonceur par défaut est |
defaultCampaignId |
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 Partenaire ou annonceur disposant d'un accès en lecture/écriture à la campagne garantie. |
|
readWritePartnerId |
Partenaire disposant d'un accès en lecture/écriture à la commande garantie. |
readWriteAdvertiserId |
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 ( |
Champs | |
---|---|
entityStatus |
Indique si la commande garantie peut être diffusée. Les valeurs acceptées sont |
entityPauseReason |
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 |
configStatus |
Uniquement en sortie. État de la configuration de la commande garantie. Les valeurs acceptables sont 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 |
|
---|---|
|
Crée une commande garantie. |
|
Les modifications lisent les annonceurs d'un ordre garanti. |
|
Récupère une commande garantie. |
|
Répertorie les commandes garanties accessibles à l'utilisateur actuel. |
|
Met à jour une commande garantie existante. |