REST Resource: advertisers.adGroupAds

Recurso: AdGroupAd

Un solo anuncio asociado a un grupo de anuncios.

Representación 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.
}
Campos
name

string

Es el nombre del recurso del anuncio.
advertiserId

string (int64 format)

El ID único del anunciante al que pertenece el anuncio.
adGroupAdId

string (int64 format)

El ID único del anuncio. El sistema lo asigna.
adGroupId

string (int64 format)

El ID único del grupo de anuncios al que pertenece el anuncio.
displayName

string

Es el nombre visible del anuncio.

Debe estar codificado en UTF-8 con un tamaño máximo de 255 bytes.
entityStatus

enum (EntityStatus)

El estado de la entidad del anuncio.
adUrls[]

object (AdUrl)

Es la lista de URLs que usa el anuncio.
Campo de unión ad_details. Los detalles del anuncio. Las direcciones (ad_details) solo pueden ser una de las siguientes opciones:
displayVideoSourceAd

object (DisplayVideoSourceAd)

Detalles de un anuncio obtenido de una creatividad de Display &Video 360
mastheadAd

object (MastheadAd)

Detalles de un anuncio publicado en el feed de la página principal de YouTube.
inStreamAd

object (InStreamAd)

Detalles de un anuncio in-stream que se puede omitir después de 5 segundos, que se utiliza para el reconocimiento de la marca o para alcanzar objetivos de marketing.
nonSkippableAd

object (NonSkippableAd)

Detalles de un anuncio de video in-stream breve que no se puede omitir, de entre 6 y 15 segundos, que se utiliza para objetivos de marketing de alcance.
bumperAd

object (BumperAd)

Detalles de un anuncio de video breve que no se puede omitir, de 6 segundos o menos, que se usa para el alcance.
audioAd

object (AudioAd)

Detalles de un anuncio de audio que se usó para lograr los objetivos de marketing
videoDiscoverAd

object (VideoDiscoveryAd)

Son los detalles de un anuncio que promociona un video que aparece en lugares de descubrimiento.
videoPerformanceAd

object (VideoPerformanceAd)

Detalles de un anuncio usado en una campaña de acción de video para generar acciones en la empresa, el servicio o el producto.

DisplayVideoSourceAd

El anuncio proviene de una creatividad de DV360.

Representación JSON 
{
  "creativeId": string
}
Campos
creativeId

string (int64 format)

Es el ID de la creatividad fuente.

MastheadAd

Detalles de un anuncio masthead.

Representación 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)
    }
  ]
}
Campos
video

object (YoutubeVideoDetails)

Es el video de YouTube que usa el anuncio.
headline

string

Es el título del anuncio.
description

string

Es la descripción del anuncio.
videoAspectRatio

enum (VideoAspectRatio)

Es la relación de aspecto del video de YouTube de reproducción automática en el masthead.
autoplayVideoStartMillisecond

string (int64 format)

Es la cantidad de tiempo, en milisegundos, después de la cual comenzará a reproducirse el video.
autoplayVideoDuration

string (Duration format)

Es el tiempo durante el que se reproduce automáticamente el video.

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".
callToActionButtonLabel

string

El texto que aparece en el botón de llamado a la acción.
callToActionFinalUrl

string

La URL de destino del botón de llamado a la acción.
callToActionTrackingUrl

string

La URL de seguimiento del botón de llamado a la acción.
showChannelArt

boolean

Si se muestra un fondo o un banner en la parte superior de una página de YouTube.
companionYoutubeVideos[]

object (YoutubeVideoDetails)

Los videos que aparecen junto al anuncio masthead en computadoras de escritorio. No puede haber más de dos.

YoutubeVideoDetails

Detalles de un video de YouTube.

Representación JSON 
{
  "id": string,
  "unavailableReason": enum (VideoUnavailableReason)
}
Campos
id

string

El ID de video de YouTube que se puede buscar en la página web de YouTube.
unavailableReason

enum (VideoUnavailableReason)

El motivo por el que los datos de video no están disponibles.

VideoUnavailableReason

Motivos por los que un video puede no estar disponible

Enumeraciones
VIDEO_UNAVAILABLE_REASON_UNSPECIFIED Desconocido o sin especificar.
VIDEO_UNAVAILABLE_REASON_PRIVATE El video es privado.
VIDEO_UNAVAILABLE_REASON_DELETED Se borrará el video.

VideoAspectRatio

Posibles relaciones de aspecto para un video de YouTube.

Enumeraciones
VIDEO_ASPECT_RATIO_UNSPECIFIED No se especificó o es desconocido.
VIDEO_ASPECT_RATIO_WIDESCREEN Se estira el video y se recortan las partes inferior y superior.
VIDEO_ASPECT_RATIO_FIXED_16_9 El video usa una relación de aspecto fija de 16:9.

InStreamAd

Detalles de un anuncio in-stream.

Representación JSON 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
Campos
commonInStreamAttribute

object (CommonInStreamAttribute)

Atributos de anuncios comunes.
customParameters

map (key: string, value: string)

Son los parámetros personalizados para pasar valores personalizados a la plantilla de URL de seguimiento.

Es un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

CommonInStreamAttribute

Atributos comunes para los anuncios in-stream, los anuncios bumper y los anuncios que no se pueden omitir.

Representación JSON 
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "actionButtonLabel": string,
  "actionHeadline": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "companionBanner": {
    object (ImageAsset)
  }
}
Campos
displayUrl

string

Es la dirección de la página web que aparece con el anuncio.
finalUrl

string

