REST Resource: advertisers.inventorySources

Ressource : InventorySource

Une source d'inventaire.

Représentation JSON 
{
  "name": string,
  "inventorySourceId": string,
  "displayName": string,
  "inventorySourceType": enum (InventorySourceType),
  "inventorySourceProductType": enum (InventorySourceProductType),
  "commitment": enum (InventorySourceCommitment),
  "deliveryMethod": enum (InventorySourceDeliveryMethod),
  "dealId": string,
  "status": {
    object (InventorySourceStatus)
  },
  "exchange": enum (Exchange),
  "updateTime": string,
  "rateDetails": {
    object (RateDetails)
  },
  "publisherName": string,
  "timeRange": {
    object (TimeRange)
  },
  "creativeConfigs": [
    {
      object (CreativeConfig)
    }
  ],
  "guaranteedOrderId": string,
  "readWriteAccessors": {
    object (InventorySourceAccessors)
  },
  "readAdvertiserIds": [
    string
  ],
  "readPartnerIds": [
    string
  ]
}
Champs
name

string

Uniquement en sortie. Nom de ressource de la source d'inventaire.
inventorySourceId

string (int64 format)

Uniquement en sortie. Identifiant unique de la source d'inventaire. Attribué par le système.
displayName

string

Nom à afficher de la source d'inventaire.

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

enum (InventorySourceType)

Indique le type de la source d'inventaire.
inventorySourceProductType

enum (InventorySourceProductType)

Uniquement en sortie. Type de produit de la source d'inventaire, indiquant la manière dont elle vend l'inventaire.
commitment

enum (InventorySourceCommitment)

Indique si la source d'inventaire est garantie ou non garantie.
deliveryMethod

enum (InventorySourceDeliveryMethod)

Mode de diffusion de la source d'inventaire.

  • Pour les sources d'inventaire non garanti, la seule valeur acceptable est INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC.
  • Pour les sources d'inventaire garanti, les valeurs acceptées sont INVENTORY_SOURCE_DELIVERY_METHOD_TAG et INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC.
dealId

string

ID de l'espace de la place de marché qui identifie de manière unique la source d'inventaire.

Il doit être unique pour chaque acheteur au sein de chaque place de marché, mais pas nécessairement d'une place de marché à l'autre.
status

object (InventorySourceStatus)

Paramètres d'état de la source d'inventaire.
exchange

enum (Exchange)

La place de marché à laquelle appartient la source d'inventaire.
updateTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la dernière mise à jour de la source d'inventaire. 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".
rateDetails

object (RateDetails)

Obligatoire. Détails du tarif de la source d'inventaire.
publisherName

string

Nom de l'éditeur/du vendeur de la source d'inventaire.
timeRange

object (TimeRange)

Période pendant laquelle cette source d'inventaire commence et arrête de diffuser des annonces.
creativeConfigs[]

object (CreativeConfig)

Exigences de la source d'inventaire concernant les créations.

Non applicable aux packages d'enchères.
guaranteedOrderId

string

Immuable. ID de l'ordre garanti auquel appartient cette source d'inventaire.

Ne s'applique que lorsque commitment est défini sur INVENTORY_SOURCE_COMMITMENT_GUARANTEED.
readWriteAccessors

object (InventorySourceAccessors)

Partenaire ou annonceurs disposant d'un accès en lecture/écriture à la source d'inventaire.

Sortie uniquement lorsque commitment est défini sur INVENTORY_SOURCE_COMMITMENT_GUARANTEED, auquel cas les accesseurs en lecture/écriture sont hérités de l'ordre garanti parent.

Obligatoire lorsque commitment est défini sur INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED.

Si commitment est défini sur INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED et qu'un partenaire est défini dans ce champ, tous les annonceurs de ce partenaire auront automatiquement un accès en lecture seule à la source d'inventaire. Ces annonceurs ne seront pas inclus dans readAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

Uniquement en sortie. ID des annonceurs disposant d'un accès en lecture seule à la source d'inventaire.
readPartnerIds[]

string (int64 format)

Uniquement en sortie. ID des partenaires disposant d'un accès en lecture seule à la source d'inventaire.

Tous les annonceurs des partenaires de ce champ héritent d'un accès en lecture seule à la source d'inventaire.

InventorySourceType

Types de sources d'inventaire possibles.

Enums
INVENTORY_SOURCE_TYPE_UNSPECIFIED Le type de source d'inventaire n'est pas spécifié ou est inconnu dans cette version.
INVENTORY_SOURCE_TYPE_PRIVATE Source d'inventaire privée.
INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE Package d'enchères.

InventorySourceProductType

