Compartir vía

Operación del servicio GetKeywordDemographics: Ad Insight

  • Artículo

Obtiene la edad y el sexo de los usuarios que han buscado las palabras clave especificadas.

Nota:

La operación de servicio GetKeywordDemographics está en desuso a partir del 21 de agosto de 2023. Más información.

Elementos Request

El objeto GetKeywordDemographicsRequest 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
Dispositivo Matriz de dispositivos para los que desea obtener datos demográficos.

Entre los tipos de dispositivos admitidos se incluyen los siguientes: equipos, teléfonos no móviles, smartphones y tabletas. El valor predeterminado es Equipos.

Si está disponible, la respuesta solo incluye datos demográficos de palabras clave para los tipos de dispositivo que especifique.		 matriz de cadenas
Palabras clave Matriz de palabras clave para las que desea obtener datos demográficos.

Los datos también se desglosan por tipo de dispositivo . 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.

Para ver los valores posibles, consulte Lenguajes de anuncios.		 string
PublisherCountry Código de país del país o región que se va a usar como origen de los datos demográficos.

El país o región que especifique debe admitir el idioma especificado en el elemento Language .

Para ver los valores posibles, consulte Lenguajes de anuncios.		 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 GetKeywordDemographicsResponse 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
KeywordDemographicResult Matriz de objetos de datos KeywordDemographicResult . El orden de los elementos corresponde directamente a las palabras clave especificadas en la solicitud. Si no hay datos demográficos disponibles para una palabra clave, la palabra clave se incluirá en la lista, pero el elemento KeywordDemographics del elemento KeywordDemographicResult correspondiente será null.

