REST Resource: adUnits

Ressource: AdUnit

Un seul bloc d'annonces.

Représentation JSON 
{
  "name": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "attributes": [
    enum (AdUnitAttribute)
  ],
  "creatives": [
    {
      object (CreativeSpecification)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "state": enum (AdUnitState),
  "rejectedReason": string,
  "location": {
    object (LatLng)
  },
  "directionSet": boolean,
  "direction": integer,
  "elevationMetersSet": boolean,
  "elevationMeters": number,
  "physicalWidthMetersSet": boolean,
  "physicalWidthMeters": number,
  "physicalHeightMetersSet": boolean,
  "physicalHeightMeters": number,
  "venue": enum (OutOfHomeVenue),
  "fixedLocation": boolean,
  "indoors": boolean,
  "impressionDataRanges": [
    {
      object (ImpressionDataRange)
    }
  ],
  "photoUrls": [
    string
  ],
  "products": [
    string
  ]
}
Champs
name

string

Nom de ressource du bloc d'annonces au format adUnits/{id}. Exemple : adUnits/adUnit123.
externalId

string

Facultatif. Identifiant géré par le vendeur, probablement dans son propre système. Une fois défini, il est peu probable qu'il change. Il ne doit pas être utilisé en interne et les contraintes ne sont pas appliquées.
displayName

string

Obligatoire. Nom à afficher du bloc d'annonces.

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

string

Facultatif. Champ libre supplémentaire permettant de décrire le bloc d'annonces.
labels

map (key: string, value: string)

Facultatif. Ensemble de libellés de format libre pour décrire ce bloc d'annonces.

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

enum (AdUnitAttribute)

Facultatif. Attributs permettant de définir plus précisément ce bloc d'annonces.
creatives[]

object (CreativeSpecification)

Facultatif. Liste des créations autorisées pouvant être diffusées pour ce bloc d'annonces. Cela peut également être défini au niveau du produit.
createTime

string (Timestamp format)

Uniquement en sortie. Code temporel de création du bloc d'annonces.

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 pour le bloc d'annonces.

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

enum (AdUnitState)

Uniquement en sortie. État du bloc d'annonces. Si AD_UNIT_STATE_REJECTED, le motif de la réponse est renvoyé.
rejectedReason

string

Uniquement en sortie. Si le champ "approval_status" est défini sur "AD_UNIT_APPROVAL_STATUS_REJECTED", ce champ contient la raison.
location

object (LatLng)

Obligatoire. Immuable. Latitude et longitude du bloc d'annonces au format degrés signés.
directionSet

boolean

Obligatoire. "True" si la direction est définie.
direction

integer

Facultatif. Immuable. Direction cardinale en degrés, le nord représentant 0. [0-360]).
elevationMetersSet

boolean

Obligatoire. Vrai si ElevationMeters est défini.
elevationMeters

number

Facultatif. Immuable. Distance entre le bas du bloc d'annonces et le sol, exprimée en mètres.
physicalWidthMetersSet

boolean

Obligatoire. Vrai si physiqueWidthMeters est défini.
physicalWidthMeters

number

Facultatif. Immuable. Largeur physique du bloc d'annonces, exprimée en mètres.
physicalHeightMetersSet

boolean

Obligatoire. Vrai si physiqueHeightMeters est défini.
physicalHeightMeters

number

Facultatif. Immuable. Hauteur physique du bloc d'annonces, exprimée en mètres.
venue

enum (OutOfHomeVenue)

Facultatif. Type de lieu de l'événement extérieur selon les normes du DPAA. Ce champ d'information peut être présenté aux annonceurs et permet également de filtrer des blocs d'annonces.
fixedLocation

boolean

Facultatif. Indique si l'annonce est à un emplacement fixe (panneau d'affichage) ou mobile (taxi).
indoors

boolean

Obligatoire. Indique si le bloc d'annonces est à l'intérieur.
impressionDataRanges[]

object (ImpressionDataRange)

Obligatoire. Plages de données sur les impressions associées à ce bloc d'annonces. Les plages de dates ne doivent pas se chevaucher. Les données sur les impressions sont nécessaires pour que le bloc d'annonces puisse être acheté.
photoUrls[]

string

Facultatif. URL des photos du bloc d'annonces.
products[]

string

Obligatoire. Noms de ressources des produits associés à ce bloc d'annonces au format products/{id}. Exemple : products/product123.

AdUnitAttribute

Attributs possibles utilisés pour affiner la définition du bloc d'annonces.

