Compartir a través de

Operación del servicio RetrieveRecommendations: Ad Insight

  • Artículo

Recupere una lista de recomendaciones.

Elementos Request

El objeto RetrieveRecommendationsRequest 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
MaxCount Número máximo de recomendaciones devueltas. El valor predeterminado es null. Si MaxCount es null o 0, devuelve todas las recomendaciones disponibles. Opcional. int
RecommendationTypes Los nombres de tipo de recomendación: ADD_BROAD_MATCH_KEYWORD, CAMPAIGN_BUDGET, KEYWORD, REMOVE_CONFLICTING_NEGATIVE_KEYWORD, RESPONSIVE_SEARCH_AD o RESPONSIVE_SEARCH_AD_ASSET. Obligatorio. matriz de cadenas

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 RetrieveRecommendationsResponse 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 Las recomendaciones disponibles para un identificador de cuenta específico. Los tipos de recomendaciones son: AddBroadMatchKeywordRecommendation, CampaignBudgetRecommendation, KeywordRecommendation, RemoveConflictingNegativeKeywordRecommendation, ResponsiveSearchAdRecommendation y ResponsiveSearchAdAssetRecommendation. Matriz RecommendationBase

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">RetrieveRecommendations</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>
    <RetrieveRecommendationsRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <RecommendationTypes i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string>ValueHere</a1:string>
      </RecommendationTypes>
      <MaxCount i:nil="false">ValueHere</MaxCount>
    </RetrieveRecommendationsRequest>
  </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>
    <RetrieveRecommendationsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Recommendations d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <RecommendationBase d4p1:type="-- derived type specified here with the appropriate prefix --">
          <AccountId>ValueHere</AccountId>
          <AccountName d4p1:nil="false">ValueHere</AccountName>
          <AdGroupId d4p1:nil="false">ValueHere</AdGroupId>
          <AdGroupName d4p1:nil="false">ValueHere</AdGroupName>
          <CampaignId d4p1:nil="false">ValueHere</CampaignId>
          <CampaignName d4p1:nil="false">ValueHere</CampaignName>
          <CurrentClicks>ValueHere</CurrentClicks>
          <CurrentConversions>ValueHere</CurrentConversions>
          <CurrentCost>ValueHere</CurrentCost>
          <CurrentImpressions>ValueHere</CurrentImpressions>
          <Dismissed>ValueHere</Dismissed>
          <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>
          <Type>ValueHere</Type>
          <!--These fields are applicable if the derived type attribute is set to CampaignBudgetRecommendation-->
          <BudgetPoints d4p1:nil="false">
            <BudgetPoint>
              <BudgetAmount>ValueHere</BudgetAmount>
              <BudgetPointType>ValueHere</BudgetPointType>
              <EstimatedWeeklyClicks>ValueHere</EstimatedWeeklyClicks>
              <EstimatedWeeklyCost>ValueHere</EstimatedWeeklyCost>
              <EstimatedWeeklyImpressions>ValueHere</EstimatedWeeklyImpressions>
            </BudgetPoint>
          </BudgetPoints>
          <BudgetType>ValueHere</BudgetType>
          <CurrentBudget>ValueHere</CurrentBudget>
          <RecommendedBudget>ValueHere</RecommendedBudget>
          <!--These fields are applicable if the derived type attribute is set to KeywordRecommendation-->
          <Competition>ValueHere</Competition>
          <MatchType>ValueHere</MatchType>
          <MonthlySearches>ValueHere</MonthlySearches>
          <SuggestedBid>ValueHere</SuggestedBid>
          <SuggestedKeyword d4p1:nil="false">ValueHere</SuggestedKeyword>
          <!--This field is applicable if the derived type attribute is set to ResponsiveSearchAdRecommendation-->
          <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>
          <!--These fields are applicable if the derived type attribute is set to RemoveConflictingNegativeKeywordRecommendation-->
          <NegativeKeyword d4p1:nil="false">ValueHere</NegativeKeyword>
          <NegativeKeywordId>ValueHere</NegativeKeywordId>
          <NegativeKeywordListName d4p1:nil="false">ValueHere</NegativeKeywordListName>
          <NegativeKeywordMatchType>ValueHere</NegativeKeywordMatchType>
          <NegativeKeywordSharedListId d4p1:nil="false">ValueHere</NegativeKeywordSharedListId>
          <Source d4p1:nil="false">ValueHere</Source>
          <!--These fields are applicable if the derived type attribute is set to UseBroadMatchKeywordRecommendation-->
          <CurrentMatchType>ValueHere</CurrentMatchType>
          <CurrentStatus d4p1:nil="false">ValueHere</CurrentStatus>
          <Keyword d4p1:nil="false">ValueHere</Keyword>
          <KeywordOrderItemId>ValueHere</KeywordOrderItemId>
          <SuggestedBid>ValueHere</SuggestedBid>
          <SuggestedMatchType>ValueHere</SuggestedMatchType>
          <SuggestedStatus d4p1:nil="false">ValueHere</SuggestedStatus>
          <!--These fields are applicable if the derived type attribute is set to ResponsiveSearchAdAssetRecommendation-->
          <RecommendedResponsiveSearchAd 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>
          </RecommendedResponsiveSearchAd>
          <ResponsiveSearchAdId>ValueHere</ResponsiveSearchAdId>
        </RecommendationBase>
      </Recommendations>
    </RetrieveRecommendationsResponse>
  </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<RetrieveRecommendationsResponse> RetrieveRecommendationsAsync(
	IList<string> recommendationTypes,
	int? maxCount)
{
	var request = new RetrieveRecommendationsRequest
	{
		RecommendationTypes = recommendationTypes,
		MaxCount = maxCount
	};

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

static RetrieveRecommendationsResponse retrieveRecommendations(
	ArrayOfstring recommendationTypes,
	int maxCount) throws RemoteException, Exception
{
	RetrieveRecommendationsRequest request = new RetrieveRecommendationsRequest();

	request.setRecommendationTypes(recommendationTypes);
	request.setMaxCount(maxCount);

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

static function RetrieveRecommendations(
	$recommendationTypes,
	$maxCount)
{

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

	$request = new RetrieveRecommendationsRequest();

	$request->RecommendationTypes = $recommendationTypes;
	$request->MaxCount = $maxCount;

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

response=adinsight_service.RetrieveRecommendations(
	RecommendationTypes=RecommendationTypes,
	MaxCount=MaxCount)

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/Retrieve

Elementos Request

El objeto RetrieveRecommendationsRequest 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
MaxCount Número máximo de recomendaciones devueltas. El valor predeterminado es null. Si MaxCount es null o 0, devuelve todas las recomendaciones disponibles. Opcional. int
RecommendationTypes Los nombres de tipo de recomendación: ADD_BROAD_MATCH_KEYWORD, CAMPAIGN_BUDGET, KEYWORD, REMOVE_CONFLICTING_NEGATIVE_KEYWORD, RESPONSIVE_SEARCH_AD o RESPONSIVE_SEARCH_AD_ASSET. Obligatorio. matriz de cadenas

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 RetrieveRecommendationsResponse 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 Las recomendaciones disponibles para un identificador de cuenta específico. Los tipos de recomendaciones son: AddBroadMatchKeywordRecommendation, CampaignBudgetRecommendation, KeywordRecommendation, RemoveConflictingNegativeKeywordRecommendation, ResponsiveSearchAdRecommendation y ResponsiveSearchAdAssetRecommendation. Matriz RecommendationBase

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.

{
  "RecommendationTypes": [
    "ValueHere"
  ],
  "MaxCount": IntValueHere
}

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 RecommendationBase es CampaignBudgetRecommendation.

{
  "Recommendations": [
    {
      "AccountId": "LongValueHere",
      "AccountName": "ValueHere",
      "AdGroupId": "LongValueHere",
      "AdGroupName": "ValueHere",
      "CampaignId": "LongValueHere",
      "CampaignName": "ValueHere",
      "CurrentClicks": "LongValueHere",
      "CurrentConversions": "LongValueHere",
      "CurrentCost": DoubleValueHere,
      "CurrentImpressions": "LongValueHere",
      "Dismissed": "ValueHere",
      "EstimatedIncreaseInClicks": "LongValueHere",
      "EstimatedIncreaseInConversions": "LongValueHere",
      "EstimatedIncreaseInCost": DoubleValueHere,
      "EstimatedIncreaseInImpressions": "LongValueHere",
      "RecommendationHash": "ValueHere",
      "RecommendationId": "ValueHere",
      "RecommendationType": "ValueHere",
      "Type": "CampaignBudgetRecommendation",
      "BudgetPoints": [
        {
          "BudgetAmount": DoubleValueHere,
          "BudgetPointType": "ValueHere",
          "EstimatedWeeklyClicks": DoubleValueHere,
          "EstimatedWeeklyCost": DoubleValueHere,
          "EstimatedWeeklyImpressions": DoubleValueHere
        }
      ],
      "BudgetType": "ValueHere",
      "CurrentBudget": DoubleValueHere,
      "RecommendedBudget": DoubleValueHere
    }
  ]
}

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<RetrieveRecommendationsResponse> RetrieveRecommendationsAsync(
	IList<string> recommendationTypes,
	int? maxCount)
{
	var request = new RetrieveRecommendationsRequest
	{
		RecommendationTypes = recommendationTypes,
		MaxCount = maxCount
	};

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

static RetrieveRecommendationsResponse retrieveRecommendations(
	ArrayOfstring recommendationTypes,
	int maxCount) throws RemoteException, Exception
{
	RetrieveRecommendationsRequest request = new RetrieveRecommendationsRequest();

	request.setRecommendationTypes(recommendationTypes);
	request.setMaxCount(maxCount);

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

static function RetrieveRecommendations(
	$recommendationTypes,
	$maxCount)
{

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

	$request = new RetrieveRecommendationsRequest();

	$request->RecommendationTypes = $recommendationTypes;
	$request->MaxCount = $maxCount;

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

response=adinsight_service.RetrieveRecommendations(
	RecommendationTypes=RecommendationTypes,
	MaxCount=MaxCount)