Compartir a través de

Migración a la versión 13

  • Artículo

Nota:

Bing Ads API versión 12 sunset a partir del 31 de octubre de 2019.

En las secciones siguientes se describen los cambios de Bing Ads API de la versión 12 a la versión 13.

Autenticación para todos los servicios

El punto de conexión de la plataforma de identidad de Microsoft para desarrolladores ya está disponible. El punto de conexión de la plataforma de identidad de Microsoft permite cuentas profesionales o educativas de Azure AD y cuentas personales de Microsoft (MSA), como hotmail.com, outlook.com y msn.com. El punto de conexión de Live Connect solo permite la autenticación con cuentas personales.

Aunque la migración desde el punto de conexión de Live Connect al punto de conexión de la plataforma de identidad de Microsoft es independiente de la migración de la versión 12 a la 13, entendemos que a muchos desarrolladores les gustaría actualizar durante el mismo sprint.

Importante

El punto de conexión de Live Connect ya no es el enfoque recomendado para los usuarios de Microsoft Advertising. Actualice al punto de conexión de la plataforma de identidad de Microsoft para asegurarse de que la aplicación puede admitir a todos los usuarios sin fricción ni interrupción del servicio. Solo el punto de conexión de la plataforma de identidad de Microsoft (v2.0) permite obtener tokens de acceso para autenticar cuentas profesionales y personales a través de la API de Bing Ads.

Información de anuncios

Para obtener documentación de referencia de servicio de la versión 13 completa, consulte Ad Insight.

Cambios importantes

Cliente proxy

Actualice el cliente proxy para usar la nueva dirección de punto de conexión y el espacio de nombres.

El espacio de nombres de destino es https://bingads.microsoft.com/AdInsight/v13.

El punto de conexión de producción es https://adinsight.api.bingads.microsoft.com/Api/Advertiser/AdInsight/v13/AdInsightService.svc.

El punto de conexión de espacio aislado es https://adinsight.api.sandbox.bingads.microsoft.com/Api/Advertiser/AdInsight/v13/AdInsightService.svc.

Espacio de nombres del contrato de datos

Anteriormente, en la versión 12, el espacio de nombres del contrato de datos para algunas entidades había variado con respecto al espacio de nombres de destino de Ad Insight. Si usó cualquiera de los siguientes espacios de nombres de la versión 12, debe usar https://bingads.microsoft.com/AdInsight/v13 insteaed en la versión 13.

  • Microsoft.BingAds.Advertiser.AdInsight.Api.DataContract.V12.Entity.SearchParameters
  • Microsoft.BingAds.Advertiser.AdInsight.Api.DataContract.V12.Entity.Common
  • Microsoft.BingAds.Advertiser.AdInsight.Api.DataContract.V12.Entity.Criterions
  • Microsoft.BingAds.Advertiser.AdInsight.Api.DataContract.V12.Entity

Los clientes que codifican el sobre SOAP e.g. PHP clientes que codifican para SoapVarDateRangeSearchParameter, deberá actualizar al espacio de nombres de destino de Ad Insight Versión 13, es decir, https://bingads.microsoft.com/AdInsight/v13.

Los clientes del SDK de Python de Bing Ads tendrán que actualizar varios prefijos de espacio de nombres para los objetos de fábrica del cliente SUDS , por ejemplo, si usó ns4:DateRangeSearchParameter en bing Ads API versión 12, usará DateRangeSearchParameter (sin el prefijo "ns4") en la versión 13. Consulte Uso de SUDS para obtener más información sobre cómo determinar el prefijo de espacio de nombres.

Masivo

Para obtener documentación completa de referencia de servicio de la versión 13, consulte Bulk.

Cambios importantes

Cliente proxy

Actualice el cliente proxy para usar la nueva dirección de punto de conexión y el espacio de nombres.

El espacio de nombres de destino es https://bingads.microsoft.com/CampaignManagement/v13.

El punto de conexión de producción es https://bulk.api.bingads.microsoft.com/Api/Advertiser/CampaignManagement/v13/BulkService.svc.

