Compartir a través de

Operación del servicio SuggestKeywordsForUrl: Ad Insight

  • Artículo

Sugiere las palabras clave posibles para el contenido ubicado en la dirección URL especificada.

Elementos Request

El objeto SuggestKeywordsForUrlRequest 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
ExcludeBrand Valor que determina si los resultados excluyen palabras clave de marca. Para excluir palabras clave de marca en el resultado, establezca en true. El valor predeterminado es falso. boolean
Idioma Idioma utilizado por el sitio web.

Para ver los valores posibles, consulte Lenguajes de anuncios.

El valor predeterminado es Inglés.		 string
MaxKeywords Valor entero positivo que especifica el número máximo de palabras clave que se van a devolver. El valor máximo que puede especificar es 800.

El valor predeterminado es 10.		 int
MinConfidenceScore Valor de filtro que limita las palabras clave que el servicio devuelve a aquellas que tienen una puntuación de confianza mayor o igual que la puntuación especificada. Por ejemplo, puede especificar que desea que la operación devuelva solo palabras clave que tengan una puntuación de confianza de al menos el 80 por ciento (0,8).

Si es null, la puntuación de confianza no se usa para limitar los resultados.		 doble
URL Dirección URL de la página web para buscar posibles palabras clave. La dirección URL puede contener un máximo de 2000 caracteres. 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 SuggestKeywordsForUrlResponse 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
Palabras clave Matriz de objetos KeywordAndConfidence que contiene las palabras clave posibles que se encuentran en el contenido de la dirección URL especificada. Además, el objeto incluye una puntuación que indica la probabilidad de que el uso de la palabra clave daría lugar a que la dirección URL se incluyera en los resultados de una consulta de búsqueda.

