REST Resource: advertisers.adGroupAds

Ressource : AdGroupAd

Une seule annonce associée à un groupe d'annonces.

Représentation JSON 
{
  "name": string,
  "advertiserId": string,
  "adGroupAdId": string,
  "adGroupId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "adUrls": [
    {
      object (AdUrl)
    }
  ],

  // Union field ad_details can be only one of the following:
  "displayVideoSourceAd": {
    object (DisplayVideoSourceAd)
  },
  "mastheadAd": {
    object (MastheadAd)
  },
  "inStreamAd": {
    object (InStreamAd)
  },
  "nonSkippableAd": {
    object (NonSkippableAd)
  },
  "bumperAd": {
    object (BumperAd)
  },
  "audioAd": {
    object (AudioAd)
  },
  "videoDiscoverAd": {
    object (VideoDiscoveryAd)
  },
  "videoPerformanceAd": {
    object (VideoPerformanceAd)
  }
  // End of list of possible types for union field ad_details.
}
Champs
name

string

Nom de ressource de l'annonce.
advertiserId

string (int64 format)

Identifiant unique de l'annonceur auquel appartient l'annonce.
adGroupAdId

string (int64 format)

Identifiant unique de l'annonce. Attribué par le système.
adGroupId

string (int64 format)

Identifiant unique du groupe d'annonces auquel appartient l'annonce.
displayName

string

Nom à afficher de l'annonce.

Doit être encodé au format UTF-8 et ne pas dépasser 255 octets.
entityStatus

enum (EntityStatus)

État de l'entité de l'annonce.
adUrls[]

object (AdUrl)

Liste des URL utilisées par l'annonce.
Champ d'union ad_details. Détails de l'annonce. ad_details ne peut être qu'un des éléments suivants :
displayVideoSourceAd

object (DisplayVideoSourceAd)

Détails d'une annonce provenant d'une création Display & Video 360.
mastheadAd

object (MastheadAd)

Détails d'une annonce diffusée dans le flux d'accueil YouTube.
inStreamAd

object (InStreamAd)

Détails d'une annonce InStream désactivable au bout de cinq secondes, utilisée pour les objectifs marketing de notoriété de la marque ou de couverture.
nonSkippableAd

object (NonSkippableAd)

Détails d'une annonce vidéo InStream courte non désactivable, d'une durée comprise entre 6 et 15 secondes, utilisée pour les objectifs marketing de couverture.
bumperAd

object (BumperAd)

Détails d'une annonce vidéo courte non désactivable, d'une durée maximale de six secondes, utilisée pour la couverture.
audioAd

object (AudioAd)

Détails d'une annonce audio utilisée pour atteindre des objectifs marketing de couverture.
videoDiscoverAd

object (VideoDiscoveryAd)

Détails d'une annonce promouvant une vidéo qui s'affiche dans les lieux de découverte.
videoPerformanceAd

object (VideoPerformanceAd)

Détails d'une annonce utilisée dans une campagne vidéo pour l'action afin d'inciter les utilisateurs à agir concernant l'entreprise, le service ou le produit.

DisplayVideoSourceAd

Annonce provenant d'une création DV360.

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

string (int64 format)

ID de la création source.

MastheadAd

Informations sur une bannière Masthead.

Représentation JSON 
{
  "video": {
    object (YoutubeVideoDetails)
  },
  "headline": string,
  "description": string,
  "videoAspectRatio": enum (VideoAspectRatio),
  "autoplayVideoStartMillisecond": string,
  "autoplayVideoDuration": string,
  "callToActionButtonLabel": string,
  "callToActionFinalUrl": string,
  "callToActionTrackingUrl": string,
  "showChannelArt": boolean,
  "companionYoutubeVideos": [
    {
      object (YoutubeVideoDetails)
    }
  ]
}
Champs
video

object (YoutubeVideoDetails)

Vidéo YouTube utilisée par l'annonce.
headline

string

Titre de l'annonce.
description

string

Description de l'annonce.
videoAspectRatio

enum (VideoAspectRatio)

Format de la vidéo YouTube en lecture automatique dans le masthead.
autoplayVideoStartMillisecond

string (int64 format)

Durée en millisecondes après laquelle la vidéo commence à être lue.
autoplayVideoDuration

string (Duration format)