El punto de conexión de espacio aislado es https://bulk.api.sandbox.bingads.microsoft.com/Api/Advertiser/CampaignManagement/v13/BulkService.svc.

Recursos de imagen de anuncio con capacidad de respuesta

Las columnas Landscape Image Media Id, Landscape Logo Media Id, Square Image Media Id y Square Logo Media Id están en desuso del registro de anuncios con capacidad de respuesta. Seguirán siendo visibles en el archivo de descarga, aunque dado que se quitarán en una versión futura, no debe tomar ninguna dependencia en estas columnas. En su lugar, use la columna Imágenes .

Datos de rendimiento de entidad

La descarga masiva de datos de rendimiento se había extinto anteriormente en la versión 12. Ahora, en la versión 13, el valor EntityPerformanceData del conjunto de valores DataScope se quita del contrato de servicio. También se quitan los objetos Date y PerformanceStatsDateRange y el conjunto de valores ReportTimePeriod Si desea que los datos se agreguen por día, semana o mes, puede usar reporting API. Para obtener más información, consulte Guías de reporting API.

Administración de campañas

Para obtener documentación completa sobre la referencia del servicio de la versión 13, consulte Administración de campañas.

Cambios importantes

Cliente proxy

Actualice el cliente proxy para usar la nueva dirección de punto de conexión y el espacio de nombres.

El espacio de nombres de destino es https://bingads.microsoft.com/CampaignManagement/v13.

El punto de conexión de producción es https://campaign.api.bingads.microsoft.com/Api/Advertiser/CampaignManagement/v13/CampaignManagementService.svc.

El punto de conexión de espacio aislado es https://campaign.api.sandbox.bingads.microsoft.com/Api/Advertiser/CampaignManagement/v13/CampaignManagementService.svc.

Recursos de imagen de anuncio con capacidad de respuesta

Los elementos LandscapeImageMediaId, LandscapeLogoMediaId, SquareImageMediaId y SquareLogoMediaId se quitan del objeto ResponsiveAd . En su lugar, debe usar el elemento Images .

Recursos de texto de anuncio con capacidad de respuesta

Si usó el elemento de cadena LongHeadline en la versión 12, debe usar el elemento LongHeadlineString (cadena) de la versión 13. El tipo de datos de LongHeadline se actualiza de cadena a AssetLink. Este vínculo de recurso está reservado para su uso futuro.

Las listas de vínculos de recursos Titulares y descripciones se agregan para su uso futuro.

Paginación predeterminada para GetMediaMetaDataByAccountId

Si el elemento PageInfo no se establece al llamar a la operación GetMediaMetaDataByAccountId , la página defaut Index será 0 y el valor predeterminado Size será 1000. En la versión 12 si no se estableció PageInfo, se devolverán todos los metadatos multimedia de la cuenta.

Se omite la puja de criterio para el tipo de datos no válido

Tanto para la versión 12 como para la 13 al agregar y actualizar un biddableCampaignCriterion, los requisitos derivados del tipo de objeto CriterionBid varían en función del contexto del tipo de objeto Criterion derivado con el que se empareja. Por ejemplo, si el criterio heredado es un criterio ProductScope , debe usar un objeto FixedBid (no un BidMultiplier).

En la versión 13 si no usa el objeto Criterion correcto, se omitirá la oferta solicitada: si se requiere la oferta, se producirá un error en la operación; Si la oferta es opcional, se usará la oferta predeterminada.

En la versión 12 si no usa el objeto Criterion correcto, se habría cumplido la oferta solicitada; sin embargo, cuando se recupera el objeto más adelante, se devuelve el tipo correcto. En otras palabras, el tipo de datos que se establece no es el mismo que el tipo de datos recuperado.

Este cambio de la versión 12 a la versión 13 solo se aplica a los criterios de puja de nivel de campaña. Para los criterios de grupo de anuncios pujables de la versión 12 y 13, si no usa el objeto Criterion correcto, se omitirá la oferta solicitada: si se requiere la oferta, se producirá un error en la operación; Si la oferta es opcional, se usará la oferta predeterminada.

