REST Resource: exchanges.orders.products

Ressource : Product

Produit

Représentation JSON 
{
  "name": string,
  "displayName": string,
  "externalDealId": string,
  "transactionType": enum (TransactionType),
  "pricingType": enum (PricingType),
  "updateTime": string,
  "startTime": string,
  "endTime": string,
  "rateDetails": {
    object (RateDetails)
  },
  "creativeConfig": [
    {
      object (CreativeConfig)
    }
  ],
  "makegood": boolean,
  "makegoodDetails": {
    object (MakegoodDetails)
  },
  "creativeSource": enum (CreativeSource),
  "mediumType": enum (MediumType),
  "audienceTargetingConfig": {
    object (AudienceTargetingConfig)
  },
  "targetingCriteria": {
    object (TargetingCriteria)
  },
  "forecastResult": {
    object (ForecastResult)
  },
  "errorDetails": {
    object (ErrorDetails)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "etag": string
}
Champs
name

string

Nom de route relatif pour le produit. Généré par le serveur. Exemple : "exchanges/1234/orders/5678/products/abc". Uniquement en sortie.
displayName

string

Nom à afficher du produit.

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

string

ID externe. Il s'agit de l'ID de l'accord sur le système de la place de marché. 100 caractères max. Les caractères alphanumériques, les traits de soulignement, les tirets et les points sont autorisés. Doit être unique pour tous les produits. Obligatoire.
transactionType

enum (TransactionType)

Type de transaction du produit. Obligatoire.
pricingType

enum (PricingType)

Type de tarification du produit. Obligatoire.
updateTime
(deprecated)

string (Timestamp format)

Code temporel de la dernière mise à jour du produit.

Utilise la norme RFC 3339, où le résultat généré se sert toujours du 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".
startTime

string (Timestamp format)

Heure à laquelle ce produit devient actif. Doit être antérieure à endTime. L'heure de début ne peut pas être postérieure de plus d'un an à la date du jour. Obligatoire.

Utilise la norme RFC 3339, où le résultat généré se sert toujours du 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)

Heure à laquelle ce produit devient inactif. Elle ne peut pas être postérieure à l'année 2036. Obligatoire.

Utilise la norme RFC 3339, où le résultat généré se sert toujours du 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)

Détails du tarif. Obligatoire.
creativeConfig[]

object (CreativeConfig)

Exigences concernant les créations pour un produit. Obligatoire pour les produits de type transaction réservée.
makegood
(deprecated)

boolean

Indique si un produit est un produit de compensation.
makegoodDetails
(deprecated)

object (MakegoodDetails)

Détails de la compensation pour un produit. Obligatoire lorsque le produit est une compensation.
creativeSource

enum (CreativeSource)

Source de la création pour un produit. Facultatif. La valeur par défaut est CREATIVE_SOURCE_ADVERTISER. Ce paramètre ne peut pas être modifié après la création du produit.
mediumType

enum (MediumType)

Type de support pour un produit. En l'absence de spécification, la valeur par défaut est DIGITAL pour assurer la rétrocompatibilité. Ce paramètre ne peut pas être modifié après la création du produit.
audienceTargetingConfig

object (AudienceTargetingConfig)

Facultatif. La configuration du ciblage d'audience sélectionnée a été appliquée au niveau de l'accord sur l'Exchange.
targetingCriteria

object (TargetingCriteria)

Uniquement en sortie. Références aux critères de ciblage de produits. Applicable uniquement aux scénarios d'offres instantanées.
forecastResult

object (ForecastResult)

Résultats des prévisions de produits. Obligatoire lorsque les critères de ciblage ne sont pas vides et que la prévision n'est pas fournie. Applicable uniquement aux scénarios d'offres instantanées.
errorDetails

object (ErrorDetails)

Vous devez spécifier les détails de l'erreur lorsque vous ne pouvez pas mettre à jour des champs de produit spécifiques. Obligatoire lorsque le résultat de la prévision ne peut pas être fourni en raison d'un critère de ciblage ou qu'une mise à jour ne peut pas être apportée au produit. Applicable uniquement aux scénarios d'offres instantanées.
frequencyCap

object (FrequencyCap)

Uniquement en sortie. Limite de la fréquence d'exposition sélectionnée par l'acheteur. Applicable uniquement aux scénarios d'offres instantanées.
etag

string

Etag à spécifier lors de la mise à jour d'un produit. Il ne doit être spécifié pour une mise à jour que si le champ "etag" n'est pas vide. Applicable uniquement aux scénarios d'offres instantanées.

CreativeConfig

Configuration des exigences concernant les créations pour un produit.

Représentation JSON 
{
  "creativeType": enum (CreativeType),
  "dimensionCreativeConfig": {
    object (DimensionCreativeConfig)
  },
  "durationCreativeConfig": {
    object (DurationCreativeConfig)
  }
}
Champs
creativeType

