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)
  },
  "program": string,
  "buyerCustomParameters": {
    string: string,
    ...
  },
  "etag": string
}
Champs
name

string

Nom de ressource relatif du 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é en UTF-8 avec une taille maximale de 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 autorisés sont les caractères alphanumériques, les traits de soulignement, les tirets et les points. Il 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ù 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".
startTime

string (Timestamp format)

Heure à laquelle ce produit devient actif. Doit être antérieure à endTime. L'heure de début ne peut pas être située plus d'un an dans le futur. Obligatoire.

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)

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

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)

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 création d'un produit. Facultatif, la valeur par défaut est CREATIVE_SOURCE_ADVERTISER. Non modifiable après la création du produit.
mediumType

enum (MediumType)

Type de support d'un produit. En l'absence de spécification, la valeur par défaut est DIGITAL pour assurer la rétrocompatibilité. Non modifiable après la création du produit.
audienceTargetingConfig

object (AudienceTargetingConfig)

Facultatif. La configuration du ciblage d'audience est appliquée au niveau de l'accord sur la place de marché.
targetingCriteria

object (TargetingCriteria)

Uniquement en sortie. Références des critères de ciblage de produits. Applicable uniquement aux scénarios d'accords instantanés.
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'accords instantanés.
errorDetails

object (ErrorDetails)

Vous devez spécifier les détails de l'erreur lorsque certains champs de produit ne peuvent pas être mis à jour. 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 effectuée sur le produit. Applicable uniquement aux scénarios d'accords instantanés.
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'accords instantanés.
program

string

Uniquement en sortie. Programme dans le cadre duquel l'acheteur a créé l'accord instantané. Laissez ce champ vide pour le flux d'échange standard. Applicable uniquement aux scénarios d'accord instantané.
buyerCustomParameters

map (key: string, value: string)

Uniquement en sortie. Paramètres de clé/valeur personnalisés définis par l'acheteur dans la demande d'accord instantané. Applicable uniquement aux scénarios d'accords instantanés.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
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'accords instantanés.

CreativeConfig

Configuration des exigences de création 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 compatible avec 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. Cette option n'est pas disponible pour les produits de type de transaction RESERVED.

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

Critères de correspondance pour la durée de la création vidéo.

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

Critères de correspondance permettant de déterminer si une création vidéo est désactivable.

Enums
SKIPPABLE_MATCH_TYPE_UNSPECIFIED Le type d'annonce 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 être désactivable.
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 désactivable.

MakegoodDetails

Configuration des détails de la compensation.

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

string

ID de l'accord externe d'origine pour lequel une compensation est demandée. 100 caractères max. Les caractères autorisés sont les caractères alphanumériques, les traits de soulignement, les tirets et les points. 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 DV360.
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 requête tentant de 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é. Entrée non valide.
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(s) de ciblage sélectionnée(s) pour un seul type de ciblage.

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "audienceSelection": {
    object (AudienceSelection)
  },
  "targetingSelection": {
    object (TargetingSelection)
  }
  // End of mutually exclusive fields.
}
Champs
type

enum (TargetingType)

Type de ciblage associé aux options sélectionnées.
Vous ne pouvez inclure qu'un seul type de sélection. La sélection choisie doit correspondre au TargetingType choisi pour le champ type. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
audienceSelection

object (AudienceSelection)

Audience sélectionnée.
targetingSelection

object (TargetingSelection)

Ensemble générique d'ID d'options sélectionnées.
Fin des champs mutuellement exclusifs.

TargetingType

Types de ciblage.

Enums
TARGETING_TYPE_UNSPECIFIED Type de ciblage non spécifié, non valide pour l'entrée.
TARGETING_TYPE_AUDIENCE Type de ciblage : audience.
TARGETING_TYPE_COUNTRY Type de ciblage : pays.
TARGETING_TYPE_DMA Type de ciblage : DMA.
TARGETING_TYPE_PROGRAMMER Programmeur de type de ciblage.
TARGETING_TYPE_BRAND Type de ciblage "Marque".
TARGETING_TYPE_CONTENT_GENRE Type de ciblage "Genre de contenu".
TARGETING_TYPE_DEVICE Type de ciblage : appareil.
TARGETING_TYPE_OPERATING_SYSTEM Type de ciblage par système d'exploitation.
TARGETING_TYPE_RATING Note du type de ciblage.
TARGETING_TYPE_ENVIRONMENT Type de ciblage : environnement.
TARGETING_TYPE_LANGUAGE Type de ciblage linguistique.
TARGETING_TYPE_GEO Type de ciblage géographique.
TARGETING_TYPE_AGE Type de ciblage par âge.
TARGETING_TYPE_GENDER Type de ciblage par genre.
TARGETING_TYPE_CONTEXTUAL_SEGMENT Segment contextuel de type de ciblage.
TARGETING_TYPE_REQUEST_FORMAT Format de la requête de type de ciblage.
TARGETING_TYPE_PUBLISHER Éditeur du type de ciblage.
TARGETING_TYPE_INVENTORY_SIZE Taille du type de ciblage.
TARGETING_TYPE_NETWORK Réseau de type de ciblage.
TARGETING_TYPE_PLATFORM Type de ciblage : plate-forme.
TARGETING_TYPE_VIDEO_DELIVERY_TYPE Type de ciblage "Type de diffusion vidéo".
TARGETING_TYPE_VIDEO_MINIMUM_PLAYER_SIZE Type de ciblage "Taille minimale du lecteur vidéo".
TARGETING_TYPE_VIDEO_COMPLETION Type de ciblage : emplacement vidéo.
TARGETING_TYPE_VIEWABILITY Visibilité du type de ciblage.
TARGETING_TYPE_REWARDED Type de ciblage : avec récompense.
TARGETING_TYPE_VIDEO_AD_DURATION_THRESHOLD_SEC Seuil de durée de l'annonce vidéo pour le type de ciblage (en secondes).
TARGETING_TYPE_VIDEO_PLACEMENT Type de ciblage : emplacement vidéo.
TARGETING_TYPE_VIDEO_PLAYBACK_METHOD Type de ciblage "Mode de lecture des vidéos".
TARGETING_TYPE_APP_ID ID d'application du type de ciblage.
TARGETING_TYPE_DOMAIN_URL URL de domaine de type de ciblage.
TARGETING_TYPE_CTR Taux de clics du type de ciblage.
TARGETING_TYPE_DEMOGRAPHICS Type de ciblage démographique.
TARGETING_TYPE_RESTRICTED_CATEGORY Type de ciblage : catégorie restreinte.
TARGETING_TYPE_AD_POSITION Type de ciblage : position de l'annonce.
TARGETING_TYPE_DAY_AND_TIME Type de ciblage par date et heure.
TARGETING_TYPE_RETAIL_MEDIA_AUDIENCE Type de ciblage "audience retail media".

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'aide de l'opérateur ET. Chaque option incluse peut être une option individuelle ou un groupe d'options associées à l'aide de l'opérateur OU.
excludedOptionIds[]