Oferta de palabra clave opcional

Al llamar a la operación AddKeywords , el elemento Bid de la palabra clave es opcional. Anteriormente, en la versión 12, la puja era necesaria para agregar palabras clave. Si quieres heredar la puja predeterminada del grupo de anuncios para la palabra clave y el tipo de coincidencia, puedes dejar la oferta de palabra clave vacía.

Tipo de coincidencia de palabras clave negativas

El elemento MatchType de NegativeKeyword es nillable. Si anteriormente había tomado una dependencia del valor predeterminado MatchType en la versión 12, es decir, Exacto, debe establecer explícitamente este elemento necesario en la versión 13.

Origen de anuncios de búsqueda dinámica

El elemento Source de DynamicSearchAdsSetting es inalcable. El elemento IncludeDynamicSearchAdsSource se quita de los mensajes de solicitud AddCampaigns y UpdateCampaigns . Si está habilitado para las fuentes de páginas, en la versión 13 puede establecer el origen.

Descripción de la campaña

El elemento Description se quita del objeto Campaign . Todavía puede usar el elemento Name para proporcionar un nombre de campaña único.

Devolver campos adicionales

El elemento ReturnAdditionalFields se quita de GetAdExtensionsAssociations, GetAdExtensionsByIds, GetAdGroupCriterionsByIds, GetAdGroupsByCampaignId, GetAdGroupsByIds, GetAdsByAdGroupId, GetAdsByEditorialStatus, GetAdsByIds, GetCampaignsByAccountId, GetCampaignsByIds, GetKeywordsByAdGroupId, GetKeywordsByEditorialStatus y GetKeywordsByIds solicita mensajes. Todos los elementos de cada anuncio, extensión de anuncio, grupo de anuncios, criterio de grupo de anuncios pujables, campaña y palabra clave se devuelven de forma predeterminada.

En paralelo, se quitan los conjuntos de valores AdAdditionalField, AdExtensionAdditionalField, AdGroupAdditionalField, AdGroupCriterionAdditionalField, CampaignAdditionalField y KeywordAdditionalField.

Migración de destino completada

Anteriormente se completó la migración de un destino compartido a una campaña exclusiva y criterios de destino de grupo de anuncios. El elemento IsMigrated ahora se quita de la respuesta de las operaciones AddAdGroupCriterions, UpdateAdGroupCriterions, AddCampaignCriterions y UpdateCampaignCriterions .

Características nuevas

Nuevos tipos de estrategia de puja

Los tipos de estrategia de puja MaxRoasBiddingScheme y TargetRoasBiddingScheme se agregan para su uso futuro en la versión 13.

Recurso compartido de clientes

El elemento CustomerShare se agrega a los objetos Audience y UetTag . Este elemento está reservado para su uso futuro.

Exclusión del objetivo de conversión de las pujas

El elemento ExcludeFromBidding se agrega al objeto ConversionGoal . Este elemento está reservado para su uso futuro.

Facturación del cliente

Para obtener documentación completa de referencia de servicio de la versión 13, consulte Facturación del cliente.

Cambios importantes

Cliente proxy

Actualice el cliente proxy para usar la nueva dirección de punto de conexión y el espacio de nombres.

El espacio de nombres de destino es https://bingads.microsoft.com/Billing/v13.

El punto de conexión de producción es https://clientcenter.api.bingads.microsoft.com/Api/Billing/v13/CustomerBillingService.svc.

El punto de conexión de espacio aislado es https://clientcenter.api.sandbox.bingads.microsoft.com/Api/Billing/v13/CustomerBillingService.svc.

Objeto Order de inserción

Se agregan varias propiedades al objeto InsertionOrder .

El elemento BalanceAmount se quita y reemplaza por el elemento BudgetRemaining .

GetInsertionOrdersByAccount se ha quitado

Se quita la operación GetInsertionOrdersByAccount. Puede usar SearchInsertionOrders en la versión 13.

Administración de clientes

Para obtener documentación de referencia de servicio de la versión 13 completa, consulte Administración de clientes.

