Leer en inglés

Compartir a través de


Introducción a la API de la biblioteca de anuncios

La Biblioteca de anuncios es una herramienta de transparencia pública que te permite ver todos los anuncios que se muestran en Bing.com. Puedes buscar anuncios por nombre de anunciante y palabras clave presentes en la copia del anuncio, y verás tanto el contenido del anuncio como los detalles adicionales del anuncio. La biblioteca de anuncios forma parte de un esfuerzo de cumplimiento para garantizar que estamos creando un Internet seguro y abierto para nuestros usuarios.

Recurso de API de la biblioteca de anuncios

Base URI

A continuación se muestra el URI base al que anexa las plantillas:

https://adlibrary.api.bingads.microsoft.com/api/v1/

Plantillas

Para crear los puntos de conexión usados para consultar la biblioteca de anuncios, anexe la plantilla adecuada a la dirección URL base:

Plantilla Verbo HTTP Descripción Recurso
Anunciantes Obtener Obtener anunciantes por nombre

Parámetros:
- top (int32, valor predeterminado 3)
- skip (int32, valor predeterminado 0)
- searchText (cadena, valor predeterminado "")
Anunciante de matriz<>
Anunciantes({AdvertiserId})
o
Anunciantes/{AdvertiserId}
Obtener Obtener anunciante por id.

Parámetros: ninguno

Nota: El Valor de AdvertiserId puede ser AccountId o VerifiedAdvertiserId. Se pueden comprobar varias cuentas con la misma identidad. Si se solicita un AccountId comprobado, en su lugar se devolverá el elemento primario VerifiedAdvertiserId.
Anunciante
Anuncios Obtener Obtener anuncios por anunciante o contenido

Parámetros:
• top (int32, valor predeterminado 12)
• omitir (int64, valor predeterminado 0)
• startDate (cadena)
• endDate (cadena)
• Fechas en formato 'aaaa-MM-dd'
• countryCodes (cadena)

Valores separados por comas, es decir, '10,26,53'
• advertiserId (int64)
• searchText (cadena)
Anuncio de matriz<>
Ads({AdId})
o
Ads/{AdId}
Obtener Obtención de anuncios por identificador

Parámetros: ninguno
Anuncio

Objetos de datos

A continuación se muestran los objetos de solicitud y respuesta que usa la API:

Objeto Description
Anunciante Define un anunciante.
Anuncio Define un anuncio.
AdDetails Define detalles adicionales sobre un anuncio.
CountryImpressionShare Define el recurso compartido de impresiones de anuncios para un país.
TargetTypeDetails Define detalles sobre los tipos de destino usados por un anuncio.

Anunciante

Define un anunciante.

Nombre Valor Tipo
AdvertiserId El identificador que identifica al anunciante.

Nota: Puede ser un AccountId o un VerifiedAdvertiserId si se comprueba al anunciante. VerifiedAdvertiserIds puede cubrir varias cuentas si se comprueban con el mismo anunciante, y una solicitud para un AccountId que se ha comprobado devolverá en su lugar el elemento primario VerifiedAdvertiserId.
Long
AdvertiserName Nombre de la cuenta o nombre legal de un anunciante verificado. Cadena
AdvertiserCountry El país donde está registrado el anunciante. Cadena
IsVerified Valor booleano que representa si se comprueba el anunciante. Booleano

Define un anuncio.

Nombre Valor Tipo
AdId Identificador que identifica el anuncio. Long
AdvertiserName Nombre de la cuenta o nombre legal de un anunciante verificado. Cadena
AdvertiserId El identificador que identifica al anunciante. Long
Título Parte del título de la copia del anuncio.

Nota: En el caso de los tipos de anuncios dinámicos, puede haber varias variaciones y el título, la descripción, las direcciones URL y los recursos pueden ser solo una versión reciente y representativa desde la última vez que se ha servido el anuncio.
Cadena
Description La parte de descripción de la copia del anuncio. Cadena
DisplayUrl Dirección URL que muestra el anuncio o el nombre del comerciante para determinados tipos de anuncios. Cadena
DestinationUrl Dirección URL real vinculada al anuncio. Cadena
AssetJson Dirección URL JSON del recurso de recurso Cadena
AdDetails Objeto que contiene detalles adicionales sobre un anuncio. AdDetails

AdDetails

