google. ima
El espacio de nombres google.ima
proporciona acceso a las clases, las interfaces, las enumeraciones y las propiedades del SDK.
Clases
Anuncio
Clase del anuncio que se extiende con clases que representan diferentes tipos de anuncios.
PuntosdeAdCue
La lista de puntos de inserción representa una programación de pausas publicitarias. Ten en cuenta que los anuncios individuales en la pausa publicitaria no se incluyen en la programación.
AdDisplayContainer.
Esta clase representa un contenedor para mostrar anuncios. El SDK creará automáticamente estructuras dentro del parámetro containerElement para alojar anuncios superpuestos y de video.
Cuando se crea una instancia de esta clase, se crea un IFRAME en containerElement y se carga el núcleo del SDK. Este IFRAME debe conservarse para que el SDK funcione correctamente. Una vez que se hayan reproducido todos los anuncios y el SDK ya no sea necesario, usa el método destroy()
para descargar el SDK.
El parámetro containerElement debe ser un elemento que forma parte del DOM. Es necesario posicionar el containerElement de manera correcta para que los anuncios se muestren correctamente. Se recomienda posicionarlo encima del reproductor de video de contenido y ajustarlo a un tamaño que abarque todo el reproductor. Consulta la documentación del SDK para obtener detalles sobre las implementaciones recomendadas.
Nota: Siempre es necesario llamar al método initialize()
en un código que una acción del usuario invocó directamente (como un clic o un toque).
Error de anuncio
AdError muestra información al usuario sobre si se produjo un error durante la carga o la reproducción de un anuncio. El descriptor de acceso de errorType proporciona información sobre si el error ocurrió durante la carga o reproducción de un anuncio.
AnuncioError
Este evento se genera cuando se produce un error cuando se carga un anuncio desde los servidores de Google o DoubleClick. Los tipos en los que puedes registrarte para el evento son AdsLoader y AdsManager.
Evento de anuncio
El anuncio genera este tipo de evento como una notificación cuando el estado del anuncio cambia y cuando los usuarios interactúan con él. Por ejemplo, cuando se comienza a reproducir el anuncio, se hace clic en él y mucho más. Puedes registrarte para los distintos eventos modificados por el estado en AdsManager.
AdMetadataEvent
Esta clase dejó de estar disponible. Use la API de AdsManager.getCuePoints(). Un evento de anuncio específico que lleva metadatos.
Información del grupo de anuncios
Un anuncio puede formar parte de un grupo de anuncios. Este objeto expone los metadatos relacionados con ese grupo, como la cantidad de anuncios en el grupo y la posición del anuncio dentro del grupo.
La API de getTotalAds
que se incluye en este objeto suele ser correcta, pero, en determinadas situaciones, representa la mejor suposición del SDK. Consulta la documentación de ese método para obtener más información.
Datos de AdProgress
Este objeto expone información sobre el progreso actual mientras se reproduce un anuncio.
AdsLoader
AdsLoader permite a los clientes solicitar anuncios a los servidores de anuncios. Para hacerlo, los usuarios deben registrarse en el evento AdsManagerLoadedEvent y, luego, solicitar anuncios.
AdsManager
Proporciona la API pública externa al editor y se comunica con la instancia interna del administrador de anuncios.
AdsManagerLoadedEvent.
Este evento se genera cuando los anuncios se cargan correctamente desde los servidores de anuncios de Google o DoubleClick mediante un elemento AdsLoader. Puedes registrarte para este evento en AdsLoader.
AdsRenderingSettings;
Define los parámetros que controlan la renderización de los anuncios.
AdsRequest.
Es una clase para especificar propiedades de la solicitud de anuncio.
Anuncio complementario
Representa un anuncio complementario.
Configuración de anuncios complementarios
El objeto CompanionAdSelectionSettings se utiliza para definir los criterios de selección cuando se llama a la función ima.Ad.getCompanionAds.
ImaSdkSettings;
Esta clase contiene la configuración de todo el SDK.
UniversalAdIdInfo;
Este objeto expone información sobre el ID del anuncio universal asociado con la creatividad, incluido el valor del ID del anuncio y el registro de ID del anuncio.
Enumeraciones
Modo de acceso de Omid
string
Modos de acceso disponibles para OMID en la Web, que controlan el nivel de acceso a la secuencia de comandos de verificación
Valor |
|
---|---|
LIMITADO |
La secuencia de comandos de verificación se encuentra en la zona de pruebas y no puede acceder a la creatividad ni a la página del publicador. Tampoco puede confirmar directamente en qué dominio del publicador se encuentra. |
DOMINIO |
La secuencia de comandos de verificación se encuentra en la zona de pruebas y no se puede acceder a la creatividad ni a la página del publicador. Sin embargo, la secuencia de comandos se carga de modo que pueda confirmar directamente en qué dominio del publicador se encuentra. |
FULL |
La secuencia de comandos de verificación tiene acceso directo a la creatividad y a la página del publicador. |
Proveedor de verificación de Omid
número
Identifica a un proveedor de verificación OMID. Los proveedores se muestran en orden alfabético.
Valor |
|
---|---|
COMPUESTA |
|
DOBLE VERIFICACIÓN |
|
|
|
CIENTA_DEL_INTEGRAL |
|
MÉTRICA |
|
MOAT |
|
NIELSEN |
|
PIXELATA |
|
OTRO |
El proveedor predeterminado que se usará cuando la URL de la secuencia de comandos no coincida con ningún otro proveedor. |
Elementos de IU
string
Enumeración que especifica diferentes elementos de la IU que se pueden configurar para que se muestren o se oculten. Es posible que se ignore esta configuración para los anuncios de AdSense y ADX.
Valor |
|
---|---|
ATRIBUCIÓN |
Muestra el texto "Anuncio" en la IU del anuncio. Debe estar presente para que se muestre el temporizador de cuenta regresiva. |
COUNTDOWN |
Se requiere la atribución de anuncios para que se muestre un temporizador de cuenta regresiva. |
Modo de vista
string
Enumeración que especifica diferentes modos de vista de VPAID para los anuncios.
Valor |
|
---|---|
NORMAL |
Modo de reproducción de anuncios normal |
PANTALLA COMPLETA (FULLSCREEN) |
Modo de reproducción de anuncios en pantalla completa. Indica al administrador de anuncios que el publicador considera la disposición actual de AdDisplayContainer como pantalla completa (por ejemplo, pantalla completa simulada). Esto no hace que el administrador de anuncios ingrese en el modo de pantalla completa. |
- Funciones obsoletas
Propiedades
Modo de acceso de Omid
string
Modos de acceso disponibles para OMID en la Web, que controlan el nivel de acceso a la secuencia de comandos de verificación
Valor |
|
---|---|
LIMITADO |
La secuencia de comandos de verificación se encuentra en la zona de pruebas y no puede acceder a la creatividad ni a la página del publicador. Tampoco puede confirmar directamente en qué dominio del publicador se encuentra. |
DOMINIO |
La secuencia de comandos de verificación se encuentra en la zona de pruebas y no se puede acceder a la creatividad ni a la página del publicador. Sin embargo, la secuencia de comandos se carga de modo que pueda confirmar directamente en qué dominio del publicador se encuentra. |
FULL |
La secuencia de comandos de verificación tiene acceso directo a la creatividad y a la página del publicador. |
Proveedor de verificación de Omid
número
Identifica a un proveedor de verificación OMID. Los proveedores se muestran en orden alfabético.
Valor |
|
---|---|
COMPUESTA |
|
DOBLE VERIFICACIÓN |
|
|
|
CIENTA_DEL_INTEGRAL |
|
MÉTRICA |
|
MOAT |
|
NIELSEN |
|
PIXELATA |
|
OTRO |
El proveedor predeterminado que se usará cuando la URL de la secuencia de comandos no coincida con ningún otro proveedor. |
Elementos de IU
string
Enumeración que especifica diferentes elementos de la IU que se pueden configurar para que se muestren o se oculten. Es posible que se ignore esta configuración para los anuncios de AdSense y ADX.
Valor |
|
---|---|
ATRIBUCIÓN |
Muestra el texto "Anuncio" en la IU del anuncio. Debe estar presente para que se muestre el temporizador de cuenta regresiva. |
COUNTDOWN |
Se requiere la atribución de anuncios para que se muestre un temporizador de cuenta regresiva. |
Modo de vista
string
Enumeración que especifica diferentes modos de vista de VPAID para los anuncios.
Valor |
|
---|---|
NORMAL |
Modo de reproducción de anuncios normal |
PANTALLA COMPLETA (FULLSCREEN) |
Modo de reproducción de anuncios en pantalla completa. Indica al administrador de anuncios que el publicador considera la disposición actual de AdDisplayContainer como pantalla completa (por ejemplo, pantalla completa simulada). Esto no hace que el administrador de anuncios ingrese en el modo de pantalla completa. |
- Funciones obsoletas
configuración
ImaSdkSettings no nula
La instancia global de configuración singleton.