Compartir a través de

Operación del servicio GetRecommendations: Ad Insight

  • Artículo

Descubra sus recomendaciones.

Elementos Request

El objeto GetRecommendationsRequest define los elementos body y header de la solicitud de operación de servicio. Los elementos deben estar en el mismo orden que se muestra en la solicitud SOAP.

Nota:

A menos que se indique lo contrario a continuación, se requieren todos los elementos de solicitud.

Elementos del cuerpo de la solicitud

Elemento Descripción Tipo de datos
AdGroupId Identificador del grupo de anuncios para el que quieres determinar las oportunidades de anuncios de búsqueda con capacidad de respuesta.

Si este elemento es nulo o vacío, la operación devolverá todas las oportunidades de determinado tipo de recomendación para la campaña especificada.		 largo
CampaignId Identificador de la campaña propietaria del grupo de anuncios especificado en el elemento AdGroupId .

Si este elemento es nulo o está vacío, adGroupId también debe ser nulo o vacío, y la operación devolverá todas las oportunidades de un tipo de recomendación determinado para la cuenta.		 largo
RecommendationType Identificador del tipo de recomendación que desea obtener.

Este elemento no puede ser nulo ni vacío. Un tipo de recomendación por solicitud, por ejemplo, ResponsiveSearchAdsOpportunity.		 string

Elementos de encabezado de solicitud

Elemento Descripción Tipo de datos
AuthenticationToken Token de acceso de OAuth que representa las credenciales de un usuario que tiene permisos para cuentas de Microsoft Advertising.

Para obtener más información, consulte Autenticación con OAuth.		 string
CustomerAccountId Identificador de la cuenta de anuncio que posee o está asociada a las entidades de la solicitud. Este elemento de encabezado debe tener el mismo valor que el elemento de cuerpo AccountId cuando ambos son necesarios. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo.

Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente.		 string
CustomerId Identificador de la cuenta de administrador (cliente) desde la que el usuario accede o funciona. Un usuario puede tener acceso a varias cuentas de administrador. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo.

Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente.		 string
DeveloperToken Token de desarrollador que se usa para acceder a Bing Ads API.

Para obtener más información, consulte Obtención de un token de desarrollador.		 string
Password Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. string
UserName Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. string

Elementos de respuesta

El objeto GetRecommendationsResponse define los elementos body y header de la respuesta de la operación de servicio. Los elementos se devuelven en el mismo orden que se muestra en soap de respuesta.

Elementos del cuerpo de la respuesta

Elemento Descripción Tipo de datos
Recomendaciones Matriz de objetos Recommendation .

Se pueden devolver 2000 elementos de lista como máximo.		 Matriz de recomendaciones

Elementos de encabezado de respuesta

Elemento Descripción Tipo de datos
Seguimiento del Id. Identificador de la entrada de registro que contiene los detalles de la llamada API. string

Solicitud de SOAP

Esta plantilla se generó mediante una herramienta para mostrar el orden del cuerpo y los elementos de encabezado de la solicitud SOAP. Para ver los tipos admitidos que puede usar con esta operación de servicio, consulte la referencia de elementos de cuerpo de solicitud anterior.

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/AdInsight/v13">
    <Action mustUnderstand="1">GetRecommendations</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
    <CustomerId i:nil="false">ValueHere</CustomerId>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetRecommendationsRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <CampaignId i:nil="false">ValueHere</CampaignId>
      <AdGroupId i:nil="false">ValueHere</AdGroupId>
      <RecommendationType i:nil="false">ValueHere</RecommendationType>
    </GetRecommendationsRequest>
  </s:Body>
</s:Envelope>

SOAP de respuesta