Enums
AD_UNIT_ATTRIBUTE_UNSPECIFIED Valeur par défaut lorsque l'attribut du bloc d'annonces n'est pas spécifié ou est inconnu dans cette version.
AD_UNIT_ATTRIBUTE_ILLUMINATED Le bloc d'annonces est-il visible dans l'obscurité s'il se trouve dans le monde réel ?
AD_UNIT_ATTRIBUTE_DIGITAL Un bloc d'annonces numériques est implicite, s'il n'est pas inclus dans un format physique classique.
AD_UNIT_ATTRIBUTE_PHYSICAL Le bloc d'annonces existe dans le monde physique en tant qu'objet.

AdUnitState

État d'un bloc d'annonces du point de vue du vendeur

Enums
AD_UNIT_STATE_UNSPECIFIED Valeur par défaut lorsque l'état du bloc d'annonces n'est pas spécifié ou est inconnu dans cette version.
AD_UNIT_STATE_PENDING Le bloc d'annonces est en attente d'approbation.
AD_UNIT_STATE_APPROVED Le bloc d'annonces est approuvé.
AD_UNIT_STATE_REJECTED Le bloc d'annonces a été refusé.
AD_UNIT_STATE_DELETED Le bloc d'annonces a été supprimé.

OutOfHomeVenue

Liste des types de lieux de visionnage en extérieur basés sur les normes DPAA.

Enums
OOH_VENUE_UNSPECIFIED Valeur par défaut lorsque le lieu de publicité extérieure n'est pas spécifié ou est inconnu dans cette version.
OOH_VENUE_AIRBORNE Salle de spectacle en extérieur classée dans la catégorie des vols aériens.
OOH_VENUE_AIRPORTS_GENERAL Lieux de publicité extérieure classés dans la catégorie "Aéroports" (général).
OOH_VENUE_AIRPORTS_BAGGAGE_CLAIM Lieu de réception extérieur classé comme zone de retrait des bagages dans les aéroports.
OOH_VENUE_AIRPORTS_TERMINAL Établissement de publicité extérieure classé dans la catégorie "Terminal des aéroports".
OOH_VENUE_AIRPORTS_LOUNGES Établissement de plein air classé comme "salons" dans les aéroports.
OOH_VENUE_ATMS Établissement de publicité extérieure classé dans la catégorie "Distributeurs de billets".
OOH_VENUE_BACKLIGHTS Salle de extérieur classée dans la catégorie "Rétroéclairages".
OOH_VENUE_BARS Publicité extérieure classée dans la catégorie "bars".
OOH_VENUE_BENCHES Lieux en extérieur classés dans la catégorie des bancs.
OOH_VENUE_BIKE_RACKS Site extérieur classé comme range-vélos.
OOH_VENUE_BULLETINS Lieux de publicité extérieure classés dans la catégorie "Bulletins".
OOH_VENUE_BUSES Établissement de publicité extérieure classé dans la catégorie "bus".
OOH_VENUE_CAFES Publicité extérieure classée dans la catégorie "Cafés".
OOH_VENUE_CASUAL_DINING_RESTAURANTS Établissement extérieur classé dans la catégorie "restaurants à l'ambiance détendue".
OOH_VENUE_CHILD_CARE Établissement de loisirs à l'extérieur classé comme garde d'enfants.
OOH_VENUE_CINEMA Publicité extérieure classée dans la catégorie "cinéma".
OOH_VENUE_CITY_INFORMATION_PANELS Lieux de publicité extérieure classés comme panneaux d'informations sur la ville.
OOH_VENUE_CONVENIENCE_STORES Publicité extérieure classée dans la catégorie des supérettes.
OOH_VENUE_DEDICATED_WILD_POSTING Établissement de publicité extérieure catégorisé comme étant réservé aux adultes.
OOH_VENUE_DOCTORS_OFFICES_GENERAL Lieu de prise de vue en extérieur classé dans la catégorie "Cabinets médicaux généraux".
OOH_VENUE_DOCTORS_OFFICES_OBSTETRICS Salle extérieure classée dans la catégorie des cabinets médicaux et obstétriques.
OOH_VENUE_DOCTORS_OFFICES_PEDIATRICS Salle de réception extérieure classée dans la catégorie des cabinets médicaux et pédiatriques.
OOH_VENUE_FAMILY_ENTERTAINMENT Publicité extérieure classée dans la catégorie "divertissement familial".
OOH_VENUE_FERRIES Site de publicité extérieure classé dans la catégorie des ferries.
OOH_VENUE_FINANCIAL_SERVICES Établissement de publicité extérieure classé dans la catégorie "Services financiers".
OOH_VENUE_GAS_STATIONS Lieu de prise de vue extérieur classé dans la catégorie "Station-service".
OOH_VENUE_GOLF_COURSES Site extérieur classé dans la catégorie des parcours de golf.
OOH_VENUE_GYMS Lieu de prise de vue extérieur classé dans la catégorie "Salles de sport".
OOH_VENUE_HOSPITALS Établissement de publicité extérieure classé dans la catégorie des hôpitaux.
OOH_VENUE_HOTELS Établissement de publicité extérieure classé dans la catégorie "Hôtels".
OOH_VENUE_JUNIOR_POSTERS Lieu de sortie en extérieur classé dans la catégorie "affiches junior".
OOH_VENUE_KIOSKS Établissement de publicité extérieure classé dans la catégorie des kiosques.
OOH_VENUE_MALLS_GENERAL Publicité extérieure classée dans la catégorie "Centres commerciaux"
OOH_VENUE_MALLS_FOOD_COURTS Publicité extérieure classée dans la catégorie des aires de restauration de centres commerciaux.
OOH_VENUE_MARINE Lieu de visionnage en extérieur classé dans la catégorie "marine".
OOH_VENUE_MOBILE_BILLBOARDS Publicité extérieure classée dans la catégorie "Panneaux d'affichage mobiles".
OOH_VENUE_MOVIE_THEATER_LOBBIES Salle de cinéma en extérieur classée dans la catégorie "Hall d'un cinéma".
OOH_VENUE_NEWSSTANDS Publicité extérieure classée dans la catégorie des kiosques à journaux.
OOH_VENUE_OFFICE_BUILDINGS Lieux de publicité extérieure classés dans la catégorie des immeubles de bureaux.
OOH_VENUE_PHONE_KIOSKS Établissement de publicité extérieure classé dans la catégorie des kiosques téléphoniques.
OOH_VENUE_POSTERS Salle de spectacle en extérieur classée dans la catégorie "affiches".
OOH_VENUE_QSR Lieu de prise de vue en extérieur classé dans la catégorie "Qsr".
OOH_VENUE_RAIL Site de publicité extérieure classé dans la catégorie "train".
OOH_VENUE_RECEPTACLES Lieu de prise de vue extérieur classé dans la catégorie "Réceptacles".
OOH_VENUE_RESORTS Établissement de publicité extérieure classé dans la catégorie "Complexes hôteliers".
OOH_VENUE_RETAIL Publicité extérieure appartenant à la catégorie "Commerce de détail".
OOH_VENUE_SALONS Établissement extérieur classé dans la catégorie "Salons de beauté".
OOH_VENUE_SHELTERS Lieu de prise de vue extérieur classé comme refuges.
OOH_VENUE_SPORTS_ARENAS Stade extérieur classé dans la catégorie "arènes sportives".
OOH_VENUE_SUBWAY Lieu de prise de vue extérieur classé dans la catégorie "Métro".
OOH_VENUE_TAXIS Établissement de publicité extérieure classé dans la catégorie des taxis.
OOH_VENUE_TRUCKSIDE Lieu de prise de vue extérieur classé comme côté camion.
OOH_VENUE_UNIVERSITIES Lieux de publicité extérieure classés dans la catégorie des universités.
OOH_VENUE_URBAN_PANELS Site de publicité extérieure classé dans la catégorie des panels urbains.
OOH_VENUE_VETERINARIAN_OFFICES Lieu de prise de vue extérieur classé dans la catégorie des cabinets vétérinaires.
OOH_VENUE_WALLS Site de publicité extérieure classé dans la catégorie "murs".
OOH_VENUE_OTHER Lieu de prise de vue en extérieur classé dans la catégorie "Autre".