Types de produits possibles d'une source d'inventaire.

Enums
INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED Le type de produit n'est pas spécifié ou est inconnu dans cette version. La modification des sources d'inventaire de ce type de produit n'est pas possible via l'API.
PREFERRED_DEAL La source d'inventaire vend l'inventaire via un accord préféré.
PRIVATE_AUCTION La source d'inventaire vend l'inventaire via des enchères privées.
PROGRAMMATIC_GUARANTEED La source d'inventaire vend l'inventaire via le programmatique garanti.
TAG_GUARANTEED La source d'inventaire vend l'inventaire via Tag garanti.
YOUTUBE_RESERVE La source d'inventaire vend de l'inventaire via YouTube Reserve.
INSTANT_RESERVE La source d'inventaire vend l'inventaire via la réservation instantanée. La modification des sources d'inventaire de ce type de produit n'est pas possible via l'API.
GUARANTEED_PACKAGE La source d'inventaire vend l'inventaire via un package garanti. La modification des sources d'inventaire de ce type de produit n'est pas possible via l'API.
PROGRAMMATIC_TV La source d'inventaire vend de l'inventaire via la TV programmatique. La modification des sources d'inventaire de ce type de produit n'est pas possible via l'API.
AUCTION_PACKAGE La source d'inventaire vend l'inventaire via un package d'enchères. La modification des sources d'inventaire de ce type de produit n'est pas possible via l'API.

InventorySourceCommitment

Types d'engagement possibles pour une source d'inventaire.

Enums
INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED L'engagement n'est pas spécifié ou est inconnu dans cette version.
INVENTORY_SOURCE_COMMITMENT_GUARANTEED L'engagement est une diffusion garantie.
INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED L'engagement est une diffusion non garantie.

InventorySourceDeliveryMethod

Modes de diffusion possibles pour une source d'inventaire.

Enums
INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED La méthode de diffusion n'est pas spécifiée ou est inconnue dans cette version.
INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC Le mode de diffusion est programmatique.
INVENTORY_SOURCE_DELIVERY_METHOD_TAG Le mode de diffusion est "Tag".

InventorySourceStatus

Paramètres d'état de la source d'inventaire.

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

enum (EntityStatus)

Indique si la source d'inventaire 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 mettre en veille cette source d'inventaire.

Ne doit pas dépasser 100 caractères.

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

enum (EntityStatus)

Uniquement en sortie. État défini par le vendeur pour la source d'inventaire.

S'applique uniquement aux sources d'inventaire synchronisées directement depuis les éditeurs. Les valeurs acceptées sont ENTITY_STATUS_ACTIVE et ENTITY_STATUS_PAUSED.
sellerPauseReason

string

Uniquement en sortie. Motif fourni par le vendeur pour la mise en veille de cette source d'inventaire.

S'applique uniquement aux sources d'inventaire synchronisées directement depuis les éditeurs et lorsque sellerStatus est défini sur ENTITY_STATUS_PAUSED.
configStatus

enum (InventorySourceConfigStatus)

Uniquement en sortie. État de configuration de la source d'inventaire.

S'applique uniquement aux sources d'inventaire garanti. Les valeurs acceptées sont INVENTORY_SOURCE_CONFIG_STATUS_PENDING et INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED.

Une source d'inventaire 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.

InventorySourceConfigStatus

États de configuration possibles pour une source d'inventaire garanti.

Enums
INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED L'état d'approbation n'est pas spécifié ou est inconnu dans cette version.
INVENTORY_SOURCE_CONFIG_STATUS_PENDING État initial d'une source d'inventaire garanti. La source d'inventaire dans cet état doit être configurée.
INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED État après que l'acheteur a configuré une source d'inventaire garanti.

RateDetails

Paramètres liés au tarif de la source d'inventaire.

Représentation JSON 
{
  "inventorySourceRateType": enum (InventorySourceRateType),
  "rate": {
    object (Money)
  },
  "unitsPurchased": string,
  "minimumSpend": {
    object (Money)
  }
}
Champs
inventorySourceRateType

enum (InventorySourceRateType)

Type de tarif.

Les valeurs acceptées sont INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED, INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR et INVENTORY_SOURCE_RATE_TYPE_CPD.
rate

object (Money)

Tarif de la source d'inventaire.
unitsPurchased

string (int64 format)

Obligatoire pour les sources d'inventaire garanti. Nombre d'impressions garanti par le vendeur.
minimumSpend

object (Money)

Uniquement en sortie. Montant que l'acheteur s'est engagé à dépenser à l'avance pour la source d'inventaire.