string (int64 format)

Les options exclues sont associées à l'aide de l'opérateur OU.

OrGroup

Groupe d'options sélectionnées associées par l'opérateur OU.

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

string (int64 format)

ID des options sélectionnées.

TargetingSelection

Options de ciblage sélectionnées et exclues, applicables à la plupart des types de ciblage.

Représentation JSON 
{
  "optionIds": [
    string
  ],
  "externalIds": [
    string
  ],
  "excludedOptionIds": [
    string
  ],
  "excludedExternalIds": [
    string
  ]
}
Champs
optionIds[]

string (int64 format)

Uniquement en sortie. ID des options de ciblage DV360 sélectionnées partagés avec la place de marché. Peut être renvoyé avec excludedOptionIds tant que les deux listes ne se chevauchent pas.
externalIds[]

string

Uniquement en sortie. ID des options de ciblage sélectionnées fournis par la place de marché. Peut être renvoyé avec excludedExternalIds tant que les deux listes ne se chevauchent pas.
excludedOptionIds[]

string (int64 format)

Uniquement en sortie. ID des options de ciblage DV3 exclues partagés avec la place de marché. Peut être renvoyé avec optionIds tant que les deux listes ne se chevauchent pas.
excludedExternalIds[]

string

Uniquement en sortie. ID des options de ciblage exclues fournis par la place de marché. Peut être renvoyé avec externalIds tant que les deux listes ne se chevauchent pas.

ForecastResult

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

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

object (Forecast)

Prévision. 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),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "number": string,
  "percentage": integer,
  "cpmPrice": {
    object (Money)
  },
  "cpmRange": {
    object (CpmRange)
  },
  "forecastBreakdownData": {
    object (ForecastBreakdownData)
  }
  // End of mutually exclusive fields.
}
Champs
forecastCategory

enum (ForecastCategory)

Catégorie de prévision spécifiée représentée par la statistique de prévision.
Vous ne pouvez inclure qu'un seul type de données statistiques. Les données renseignées doivent correspondre au champ forecastCategory. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
number

string (int64 format)

Données numériques.
percentage

integer

Données de pourcentage.
cpmPrice

object (Money)

Données sur les prix au CPM.
cpmRange

object (CpmRange)

Données sur la gamme de prix au CPM.
forecastBreakdownData

object (ForecastBreakdownData)

Données de répartition des prévisions.
Fin des champs mutuellement exclusifs.

ForecastCategory

Catégorie de prévision.

Enums
FORECAST_CATEGORY_UNSPECIFIED Catégorie non spécifiée. Entrée non valide.
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ériques. Données de pourcentage.
FORECAST_CATEGORY_SUGGESTED_CPM Prix au CPM suggéré. Plage de CPM ou données sur les prix au CPM.
FORECAST_CATEGORY_UNIQUE_REACH Prévoir 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)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "impressions": string
  // End of mutually exclusive fields.
}
Champs
selectedTargetingOption

object (SelectedTargetingOption)

Option(s) de ciblage sélectionnée(s) pour un seul type de ciblage.
Vous ne pouvez inclure qu'un seul type de données de répartition. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
impressions

string (int64 format)

Prévoir les impressions.
Fin des champs mutuellement exclusifs.

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

Le message spécifié lors de la mise à jour comporte des erreurs.
instantDealErrorStatus

enum (InstantDealErrorStatus)

État d'erreur spécifié lorsque la mise à jour comporte des erreurs pour les accords instantanés.

InstantDealErrorStatus

État d'erreur spécifié lorsque la mise à jour de l'accord instantané comporte 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 des champs de saisie ne sont pas valides.

FrequencyCap

Nombre de fois qu'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 sera appliquée à l'ensemble de 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 la fréquence d'exposition 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

 Répertorie les produits.

patch

 Met à jour un produit.