Operación del servicio GetHistoricalKeywordPerformance: Ad Insight

Artículo
11/14/2024

Obtiene el rendimiento histórico del término de búsqueda normalizado. Los resultados se agregan por tipo de dispositivo.

Elementos Request

El objeto GetHistoricalKeywordPerformanceRequest 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
Dispositivos	Una lista de uno o varios de los siguientes tipos de dispositivos: equipos, no móviles, smartphones, tabletas. El valor predeterminado es Equipos. La respuesta incluye datos de rendimiento de palabras clave para los tipos de dispositivo que especifique solo, si están disponibles. Se usa para determinar el rendimiento de una palabra clave en los tipos de dispositivo especificados.	matriz de cadenas
Palabras clave	Matriz de palabras clave para las que desea obtener estadísticas de rendimiento históricas. La matriz puede contener un máximo de 1000 palabras clave y cada palabra clave puede contener un máximo de 100 caracteres.	matriz de cadenas
Idioma	Idioma en el que se escriben las palabras clave. Los países o regiones que especifique en el elemento PublisherCountries deben admitir el idioma especificado. Los valores posibles son danés, holandés, inglés, finés, francés, alemán, italiano, noruego, portugués, español, sueco y tradicional chino.	string
MatchTypes	Tipos de coincidencia para los que desea obtener datos históricos. No puede especificar el tipo de coincidencia de contenido.	Matriz MatchType
PublisherCountries	Códigos de país de los países o regiones que se usarán como origen de los datos históricos. Puede especificar uno o varios códigos de país. Cada país o región que especifique debe admitir el idioma especificado en el elemento Language . Se admiten las siguientes combinaciones de idioma y país o región: Danés: DK Holandés: NL Inglés: AU, CA, GB, ID, IN, MY, PH, SG, TH, US, VN Finlandés: FI Francés: CA, FR Alemán: AT, CH, DE Italiano: TI Noruego: NB Portugués: BR Español: AR, CL, CO, ES, MX, PE, VE Sueco: SE TraditionalChinese: HK, TW Si este elemento es null, el servicio incluye de forma predeterminada todos los países o regiones que admiten el idioma especificado.	matriz de cadenas
TargetAdPosition	Posición de los resultados de búsqueda para los que desea obtener datos de rendimiento. Por ejemplo, para obtener datos de rendimiento cuando aparecieran anuncios en la primera posición de la línea principal mediante la palabra clave y el tipo de coincidencia, establezca este elemento en MainLine1. Para obtener datos de rendimiento cuando aparecieran anuncios en cualquier posición de los resultados de la búsqueda mediante la palabra clave y el tipo de coincidencia, establezca este elemento en Todo. SixMonths Si especifica All para este elemento, el servicio devolverá varios resultados por palabra clave para cada posición de anuncio admitida. Si especifica Aggregate, el servicio devolverá un resultado agregado. Los anuncios de barra lateral ya no se ofrecen en sitios de Bing propiedad y operados en el Estados Unidos. Si solo solicita datos de primera página, por ejemplo, FirstPage1 para el Estados Unidos (EE. UU.), el elemento KeywordKPIs del resultado será nil/empty. Si incluye países o regiones adicionales, por ejemplo, EE. UU. y CA en la misma solicitud, los resultados de la primera página solo se atribuyen a países o regiones fuera del Estados Unidos.	AdPosition
TimeInterval	Período de tiempo que identifica los datos que se van a usar para determinar el índice de rendimiento clave de las palabras clave especificadas. Por ejemplo, use datos de los siete días anteriores o los 30 días anteriores para determinar el rendimiento de la palabra clave. El valor predeterminado es LastDay.	TimeInterval

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 GetHistoricalKeywordPerformanceResponse 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
KeywordHistoricalPerformances	Matriz de objetos de datos KeywordHistoricalPerformance . La matriz contiene un elemento para cada palabra clave, dispositivo, tipo de coincidencia y posición del anuncio especificados en la solicitud. Si la palabra clave no es válida o no tiene datos disponibles, el elemento correspondiente de la matriz será null.	Matriz KeywordHistoricalPerformance

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">GetHistoricalKeywordPerformance</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>
    <GetHistoricalKeywordPerformanceRequest 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>
      <TimeInterval i:nil="false">ValueHere</TimeInterval>
      <TargetAdPosition i:nil="false">ValueHere</TargetAdPosition>
      <MatchTypes i:nil="false">
        <MatchType>ValueHere</MatchType>
      </MatchTypes>
      <Language i:nil="false">ValueHere</Language>
      <PublisherCountries i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string>ValueHere</a1:string>
      </PublisherCountries>
      <Devices i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string>ValueHere</a1:string>
      </Devices>
    </GetHistoricalKeywordPerformanceRequest>
  </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>
    <GetHistoricalKeywordPerformanceResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <KeywordHistoricalPerformances d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordHistoricalPerformance>
          <Keyword d4p1:nil="false">ValueHere</Keyword>
          <KeywordKPIs d4p1:nil="false">
            <KeywordKPI>
              <Device d4p1:nil="false">ValueHere</Device>
              <MatchType>ValueHere</MatchType>
              <AdPosition>ValueHere</AdPosition>
              <Clicks>ValueHere</Clicks>
              <Impressions>ValueHere</Impressions>
              <AverageCPC>ValueHere</AverageCPC>
              <CTR>ValueHere</CTR>
              <TotalCost>ValueHere</TotalCost>
              <AverageBid>ValueHere</AverageBid>
            </KeywordKPI>
          </KeywordKPIs>
        </KeywordHistoricalPerformance>
      </KeywordHistoricalPerformances>
    </GetHistoricalKeywordPerformanceResponse>
  </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<GetHistoricalKeywordPerformanceResponse> GetHistoricalKeywordPerformanceAsync(
	IList<string> keywords,
	TimeInterval? timeInterval,
	AdPosition? targetAdPosition,
	IList<MatchType> matchTypes,
	string language,
	IList<string> publisherCountries,
	IList<string> devices)
{
	var request = new GetHistoricalKeywordPerformanceRequest
	{
		Keywords = keywords,
		TimeInterval = timeInterval,
		TargetAdPosition = targetAdPosition,
		MatchTypes = matchTypes,
		Language = language,
		PublisherCountries = publisherCountries,
		Devices = devices
	};

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

static GetHistoricalKeywordPerformanceResponse getHistoricalKeywordPerformance(
	ArrayOfstring keywords,
	TimeInterval timeInterval,
	AdPosition targetAdPosition,
	ArrayOfMatchType matchTypes,
	java.lang.String language,
	ArrayOfstring publisherCountries,
	ArrayOfstring devices) throws RemoteException, Exception
{
	GetHistoricalKeywordPerformanceRequest request = new GetHistoricalKeywordPerformanceRequest();

	request.setKeywords(keywords);
	request.setTimeInterval(timeInterval);
	request.setTargetAdPosition(targetAdPosition);
	request.setMatchTypes(matchTypes);
	request.setLanguage(language);
	request.setPublisherCountries(publisherCountries);
	request.setDevices(devices);

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

static function GetHistoricalKeywordPerformance(
	$keywords,
	$timeInterval,
	$targetAdPosition,
	$matchTypes,
	$language,
	$publisherCountries,
	$devices)
{

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

	$request = new GetHistoricalKeywordPerformanceRequest();

	$request->Keywords = $keywords;
	$request->TimeInterval = $timeInterval;
	$request->TargetAdPosition = $targetAdPosition;
	$request->MatchTypes = $matchTypes;
	$request->Language = $language;
	$request->PublisherCountries = $publisherCountries;
	$request->Devices = $devices;

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

response=adinsight_service.GetHistoricalKeywordPerformance(
	Keywords=Keywords,
	TimeInterval=TimeInterval,
	TargetAdPosition=TargetAdPosition,
	MatchTypes=MatchTypes,
	Language=Language,
	PublisherCountries=PublisherCountries,
	Devices=Devices)

Requisitos

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

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

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

Elementos Request

El objeto GetHistoricalKeywordPerformanceRequest 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
Dispositivos	Una lista de uno o varios de los siguientes tipos de dispositivos: equipos, no móviles, smartphones, tabletas. El valor predeterminado es Equipos. La respuesta incluye datos de rendimiento de palabras clave para los tipos de dispositivo que especifique solo, si están disponibles. Se usa para determinar el rendimiento de una palabra clave en los tipos de dispositivo especificados.	matriz de cadenas
Palabras clave	Matriz de palabras clave para las que desea obtener estadísticas de rendimiento históricas. La matriz puede contener un máximo de 1000 palabras clave y cada palabra clave puede contener un máximo de 100 caracteres.	matriz de cadenas
Idioma	Idioma en el que se escriben las palabras clave. Los países o regiones que especifique en el elemento PublisherCountries deben admitir el idioma especificado. Los valores posibles son danés, holandés, inglés, finés, francés, alemán, italiano, noruego, portugués, español, sueco y tradicional chino.	string
MatchTypes	Tipos de coincidencia para los que desea obtener datos históricos. No puede especificar el tipo de coincidencia de contenido.	Matriz MatchType
PublisherCountries	Códigos de país de los países o regiones que se usarán como origen de los datos históricos. Puede especificar uno o varios códigos de país. Cada país o región que especifique debe admitir el idioma especificado en el elemento Language . Se admiten las siguientes combinaciones de idioma y país o región: Danés: DK Holandés: NL Inglés: AU, CA, GB, ID, IN, MY, PH, SG, TH, US, VN Finlandés: FI Francés: CA, FR Alemán: AT, CH, DE Italiano: TI Noruego: NB Portugués: BR Español: AR, CL, CO, ES, MX, PE, VE Sueco: SE TraditionalChinese: HK, TW Si este elemento es null, el servicio incluye de forma predeterminada todos los países o regiones que admiten el idioma especificado.	matriz de cadenas
TargetAdPosition	Posición de los resultados de búsqueda para los que desea obtener datos de rendimiento. Por ejemplo, para obtener datos de rendimiento cuando aparecieran anuncios en la primera posición de la línea principal mediante la palabra clave y el tipo de coincidencia, establezca este elemento en MainLine1. Para obtener datos de rendimiento cuando aparecieran anuncios en cualquier posición de los resultados de la búsqueda mediante la palabra clave y el tipo de coincidencia, establezca este elemento en Todo. SixMonths Si especifica All para este elemento, el servicio devolverá varios resultados por palabra clave para cada posición de anuncio admitida. Si especifica Aggregate, el servicio devolverá un resultado agregado. Los anuncios de barra lateral ya no se ofrecen en sitios de Bing propiedad y operados en el Estados Unidos. Si solo solicita datos de primera página, por ejemplo, FirstPage1 para el Estados Unidos (EE. UU.), el elemento KeywordKPIs del resultado será nil/empty. Si incluye países o regiones adicionales, por ejemplo, EE. UU. y CA en la misma solicitud, los resultados de la primera página solo se atribuyen a países o regiones fuera del Estados Unidos.	AdPosition
TimeInterval	Período de tiempo que identifica los datos que se van a usar para determinar el índice de rendimiento clave de las palabras clave especificadas. Por ejemplo, use datos de los siete días anteriores o los 30 días anteriores para determinar el rendimiento de la palabra clave. El valor predeterminado es LastDay.	TimeInterval

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

Elementos del cuerpo de la respuesta

Elemento	Descripción	Tipo de datos
KeywordHistoricalPerformances	Matriz de objetos de datos KeywordHistoricalPerformance . La matriz contiene un elemento para cada palabra clave, dispositivo, tipo de coincidencia y posición del anuncio especificados en la solicitud. Si la palabra clave no es válida o no tiene datos disponibles, el elemento correspondiente de la matriz será null.	Matriz KeywordHistoricalPerformance

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"
  ],
  "TimeInterval": "ValueHere",
  "TargetAdPosition": "ValueHere",
  "MatchTypes": [
    "ValueHere"
  ],
  "Language": "ValueHere",
  "PublisherCountries": [
    "ValueHere"
  ],
  "Devices": [
    "ValueHere"
  ]
}

JSON de respuesta

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

{
  "KeywordHistoricalPerformances": [
    {
      "Keyword": "ValueHere",
      "KeywordKPIs": [
        {
          "AdPosition": "ValueHere",
          "AverageBid": DoubleValueHere,
          "AverageCPC": DoubleValueHere,
          "Clicks": IntValueHere,
          "CTR": DoubleValueHere,
          "Device": "ValueHere",
          "Impressions": "LongValueHere",
          "MatchType": "ValueHere",
          "TotalCost": 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<GetHistoricalKeywordPerformanceResponse> GetHistoricalKeywordPerformanceAsync(
	IList<string> keywords,
	TimeInterval? timeInterval,
	AdPosition? targetAdPosition,
	IList<MatchType> matchTypes,
	string language,
	IList<string> publisherCountries,
	IList<string> devices)
{
	var request = new GetHistoricalKeywordPerformanceRequest
	{
		Keywords = keywords,
		TimeInterval = timeInterval,
		TargetAdPosition = targetAdPosition,
		MatchTypes = matchTypes,
		Language = language,
		PublisherCountries = publisherCountries,
		Devices = devices
	};

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

static GetHistoricalKeywordPerformanceResponse getHistoricalKeywordPerformance(
	ArrayOfstring keywords,
	TimeInterval timeInterval,
	AdPosition targetAdPosition,
	ArrayOfMatchType matchTypes,
	java.lang.String language,
	ArrayOfstring publisherCountries,
	ArrayOfstring devices) throws RemoteException, Exception
{
	GetHistoricalKeywordPerformanceRequest request = new GetHistoricalKeywordPerformanceRequest();

	request.setKeywords(keywords);
	request.setTimeInterval(timeInterval);
	request.setTargetAdPosition(targetAdPosition);
	request.setMatchTypes(matchTypes);
	request.setLanguage(language);
	request.setPublisherCountries(publisherCountries);
	request.setDevices(devices);

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

static function GetHistoricalKeywordPerformance(
	$keywords,
	$timeInterval,
	$targetAdPosition,
	$matchTypes,
	$language,
	$publisherCountries,
	$devices)
{

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

	$request = new GetHistoricalKeywordPerformanceRequest();

	$request->Keywords = $keywords;
	$request->TimeInterval = $timeInterval;
	$request->TargetAdPosition = $targetAdPosition;
	$request->MatchTypes = $matchTypes;
	$request->Language = $language;
	$request->PublisherCountries = $publisherCountries;
	$request->Devices = $devices;

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

response=adinsight_service.GetHistoricalKeywordPerformance(
	Keywords=Keywords,
	TimeInterval=TimeInterval,
	TargetAdPosition=TargetAdPosition,
	MatchTypes=MatchTypes,
	Language=Language,
	PublisherCountries=PublisherCountries,
	Devices=Devices)

Compartir a través de

Operación del servicio GetHistoricalKeywordPerformance: Ad Insight

Elementos Request

Elementos del cuerpo de la solicitud

Elementos de encabezado de solicitud

Elementos de respuesta

Elementos del cuerpo de la respuesta

Elementos de encabezado de respuesta

Solicitud de SOAP

SOAP de respuesta

Sintaxis de código

Requisitos

Dirección URL de solicitud

Elementos Request

Elementos del cuerpo de la solicitud

Elementos de encabezado de solicitud

Elementos de respuesta

Elementos del cuerpo de la respuesta

Elementos de encabezado de respuesta

Solicitud de JSON

JSON de respuesta

Sintaxis de código

Comentarios

Recursos adicionales