Los resultados se ordenan por orden de las palabras clave con la puntuación de confianza más alta a las que tienen la puntuación de confianza más baja.		 Matriz KeywordAndConfidence

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">SuggestKeywordsForUrl</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>
    <SuggestKeywordsForUrlRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Url i:nil="false">ValueHere</Url>
      <Language i:nil="false">ValueHere</Language>
      <MaxKeywords i:nil="false">ValueHere</MaxKeywords>
      <MinConfidenceScore i:nil="false">ValueHere</MinConfidenceScore>
      <ExcludeBrand i:nil="false">ValueHere</ExcludeBrand>
    </SuggestKeywordsForUrlRequest>
  </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>
    <SuggestKeywordsForUrlResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Keywords d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordAndConfidence>
          <SuggestedKeyword d4p1:nil="false">ValueHere</SuggestedKeyword>
          <ConfidenceScore>ValueHere</ConfidenceScore>
        </KeywordAndConfidence>
      </Keywords>
    </SuggestKeywordsForUrlResponse>
  </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<SuggestKeywordsForUrlResponse> SuggestKeywordsForUrlAsync(
	string url,
	string language,
	int? maxKeywords,
	double? minConfidenceScore,
	bool? excludeBrand)
{
	var request = new SuggestKeywordsForUrlRequest
	{
		Url = url,
		Language = language,
		MaxKeywords = maxKeywords,
		MinConfidenceScore = minConfidenceScore,
		ExcludeBrand = excludeBrand
	};

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

static SuggestKeywordsForUrlResponse suggestKeywordsForUrl(
	java.lang.String url,
	java.lang.String language,
	int maxKeywords,
	double minConfidenceScore,
	boolean excludeBrand) throws RemoteException, Exception
{
	SuggestKeywordsForUrlRequest request = new SuggestKeywordsForUrlRequest();

	request.setUrl(url);
	request.setLanguage(language);
	request.setMaxKeywords(maxKeywords);
	request.setMinConfidenceScore(minConfidenceScore);
	request.setExcludeBrand(excludeBrand);

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

static function SuggestKeywordsForUrl(
	$url,
	$language,
	$maxKeywords,
	$minConfidenceScore,
	$excludeBrand)
{

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

	$request = new SuggestKeywordsForUrlRequest();

	$request->Url = $url;
	$request->Language = $language;
	$request->MaxKeywords = $maxKeywords;
	$request->MinConfidenceScore = $minConfidenceScore;
	$request->ExcludeBrand = $excludeBrand;

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

response=adinsight_service.SuggestKeywordsForUrl(
	Url=Url,
	Language=Language,
	MaxKeywords=MaxKeywords,
	MinConfidenceScore=MinConfidenceScore,
	ExcludeBrand=ExcludeBrand)

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/KeywordSuggestions/QueryByUrl

Elementos Request

El objeto SuggestKeywordsForUrlRequest 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
ExcludeBrand Valor que determina si los resultados excluyen palabras clave de marca. Para excluir palabras clave de marca en el resultado, establezca en true. El valor predeterminado es falso. boolean
Idioma Idioma utilizado por el sitio web.

Para ver los valores posibles, consulte Lenguajes de anuncios.

El valor predeterminado es Inglés.		 string
MaxKeywords Valor entero positivo que especifica el número máximo de palabras clave que se van a devolver. El valor máximo que puede especificar es 800.

El valor predeterminado es 10.		 int
MinConfidenceScore Valor de filtro que limita las palabras clave que el servicio devuelve a aquellas que tienen una puntuación de confianza mayor o igual que la puntuación especificada. Por ejemplo, puede especificar que desea que la operación devuelva solo palabras clave que tengan una puntuación de confianza de al menos el 80 por ciento (0,8).

Si es null, la puntuación de confianza no se usa para limitar los resultados.		 doble
URL Dirección URL de la página web para buscar posibles palabras clave. La dirección URL puede contener un máximo de 2000 caracteres. 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 SuggestKeywordsForUrlResponse 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
Palabras clave Matriz de objetos KeywordAndConfidence que contiene las palabras clave posibles que se encuentran en el contenido de la dirección URL especificada. Además, el objeto incluye una puntuación que indica la probabilidad de que el uso de la palabra clave daría lugar a que la dirección URL se incluyera en los resultados de una consulta de búsqueda.

Los resultados se ordenan por orden de las palabras clave con la puntuación de confianza más alta a las que tienen la puntuación de confianza más baja.		 Matriz KeywordAndConfidence

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.

{
  "Url": "ValueHere",
  "Language": "ValueHere",
  "MaxKeywords": IntValueHere,
  "MinConfidenceScore": DoubleValueHere,
  "ExcludeBrand": "ValueHere"
}

JSON de respuesta

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

{
  "Keywords": [
    {
      "ConfidenceScore": DoubleValueHere,
      "SuggestedKeyword": "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<SuggestKeywordsForUrlResponse> SuggestKeywordsForUrlAsync(
	string url,
	string language,
	int? maxKeywords,
	double? minConfidenceScore,
	bool? excludeBrand)
{
	var request = new SuggestKeywordsForUrlRequest
	{
		Url = url,
		Language = language,
		MaxKeywords = maxKeywords,
		MinConfidenceScore = minConfidenceScore,
		ExcludeBrand = excludeBrand
	};

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

static SuggestKeywordsForUrlResponse suggestKeywordsForUrl(
	java.lang.String url,
	java.lang.String language,
	int maxKeywords,
	double minConfidenceScore,
	boolean excludeBrand) throws RemoteException, Exception
{
	SuggestKeywordsForUrlRequest request = new SuggestKeywordsForUrlRequest();

	request.setUrl(url);
	request.setLanguage(language);
	request.setMaxKeywords(maxKeywords);
	request.setMinConfidenceScore(minConfidenceScore);
	request.setExcludeBrand(excludeBrand);

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

static function SuggestKeywordsForUrl(
	$url,
	$language,
	$maxKeywords,
	$minConfidenceScore,
	$excludeBrand)
{

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

	$request = new SuggestKeywordsForUrlRequest();

	$request->Url = $url;
	$request->Language = $language;
	$request->MaxKeywords = $maxKeywords;
	$request->MinConfidenceScore = $minConfidenceScore;
	$request->ExcludeBrand = $excludeBrand;

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

response=adinsight_service.SuggestKeywordsForUrl(
	Url=Url,
	Language=Language,
	MaxKeywords=MaxKeywords,
	MinConfidenceScore=MinConfidenceScore,
	ExcludeBrand=ExcludeBrand)