Export (0) Print
Expand All

SuggestKeywordsForUrlRequest Message

Defines the request message that the client passes to the SuggestKeywordsForUrl operation.

<wsdl:message name="SuggestKeywordsForUrlRequest">
  <wsdl:part name="parameters" element="tns:SuggestKeywordsForUrlRequest" />
</wsdl:message>

Body Elements

Element

Description

Data Type

Required

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

No

Language

The language used by the website.

For possible values, see Languages.

The default is English.

string

No

MaxKeywords

A positive integer value that specifies the maximum number of keywords to return. The maximum value that you can specify is 200.

The default is 10.

int

No

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

No

Url

The URL of the webpage to scan for possible keywords. The URL can contain a maximum of 2,000 characters.

string

Yes

Header Elements

For information about the values you set the DeveloperToken, Password, and UserName elements to, see Getting Started With the Bing Ads API.

Element

Description

Data Type

ApplicationToken

The application-access token. This header element is not used and should be null.

string

AuthenticationToken

The authentication token. This header element is not used and should be null.

string

CustomerAccountId

The identifier of the account that owns the entities in the request.

string

CustomerId

The identifier of the customer that owns the account. This header element is not used and should be null.

string

DeveloperToken

The caller's developer access token.

string

Password

The user's sign-in password.

string

UserName

The user's sign-in user name. You cannot set this element to a Microsoft account (formerly known as Windows Live ID).

string

SOAP

The following example shows the complete SOAP envelope for a SuggestKeywordsForUrlRequest request.

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://adcenter.microsoft.com/v8">
    <Action mustUnderstand="1">SuggestKeywordsForUrl</Action>
    <ApplicationToken i:nil="true" />
    <AuthenticationToken i:nil="false"></AuthenticationToken>
    <CustomerAccountId i:nil="true" />
    <CustomerId i:nil="true" />
    <DeveloperToken i:nil="false"></DeveloperToken>
    <Password i:nil="false"></Password>
    <UserName i:nil="false"></UserName>
  </s:Header>
  <s:Body>
    <SuggestKeywordsForUrlRequest xmlns="https://adcenter.microsoft.com/v8">
      <Url i:nil="false"></Url>
      <Language i:nil="false"></Language>
      <MaxKeywords i:nil="false"></MaxKeywords>
      <MinConfidenceScore i:nil="false"></MinConfidenceScore>
      <ExcludeBrand i:nil="false"></ExcludeBrand>
    </SuggestKeywordsForUrlRequest>
  </s:Body>
</s:Envelope>

Requirements

AdIntelligenceService.svc v8

Namespace: https://adcenter.microsoft.com/v8

Community Additions

Show:
© 2014 Microsoft