Cambios importantes

Cliente proxy

Actualice el cliente proxy para usar la nueva dirección de punto de conexión y el espacio de nombres.

El espacio de nombres de destino es https://bingads.microsoft.com/Customer/v13.

El punto de conexión de producción es https://clientcenter.api.bingads.microsoft.com/Api/CustomerManagement/v13/CustomerManagementService.svc.

El punto de conexión de espacio aislado es https://clientcenter.api.sandbox.bingads.microsoft.com/Api/CustomerManagement/v13/CustomerManagementService.svc.

Se realizan varios cambios en el objeto ClientLink .

Dirección del cliente

En la versión 13, el elemento CustomerAddress se incluirá en todos los objetos Customer devueltos de forma predeterminada. No es necesario solicitar explícitamente este elemento. El elemento IncludeCustomerAddress se quita de los mensajes de solicitud GetCustomer y SearchCustomers .

Id. de cuenta vinculada

En la versión 13, el elemento LinkedAccountIds se incluirá en todos los objetos CustomerRole devueltos de forma predeterminada. No es necesario solicitar explícitamente este elemento. El elemento IncludeLinkedAccountIds se quita del mensaje de solicitud GetUser .

Información fiscal para Australia y Brasil

Las claves TaxId y TaxType ya no están disponibles al establecer la cuenta TaxInformation para Australia y Brasil. Para Australia, use AUGSTNumber como clave y establezca el valor en el identificador fiscal. Para Brasil, las claves posibles son CCM, CPF y CNPJ.

Descripción Versión 12 Versión 13
Cuentas en Australia TaxId=YourTaxId AUGSTNumber=YourTaxId
Cuentas empresariales en Brasil TaxId=YourTaxId; TaxType=Business CPNJ=YourTaxId
Cuentas personales en Brasil TaxId=YourTaxId; TaxType=Personal CPF=YourTaxId

Para las cuentas empresariales dentro de la ciudad de Sao Paulo, Brasil no hay ningún cambio en la clave ccm entre las versiones 12 y 13.

Características nuevas

Permiso de vínculo de rol de cliente

El elemento CustomerLinkPermission se agrega al objeto CustomerRole . Este elemento está reservado para su uso futuro.

Reporting

Para obtener documentación de referencia de servicio de la versión 13 completa, consulte Informes.

Cambios importantes

Cliente proxy

Actualice el cliente proxy para usar la nueva dirección de punto de conexión y el espacio de nombres.

El espacio de nombres de destino es https://bingads.microsoft.com/Reporting/v13.

El punto de conexión de producción es https://reporting.api.bingads.microsoft.com/Api/Advertiser/Reporting/v13/ReportingService.svc.

El punto de conexión de espacio aislado es https://reporting.api.sandbox.bingads.microsoft.com/Api/Advertiser/Reporting/v13/ReportingService.svc.

Columnas necesarias para ProductMatchCountReportRequest

Las columnas necesarias se actualizan al enviar ProductMatchCountReportRequest. En la versión 13 se requieren las columnas AccountName, CampaignName, MatchedProductsAtProductGroup y ProductGroup.

Anteriormente, en la versión 12, además del requisito AccountName y CampaignName, se requerían una o varias de las columnas de estadísticas de rendimiento MatchedProductsAtAdGroup, MatchedProductsAtCampaign o MatchedProductsAtProductGroup.

Filtro de informe de idioma

Se agrega el conjunto de valores LanguageReportFilter . El elemento LanguageCode (cadena) se reemplaza por el elemento Languages (LanguageReportFilter) de los siguientes filtros de informe.

Informe de todas las conversiones e ingresos por objetivos

Las columnas Conversiones e Ingresos de GoalsAndFunnelsReportColumn se denominan AllConversions y AllRevenue , respectivamente. El significado de los datos no ha cambiado de la versión 12 a la 13.

Encabezados de informe en francés

Se ha quitado la compatibilidad con la descarga de un informe con encabezados en francés. Solo se admiten encabezados en inglés en la versión 13. El elemento Language se quita del objeto ReportRequest y se quita el conjunto de valores ReportLanguage .