Cada KeywordDemographicResult contiene una matriz de objetos de datos KeywordDemographic . La matriz contiene un elemento para cada dispositivo especificado en la solicitud. Cada palabra claveDemographic contiene el porcentaje de tiempo que los usuarios de una determinada edad y género buscaron la palabra clave especificada.		 Matriz KeywordDemographicResult

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">GetKeywordDemographics</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>
    <GetKeywordDemographicsRequest 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>
      <Language i:nil="false">ValueHere</Language>
      <PublisherCountry i:nil="false">ValueHere</PublisherCountry>
      <Device i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string>ValueHere</a1:string>
      </Device>
    </GetKeywordDemographicsRequest>
  </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>
    <GetKeywordDemographicsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <KeywordDemographicResult d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordDemographicResult>
          <Keyword d4p1:nil="false">ValueHere</Keyword>
          <KeywordDemographics d4p1:nil="false">
            <KeywordDemographic>
              <Device d4p1:nil="false">ValueHere</Device>
              <EighteenToTwentyFour>ValueHere</EighteenToTwentyFour>
              <TwentyFiveToThirtyFour>ValueHere</TwentyFiveToThirtyFour>
              <ThirtyFiveToFourtyNine>ValueHere</ThirtyFiveToFourtyNine>
              <FiftyToSixtyFour>ValueHere</FiftyToSixtyFour>
              <SixtyFiveAndAbove>ValueHere</SixtyFiveAndAbove>
              <AgeUnknown>ValueHere</AgeUnknown>
              <Female>ValueHere</Female>
              <Male>ValueHere</Male>
              <GenderUnknown>ValueHere</GenderUnknown>
            </KeywordDemographic>
          </KeywordDemographics>
        </KeywordDemographicResult>
      </KeywordDemographicResult>
    </GetKeywordDemographicsResponse>
  </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<GetKeywordDemographicsResponse> GetKeywordDemographicsAsync(
	IList<string> keywords,
	string language,
	string publisherCountry,
	IList<string> device)
{
	var request = new GetKeywordDemographicsRequest
	{
		Keywords = keywords,
		Language = language,
		PublisherCountry = publisherCountry,
		Device = device
	};

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

static GetKeywordDemographicsResponse getKeywordDemographics(
	ArrayOfstring keywords,
	java.lang.String language,
	java.lang.String publisherCountry,
	ArrayOfstring device) throws RemoteException, Exception
{
	GetKeywordDemographicsRequest request = new GetKeywordDemographicsRequest();

	request.setKeywords(keywords);
	request.setLanguage(language);
	request.setPublisherCountry(publisherCountry);
	request.setDevice(device);

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

static function GetKeywordDemographics(
	$keywords,
	$language,
	$publisherCountry,
	$device)
{

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

	$request = new GetKeywordDemographicsRequest();

	$request->Keywords = $keywords;
	$request->Language = $language;
	$request->PublisherCountry = $publisherCountry;
	$request->Device = $device;

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

response=adinsight_service.GetKeywordDemographics(
	Keywords=Keywords,
	Language=Language,
	PublisherCountry=PublisherCountry,
	Device=Device)

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/KeywordDemographics/Query

Elementos Request

El objeto GetKeywordDemographicsRequest 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
Dispositivo Matriz de dispositivos para los que desea obtener datos demográficos.

Entre los tipos de dispositivos admitidos se incluyen los siguientes: equipos, teléfonos no móviles, smartphones y tabletas. El valor predeterminado es Equipos.

Si está disponible, la respuesta solo incluye datos demográficos de palabras clave para los tipos de dispositivo que especifique.		 matriz de cadenas
Palabras clave Matriz de palabras clave para las que desea obtener datos demográficos.

Los datos también se desglosan por tipo de dispositivo . 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.

Para ver los valores posibles, consulte Lenguajes de anuncios.		 string
PublisherCountry Código de país del país o región que se va a usar como origen de los datos demográficos.

El país o región que especifique debe admitir el idioma especificado en el elemento Language .

Para ver los valores posibles, consulte Lenguajes de anuncios.		 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 GetKeywordDemographicsResponse 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
KeywordDemographicResult Matriz de objetos de datos KeywordDemographicResult . El orden de los elementos corresponde directamente a las palabras clave especificadas en la solicitud. Si no hay datos demográficos disponibles para una palabra clave, la palabra clave se incluirá en la lista, pero el elemento KeywordDemographics del elemento KeywordDemographicResult correspondiente será null.

Cada KeywordDemographicResult contiene una matriz de objetos de datos KeywordDemographic . La matriz contiene un elemento para cada dispositivo especificado en la solicitud. Cada palabra claveDemographic contiene el porcentaje de tiempo que los usuarios de una determinada edad y género buscaron la palabra clave especificada.		 Matriz KeywordDemographicResult

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"
  ],
  "Language": "ValueHere",
  "PublisherCountry": "ValueHere",
  "Device": [
    "ValueHere"
  ]
}

JSON de respuesta

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

{
  "KeywordDemographicResult": [
    {
      "Keyword": "ValueHere",
      "KeywordDemographics": [
        {
          "AgeUnknown": DoubleValueHere,
          "Device": "ValueHere",
          "EighteenToTwentyFour": DoubleValueHere,
          "Female": DoubleValueHere,
          "FiftyToSixtyFour": DoubleValueHere,
          "GenderUnknown": DoubleValueHere,
          "Male": DoubleValueHere,
          "SixtyFiveAndAbove": DoubleValueHere,
          "ThirtyFiveToFourtyNine": DoubleValueHere,
          "TwentyFiveToThirtyFour": 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<GetKeywordDemographicsResponse> GetKeywordDemographicsAsync(
	IList<string> keywords,
	string language,
	string publisherCountry,
	IList<string> device)
{
	var request = new GetKeywordDemographicsRequest
	{
		Keywords = keywords,
		Language = language,
		PublisherCountry = publisherCountry,
		Device = device
	};

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

static GetKeywordDemographicsResponse getKeywordDemographics(
	ArrayOfstring keywords,
	java.lang.String language,
	java.lang.String publisherCountry,
	ArrayOfstring device) throws RemoteException, Exception
{
	GetKeywordDemographicsRequest request = new GetKeywordDemographicsRequest();

	request.setKeywords(keywords);
	request.setLanguage(language);
	request.setPublisherCountry(publisherCountry);
	request.setDevice(device);

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

static function GetKeywordDemographics(
	$keywords,
	$language,
	$publisherCountry,
	$device)
{

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

	$request = new GetKeywordDemographicsRequest();

	$request->Keywords = $keywords;
	$request->Language = $language;
	$request->PublisherCountry = $publisherCountry;
	$request->Device = $device;

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

response=adinsight_service.GetKeywordDemographics(
	Keywords=Keywords,
	Language=Language,
	PublisherCountry=PublisherCountry,
	Device=Device)