REST Resource: advertisers.adGroupAds

Risorsa: AdGroupAd

Un singolo annuncio associato a un gruppo di annunci.

Rappresentazione 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.
}
Campi
name

string

Il nome della risorsa dell'annuncio.
advertiserId

string (int64 format)

L'ID univoco dell'inserzionista a cui appartiene l'annuncio.
adGroupAdId

string (int64 format)

L'ID univoco dell'annuncio. Assegnato dal sistema.
adGroupId

string (int64 format)

L'ID univoco del gruppo di annunci a cui appartiene l'annuncio.
displayName

string

Il nome visualizzato dell'annuncio.

Deve essere codificata in UTF-8 con una dimensione massima di 255 byte.
entityStatus

enum (EntityStatus)

Lo stato dell'entità dell'annuncio.
adUrls[]

object (AdUrl)

Elenco degli URL utilizzati dall'annuncio.
Campo unione ad_details. I dettagli dell'annuncio. ad_details può essere solo uno dei seguenti:
displayVideoSourceAd

object (DisplayVideoSourceAd)

Dettagli di un annuncio proveniente da una creatività Display & Video 360.
mastheadAd

object (MastheadAd)

Dettagli di un annuncio pubblicato nel feed della home page di YouTube.
inStreamAd

object (InStreamAd)

Dettagli di un annuncio in-stream ignorabile dopo 5 secondi, utilizzato per gli obiettivi di marketing di brand awareness o copertura.
nonSkippableAd

object (NonSkippableAd)

Dettagli di un annuncio video in-stream breve non ignorabile, di durata compresa tra 6 e 15 secondi, utilizzato per gli obiettivi di marketing di copertura.
bumperAd

object (BumperAd)

Dettagli di un annuncio video breve non ignorabile, di durata pari o inferiore a 6 secondi, utilizzato per la copertura.
audioAd

object (AudioAd)

Dettagli di un annuncio audio utilizzato per raggiungere gli obiettivi di marketing di copertura.
videoDiscoverAd

object (VideoDiscoveryAd)

Dettagli di un annuncio che promuove un video visualizzato nei luoghi di scoperta.
videoPerformanceAd

object (VideoPerformanceAd)

Dettagli di un annuncio utilizzato in una campagna video per azione per incentivare le azioni nei confronti dell'attività, del servizio o del prodotto.

DisplayVideoSourceAd

L'annuncio proviene da una creatività DV360.

Rappresentazione JSON 
{
  "creativeId": string
}
Campi
creativeId

string (int64 format)

L'ID della creatività di origine.

MastheadAd

Dettagli di un annuncio masthead.

Rappresentazione 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)
    }
  ]
}
Campi
video

object (YoutubeVideoDetails)

Il video di YouTube utilizzato dall'annuncio.
headline

string

Titolo dell'annuncio.
description

string

La descrizione dell'annuncio.
videoAspectRatio

enum (VideoAspectRatio)

Le proporzioni del video di YouTube con riproduzione automatica nel masthead.
autoplayVideoStartMillisecond

string (int64 format)

Il tempo in millisecondi dopo il quale il video inizierà la riproduzione.
autoplayVideoDuration

string (Duration format)

La durata della riproduzione automatica del video.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
callToActionButtonLabel

string

Il testo del pulsante di invito all'azione.
callToActionFinalUrl

string

L'URL di destinazione del pulsante di invito all'azione.
callToActionTrackingUrl

string

L'URL di monitoraggio del pulsante di invito all'azione.
showChannelArt

boolean

Se mostrare uno sfondo o un banner visualizzato nella parte superiore di una pagina YouTube.
companionYoutubeVideos[]

object (YoutubeVideoDetails)

I video che vengono visualizzati accanto all'annuncio masthead su computer. Non possono essere più di due.

YoutubeVideoDetails

Dettagli di un video di YouTube.

Rappresentazione JSON 
{
  "id": string,
  "unavailableReason": enum (VideoUnavailableReason)
}
Campi
id

string

L'ID video di YouTube, che può essere cercato nella pagina web di YouTube.
unavailableReason

enum (VideoUnavailableReason)

Il motivo per cui i dati del video non sono disponibili.

VideoUnavailableReason

Possibili motivi per cui un video potrebbe non essere disponibile.

Enum
VIDEO_UNAVAILABLE_REASON_UNSPECIFIED Sconosciuto o non specificato.
VIDEO_UNAVAILABLE_REASON_PRIVATE Il video è privato.
VIDEO_UNAVAILABLE_REASON_DELETED Il video è stato eliminato.

VideoAspectRatio

Possibili formati per un video di YouTube.

Enum
VIDEO_ASPECT_RATIO_UNSPECIFIED Non specificato o sconosciuto.
VIDEO_ASPECT_RATIO_WIDESCREEN Il video è allungato e la parte superiore e inferiore sono ritagliate.
VIDEO_ASPECT_RATIO_FIXED_16_9 Il video utilizza proporzioni fisse 16:9.

InStreamAd

Dettagli di un annuncio in-stream.

Rappresentazione JSON 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
Campi
commonInStreamAttribute

object (CommonInStreamAttribute)

Attributi annuncio comuni.
customParameters

map (key: string, value: string)

I parametri personalizzati per trasmettere valori personalizzati al modello di URL di monitoraggio.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

CommonInStreamAttribute

Attributi comuni per annunci in-stream, non ignorabili e bumper.

Rappresentazione JSON 
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "actionButtonLabel": string,
  "actionHeadline": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "companionBanner": {
    object (ImageAsset)
  }
}
Campi
displayUrl

string

L'indirizzo della pagina web visualizzato con l'annuncio.
finalUrl