Durée pendant laquelle la vidéo sera lue automatiquement.

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

string

Texte du bouton d'incitation à l'action.
callToActionFinalUrl

string

URL de destination du bouton d'incitation à l'action.
callToActionTrackingUrl

string

URL de suivi du bouton d'incitation à l'action.
showChannelArt

boolean

Indique si un arrière-plan ou une bannière doit s'afficher en haut d'une page YouTube.
companionYoutubeVideos[]

object (YoutubeVideoDetails)

Vidéos s'affichant à côté de la bannière Masthead sur ordinateur. Vous ne pouvez pas en ajouter plus de deux.

YoutubeVideoDetails

Informations sur une vidéo YouTube.

Représentation JSON 
{
  "id": string,
  "unavailableReason": enum (VideoUnavailableReason)
}
Champs
id

string

ID vidéo YouTube qui peut être recherché sur la page Web YouTube.
unavailableReason

enum (VideoUnavailableReason)

Raison pour laquelle les données vidéo ne sont pas disponibles.

VideoUnavailableReason

Raisons possibles pour lesquelles une vidéo peut ne pas être disponible.

Enums
VIDEO_UNAVAILABLE_REASON_UNSPECIFIED Inconnu ou non spécifié.
VIDEO_UNAVAILABLE_REASON_PRIVATE Cette vidéo est privée.
VIDEO_UNAVAILABLE_REASON_DELETED La vidéo est supprimée.

VideoAspectRatio

Formats possibles pour une vidéo YouTube.

Enums
VIDEO_ASPECT_RATIO_UNSPECIFIED Non spécifié ou inconnu.
VIDEO_ASPECT_RATIO_WIDESCREEN La vidéo est étirée et le haut et le bas sont recadrés.
VIDEO_ASPECT_RATIO_FIXED_16_9 La vidéo utilise un format 16:9 fixe.

InStreamAd

Informations sur une annonce InStream.

Représentation JSON 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
Champs
commonInStreamAttribute

object (CommonInStreamAttribute)

Attributs d'annonce courants.
customParameters

map (key: string, value: string)

Paramètres personnalisés permettant de transmettre des valeurs personnalisées au modèle d'URL de suivi.

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

CommonInStreamAttribute

Attributs communs aux annonces InStream, non désactivables et bumper.

Représentation JSON 
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "actionButtonLabel": string,
  "actionHeadline": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "companionBanner": {
    object (ImageAsset)
  }
}
Champs
displayUrl

string

Adresse de la page Web qui s'affiche avec l'annonce.
finalUrl

string

URL de la page Web à laquelle les internautes accèdent après avoir cliqué sur l'annonce.
trackingUrl

string

Adresse URL chargée en arrière-plan à des fins de suivi.
actionButtonLabel

string

Texte du bouton d'incitation à l'action.
actionHeadline

string

Titre de la bannière d'incitation à l'action.
video

object (YoutubeVideoDetails)

Vidéo YouTube de l'annonce.
companionBanner

object (ImageAsset)

Image qui s'affiche à côté de l'annonce vidéo.

ImageAsset

Métadonnées d'un composant Image.

Représentation JSON 
{
  "mimeType": string,
  "fullSize": {
    object (Dimensions)
  },
  "fileSize": string
}
Champs
mimeType

string

Type MIME du composant Image.
fullSize

object (Dimensions)

Métadonnées de cette image dans sa taille d'origine.
fileSize

string (int64 format)

Taille du fichier de l'image en octets.

NonSkippableAd

Informations sur une annonce non désactivable.

Représentation JSON 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
Champs
commonInStreamAttribute

object (CommonInStreamAttribute)

Attributs d'annonce courants.
customParameters

map (key: string, value: string)

Paramètres personnalisés permettant de transmettre des valeurs personnalisées au modèle d'URL de suivi.

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

BumperAd

Informations sur une annonce bumper.

Représentation JSON 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  }
}
Champs
commonInStreamAttribute

object (CommonInStreamAttribute)

Attributs d'annonce courants.

AudioAd

Informations sur une annonce audio.

Représentation JSON 
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "video": {
    object (YoutubeVideoDetails)
  }
}
Champs
displayUrl

string

Adresse de la page Web qui s'affiche avec l'annonce.
finalUrl

string

