REST Resource: advertisers.youtubeAdGroupAds

Recurso: YouTubeAdGroupAd

Es un anuncio único asociado a un grupo de anuncios de YouTube.

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)

El ID único del anuncio. Lo asigna el sistema.
adGroupId

string (int64 format)

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

string

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)

Lista de las URLs que utiliza 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 provenientes de una creatividad de Display & Video 360
mastheadAd

object (MastheadAd)

Son los 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 objetivos de marketing de alcance o reconocimiento de la marca.
nonSkippableAd

object (NonSkippableAd)

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

object (BumperAd)

Detalles de un anuncio de video corto que no se puede omitir, igual o inferior a 6 segundos, utilizado para alcance.
audioAd

object (AudioAd)

Detalles de un anuncio de audio utilizado para alcanzar 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)

Son los detalles de un anuncio que se usa en una campaña de acción de video para generar acciones para 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 de origen.

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 utiliza el anuncio.
headline

string

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 que se reproduce automáticamente en el masthead.
autoplayVideoStartMillisecond

string (int64 format)

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

string (Duration format)

El tiempo durante el que se reproducirá automáticamente el video.

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

string

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

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

boolean

Si se muestra un fondo o un 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 ser más de dos.

YoutubeVideoDetails

Detalles de un video de YouTube.

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

string

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 del video no están disponibles.

VideoUnavailableReason

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

Enumeradores
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

Las posibles relaciones de aspecto de un video de YouTube.

Enumeradores
VIDEO_ASPECT_RATIO_UNSPECIFIED No especificado o desconocido.
VIDEO_ASPECT_RATIO_WIDESCREEN El video se estira y se recortan las partes inferior y superior.
VIDEO_ASPECT_RATIO_FIXED_16_9 El video tiene 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 comunes de los anuncios.
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 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

Indica 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 cargada en segundo plano para fines de seguimiento.
actionButtonLabel

string

El texto del 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 se muestra junto al anuncio de video.

ImageAsset

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)

Metadatos de esta imagen en su tamaño original.
fileSize

string (int64 format)

Tamaño de archivo del recurso de imagen expresado 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 comunes de los anuncios.
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 comunes de los anuncios.

AudioAd

Detalles de un anuncio de audio.

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

string

Indica 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 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

El título del anuncio.
description1

string

Primera línea de texto para el anuncio.
description2

string

Segunda línea de texto para el anuncio
video

object (YoutubeVideoDetails)

El video de YouTube que promociona el anuncio.
thumbnail

enum (Thumbnail)

Imagen en miniatura utilizada en el anuncio.

Miniatura

Posibles opciones de miniaturas en los anuncios video discovery.

Enumeradores
THUMBNAIL_UNSPECIFIED Desconocido o sin especificar.
THUMBNAIL_DEFAULT La miniatura predeterminada 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

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 cargada en segundo plano para fines de seguimiento.
actionButtonLabels[]

string

La lista de recursos de texto que se muestra 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 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

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

string

El dominio de la URL visible.
videos[]

object (YoutubeVideoDetails)

Es la lista de elementos 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 se utilizan en 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

Tipos de URL de anuncio posibles.

Enumeradores
AD_URL_TYPE_UNSPECIFIED Desconocido o sin especificar.
AD_URL_TYPE_BEACON_IMPRESSION Es un píxel de seguimiento de 1 x 1 para hacer ping cuando se publica una impresión de una creatividad.
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION Contador de impresiones de DCM expandible. En el momento de la entrega, se expande a varias balizas.
AD_URL_TYPE_BEACON_CLICK URL de seguimiento para hacer ping cuando se activa el evento de clic.
AD_URL_TYPE_BEACON_SKIP URL de seguimiento para hacer ping cuando se activa el evento de omisión.

Métodos

get

 Obtiene un anuncio del grupo de anuncios de YouTube.

list

 Muestra una lista de anuncios del grupo de anuncios de YouTube.