REST Resource: advertisers.adGroupAds

Recurso: AdGroupAd

Es 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)

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

string (int64 format)

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

string (int64 format)

Es 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)

Es 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. Son los detalles del anuncio. Las direcciones (ad_details) solo pueden ser una de las siguientes opciones:
displayVideoSourceAd

object (DisplayVideoSourceAd)

Son los detalles de un anuncio proveniente 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)

Son los detalles de un anuncio in-stream que se puede omitir después de 5 segundos y que se utiliza para los objetivos de marketing de reconocimiento de la marca o alcance.
nonSkippableAd

object (NonSkippableAd)

Son los detalles de un anuncio de video in-stream corto que no se puede omitir, de entre 6 y 15 segundos, que se usa para los objetivos de marketing de alcance.
bumperAd

object (BumperAd)

Son los detalles de un anuncio de video corto que no se puede omitir, de 6 segundos o menos, que se usa para el alcance.
audioAd

object (AudioAd)

Son los detalles de un anuncio de audio que se usa para los objetivos de marketing de alcance.
videoDiscoverAd

object (VideoDiscoveryAd)

Son los detalles de un anuncio que promociona un video y que se muestra en los lugares de descubrimiento.
videoPerformanceAd

object (VideoPerformanceAd)

Son los detalles de un anuncio utilizado en una campaña de acción de video para generar acciones para la empresa, el servicio o el producto.

DisplayVideoSourceAd

Anuncio proveniente de una creatividad de DV360.

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

string (int64 format)

Es el ID de la creatividad fuente.

MastheadAd

Son los 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 proporción de aspecto del video de YouTube que se reproduce automáticamente 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 la duración del tiempo en que el video se reproducirá automáticamente.

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

string

Es el texto del 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

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

boolean

Indica si se debe mostrar un fondo o banner que aparece en la parte superior de una página de YouTube.
companionYoutubeVideos[]

object (YoutubeVideoDetails)

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

YoutubeVideoDetails

Son los detalles de un video de YouTube.

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

string

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

enum (VideoUnavailableReason)

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

VideoUnavailableReason

Posibles motivos por los que un video podría no estar disponible.

Enums
VIDEO_UNAVAILABLE_REASON_UNSPECIFIED Desconocido o sin especificar.
VIDEO_UNAVAILABLE_REASON_PRIVATE El video es privado.
VIDEO_UNAVAILABLE_REASON_DELETED Se borró el video.

VideoAspectRatio

Son las relaciones de aspecto posibles para un video de YouTube.

Enums
VIDEO_ASPECT_RATIO_UNSPECIFIED No especificado o desconocido.
VIDEO_ASPECT_RATIO_WIDESCREEN El video se estira y se recortan la parte superior y la inferior.
VIDEO_ASPECT_RATIO_FIXED_16_9 El video usa una relación de aspecto fija de 16:9.

InStreamAd

Son los detalles de un anuncio in-stream.

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

object (CommonInStreamAttribute)

Son atributos comunes del 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" }.

CommonInStreamAttribute

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

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 URL que se carga en segundo plano para fines de seguimiento.
actionButtonLabel

string

Es el texto del botón de llamado a la acción.
actionHeadline

string

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

object (YoutubeVideoDetails)

Es el video de YouTube del anuncio.
companionBanner

object (ImageAsset)

Es la imagen que se muestra 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

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)

Tamaño del archivo del recurso de imagen en bytes.

NonSkippableAd

Son los detalles de un anuncio que no se puede omitir.

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

object (CommonInStreamAttribute)

Son atributos comunes del 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" }.

BumperAd

Son los detalles de un anuncio bumper.

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

object (CommonInStreamAttribute)

Son atributos comunes del anuncio.

AudioAd

Son los 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 URL que se carga en segundo plano para fines de seguimiento.
video

object (YoutubeVideoDetails)

Es el video de YouTube del anuncio.

VideoDiscoveryAd

Son los detalles de un anuncio de 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 en miniatura que se usa en el anuncio.

Miniatura

Son las opciones de miniaturas posibles en los anuncios video discovery.

Enums
THUMBNAIL_UNSPECIFIED Desconocido o sin especificar.
THUMBNAIL_DEFAULT Es la miniatura predeterminada, que se puede generar automáticamente o subir por el usuario.
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

Son los 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 URL que se carga 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

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

string

Es la lista de descripciones que se muestran 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

Son las URLs adicionales relacionadas con el anuncio, incluidas las balizas.

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

enum (AdUrlType)

Es el tipo de URL del anuncio.
url

string

Es el valor de cadena de la URL.

AdUrlType

Son los posibles tipos de URLs de anuncios.

Enums
AD_URL_TYPE_UNSPECIFIED Desconocido o sin especificar.
AD_URL_TYPE_BEACON_IMPRESSION Es un píxel de seguimiento de 1 x 1 que se envía cuando se publica una impresión de una creatividad.
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION Es un pixel contador de impresiones de DCM desplegable. En el momento de la publicación, se expande a varias balizas.
AD_URL_TYPE_BEACON_CLICK Es la URL de seguimiento a la que se envía un ping cuando se activa el evento de clic.
AD_URL_TYPE_BEACON_SKIP Es la URL de seguimiento a la que se hará un ping cuando se active el evento de omisión.

Métodos

get

 Obtiene un anuncio del grupo de anuncios.

list

 Enumera los anuncios del grupo de anuncios.