S'applique uniquement aux sources d'inventaire garanti.

InventorySourceRateType

Types de tarifs possibles pour une source d'inventaire.

Enums
INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED Le type de tarif n'est pas spécifié ou est inconnu dans cette version.
INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED Le type de tarif est "CPM (fixe)".
INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR Le type de tarif est "CPM (plancher)".
INVENTORY_SOURCE_RATE_TYPE_CPD Le type de tarif est "Coût par jour".
INVENTORY_SOURCE_RATE_TYPE_CPH Le type de tarif est "Coût par heure".
INVENTORY_SOURCE_RATE_TYPE_FLAT Le type de tarif est "Forfait".

Valeur monétaire

Représente un montant associé à un type de devise.

Représentation JSON 
{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}
Champs
currencyCode

string

Code de la devise à trois lettres défini par la norme ISO 4217.
units

string (int64 format)

Unités entières du montant. Par exemple, si currencyCode est défini sur "USD", une unité correspond à un dollar américain.
nanos

integer

Nombre de nano-unités (10^-9) du montant. La valeur doit être comprise entre -999 999 999 et +999 999 999 inclus. Si units est positif, nanos doit être positif ou égal à zéro. Si units est égal à zéro, nanos peut être positif, nul ou négatif. Si units est négatif, nanos doit être négatif ou égal à zéro. Par exemple, -1,75 $ est représenté par units=-1 et nanos=-750 000 000.

TimeRange

Une période.

Représentation JSON 
{
  "startTime": string,
  "endTime": string
}
Champs
startTime

string (Timestamp format)

Obligatoire. Limite inférieure d'une période (inclusive).

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".
endTime

string (Timestamp format)

Obligatoire. Limite supérieure d'une période, inclusive.

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".

CreativeConfig

Configuration des exigences de création pour la source d'inventaire.

Représentation JSON 
{
  "creativeType": enum (CreativeType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "displayCreativeConfig": {
    object (InventorySourceDisplayCreativeConfig)
  },
  "videoCreativeConfig": {
    object (InventorySourceVideoCreativeConfig)
  }
  // End of mutually exclusive fields.
}
Champs
creativeType

enum (CreativeType)

Type de création pouvant être attribué à la source d'inventaire. Seuls les types suivants sont acceptés :

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

Applicable lorsque creative_type est l'un des éléments suivants :

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

Configuration des créations pouvant être attribuées à la source d'inventaire. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
displayCreativeConfig

object (InventorySourceDisplayCreativeConfig)

Configuration des créations display. Applicable lorsque creativeType est défini sur CREATIVE_TYPE_STANDARD.
videoCreativeConfig

object (InventorySourceVideoCreativeConfig)

Configuration des créations vidéo. Applicable lorsque creativeType est défini sur CREATIVE_TYPE_VIDEO.
Fin des champs mutuellement exclusifs.

InventorySourceDisplayCreativeConfig

Configuration des créations display.

Représentation JSON 
{
  "creativeSize": {
    object (Dimensions)
  }
}
Champs
creativeSize

object (Dimensions)

Exigences de taille pour les créations display pouvant être attribuées à la source d'inventaire.

InventorySourceVideoCreativeConfig

Configuration des créations vidéo.

Représentation JSON 
{
  "duration": string
}
Champs
duration

string (Duration format)

Exigences de durée pour les créations vidéo pouvant être attribuées à la source d'inventaire.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"

InventorySourceAccessors

Partenaire ou annonceurs ayant accès à la source d'inventaire.

Représentation JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "partner": {
    object (PartnerAccessor)
  },
  "advertisers": {
    object (AdvertiserAccessors)
  }
  // End of mutually exclusive fields.
}
Champs
Partenaire ou annonceurs ayant accès à la source d'inventaire. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
partner

object (PartnerAccessor)

Partenaire ayant accès à la source d'inventaire.
advertisers

object (AdvertiserAccessors)

Annonceurs ayant accès à la source d'inventaire. Tous les annonceurs doivent appartenir au même partenaire.
Fin des champs mutuellement exclusifs.

PartnerAccessor

Partenaire ayant accès à la source d'inventaire.

Représentation JSON 
{
  "partnerId": string
}
Champs
partnerId

string (int64 format)

ID du partenaire.

AdvertiserAccessors

Annonceurs ayant accès à la source d'inventaire.

Représentation JSON 
{
  "advertiserIds": [
    string
  ]
}
Champs
advertiserIds[]

string (int64 format)

ID des annonceurs.

Méthodes

get

 Récupère un accord de source d'inventaire.

list

 Répertorie les accords de source d'inventaire.