Compartir a través de

Operación de servicio GetEstimatedPositionByKeywords: Ad Insight

  • Artículo

Obtiene la posición estimada en los resultados de la búsqueda si se usaría el valor de puja especificado para las palabras clave especificadas. Además, la operación proporciona estimaciones de clics, costo medio por clic (CPC) e impresiones de que las palabras clave se podrían generar con la puja estimada.

Las estimaciones no son una predicción ni una garantía de rendimiento futuro.

Nota:

Esta operación es para campañas de búsqueda que usan la estrategia de puja de CPC mejorada.

Elementos Request

El objeto GetEstimatedPositionByKeywordsRequest 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 cuyos datos de rendimiento se usan para ayudar a determinar el rendimiento de la palabra clave en el contexto del grupo de anuncios. Especificar un grupo de anuncios ayuda a mejorar la precisión de la posición sugerida.

Si especificas un grupo de anuncios, debes especificar la campaña a la que pertenece.		 largo
CampaignId Identificador de la campaña propietaria del grupo de anuncios especificado en AdGroupId. Si no especifica un grupo de anuncios, los datos de rendimiento de la campaña se usan para ayudar a determinar el rendimiento de la palabra clave en el contexto de la campaña.

Especificar una campaña y un grupo de anuncios ayuda a mejorar la precisión de la posición sugerida. Si no se especifican Ni AdGroupId ni CampaignId , la operación usa el elemento de encabezado CustomerAccountId especificado para ayudar a determinar el rendimiento de la palabra clave en el contexto de la cuenta.		 largo
CurrencyCode El código ISO de la unidad monetaria que se va a usar para calcular las estimaciones de costos y el valor de puja sugerido.

Si no se establece, el servicio determina la moneda de la cuenta especificada en el elemento de encabezado CustomerAccountId . Si no se establece Currency ni CustomerAccountId , el servicio usa USD.		 CurrencyCode
Palabras clave Matriz de palabras clave para las que desea obtener la posición estimada en los resultados de la búsqueda, en función del valor de puja especificado. Puede especificar un máximo de 1000 palabras clave y cada palabra clave puede contener un máximo de 100 caracteres. matriz de cadenas
Idioma Idioma usado en paralelo con los identificadores de ubicación para calcular la posición.

El idioma debe admitirse en cada una de las ubicaciones que especifique en LocationIds.

Para ver los posibles valores de idioma, consulte Lenguajes de anuncios.

Si no especifica el idioma, la operación de servicio usa el idioma del AdGroupId o CampaignId especificados. Si no se establece ninguna de estas propiedades, se usa EN (inglés) de forma predeterminada.		 string
LocationIds Identificador o identificadores de las ubicaciones geográficas que se van a usar para calcular la posición.

Todas las ubicaciones deben admitir el idioma especificado en el elemento Language . Aunque puede especificar varios identificadores de ubicación, como procedimiento recomendado para las estimaciones de posición más precisas por ubicación, solo debe especificar una ubicación por llamada de servicio.

Para ver los posibles identificadores de ubicación, consulte Códigos de ubicación geográfica.

Si no especifica ninguna ubicación, la operación de servicio usa los criterios de ubicación del AdGroupId o CampaignId especificados. Si no se establece ninguna de estas propiedades, se usa 190 (Estados Unidos) de forma predeterminada.		 matriz larga
MatchTypes Matriz de tipos de coincidencia únicos para los que desea obtener estimaciones.

No puede especificar el tipo de coincidencia de contenido.		 Matriz MatchType
MaxBid Valor máximo de la puja que se va a usar para determinar la posición estimada en los resultados de la búsqueda. doble

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 GetEstimatedPositionByKeywordsResponse 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
KeywordEstimatedPositions Matriz de objetos de datos KeywordEstimatedPosition . La matriz contiene un elemento para cada palabra clave especificada en la solicitud. Si la palabra clave no es válida, el elemento correspondiente de la matriz será null.