enum (CreativeType)

Type de création. Obligatoire.
dimensionCreativeConfig

object (DimensionCreativeConfig)

Configuration des créations display.

Ce champ n'est pas disponible pour les créations natives (CREATIVE_TYPE_NATIVE).
durationCreativeConfig

object (DurationCreativeConfig)

Configuration des créations vidéo.

CreativeType

Types de créations possibles.

Enums
CREATIVE_TYPE_UNSPECIFIED Type de création non spécifié. Valeur saisie non valide.
CREATIVE_TYPE_DISPLAY Type de création display.
CREATIVE_TYPE_VIDEO Type de création vidéo.
CREATIVE_TYPE_AUDIO Type de création audio.
CREATIVE_TYPE_NATIVE Type de création native.

DimensionCreativeConfig

Dimensions de la création display en pixels.

Représentation JSON 
{
  "width": integer,
  "height": integer
}
Champs
width

integer

Largeur de la création display. Obligatoire.
height

integer

Hauteur de la création display. Obligatoire.

DurationCreativeConfig

Configuration de la création en termes de durée.

Représentation JSON 
{
  "duration": string,
  "durationMatchType": enum (DurationMatchType),
  "skippableMatchType": enum (SkippableMatchType)
}
Champs
duration

string (Duration format)

Durée de la création vidéo en secondes. Obligatoire

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

enum (DurationMatchType)

Critères de correspondance de la durée.
skippableMatchType

enum (SkippableMatchType)

Type de création vidéo désactivable.

DurationMatchType

Formats possibles pour le critère de correspondance de la durée.

Enums
DURATION_MATCH_TYPE_UNSPECIFIED Le critère de correspondance de la durée n'est pas spécifié ou est inconnu dans cette version. Valeur saisie non valide.
DURATION_MATCH_TYPE_EQUAL_TO La durée de la création doit être identique à la durée requise.
DURATION_MATCH_TYPE_LESS_THAN_OR_EQUAL_TO La durée de la création doit être inférieure ou égale à la durée requise.

SkippableMatchType

Formats possibles pour un produit.

Enums
SKIPPABLE_MATCH_TYPE_UNSPECIFIED Le type de vidéo désactivable n'est pas spécifié ou est inconnu dans cette version. Valeur saisie non valide.
SKIPPABLE_MATCH_TYPE_SKIPPABLE La création doit pouvoir être ignorée.
SKIPPABLE_MATCH_TYPE_NOT_SKIPPABLE La création ne doit pas être désactivable.
SKIPPABLE_MATCH_TYPE_ANY La création peut être désactivable ou non.

MakegoodDetails

Configuration des détails de la compensation.

Représentation JSON 
{
  "originalExternalDealId": string,
  "reason": string
}
Champs
originalExternalDealId

string

ID d'accord externe d'origine pour lequel une rediffusion de compensation est demandée. 100 caractères max. Les caractères alphanumériques, les traits de soulignement, les tirets et les points sont autorisés. Obligatoire.
reason

string

Motif de la rediffusion de compensation initiée par le vendeur. 250 caractères maximum. Obligatoire.

CreativeSource

Source de la création : emplacement à partir duquel les créations seront diffusées.

Enums
CREATIVE_SOURCE_UNSPECIFIED La source de la création n'est pas spécifiée ou est inconnue dans cette version. Valeur saisie non valide.
CREATIVE_SOURCE_ADVERTISER Les créations seront diffusées par DV3.
CREATIVE_SOURCE_PUBLISHER Les créations seront diffusées par l'éditeur. Les créations hébergées par l'éditeur ne sont pas acceptées pour le moment. Toute demande visant à définir la source de la création sur CREATIVE_SOURCE_PUBLISHER échouera.

AudienceTargetingConfig

Configuration du ciblage d'audience.

Représentation JSON 
{
  "audienceType": enum (AudienceType)
}
Champs
audienceType

enum (AudienceType)

Type d'audience. Obligatoire.

AudienceType

Type d'audience.

Enums
AUDIENCE_TYPE_UNSPECIFIED Type d'audience non spécifié. Non valide pour la saisie.
AUDIENCE_TYPE_COMMERCE Type d'audience pour le commerce.

TargetingCriteria

Critères de ciblage spécifiés.

Représentation JSON 
{
  "selectedTargetingOptions": [
    {
      object (SelectedTargetingOption)
    }
  ]
}
Champs
selectedTargetingOptions[]

object (SelectedTargetingOption)

Options sélectionnées.

SelectedTargetingOption

Option ou options de ciblage sélectionnées pour un seul type de ciblage.

Représentation JSON 
{
  "type": enum (TargetingType),

  // Union field value can be only one of the following:
  "audienceSelection": {
    object (AudienceSelection)
  },
  "targetingSelection": {
    object (TargetingSelection)
  }
  // End of list of possible types for union field value.
}
Champs
type