ImpressionDataRange

Données sur les impressions pour une plage de dates

Représentation JSON 
{
  "impressionDataStartTime": string,
  "impressionDataEndTime": string,
  "impressionDataUnits": [
    {
      object (ImpressionDataUnit)
    }
  ]
}
Champs
impressionDataStartTime

string (Timestamp format)

Obligatoire. Début de l'intervalle pendant lequel les données d'impression sont valides (incluses).

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

string (Timestamp format)

Obligatoire. Fin de l'intervalle au cours duquel les données d'impression sont valides (exclues).

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".
impressionDataUnits[]

object (ImpressionDataUnit)

Obligatoire. Données sur les impressions pour la période spécifiée.

ImpressionDataUnit

Données sur les impressions pour un jour de la semaine et des heures de la journée donnés.

Représentation JSON 
{
  "dayOfWeek": enum (DayOfWeek),
  "hourOfDay": integer,
  "impressions": string
}
Champs
dayOfWeek

enum (DayOfWeek)

Obligatoire. Jour de la semaine représenté par les données d'impression.
hourOfDay

integer

Obligatoire. Heures de la journée représentées par les données d'impression au format 24 heures. Elle doit être comprise entre 0 à 23.
impressions

string (int64 format)

Obligatoire. Nombre d'impressions le jour de la semaine spécifié aux heures de la journée spécifiées.

Méthodes

create

 Crée un bloc d'annonces.

delete

 Supprime un bloc d'annonces existant.

get

 Récupère un bloc d'annonces individuel.

list

 Liste les blocs d'annonces.

patch

 Met à jour un bloc d'annonces existant.