Si hay datos disponibles para la palabra clave , EstimatedPositionAndTraffic proporcionará la posición estimada en los resultados de búsqueda donde podrían aparecer los anuncios, en función del valor de puja especificado. De lo contrario, el elemento EstimatedPositions se establecerá en null.		 Matriz KeywordEstimatedPosition

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">GetEstimatedPositionByKeywords</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>
    <GetEstimatedPositionByKeywordsRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Keywords i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string>ValueHere</a1:string>
      </Keywords>
      <MaxBid>ValueHere</MaxBid>
      <Language i:nil="false">ValueHere</Language>
      <LocationIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </LocationIds>
      <CurrencyCode i:nil="false">ValueHere</CurrencyCode>
      <MatchTypes i:nil="false">
        <MatchType>ValueHere</MatchType>
      </MatchTypes>
      <CampaignId i:nil="false">ValueHere</CampaignId>
      <AdGroupId i:nil="false">ValueHere</AdGroupId>
    </GetEstimatedPositionByKeywordsRequest>
  </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>
    <GetEstimatedPositionByKeywordsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <KeywordEstimatedPositions d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordEstimatedPosition>
          <Keyword d4p1:nil="false">ValueHere</Keyword>
          <EstimatedPositions d4p1:nil="false">
            <EstimatedPositionAndTraffic>
              <MatchType>ValueHere</MatchType>
              <MinClicksPerWeek>ValueHere</MinClicksPerWeek>
              <MaxClicksPerWeek>ValueHere</MaxClicksPerWeek>
              <AverageCPC>ValueHere</AverageCPC>
              <MinImpressionsPerWeek>ValueHere</MinImpressionsPerWeek>
              <MaxImpressionsPerWeek>ValueHere</MaxImpressionsPerWeek>
              <CTR>ValueHere</CTR>
              <MinTotalCostPerWeek>ValueHere</MinTotalCostPerWeek>
              <MaxTotalCostPerWeek>ValueHere</MaxTotalCostPerWeek>
              <CurrencyCode>ValueHere</CurrencyCode>
              <EstimatedAdPosition>ValueHere</EstimatedAdPosition>
            </EstimatedPositionAndTraffic>
          </EstimatedPositions>
        </KeywordEstimatedPosition>
      </KeywordEstimatedPositions>
    </GetEstimatedPositionByKeywordsResponse>
  </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<GetEstimatedPositionByKeywordsResponse> GetEstimatedPositionByKeywordsAsync(
	IList<string> keywords,
	double maxBid,
	string language,
	IList<long> locationIds,
	CurrencyCode? currencyCode,
	IList<MatchType> matchTypes,
	long? campaignId,
	long? adGroupId)
{
	var request = new GetEstimatedPositionByKeywordsRequest
	{
		Keywords = keywords,
		MaxBid = maxBid,
		Language = language,
		LocationIds = locationIds,
		CurrencyCode = currencyCode,
		MatchTypes = matchTypes,
		CampaignId = campaignId,
		AdGroupId = adGroupId
	};

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

static GetEstimatedPositionByKeywordsResponse getEstimatedPositionByKeywords(
	ArrayOfstring keywords,
	double maxBid,
	java.lang.String language,
	ArrayOflong locationIds,
	CurrencyCode currencyCode,
	ArrayOfMatchType matchTypes,
	java.lang.Long campaignId,
	java.lang.Long adGroupId) throws RemoteException, Exception
{
	GetEstimatedPositionByKeywordsRequest request = new GetEstimatedPositionByKeywordsRequest();

	request.setKeywords(keywords);
	request.setMaxBid(maxBid);
	request.setLanguage(language);
	request.setLocationIds(locationIds);
	request.setCurrencyCode(currencyCode);
	request.setMatchTypes(matchTypes);
	request.setCampaignId(campaignId);
	request.setAdGroupId(adGroupId);

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

static function GetEstimatedPositionByKeywords(
	$keywords,
	$maxBid,
	$language,
	$locationIds,
	$currencyCode,
	$matchTypes,
	$campaignId,
	$adGroupId)
{

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

	$request = new GetEstimatedPositionByKeywordsRequest();

	$request->Keywords = $keywords;
	$request->MaxBid = $maxBid;
	$request->Language = $language;
	$request->LocationIds = $locationIds;
	$request->CurrencyCode = $currencyCode;
	$request->MatchTypes = $matchTypes;
	$request->CampaignId = $campaignId;
	$request->AdGroupId = $adGroupId;

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

response=adinsight_service.GetEstimatedPositionByKeywords(
	Keywords=Keywords,
	MaxBid=MaxBid,
	Language=Language,
	LocationIds=LocationIds,
	CurrencyCode=CurrencyCode,
	MatchTypes=MatchTypes,
	CampaignId=CampaignId,
	AdGroupId=AdGroupId)

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/EstimatedPosition/QueryByKeywords

Elementos Request

El objeto GetEstimatedPositionByKeywordsRequest 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 cuyos datos de rendimiento se usan para ayudar a determinar el rendimiento de la palabra clave en el contexto del grupo de anuncios. Especificar un grupo de anuncios ayuda a mejorar la precisión de la posición sugerida.

Si especificas un grupo de anuncios, debes especificar la campaña a la que pertenece.		 largo
CampaignId Identificador de la campaña propietaria del grupo de anuncios especificado en AdGroupId. Si no especifica un grupo de anuncios, los datos de rendimiento de la campaña se usan para ayudar a determinar el rendimiento de la palabra clave en el contexto de la campaña.

Especificar una campaña y un grupo de anuncios ayuda a mejorar la precisión de la posición sugerida. Si no se especifican Ni AdGroupId ni CampaignId , la operación usa el elemento de encabezado CustomerAccountId especificado para ayudar a determinar el rendimiento de la palabra clave en el contexto de la cuenta.		 largo
CurrencyCode El código ISO de la unidad monetaria que se va a usar para calcular las estimaciones de costos y el valor de puja sugerido.

Si no se establece, el servicio determina la moneda de la cuenta especificada en el elemento de encabezado CustomerAccountId . Si no se establece Currency ni CustomerAccountId , el servicio usa USD.		 CurrencyCode
Palabras clave Matriz de palabras clave para las que desea obtener la posición estimada en los resultados de la búsqueda, en función del valor de puja especificado. Puede especificar un máximo de 1000 palabras clave y cada palabra clave puede contener un máximo de 100 caracteres. matriz de cadenas
Idioma Idioma usado en paralelo con los identificadores de ubicación para calcular la posición.

El idioma debe admitirse en cada una de las ubicaciones que especifique en LocationIds.

Para ver los posibles valores de idioma, consulte Lenguajes de anuncios.

Si no especifica el idioma, la operación de servicio usa el idioma del AdGroupId o CampaignId especificados. Si no se establece ninguna de estas propiedades, se usa EN (inglés) de forma predeterminada.		 string
LocationIds Identificador o identificadores de las ubicaciones geográficas que se van a usar para calcular la posición.

Todas las ubicaciones deben admitir el idioma especificado en el elemento Language . Aunque puede especificar varios identificadores de ubicación, como procedimiento recomendado para las estimaciones de posición más precisas por ubicación, solo debe especificar una ubicación por llamada de servicio.

Para ver los posibles identificadores de ubicación, consulte Códigos de ubicación geográfica.

Si no especifica ninguna ubicación, la operación de servicio usa los criterios de ubicación del AdGroupId o CampaignId especificados. Si no se establece ninguna de estas propiedades, se usa 190 (Estados Unidos) de forma predeterminada.		 matriz larga
MatchTypes Matriz de tipos de coincidencia únicos para los que desea obtener estimaciones.

No puede especificar el tipo de coincidencia de contenido.		 Matriz MatchType
MaxBid Valor máximo de la puja que se va a usar para determinar la posición estimada en los resultados de la búsqueda. doble

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 GetEstimatedPositionByKeywordsResponse 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
KeywordEstimatedPositions Matriz de objetos de datos KeywordEstimatedPosition . La matriz contiene un elemento para cada palabra clave especificada en la solicitud. Si la palabra clave no es válida, el elemento correspondiente de la matriz será null.

Si hay datos disponibles para la palabra clave , EstimatedPositionAndTraffic proporcionará la posición estimada en los resultados de búsqueda donde podrían aparecer los anuncios, en función del valor de puja especificado. De lo contrario, el elemento EstimatedPositions se establecerá en null.		 Matriz KeywordEstimatedPosition

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.

{
  "Keywords": [
    "ValueHere"
  ],
  "MaxBid": DoubleValueHere,
  "Language": "ValueHere",
  "LocationIds": [
    "LongValueHere"
  ],
  "CurrencyCode": "ValueHere",
  "MatchTypes": [
    "ValueHere"
  ],
  "CampaignId": "LongValueHere",
  "AdGroupId": "LongValueHere"
}

JSON de respuesta

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

{
  "KeywordEstimatedPositions": [
    {
      "EstimatedPositions": [
        {
          "AverageCPC": DoubleValueHere,
          "CTR": DoubleValueHere,
          "CurrencyCode": "ValueHere",
          "EstimatedAdPosition": DoubleValueHere,
          "MatchType": "ValueHere",
          "MaxClicksPerWeek": DoubleValueHere,
          "MaxImpressionsPerWeek": "LongValueHere",
          "MaxTotalCostPerWeek": DoubleValueHere,
          "MinClicksPerWeek": DoubleValueHere,
          "MinImpressionsPerWeek": "LongValueHere",
          "MinTotalCostPerWeek": DoubleValueHere
        }
      ],
      "Keyword": "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<GetEstimatedPositionByKeywordsResponse> GetEstimatedPositionByKeywordsAsync(
	IList<string> keywords,
	double maxBid,
	string language,
	IList<long> locationIds,
	CurrencyCode? currencyCode,
	IList<MatchType> matchTypes,
	long? campaignId,
	long? adGroupId)
{
	var request = new GetEstimatedPositionByKeywordsRequest
	{
		Keywords = keywords,
		MaxBid = maxBid,
		Language = language,
		LocationIds = locationIds,
		CurrencyCode = currencyCode,
		MatchTypes = matchTypes,
		CampaignId = campaignId,
		AdGroupId = adGroupId
	};

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

static GetEstimatedPositionByKeywordsResponse getEstimatedPositionByKeywords(
	ArrayOfstring keywords,
	double maxBid,
	java.lang.String language,
	ArrayOflong locationIds,
	CurrencyCode currencyCode,
	ArrayOfMatchType matchTypes,
	java.lang.Long campaignId,
	java.lang.Long adGroupId) throws RemoteException, Exception
{
	GetEstimatedPositionByKeywordsRequest request = new GetEstimatedPositionByKeywordsRequest();

	request.setKeywords(keywords);
	request.setMaxBid(maxBid);
	request.setLanguage(language);
	request.setLocationIds(locationIds);
	request.setCurrencyCode(currencyCode);
	request.setMatchTypes(matchTypes);
	request.setCampaignId(campaignId);
	request.setAdGroupId(adGroupId);

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

static function GetEstimatedPositionByKeywords(
	$keywords,
	$maxBid,
	$language,
	$locationIds,
	$currencyCode,
	$matchTypes,
	$campaignId,
	$adGroupId)
{

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

	$request = new GetEstimatedPositionByKeywordsRequest();

	$request->Keywords = $keywords;
	$request->MaxBid = $maxBid;
	$request->Language = $language;
	$request->LocationIds = $locationIds;
	$request->CurrencyCode = $currencyCode;
	$request->MatchTypes = $matchTypes;
	$request->CampaignId = $campaignId;
	$request->AdGroupId = $adGroupId;

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

response=adinsight_service.GetEstimatedPositionByKeywords(
	Keywords=Keywords,
	MaxBid=MaxBid,
	Language=Language,
	LocationIds=LocationIds,
	CurrencyCode=CurrencyCode,
	MatchTypes=MatchTypes,
	CampaignId=CampaignId,
	AdGroupId=AdGroupId)