enum (TargetingType)

Type de ciblage associé aux options sélectionnées.
Champ d'union value. Vous ne pouvez inclure qu'un seul type de sélection. La sélection choisie doit correspondre à la valeur TargetingType choisie pour le champ "type". value ne peut être qu'un des éléments suivants :
audienceSelection

object (AudienceSelection)

Audience sélectionnée
targetingSelection

object (TargetingSelection)

Ensemble générique d'ID d'options sélectionnées.

TargetingType

Types de ciblage.

Enums
TARGETING_TYPE_UNSPECIFIED Type de ciblage non spécifié, non valide pour la saisie.
TARGETING_TYPE_AUDIENCE Audience de type "ciblage".
TARGETING_TYPE_COUNTRY Pays du type de ciblage.
TARGETING_TYPE_DMA Type de ciblage "dma".
TARGETING_TYPE_PROGRAMMER Type de ciblage du programmeur.
TARGETING_TYPE_BRAND Type de ciblage "Marque".
TARGETING_TYPE_CONTENT_GENRE Genre de contenu du type de ciblage.
TARGETING_TYPE_DEVICE Type de ciblage par appareil.
TARGETING_TYPE_OPERATING_SYSTEM Type de ciblage par système d'exploitation.
TARGETING_TYPE_RATING Classification du type de ciblage.
TARGETING_TYPE_ENVIRONMENT Environnement de type de ciblage.
TARGETING_TYPE_LANGUAGE Langue du type de ciblage.
TARGETING_TYPE_GEO Type de ciblage géographique.
TARGETING_TYPE_AGE Type de ciblage : âge.
TARGETING_TYPE_GENDER Type de ciblage par genre.
TARGETING_TYPE_CONTEXTUAL_SEGMENT Segment contextuel de type ciblage.
TARGETING_TYPE_REQUEST_FORMAT Format de la demande de type de ciblage.
TARGETING_TYPE_PUBLISHER Type de ciblage de l'éditeur.
TARGETING_TYPE_INVENTORY_SIZE Taille du type de ciblage.
TARGETING_TYPE_NETWORK Réseau de type de ciblage.
TARGETING_TYPE_PLATFORM Plate-forme de type de ciblage.
TARGETING_TYPE_VIDEO_DELIVERY_TYPE Type de ciblage du type de diffusion vidéo.
TARGETING_TYPE_VIDEO_MINIMUM_PLAYER_SIZE Taille minimale du lecteur vidéo pour le type de ciblage.

AudienceSelection

Options de ciblage d'audience sélectionnées.

Représentation JSON 
{
  "includedOrGroups": [
    {
      object (OrGroup)
    }
  ],
  "excludedOptionIds": [
    string
  ]
}
Champs
includedOrGroups[]

object (OrGroup)

Les options incluses sont associées à l'opérateur AND. Chaque option incluse peut être une option individuelle ou un groupe d'options associées à l'opérateur OR.
excludedOptionIds[]

string (int64 format)

Les options exclues sont associées à l'opérateur OR.

OrGroup

Groupe d'options sélectionnées combinées par un OU.

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

string (int64 format)

ID des options sélectionnées.

TargetingSelection

Ensemble d'un ou plusieurs ID d'options sélectionnés, applicable à la plupart des types de ciblage.

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

string (int64 format)

ID des options sélectionnées.

ForecastResult

Résultat de prévision spécifié.

Représentation JSON 
{
  "forecasts": [
    {
      object (Forecast)
    }
  ]
}
Champs
forecasts[]

object (Forecast)

Prévisions. "forecastCategory" doit être unique pour chaque élément spécifié.

Prévision

Prévision de la catégorie de prévision spécifiée.

Représentation JSON 
{
  "forecastCategory": enum (ForecastCategory),

  // Union field forecast_data can be only one of the following:
  "number": string,
  "percentage": integer,
  "cpmPrice": {
    object (Money)
  },
  "cpmRange": {
    object (CpmRange)
  },
  "forecastBreakdownData": {
    object (ForecastBreakdownData)
  }
  // End of list of possible types for union field forecast_data.
}
Champs
forecastCategory

enum (ForecastCategory)

Catégorie de prévision spécifiée représentée par la statistique de prévision.
Champ d'union forecast_data. Vous ne pouvez inclure qu'un seul type de données statistiques. Les données renseignées doivent correspondre au champ "forecastCategory". forecast_data ne peut être qu'un des éléments suivants :
number

string (int64 format)

Données numériques.
percentage

integer

Données en pourcentage.
cpmPrice

object (Money)

Données sur le prix du CPM.
cpmRange

object (CpmRange)

Données sur la plage de prix du CPM.
forecastBreakdownData

