REST Resource: products

Ressource : Product

Un seul produit.

Représentation JSON
{
  "name": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "creativeSpecifications": [
    {
      object (CreativeSpecification)
    }
  ],
  "bookingLeadTime": string,
  "assignmentLeadTime": string,
  "minFlightDuration": string,
  "maxFlightDuration": string,
  "slotDuration": string,
  "createTime": string,
  "updateTime": string,
  "currencyCode": string
}
Champs
name

string

Nom de ressource du produit au format products/{id}. Exemple : products/product123.

externalId

string

Facultatif. Identifiant utilisé pour mapper cette entité à des sources externes.

displayName

string

Obligatoire. Nom à afficher du produit.

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

description

string

Facultatif. Champ de forme libre supplémentaire permettant de décrire le produit.

labels

map (key: string, value: string)

Facultatif. Ensemble d'étiquettes de forme libre pour décrire ce produit.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

creativeSpecifications[]

object (CreativeSpecification)

Obligatoire. Liste des créations autorisées pouvant être diffusées pour ce produit.

bookingLeadTime

string (Duration format)

Obligatoire. Délai de livraison requis pour réserver le produit. La valeur + bookingLeadTime doit désormais être postérieure à la date de début du vol.

Durée en secondes avec neuf chiffres au maximum après la virgule. Se termine par "s". Example : "3.5s".

assignmentLeadTime

string (Duration format)

Obligatoire. Délai de livraison requis pour l'attribution des créations.

Durée en secondes avec neuf chiffres au maximum après la virgule. Se termine par "s". Example : "3.5s".

minFlightDuration

string (Duration format)

Facultatif. Durée de diffusion minimale pour ce produit.

Durée en secondes avec neuf chiffres au maximum après la virgule. Se termine par "s". Example : "3.5s".

maxFlightDuration

string (Duration format)

Obligatoire. Durée de diffusion maximale pour ce produit.

Durée en secondes avec neuf chiffres au maximum après la virgule. Se termine par "s". Example : "3.5s".

slotDuration

string (Duration format)

Obligatoire. Durée du créneau pour ce produit.

Durée en secondes avec neuf chiffres au maximum après la virgule. Se termine par "s". Example : "3.5s".

createTime

string (Timestamp format)

Uniquement en sortie. Code temporel de création du produit.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

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

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

currencyCode

string

Code de devise en majuscules à trois lettres défini dans la norme ISO 4217.

Méthodes

create

Crée un produit.

get

Récupère un produit individuel.

list

Liste les produits.

patch

Met à jour un produit existant.