Esta plantilla se generó mediante una herramienta para mostrar el orden de los elementos body y header para la respuesta SOAP.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/AdInsight/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <GetRecommendationsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Recommendations d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <Recommendation d4p1:type="-- derived type specified here with the appropriate prefix --">
          <AccountId>ValueHere</AccountId>
          <AdGroupId d4p1:nil="false">ValueHere</AdGroupId>
          <CampaignId d4p1:nil="false">ValueHere</CampaignId>
          <CurrentClicks>ValueHere</CurrentClicks>
          <CurrentConversions>ValueHere</CurrentConversions>
          <CurrentCost>ValueHere</CurrentCost>
          <CurrentImpressions>ValueHere</CurrentImpressions>
          <EstimatedIncreaseInClicks>ValueHere</EstimatedIncreaseInClicks>
          <EstimatedIncreaseInConversions>ValueHere</EstimatedIncreaseInConversions>
          <EstimatedIncreaseInCost>ValueHere</EstimatedIncreaseInCost>
          <EstimatedIncreaseInImpressions>ValueHere</EstimatedIncreaseInImpressions>
          <RecommendationHash d4p1:nil="false">ValueHere</RecommendationHash>
          <RecommendationId d4p1:nil="false">ValueHere</RecommendationId>
          <RecommendationType d4p1:nil="false">ValueHere</RecommendationType>
          <!--This field is applicable if the derived type attribute is set to ResponsiveSearchAdsRecommendation-->
          <SuggestedAd d4p1:nil="false">
            <Descriptions d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <a1:string>ValueHere</a1:string>
            </Descriptions>
            <FinalUrl d4p1:nil="false">ValueHere</FinalUrl>
            <Headlines d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <a1:string>ValueHere</a1:string>
            </Headlines>
            <Path1 d4p1:nil="false">ValueHere</Path1>
            <Path2 d4p1:nil="false">ValueHere</Path2>
          </SuggestedAd>
        </Recommendation>
      </Recommendations>
    </GetRecommendationsResponse>
  </s:Body>
</s:Envelope>

Sintaxis de código

La sintaxis de ejemplo se puede usar con los SDK de Bing Ads. Consulte Ejemplos de código de API de Bing Ads para obtener más ejemplos.

public async Task<GetRecommendationsResponse> GetRecommendationsAsync(
	long? campaignId,
	long? adGroupId,
	string recommendationType)
{
	var request = new GetRecommendationsRequest
	{
		CampaignId = campaignId,
		AdGroupId = adGroupId,
		RecommendationType = recommendationType
	};

	return (await AdInsightService.CallAsync((s, r) => s.GetRecommendationsAsync(r), request));
}

static GetRecommendationsResponse getRecommendations(
	java.lang.Long campaignId,
	java.lang.Long adGroupId,
	java.lang.String recommendationType) throws RemoteException, Exception
{
	GetRecommendationsRequest request = new GetRecommendationsRequest();

	request.setCampaignId(campaignId);
	request.setAdGroupId(adGroupId);
	request.setRecommendationType(recommendationType);

	return AdInsightService.getService().getRecommendations(request);
}

static function GetRecommendations(
	$campaignId,
	$adGroupId,
	$recommendationType)
{

	$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];

	$request = new GetRecommendationsRequest();

	$request->CampaignId = $campaignId;
	$request->AdGroupId = $adGroupId;
	$request->RecommendationType = $recommendationType;

	return $GLOBALS['AdInsightProxy']->GetService()->GetRecommendations($request);
}

response=adinsight_service.GetRecommendations(
	CampaignId=CampaignId,
	AdGroupId=AdGroupId,
	RecommendationType=RecommendationType)

Requisitos

Servicio: AdInsightService.svc v13
Namespace: https://bingads.microsoft.com/AdInsight/v13

Dirección URL de solicitud

https://adinsight.api.bingads.microsoft.com/AdInsight/v13/Recommendations/Query

Elementos Request

El objeto GetRecommendationsRequest define los elementos body y header de la solicitud de operación de servicio.

Nota:

A menos que se indique lo contrario a continuación, se requieren todos los elementos de solicitud.

Elementos del cuerpo de la solicitud

Elemento Descripción Tipo de datos
AdGroupId Identificador del grupo de anuncios para el que quieres determinar las oportunidades de anuncios de búsqueda con capacidad de respuesta.

Si este elemento es nulo o vacío, la operación devolverá todas las oportunidades de determinado tipo de recomendación para la campaña especificada.		 largo
CampaignId Identificador de la campaña propietaria del grupo de anuncios especificado en el elemento AdGroupId .

Si este elemento es nulo o está vacío, adGroupId también debe ser nulo o vacío, y la operación devolverá todas las oportunidades de un tipo de recomendación determinado para la cuenta.		 largo
RecommendationType Identificador del tipo de recomendación que desea obtener.

Este elemento no puede ser nulo ni vacío. Un tipo de recomendación por solicitud, por ejemplo, ResponsiveSearchAdsOpportunity.		 string

Elementos de encabezado de solicitud

Elemento Descripción Tipo de datos
Autorización Token de acceso de OAuth que representa las credenciales de un usuario que tiene permisos para cuentas de Microsoft Advertising. Asegúrese de que el token tiene el prefijo "Portador", esto es necesario para la autenticación adecuada.