string

L'indirizzo URL della pagina web che gli utenti raggiungono dopo aver fatto clic sull'annuncio.
trackingUrl

string

L'indirizzo URL caricato in background a scopo di monitoraggio.
actionButtonLabel

string

Il testo del pulsante di invito all'azione.
actionHeadline

string

Il titolo del banner di invito all'azione.
video

object (YoutubeVideoDetails)

Il video di YouTube dell'annuncio.
companionBanner

object (ImageAsset)

L'immagine visualizzata accanto all'annuncio video.

ImageAsset

Metadati di un asset immagine.

Rappresentazione JSON 
{
  "mimeType": string,
  "fullSize": {
    object (Dimensions)
  },
  "fileSize": string
}
Campi
mimeType

string

Tipo MIME dell'asset immagine.
fullSize

object (Dimensions)

Metadati di questa immagine nelle sue dimensioni originali.
fileSize

string (int64 format)

Dimensioni del file dell'asset immagine in byte.

NonSkippableAd

Dettagli di un annuncio non ignorabile.

Rappresentazione JSON 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
Campi
commonInStreamAttribute

object (CommonInStreamAttribute)

Attributi annuncio comuni.
customParameters

map (key: string, value: string)

I parametri personalizzati per trasmettere valori personalizzati al modello di URL di monitoraggio.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

BumperAd

Dettagli di un annuncio bumper.

Rappresentazione JSON 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  }
}
Campi
commonInStreamAttribute

object (CommonInStreamAttribute)

Attributi annuncio comuni.

AudioAd

Dettagli di un annuncio audio.

Rappresentazione JSON 
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "video": {
    object (YoutubeVideoDetails)
  }
}
Campi
displayUrl

string

L'indirizzo della pagina web visualizzato con l'annuncio.
finalUrl

string

L'indirizzo URL della pagina web che gli utenti raggiungono dopo aver fatto clic sull'annuncio.
trackingUrl

string

L'indirizzo URL caricato in background a scopo di monitoraggio.
video

object (YoutubeVideoDetails)

Il video di YouTube dell'annuncio.

VideoDiscoveryAd

Dettagli di un annuncio video discovery.

Rappresentazione JSON 
{
  "headline": string,
  "description1": string,
  "description2": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "thumbnail": enum (Thumbnail)
}
Campi
headline

string

Il titolo dell'annuncio.
description1

string

Prima riga di testo dell'annuncio.
description2

string

Seconda riga di testo per l'annuncio.
video

object (YoutubeVideoDetails)

Il video di YouTube promosso dall'annuncio.
thumbnail

enum (Thumbnail)

L'immagine in miniatura utilizzata nell'annuncio.

Miniatura

Possibili opzioni di miniature negli annunci video discovery.

Enum
THUMBNAIL_UNSPECIFIED Sconosciuto o non specificato.
THUMBNAIL_DEFAULT La miniatura predefinita, che può essere generata automaticamente o caricata dall'utente.
THUMBNAIL_1 Miniatura 1, generata dal video.
THUMBNAIL_2 Miniatura 2, generata dal video.
THUMBNAIL_3 Miniatura 3, generata dal video.

VideoPerformanceAd

Dettagli di un annuncio video sul rendimento.

Rappresentazione 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)
    }
  ]
}
Campi
finalUrl

string

L'indirizzo URL della pagina web che gli utenti raggiungono dopo aver fatto clic sull'annuncio.
trackingUrl

string

L'indirizzo URL caricato in background a scopo di monitoraggio.
actionButtonLabels[]

string

L'elenco degli asset di testo visualizzati sul pulsante di invito all'azione.
headlines[]

string

L'elenco dei titoli mostrati nel banner dell'invito all'azione.
longHeadlines[]

string

L'elenco dei titoli singoli mostrati nel banner dell'invito all'azione.
descriptions[]

string

L'elenco delle descrizioni mostrate nel banner dell'invito all'azione.
displayUrlBreadcrumb1

string

La prima parte dopo il dominio nell'URL di visualizzazione.
displayUrlBreadcrumb2

string

La seconda parte dopo il dominio nell'URL di visualizzazione.
domain

string

Il dominio dell'URL di visualizzazione.
videos[]

object (YoutubeVideoDetails)

L'elenco degli asset video di YouTube utilizzati da questo annuncio.
customParameters

map (key: string, value: string)

I parametri personalizzati per trasmettere valori personalizzati al modello di URL di monitoraggio.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
companionBanners[]

object (ImageAsset)

L'elenco dei banner companion utilizzati da questo annuncio.

AdUrl

URL aggiuntivi correlati all'annuncio, inclusi i beacon.

Rappresentazione JSON 
{
  "type": enum (AdUrlType),
  "url": string
}
Campi
type

enum (AdUrlType)

Il tipo di URL annuncio.
url

string

Il valore stringa dell'URL.

AdUrlType

Possibili tipi di URL annuncio.

Enum
AD_URL_TYPE_UNSPECIFIED Sconosciuto o non specificato.
AD_URL_TYPE_BEACON_IMPRESSION Un pixel di monitoraggio 1 x 1 da pingare quando viene pubblicata un'impressione di una creatività.
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION Beacon per impressioni DCM espandibili. Al momento della pubblicazione, viene espanso in diversi beacon.
AD_URL_TYPE_BEACON_CLICK URL di monitoraggio da pingare quando viene attivato l'evento relativo ai clic.
AD_URL_TYPE_BEACON_SKIP URL di monitoraggio da pingare quando viene attivato l'evento di salto.

Metodi

get

 Recupera un annuncio del gruppo di annunci.

list

 Elenca gli annunci del gruppo di annunci.