URL de la page Web à laquelle les internautes accèdent après avoir cliqué sur l'annonce.
trackingUrl

string

Adresse URL chargée en arrière-plan à des fins de suivi.
video

object (YoutubeVideoDetails)

Vidéo YouTube de l'annonce.

VideoDiscoveryAd

Détails d'une annonce vidéo Discovery.

Représentation JSON 
{
  "headline": string,
  "description1": string,
  "description2": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "thumbnail": enum (Thumbnail)
}
Champs
headline

string

Titre de l'annonce.
description1

string

Première ligne de texte de l'annonce.
description2

string

Deuxième ligne de texte de l'annonce.
video

object (YoutubeVideoDetails)

Vidéo YouTube promue par l'annonce.
thumbnail

enum (Thumbnail)

Image miniature utilisée dans l'annonce.

Miniature

Options de miniatures possibles dans les annonces vidéo Discovery.

Enums
THUMBNAIL_UNSPECIFIED Inconnu ou non spécifié.
THUMBNAIL_DEFAULT La miniature par défaut peut être générée automatiquement ou importée par l'utilisateur.
THUMBNAIL_1 Miniature 1, générée à partir de la vidéo.
THUMBNAIL_2 Miniature 2, générée à partir de la vidéo.
THUMBNAIL_3 Miniature 3, générée à partir de la vidéo.

VideoPerformanceAd

Détails d'une annonce vidéo axée sur les performances.

Représentation JSON 
{
  "finalUrl": string,
  "trackingUrl": string,
  "actionButtonLabels": [
    string
  ],
  "headlines": [
    string
  ],
  "longHeadlines": [
    string
  ],
  "descriptions": [
    string
  ],
  "displayUrlBreadcrumb1": string,
  "displayUrlBreadcrumb2": string,
  "domain": string,
  "videos": [
    {
      object (YoutubeVideoDetails)
    }
  ],
  "customParameters": {
    string: string,
    ...
  },
  "companionBanners": [
    {
      object (ImageAsset)
    }
  ]
}
Champs
finalUrl

string

URL de la page Web à laquelle les internautes accèdent après avoir cliqué sur l'annonce.
trackingUrl

string

Adresse URL chargée en arrière-plan à des fins de suivi.
actionButtonLabels[]

string

Liste des composants Texte affichés sur le bouton d'incitation à l'action.
headlines[]

string

Liste des titres affichés sur la bannière d'incitation à l'action.
longHeadlines[]

string

Liste des titres seuls affichés sur la bannière d'incitation à l'action.
descriptions[]

string

Liste des descriptions affichées sur la bannière d'incitation à l'action.
displayUrlBreadcrumb1

string

Première partie de l'URL à afficher après le domaine.
displayUrlBreadcrumb2

string

Il s'agit de la deuxième partie de l'URL à afficher après le domaine.
domain

string

Domaine de l'URL à afficher.
videos[]

object (YoutubeVideoDetails)

Liste des composants vidéo YouTube utilisés par cette annonce.
customParameters

map (key: string, value: string)

Paramètres personnalisés permettant de transmettre des valeurs personnalisées au modèle d'URL de suivi.

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

object (ImageAsset)

Liste des bannières associées utilisées par cette annonce.

AdUrl

URL supplémentaires associées à l'annonce, y compris les balises.

Représentation JSON 
{
  "type": enum (AdUrlType),
  "url": string
}
Champs
type

enum (AdUrlType)

Type d'URL de l'annonce.
url

string

Valeur de la chaîne URL.

AdUrlType

Types d'URL d'annonce possibles.

Enums
AD_URL_TYPE_UNSPECIFIED Inconnu ou non spécifié.
AD_URL_TYPE_BEACON_IMPRESSION Pixel de suivi 1 x 1 à pinguer lorsqu'une impression d'une création est diffusée.
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION Balise d'impression DCM extensible. Au moment de la diffusion, il est développé en plusieurs balises.
AD_URL_TYPE_BEACON_CLICK URL de suivi à envoyer lorsque l'événement de clic est déclenché.
AD_URL_TYPE_BEACON_SKIP URL de suivi à pinguer lorsque l'événement de désactivation est déclenché.

Méthodes

get

 Récupère une annonce de groupe d'annonces.

list

 Liste les annonces du groupe d'annonces.