Se quitó AgeGenderDemographicReportRequest

Se quita AgeGenderDemographicReportRequest. En su lugar, puede usar AgeGenderAudienceReportRequest.

Tipo de campaña de búsqueda

En el caso de las campañas de búsqueda, los datos devueltos en la columna CampaignType son "Search". En la versión 12, el valor devuelto era "Buscar & contenido". La columna CampaignType está disponible a través de los conjuntos de valores AdGroupPerformanceReportColumn, AdPerformanceReportColumn, CampaignPerformanceReportColumn y SearchQueryPerformanceReportColumn .

Formato de datos del grupo de productos

Se actualiza el formato de los datos devueltos en la columna ProductGroup .

Versión Descripción Ejemplo
12 Usa "\" (barra diagonal inversa) para delimitar los niveles.

Los valores de atributo no están rodeados por "" (comillas dobles).

El nivel de categoría se anexa a los valores de atributo si es aplicable, por ejemplo, "(1st Level)", "(2nd Level)", etc.		 * \ Category=Animals & Pet Supplies(1st Level) \ Category=Pet Supplies(2nd Level) \ Category=Bird Supplies(3rd Level)
13 Usa "/" (barra diagonal) para delimitar los niveles.

Los valores de atributo están rodeados por "" (comillas dobles).

No indica el nivel de categoría, por ejemplo, se quita "(1º nivel)".		 * / Category="Animals & Pet Supplies" / Category="Pet Supplies" / Category="Bird Supplies"

Este cambio se aplica a la columna ProductGroup a través de los siguientes conjuntos de valores.

Guión para puntuación de calidad no disponible

En la versión 13 si no se calculó la puntuación de calidad, los datos devueltos serán "--" (guion doble) en las columnas AdRelevance, ExpectedCtr, HistoricalAdRelevance, HistoricalExpectedCtr, HistoricalLandingPageExperience, HistoricalQualityScore, LandingPageExperience y QualityScore. En la versión 12 se devolvió el valor de "0" (cero). Estas columnas están disponibles en los conjuntos de valores AdGroupPerformanceReportColumn, CampaignPerformanceReportColumn, KeywordPerformanceReportColumn y ShareOfVoiceReportColumn .

Se han reemplazado algunas columnas del recurso compartido de impresiones.

Los conjuntos de valores ImpressionLostToAdRelevancePercent, ImpressionLostToBidPercent, ImpressionLostToExpectedCtrPercent, ImpressionLostToRelevancePercent e ImpressionLostToRankPercent se quitan de los conjuntos de valores AccountPerformanceReportColumn, AdGroupPerformanceReportColumn, CampaignPerformanceReportColumn y ShareOfVoiceReportColumn .

En la versión 13, los datos que se habían dividido entre esas columnas de la versión 12 se agregan y están disponibles a través de la columna ImpressionLostToRankAggPercent, que tiene en cuenta todos esos factores al calcular la impresión perdida en porcentaje de clasificación.

Columnas AverageCpp, ClickCalls y ManualCalls eliminadas

Las columnas AverageCpp, ClickCalls y ManualCalls se quitan de los conjuntos de valores AccountPerformanceReportColumn, AdGroupPerformanceReportColumn y CampaignPerformanceReportColumn .

Columnas CallStatus y CallTypeName eliminadas

Las columnas CallStatus y CallTypeName se quitan del conjunto de valores CallDetailReportColumn . Microsoft Advertising dejó de cobrar por llamadas manuales a un número seguido el 12 de marzo de 2014.

Requerir ámbito de cuenta, campaña o grupo de anuncios

En la versión 13, debes limitar la solicitud a cuentas, campañas o grupos de anuncios específicos. Por ejemplo, puede incluir hasta 1000 cuentas, 300 campañas o 300 grupos de anuncios a través de AccountThroughAdGroupReportScope. Anteriormente, en la versión 12, se podía dejar el ámbito de informe null para algunos tipos de informe y se devolverían datos para todas las cuentas a las que se podía acceder.