Define detalles adicionales para un anuncio.

Nombre Valor Tipo
PaidForByName Nombre del cliente que pagó por el anuncio si es diferente del propietario de la cuenta. Cadena
StartDate Fecha UTC en la que se ejecutó el anuncio por primera vez o cuando la biblioteca de anuncios registró la primera impresión válida.

Nota: La biblioteca de anuncios solo registra impresiones de anuncios en la Unión Europea (UE) o en el Espacio Económico Europeo (EEE) desde junio de 2023. La fecha de inicio real de un anuncio puede ser anterior al inicio de nuestra biblioteca de anuncios o a la fecha en que el anuncio recibió su primera impresión válida.
Cadena
EndDate Fecha UTC en la que se ejecutó el anuncio por última vez o cuando la biblioteca de anuncios registró la última impresión válida.

Nota: Además de la nota anterior, puede haber un retraso de 1 a 3 días en la información que aparece en la biblioteca de anuncios, por lo que es posible que EndDate no refleje las impresiones más recientes mostradas en los últimos días si un anuncio sigue activo.
Cadena
TotalImpressionsRange Intervalo que representa el número total de impresiones que el anuncio ha recibido en la UE y el EEE. Cadena
ImpressionsByCountry Lista de pares clave-valor que representan el porcentaje de impresiones de cada país miembro de la UE o del EEE. array<CountryImpressionShareObject>
TargetTypes Una lista de tipos de destino que se usan para la segmentación de anuncios y si también se usaron para la exclusión.

Nota: Esta es una lista agregada de todos los tipos de destino usados en cualquier momento durante la ejecución del anuncio para todas las impresiones válidas y puede que no indique necesariamente qué factores se usaron para una impresión específica.
array<TargetTypeDetails>
RestrictionReason Si está presente, el motivo por el que se ha restringido la publicación de un anuncio en la biblioteca de anuncios o su visualización. RestrictionReason

CountryImpressionShare

Define el recurso compartido de impresiones de un anuncio para un país determinado.

Nombre Valor Tipo
País País en el que se mostró el anuncio. País
ImpressionShare La parte de las impresiones del anuncio para el país, representada como un porcentaje (es decir, 17,3%). Cadena

TargetDetails

Define el recurso compartido de impresiones de un anuncio para un país determinado.

Nombre Valor Tipo
TargetType Parámetro usado para la selección de destino. TargetType
UsedForExclusion Indica si el tipo de destino también se usó para la exclusión. Booleano

Conjuntos de valores

A continuación se muestran los conjuntos de valores que usa la API.

Objeto Description
País Define los valores de los países considerados por la biblioteca de anuncios para filtrar e informar de impresiones de anuncios.
TargetType Define los tipos de parámetros de destino a los que realiza el seguimiento la biblioteca de anuncios.
RestrictionReason Define la razón por la que se ha restringido la publicación de un anuncio o su visualización en la biblioteca de anuncios.

País

Define los valores de los países de la Unión Europea y de los miembros del Espacio Económico Europeo considerados por la Biblioteca de anuncios para filtrar e informar sobre las impresiones de anuncios.

Nombre Valor
Austria 10
Bélgica 14
Bulgaria 26
Croacia 49
Chipre 207
Checostia 51
Dinamarca 53
Estonia 61
Finlandia 65
Francia 66
Alemania 72
Grecia 76
Hungría 88
Irlanda 92
Italia 93
Letonia 104
Lituania 108
Luxemburgo 109
Malta 115
Países Bajos 129
Polonia 151
Portugal 152
Rumanía 226
Eslovaquia 165
Eslovenia 167
España 170
Suecia 175
Islandia 89
Liechtenstein 107
Noruega 139

TargetType

Define los tipos de parámetros de destino a los que realiza el seguimiento la biblioteca de anuncios.

Nombre Valor Description
Gender 1 Orientación basada en el género.
Edad 2 Segmentación basada en el grupo de edad.
Ubicación 3 Segmentación basada en áreas geográficas en las que se encuentran los usuarios o que buscan.
MicrosoftAudiences 22 Segmentación basada en audiencias definidas por Microsoft, incluidas audiencias en el mercado, audiencias similares y segmentación de perfiles de LinkedIn.
AnuncianteAudiences 25 Segmentación basada en audiencias definidas por el anunciante, incluidas audiencias personalizadas, listas de coincidencias de clientes y listas de remarketing.