Es la dirección URL de la página web a la que llegan los usuarios después de hacer clic en el anuncio.
trackingUrl

string

Es la dirección de URL cargada en segundo plano para fines de seguimiento.
actionButtonLabel

string

El texto que aparece en el botón de llamado a la acción.
actionHeadline

string

El título del banner de llamado a la acción.
video

object (YoutubeVideoDetails)

El video de YouTube del anuncio.
companionBanner

object (ImageAsset)

Es la imagen que aparece junto al anuncio de video.

ImageAsset

Son los metadatos de un recurso de imagen.

Representación JSON 
{
  "mimeType": string,
  "fullSize": {
    object (Dimensions)
  },
  "fileSize": string
}
Campos
mimeType

string

Es el tipo de MIME del recurso de imagen.
fullSize

object (Dimensions)

Son los metadatos de esta imagen en su tamaño original.
fileSize

string (int64 format)

Es el tamaño del archivo del recurso de imagen en bytes.

NonSkippableAd

Detalles de un anuncio que no se puede omitir.

Representación JSON 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
Campos
commonInStreamAttribute

object (CommonInStreamAttribute)

Atributos de anuncios comunes.
customParameters

map (key: string, value: string)

Son los parámetros personalizados para pasar valores personalizados a la plantilla de URL de seguimiento.

Es un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

BumperAd

Detalles de un anuncio bumper.

Representación JSON 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  }
}
Campos
commonInStreamAttribute

object (CommonInStreamAttribute)

Atributos de anuncios comunes.

AudioAd

Detalles de un anuncio de audio.

Representación JSON 
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "video": {
    object (YoutubeVideoDetails)
  }
}
Campos
displayUrl

string

Es la dirección de la página web que aparece con el anuncio.
finalUrl

string

Es la dirección URL de la página web a la que llegan los usuarios después de hacer clic en el anuncio.
trackingUrl

string

Es la dirección de URL cargada en segundo plano para fines de seguimiento.
video

object (YoutubeVideoDetails)

El video de YouTube del anuncio

VideoDiscoveryAd

Detalles de un anuncio video discovery.

Representación JSON 
{
  "headline": string,
  "description1": string,
  "description2": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "thumbnail": enum (Thumbnail)
}
Campos
headline

string

Es el título del anuncio.
description1

string

Es la primera línea de texto del anuncio.
description2

string

Es la segunda línea de texto del anuncio.
video

object (YoutubeVideoDetails)

Es el video de YouTube que promociona el anuncio.
thumbnail

enum (Thumbnail)

Es la imagen de miniatura que se usa en el anuncio.

Miniatura

Posibles opciones de miniaturas en los anuncios de video discovery.

Enumeraciones
THUMBNAIL_UNSPECIFIED Desconocido o sin especificar.
THUMBNAIL_DEFAULT La miniatura predeterminada puede generarse automáticamente o subirse por usuarios.
THUMBNAIL_1 Miniatura 1, generada a partir del video.
THUMBNAIL_2 Miniatura 2, generada a partir del video.
THUMBNAIL_3 Miniatura 3, generada a partir del video.

VideoPerformanceAd

Detalles de un anuncio de rendimiento de video.

Representación 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)
    }
  ]
}
Campos
finalUrl

string

Es la dirección URL de la página web a la que llegan los usuarios después de hacer clic en el anuncio.
trackingUrl

string

Es la dirección de URL cargada en segundo plano para fines de seguimiento.
actionButtonLabels[]

string

Es la lista de recursos de texto que se muestran en el botón de llamado a la acción.
headlines[]

string

Es la lista de títulos que se muestran en el banner de llamado a la acción.
longHeadlines[]

string

La lista de títulos independientes que se muestran en el banner de llamado a la acción.
descriptions[]

string

Es la lista de descripciones que se muestra en el banner de llamado a la acción.
displayUrlBreadcrumb1

string

Es la primera parte después del dominio en la URL visible.
displayUrlBreadcrumb2

string

Es la segunda parte después del dominio en la URL visible.
domain

string

Es el dominio de la URL visible.
videos[]

object (YoutubeVideoDetails)

Es la lista de recursos de video de YouTube que utiliza este anuncio.
customParameters

map (key: string, value: string)

Son los parámetros personalizados para pasar valores personalizados a la plantilla de URL de seguimiento.

Es un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
companionBanners[]

object (ImageAsset)

Es la lista de banners complementarios que usa este anuncio.

AdUrl

URLs adicionales relacionadas con el anuncio, incluidos los píxeles contadores

Representación JSON 
{
  "type": enum (AdUrlType),
  "url": string
}
Campos
type

enum (AdUrlType)

Es el tipo de URL del anuncio.
url

string

El valor de la cadena de URL

AdUrlType

Posibles tipos de URLs de anuncios.

Enumeraciones
AD_URL_TYPE_UNSPECIFIED Desconocido o sin especificar.
AD_URL_TYPE_BEACON_IMPRESSION Es un píxel de seguimiento de 1 x 1 que envía un ping cuando se publica una impresión de una creatividad.
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION Pixel contador de impresiones de DCM expandible. Durante la publicación, se expande a varias balizas.
AD_URL_TYPE_BEACON_CLICK Es la URL de seguimiento a la que se le enviará un ping cuando se active el evento de clic.
AD_URL_TYPE_BEACON_SKIP Es la URL de seguimiento a la que se le enviará un ping cuando se active el evento de omisión.

Métodos

get

 Obtiene un anuncio del grupo de anuncios.

list

 Muestra los anuncios del grupo de anuncios.