Para obtener más información, consulte Autenticación con OAuth.		 string
CustomerAccountId Identificador de la cuenta de anuncio que posee o está asociada a las entidades de la solicitud. Este elemento de encabezado debe tener el mismo valor que el elemento de cuerpo AccountId cuando ambos son necesarios. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo.

Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente.		 string
CustomerId Identificador de la cuenta de administrador (cliente) desde la que el usuario accede o funciona. Un usuario puede tener acceso a varias cuentas de administrador. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo.

Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente.		 string
DeveloperToken Token de desarrollador que se usa para acceder a Bing Ads API.

Para obtener más información, consulte Obtención de un token de desarrollador.		 string
Password Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. string
UserName Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. string

Elementos de respuesta

El objeto GetRecommendationsResponse define los elementos body y header de la respuesta de la operación de servicio. Los elementos se devuelven en el mismo orden que se muestra en el JSON de respuesta.

Elementos del cuerpo de la respuesta

Elemento Descripción Tipo de datos
Recomendaciones Matriz de objetos Recommendation .

Se pueden devolver 2000 elementos de lista como máximo.		 Matriz de recomendaciones

Elementos de encabezado de respuesta

Elemento Descripción Tipo de datos
Seguimiento del Id. Identificador de la entrada de registro que contiene los detalles de la llamada API. string

Solicitud de JSON

Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la solicitud JSON. Para ver los tipos admitidos que puede usar con esta operación de servicio, consulte la referencia de elementos de cuerpo de solicitud anterior.

{
  "CampaignId": "LongValueHere",
  "AdGroupId": "LongValueHere",
  "RecommendationType": "ValueHere"
}

JSON de respuesta

Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la respuesta JSON.

A continuación se muestra un ejemplo que es aplicable si el tipo de recomendación es ResponsiveSearchAdsRecommendation.

{
  "Recommendations": [
    {
      "AccountId": "LongValueHere",
      "AdGroupId": "LongValueHere",
      "CampaignId": "LongValueHere",
      "CurrentClicks": "LongValueHere",
      "CurrentConversions": "LongValueHere",
      "CurrentCost": DoubleValueHere,
      "CurrentImpressions": "LongValueHere",
      "EstimatedIncreaseInClicks": "LongValueHere",
      "EstimatedIncreaseInConversions": "LongValueHere",
      "EstimatedIncreaseInCost": DoubleValueHere,
      "EstimatedIncreaseInImpressions": "LongValueHere",
      "RecommendationHash": "ValueHere",
      "RecommendationId": "ValueHere",
      "RecommendationType": "ValueHere",
      "Type": "ResponsiveSearchAdsRecommendation",
      "SuggestedAd": {
        "Descriptions": [
          "ValueHere"
        ],
        "FinalUrl": "ValueHere",
        "Headlines": [
          "ValueHere"
        ],
        "Path1": "ValueHere",
        "Path2": "ValueHere"
      }
    }
  ]
}

Sintaxis de código

Para llamar a la API REST a través de SDK, debe actualizar el SDK a una versión determinada y configurar los parámetros del sistema. La sintaxis de ejemplo se puede usar con los SDK de Bing Ads. Consulte Ejemplos de código de API de Bing Ads para obtener más ejemplos.

public async Task<GetRecommendationsResponse> GetRecommendationsAsync(
	long? campaignId,
	long? adGroupId,
	string recommendationType)
{
	var request = new GetRecommendationsRequest
	{
		CampaignId = campaignId,
		AdGroupId = adGroupId,
		RecommendationType = recommendationType
	};

	return (await AdInsightService.CallAsync((s, r) => s.GetRecommendationsAsync(r), request));
}

static GetRecommendationsResponse getRecommendations(
	java.lang.Long campaignId,
	java.lang.Long adGroupId,
	java.lang.String recommendationType) throws RemoteException, Exception
{
	GetRecommendationsRequest request = new GetRecommendationsRequest();

	request.setCampaignId(campaignId);
	request.setAdGroupId(adGroupId);
	request.setRecommendationType(recommendationType);

	return AdInsightService.getService().getRecommendations(request);
}

static function GetRecommendations(
	$campaignId,
	$adGroupId,
	$recommendationType)
{

	$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];

	$request = new GetRecommendationsRequest();

	$request->CampaignId = $campaignId;
	$request->AdGroupId = $adGroupId;
	$request->RecommendationType = $recommendationType;

	return $GLOBALS['AdInsightProxy']->GetService()->GetRecommendations($request);
}

response=adinsight_service.GetRecommendations(
	CampaignId=CampaignId,
	AdGroupId=AdGroupId,
	RecommendationType=RecommendationType)