Autenticación de API

Al igual que la interfaz de usuario de la biblioteca de anuncios, la API de la biblioteca de anuncios está disponible públicamente y no requiere ningún registro de usuario ni inicio de sesión. Sin embargo, para proteger la seguridad y la estabilidad de nuestra plataforma, las solicitudes no autenticadas se enfrentarán a límites más estrictos sobre la frecuencia con la que puede llamar a la API y cuántas entidades puede solicitar por llamada.

Para usar la API de la biblioteca de anuncios con límites mayores, necesitará lo siguiente:

  • Una cuenta de Microsoft
  • Una cuenta de Microsoft Advertising
  • Un token de desarrollador

Para crear una cuenta de Microsoft Advertising, vaya a https://ads.microsoft.com. Si no ha iniciado sesión en su cuenta Microsoft, se le redirigirá para iniciar sesión en su cuenta o para registrarse en una. Después de iniciar sesión, tendrá la opción de registrarse para obtener una nueva cuenta de Microsoft Advertising. Seleccione la opción de registro y seleccione Continuar.

Autenticación de las credenciales

La API de la biblioteca de anuncios usa los mismos esquemas de autenticación que Bing Ads API. Para obtener más información sobre cómo autenticar las credenciales de la cuenta de Microsoft con OAuth, consulte Autenticación con el Plataforma de identidad de Microsoft.

Puede usar el SDK de Bing Ads para .NET, Java o Python para autenticar las credenciales de la cuenta de Microsoft. Para obtener más información sobre el uso del SDK para obtener el token de acceso, consulte C# | Java | Python.

Nota: El SDK de Bing Ads no proporciona interfaces para la API de la biblioteca de anuncios. Solo debe usar el SDK para obtener el token de acceso si también usa el SDK para campañas de Microsoft Advertising. De lo contrario, puede que no valga la pena la sobrecarga de instalar el SDK.

Si no usa el SDK de Bing Ads para la autenticación, consulte Autenticación de credenciales de cuenta microsoft en C# para ver un ejemplo que muestra cómo usar OAuth para autenticar las credenciales de la cuenta microsoft.

¿Dónde usar las credenciales y los tokens de desarrollador?

Para aumentar los límites, todas las llamadas deben especificar:

  • Encabezado DeveloperToken establecido en el token de desarrollador.
  • Encabezado AuthenticationToken establecido en el token de acceso.

Para obtener información sobre estos y otros encabezados que la solicitud y la respuesta pueden contener, vea Encabezados.

Pasos más sencillos de Sign-Up de la cuenta de Microsoft Advertising

Si es un investigador o un regulador que desea acceder a la API de la biblioteca de anuncios, pero aún no tiene una cuenta de Microsoft Advertising o desea anunciarse en nuestra plataforma, siga estos pasos:

  1. Visite https://ads.microsoft.com/ y seleccione Registrarse ahora. de API de la biblioteca de anuncios Paso 1Registro

  2. Inicie sesión con una cuenta microsoft existente o seleccione Crear una.Registro de API de la biblioteca de anuncios Paso 2

  3. Use una dirección de correo electrónico o un número de teléfono existentes o seleccione Obtener una nueva dirección de correo electrónico. Paso 3 del registro de la API de la biblioteca de anuncios
    Escriba la información anterior si va a crear una nueva dirección de correo electrónico (dirección de correo electrónico, contraseña, nombre/apellido, país/región y fecha de nacimiento) y resuelva captcha si es necesario.

  4. Para pasar por alto la configuración lo más rápido posible, seleccione Crear nueva campaña y , a continuación, Cambiar a experto. Paso 4a paso 4a de registro de la API de la biblioteca de anuncios
    Paso 4b paso 4b del registro de la API de la biblioteca de anuncios

  5. Seleccione Omitir la creación de campañas para configurar una cuenta sin una campaña. Registro de API de la biblioteca de anuncios Paso 5

  6. En este momento, se ha creado una cuenta y no se necesita más información. Registro de API de la biblioteca de anuncios Paso 6

Ahora puede continuar con cuenta de desarrollador para solicitar un token para acceder a la API. Como parte de esto, deberá revisar nuestros Términos de uso para desarrolladores.