REST Resource: inventorySources

Ressource: InventorySource

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)
    }
  ],
  "subSitePropertyId": string,
  "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. ID unique de la source d'inventaire. Attribué par le système.
displayName

string

Nom à afficher de la source d'inventaire.

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

enum (InventorySourceType)

Indique le type de source d'inventaire.
inventorySourceProductType

enum (InventorySourceProductType)

Uniquement en sortie. Type de produit de la source d'inventaire, indiquant la façon dont elle vend l'inventaire.
commitment

enum (InventorySourceCommitment)

Indique si la source d'inventaire a une diffusion garantie ou non.
deliveryMethod

enum (InventorySourceDeliveryMethod)

Mode de diffusion de la source d'inventaire.

  • Pour les sources d'inventaire non garanties, seule la valeur acceptable est INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC.
  • Pour les sources d'inventaire garanties, les valeurs acceptables sont INVENTORY_SOURCE_DELIVERY_METHOD_TAG et INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC.
dealId

string

ID dans 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 unique entre les places de marché.
status

object (InventorySourceStatus)

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

enum (Exchange)

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

string (Timestamp format)

Uniquement en sortie. Horodatage de la dernière mise à jour de la source d'inventaire. Attribué par le système.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
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 démarre et arrête la diffusion.
creativeConfigs[]

object (CreativeConfig)

Exigences liées aux créations de la source d'inventaire.

Non applicable aux packages d'enchères.
guaranteedOrderId

string

Immuable. ID de la commande garantie à laquelle cette source d'inventaire appartient.

Ne s'applique que lorsque la valeur de commitment est INVENTORY_SOURCE_COMMITMENT_GUARANTEED.
readWriteAccessors

object (InventorySourceAccessors)

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

Résultat 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 disposeront automatiquement d'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. Identifiants 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 ou partenaires indiqués dans 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. Vous ne pouvez pas modifier les sources d'inventaire de ce type de produit via l'API.
PREFERRED_DEAL La source d'inventaire vend l'inventaire par le biais d'un accord préféré.
PRIVATE_AUCTION La source d'inventaire vend l'inventaire par le biais d'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 des accords de tags garantis.
YOUTUBE_RESERVE La source d'inventaire vend l'inventaire via YouTube Reserve.
INSTANT_RESERVE La source d'inventaire vend l'inventaire via la Réservation instantanée. Vous ne pouvez pas modifier les sources d'inventaire de ce type de produit via l'API.
GUARANTEED_PACKAGE La source d'inventaire vend l'inventaire via un package garanti. Vous ne pouvez pas modifier les sources d'inventaire de ce type de produit via l'API.
PROGRAMMATIC_TV La source d'inventaire vend l'inventaire via la TV programmatique. Vous ne pouvez pas modifier les sources d'inventaire de ce type de produit via l'API.
AUCTION_PACKAGE La source d'inventaire vend l'inventaire via un package d'enchères. Vous ne pouvez pas modifier les sources d'inventaire de ce type de produit via l'API.

InventorySourceCommitment

Types d'engagements 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 Le mode de diffusion n'est pas spécifié ou est inconnu dans cette version.
INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC Le mode de diffusion est programmatique.
INVENTORY_SOURCE_DELIVERY_METHOD_TAG La méthode 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 la mise en veille de 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.

Ne s'applique qu'aux sources d'inventaire synchronisées directement à partir des éditeurs. Les valeurs acceptables sont ENTITY_STATUS_ACTIVE et ENTITY_STATUS_PAUSED.
sellerPauseReason

string

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

Ne s'applique qu'aux sources d'inventaire synchronisées directement à partir des éditeurs et lorsque sellerStatus est défini sur ENTITY_STATUS_PAUSED.
configStatus

enum (InventorySourceConfigStatus)

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

Ne s'applique qu'aux sources d'inventaire garanties. Les valeurs acceptables sont INVENTORY_SOURCE_CONFIG_STATUS_PENDING et INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED.

Une source d'inventaire doit être configurée (remplir les champs obligatoires, choisir des créations et sélectionner une campagne par défaut) avant de pouvoir la diffuser.

InventorySourceConfigStatus

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

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 garantie. Dans cet état, la source d'inventaire doit être configurée.
INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED État une fois que l'acheteur a configuré une source d'inventaire garantie.

RateDetails

Paramètres de 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 garanties. Nombre d'impressions garanties par le vendeur.
minimumSpend

object (Money)

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

Ne s'applique qu'aux sources d'inventaire garanties.

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_FLAT Le type de tarif est Tarif forfaitaire.

Monnaie

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

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

string

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

string (int64 format)

Unités entières du montant. Par exemple, si currencyCode correspond à "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 nul. Si units est égal à zéro, nanos peut être positif, zéro ou négatif. Si units est négatif, nanos doit être négatif ou nul. Par exemple, -1,75 $ est représenté par units=-1 et nanos=-750 000 000.

TimeRange

Période

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

string (Timestamp format)

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

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Obligatoire. Limite supérieure (incluse) d'une période.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

CreativeConfig

Configuration des exigences liées aux créations pour la source d'inventaire.

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

  // Union field creative_config_scheme can be only one of the following:
  "displayCreativeConfig": {
    object (InventorySourceDisplayCreativeConfig)
  },
  "videoCreativeConfig": {
    object (InventorySourceVideoCreativeConfig)
  }
  // End of list of possible types for union field creative_config_scheme.
}
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

Champ d'union creative_config_scheme. Applicable lorsque creative_type correspond à l'une des valeurs suivantes:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

Configuration des créations pouvant être attribuées à la source d'inventaire. creative_config_scheme ne peut être qu'un des éléments suivants :
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.

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)

Durée minimale requise 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 
{

  // Union field accessors can be only one of the following:
  "partner": {
    object (PartnerAccessor)
  },
  "advertisers": {
    object (AdvertiserAccessors)
  }
  // End of list of possible types for union field accessors.
}
Champs
Champ d'union accessors. Partenaire ou annonceurs ayant accès à la source d'inventaire. accessors ne peut être qu'un des éléments suivants :
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.

PartnerAccessor

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

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

string (int64 format)

Identifiant du partenaire.

AdvertiserAccessors

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

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

string (int64 format)

Identifiants des annonceurs.

Méthodes

create

 crée une source d'inventaire ;

editInventorySourceReadWriteAccessors

 Modifie les accesseurs en lecture/écriture d'une source d'inventaire.

get

 Récupère une source d'inventaire.

list

 Répertorie les sources d'inventaire auxquelles l'utilisateur actuel peut accéder.

patch

 Met à jour une source d'inventaire existante.