SuggestKeywordsForUrl Service Operation - Ad Insight

Suggests the possible keywords for the content located at the specified URL.

Request Elements

The SuggestKeywordsForUrlRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.

Request Body Elements

Element Description Data Type
ExcludeBrand A value that determines whether the results exclude brand keywords. To exclude brand keywords in the result, set to true. The default is false. boolean
Language The language used by the website.

For possible values, see Ad Languages.

The default is English.
string
MaxKeywords A positive integer value that specifies the maximum number of keywords to return. The maximum value that you can specify is 800.

The default is 10.
int
MinConfidenceScore A filter value that limits the keywords that the service returns to those that have a confidence score that is greater than or equal to the specified score. For example, you can specify that you want the operation to return only keywords that have a confidence score of at least 80 percent (0.8).

If null, the confidence score is not used to limit the results.
double
Url The URL of the webpage to scan for possible keywords. The URL can contain a maximum of 2,000 characters. string

Request Header Elements

Element Description Data Type
AuthenticationToken The OAuth access token that represents a Microsoft Account user who has permissions to Bing Ads accounts. string
CustomerAccountId The identifier of the account that owns the entities in the request. This header element must have the same value as the AccountId body element when both are required. string
CustomerId The identifier of the customer that contains and owns the account. If you manage an account of another customer, you should use that customer ID instead of your own customer ID. string
DeveloperToken The developer token used to access the Bing Ads API. string
Password This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string
UserName This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string

Note

The CustomerAccountId and CustomerId are required for most service operations, and as a best practice you should always specify them in the request.

Response Elements

The SuggestKeywordsForUrlResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.

Response Body Elements

Element Description Data Type
Keywords An array of KeywordAndConfidence objects that contains the possible keywords found in the content of the specified URL. In addition, the object includes a score that indicates the probability that using the keyword would result in the URL being included in the results of a search query.

The results are sorted in order from keywords with the highest confidence score to those with the lowest confidence score.
KeywordAndConfidence array

Response Header Elements

Element Description Data Type
TrackingId The identifier of the log entry that contains the details of the API call. string

Request SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="Microsoft.Advertiser.AdInsight.Api.Service.V12">
    <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="Microsoft.Advertiser.AdInsight.Api.Service.V12">
      <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>

Response SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP response.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="Microsoft.Advertiser.AdInsight.Api.Service.V12">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <SuggestKeywordsForUrlResponse xmlns="Microsoft.Advertiser.AdInsight.Api.Service.V12">
      <Keywords xmlns:e117="http://schemas.datacontract.org/2004/07/Microsoft.BingAds.Advertiser.AdInsight.Api.DataContract.V12.Entity" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e117:KeywordAndConfidence>
          <e117:SuggestedKeyword d4p1:nil="false">ValueHere</e117:SuggestedKeyword>
          <e117:ConfidenceScore>ValueHere</e117:ConfidenceScore>
        </e117:KeywordAndConfidence>
      </Keywords>
    </SuggestKeywordsForUrlResponse>
  </s:Body>
</s:Envelope>

Code Syntax

The example syntax can be used with Bing Ads SDKs. See Bing Ads Code Examples for more examples.

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)

Requirements

Service: AdInsightService.svc v12
Namespace: Microsoft.Advertiser.AdInsight.Api.Service.V12