object (ForecastBreakdownData)

Données de répartition des prévisions.

ForecastCategory

Catégorie de prévision.

Enums
FORECAST_CATEGORY_UNSPECIFIED Catégorie non spécifiée. Non valide pour la saisie.
FORECAST_CATEGORY_TOTAL_OPPORTUNITIES Nombre total d'opportunités. Données numériques.
FORECAST_CATEGORY_TOTAL_AUDIENCE Audience totale Données numériques.
FORECAST_CATEGORY_DIGITAL_TRP Points de couverture cible numérique. Données en pourcentage.
FORECAST_CATEGORY_SUGGESTED_CPM Prix au CPM suggéré Plage de CPM ou données sur le prix du CPM
FORECAST_CATEGORY_UNIQUE_REACH Prévoyez la couverture unique. Données numériques.
FORECAST_CATEGORY_FORECAST_BREAKDOWN Répartition des prévisions. Données de répartition des prévisions.

CpmRange

La plage de CPM contient le CPM minimal et maximal.

Représentation JSON 
{
  "minCpm": {
    object (Money)
  },
  "maxCpm": {
    object (Money)
  }
}
Champs
minCpm

object (Money)

Limite inférieure de la plage de CPM.
maxCpm

object (Money)

Limite supérieure de la plage de CPM.

ForecastBreakdownData

Les données de répartition des prévisions contiennent une liste de répartitions des prévisions.

Représentation JSON 
{
  "forecastBreakdowns": [
    {
      object (ForecastBreakdown)
    }
  ]
}
Champs
forecastBreakdowns[]

object (ForecastBreakdown)

Liste des répartitions des prévisions.

ForecastBreakdown

Répartition des prévisions pour l'option de ciblage sélectionnée.

Représentation JSON 
{
  "selectedTargetingOption": {
    object (SelectedTargetingOption)
  },

  // Union field breakdown_data can be only one of the following:
  "impressions": string
  // End of list of possible types for union field breakdown_data.
}
Champs
selectedTargetingOption

object (SelectedTargetingOption)

Option ou options de ciblage sélectionnées pour un seul type de ciblage.
Champ d'union breakdown_data. Vous ne pouvez inclure qu'un seul type de données de répartition. breakdown_data ne peut être qu'un des éléments suivants :
impressions

string (int64 format)

Prévoir les impressions.

ErrorDetails

Détails de l'erreur spécifiés lorsque la mise à jour comporte des erreurs.

Représentation JSON 
{
  "message": string,
  "instantDealErrorStatus": enum (InstantDealErrorStatus)
}
Champs
message

string

Message spécifié lorsque la mise à jour comporte des erreurs.
instantDealErrorStatus

enum (InstantDealErrorStatus)

État d'erreur spécifié lorsque la mise à jour des offres instantanées comporte des erreurs.

InstantDealErrorStatus

État d'erreur spécifié lorsque la mise à jour instantanée d'une offre présente des erreurs.

Enums
INSTANT_DEAL_ERROR_STATUS_UNSPECIFIED État d'erreur non spécifié.
INSTANT_DEAL_ERROR_STATUS_INVENTORY_UNAVAILABLE L'état d'erreur indique que l'inventaire n'est pas disponible.
INSTANT_DEAL_ERROR_STATUS_FORECAST_UNAVAILABLE L'état d'erreur indique que les prévisions ne sont pas disponibles.
INSTANT_DEAL_ERROR_STATUS_INVALID_INPUT L'état d'erreur indique que certains champs de saisie ne sont pas valides.

FrequencyCap

Nombre de fois où un utilisateur peut voir la même annonce au cours d'une période donnée

Représentation JSON 
{
  "timeUnit": enum (TimeUnit),
  "maxImpressions": string
}
Champs
timeUnit

enum (TimeUnit)

Unité de temps dans laquelle la limite de la fréquence d'exposition sera appliquée.
maxImpressions

string (int64 format)

Nombre maximal de fois où un utilisateur peut voir la même annonce au cours de cette période.

TimeUnit

Unité de temps dans laquelle la limite de la fréquence d'exposition sera appliquée.

Enums
TIME_UNIT_UNSPECIFIED Unité de temps non spécifiée.
TIME_UNIT_LIFETIME La limite de la fréquence d'exposition s'appliquera pendant toute la durée de vie.
TIME_UNIT_MONTHS La limite de la fréquence d'exposition sera appliquée à un certain nombre de mois.
TIME_UNIT_WEEKS La limite de fréquence sera appliquée à un certain nombre de semaines.
TIME_UNIT_DAYS La limite de la fréquence d'exposition sera appliquée à un certain nombre de jours.

Méthodes

create

 Crée un produit.

get

 Récupère un produit.

list

 Liste les produits.

patch

 Met à jour un produit.