GetKeywordOpportunities Service Operation - Ad Insight
Gets a list of keyword suggestions that are relevant to the specified ad group. The keyword suggestion also includes a suggested bid value.
Request Elements
The GetKeywordOpportunitiesRequest 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.
Note
Unless otherwise noted below, all request elements are required.
Request Body Elements
| Element | Description | Data Type |
|---|---|---|
| AdGroupId | The identifier of the ad group to get keyword suggestions for. The following restrictions apply to the specified ad group: - Its language must be set to English. - Its distribution medium must include Search. - It should contain keywords and ads. The operation will suggest keywords only if the ad group contains one or more ads and keywords; the more keywords and ads that the ad group contains, the richer the set of suggested keywords will be. If AdGroupId is nil or empty, the operation will return all keyword opportunities for the specified campaign. |
long |
| CampaignId | The identifier of the campaign that owns the specified ad group. If the CampaignId element is nil or empty, then the AdGroupId must also be nil or empty, and the operation will return all keyword opportunities for the account. |
long |
| OpportunityType | Determines the type or types of keyword opportunities that you want. You may include multiple values as flags. How you specify multiple flags depends on the programming language that you use. For example, C# treats these values as flag values and Java treats them as an array of strings. The SOAP should include a string that contains a space-delimited list of values for example, <OpportunityType>BroadMatch CampaignContext</OpportunityType>. |
KeywordOpportunityType |
Request Header Elements
| Element | Description | Data Type |
|---|---|---|
| AuthenticationToken | The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. For more information see Authentication with OAuth. |
string |
| CustomerAccountId | The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| CustomerId | The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| DeveloperToken | The developer token used to access the Bing Ads API. For more information see Get a Developer Token. |
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 |
Response Elements
The GetKeywordOpportunitiesResponse 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 |
|---|---|---|
| Opportunities | A list of KeywordOpportunity data objects that identifies a suggested keyword and bid value. The list will be empty if there are no suggestions, which may occur if the ad group does not contain existing ads and keywords. Currently up to 1,000 list items can be returned although the limit is subject to change. |
KeywordOpportunity 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="https://bingads.microsoft.com/AdInsight/v13">
<Action mustUnderstand="1">GetKeywordOpportunities</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>
<GetKeywordOpportunitiesRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
<AdGroupId i:nil="false">ValueHere</AdGroupId>
<CampaignId i:nil="false">ValueHere</CampaignId>
<OpportunityType>ValueHere</OpportunityType>
</GetKeywordOpportunitiesRequest>
</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="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>
<GetKeywordOpportunitiesResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
<Opportunities d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<KeywordOpportunity d4p1:type="-- derived type specified here with the appropriate prefix --">
<AdGroupId>ValueHere</AdGroupId>
<AdGroupName d4p1:nil="false">ValueHere</AdGroupName>
<CampaignId>ValueHere</CampaignId>
<CampaignName d4p1:nil="false">ValueHere</CampaignName>
<Competition>ValueHere</Competition>
<EstimatedIncreaseInClicks>ValueHere</EstimatedIncreaseInClicks>
<EstimatedIncreaseInCost>ValueHere</EstimatedIncreaseInCost>
<EstimatedIncreaseInImpressions>ValueHere</EstimatedIncreaseInImpressions>
<MatchType>ValueHere</MatchType>
<MonthlySearches>ValueHere</MonthlySearches>
<SuggestedBid>ValueHere</SuggestedBid>
<SuggestedKeyword d4p1:nil="false">ValueHere</SuggestedKeyword>
<!--These fields are applicable if the derived type attribute is set to BroadMatchKeywordOpportunity-->
<AverageCPC>ValueHere</AverageCPC>
<AverageCTR>ValueHere</AverageCTR>
<ClickShare>ValueHere</ClickShare>
<ImpressionShare>ValueHere</ImpressionShare>
<ReferenceKeywordBid>ValueHere</ReferenceKeywordBid>
<ReferenceKeywordId>ValueHere</ReferenceKeywordId>
<ReferenceKeywordMatchType>ValueHere</ReferenceKeywordMatchType>
<SearchQueryKPIs d4p1:nil="false">
<BroadMatchSearchQueryKPI>
<AverageCTR>ValueHere</AverageCTR>
<Clicks>ValueHere</Clicks>
<Impressions>ValueHere</Impressions>
<SRPV>ValueHere</SRPV>
<SearchQuery d4p1:nil="false">ValueHere</SearchQuery>
</BroadMatchSearchQueryKPI>
</SearchQueryKPIs>
</KeywordOpportunity>
</Opportunities>
</GetKeywordOpportunitiesResponse>
</s:Body>
</s:Envelope>
Code Syntax
The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.
public async Task<GetKeywordOpportunitiesResponse> GetKeywordOpportunitiesAsync(
long? adGroupId,
long? campaignId,
KeywordOpportunityType opportunityType)
{
var request = new GetKeywordOpportunitiesRequest
{
AdGroupId = adGroupId,
CampaignId = campaignId,
OpportunityType = opportunityType
};
return (await AdInsightService.CallAsync((s, r) => s.GetKeywordOpportunitiesAsync(r), request));
}
static GetKeywordOpportunitiesResponse getKeywordOpportunities(
java.lang.Long adGroupId,
java.lang.Long campaignId,
ArrayList<KeywordOpportunityType> opportunityType) throws RemoteException, Exception
{
GetKeywordOpportunitiesRequest request = new GetKeywordOpportunitiesRequest();
request.setAdGroupId(adGroupId);
request.setCampaignId(campaignId);
request.setOpportunityType(opportunityType);
return AdInsightService.getService().getKeywordOpportunities(request);
}
static function GetKeywordOpportunities(
$adGroupId,
$campaignId,
$opportunityType)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetKeywordOpportunitiesRequest();
$request->AdGroupId = $adGroupId;
$request->CampaignId = $campaignId;
$request->OpportunityType = $opportunityType;
return $GLOBALS['AdInsightProxy']->GetService()->GetKeywordOpportunities($request);
}
response=adinsight_service.GetKeywordOpportunities(
AdGroupId=AdGroupId,
CampaignId=CampaignId,
OpportunityType=OpportunityType)
Requirements
Service: AdInsightService.svc v13
Namespace: https://bingads.microsoft.com/AdInsight/v13
Request Url
https://adinsight.api.bingads.microsoft.com/AdInsight/v13/KeywordOpportunities/Query
Request Elements
The GetKeywordOpportunitiesRequest object defines the body and header elements of the service operation request.
Note
Unless otherwise noted below, all request elements are required.
Request Body Elements
| Element | Description | Data Type |
|---|---|---|
| AdGroupId | The identifier of the ad group to get keyword suggestions for. The following restrictions apply to the specified ad group: - Its language must be set to English. - Its distribution medium must include Search. - It should contain keywords and ads. The operation will suggest keywords only if the ad group contains one or more ads and keywords; the more keywords and ads that the ad group contains, the richer the set of suggested keywords will be. If AdGroupId is nil or empty, the operation will return all keyword opportunities for the specified campaign. |
long |
| CampaignId | The identifier of the campaign that owns the specified ad group. If the CampaignId element is nil or empty, then the AdGroupId must also be nil or empty, and the operation will return all keyword opportunities for the account. |
long |
| OpportunityType | Determines the type or types of keyword opportunities that you want. You may include multiple values as flags. How you specify multiple flags depends on the programming language that you use. For example, C# treats these values as flag values and Java treats them as an array of strings. The SOAP should include a string that contains a space-delimited list of values for example, <OpportunityType>BroadMatch CampaignContext</OpportunityType>. |
KeywordOpportunityType |
Request Header Elements
| Element | Description | Data Type |
|---|---|---|
| Authorization | The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. Please ensure that the token is prefixed with "Bearer ", this is necessary for proper authentication. For more information see Authentication with OAuth. |
string |
| CustomerAccountId | The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| CustomerId | The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| DeveloperToken | The developer token used to access the Bing Ads API. For more information see Get a Developer Token. |
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 |
Response Elements
The GetKeywordOpportunitiesResponse 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 JSON.
Response Body Elements
| Element | Description | Data Type |
|---|---|---|
| Opportunities | A list of KeywordOpportunity data objects that identifies a suggested keyword and bid value. The list will be empty if there are no suggestions, which may occur if the ad group does not contain existing ads and keywords. Currently up to 1,000 list items can be returned although the limit is subject to change. |
KeywordOpportunity 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 JSON
This template was generated by a tool to show the body and header elements for the JSON request. For supported types that you can use with this service operation, see the Request Body Elements reference above.
{
"AdGroupId": "LongValueHere",
"CampaignId": "LongValueHere",
"OpportunityType": "ValueHere"
}
Response JSON
This template was generated by a tool to show the body and header elements for the JSON response.
Below is an example that is applicable if the type of KeywordOpportunity is BroadMatchKeywordOpportunity.
{
"Opportunities": [
{
"AdGroupId": "LongValueHere",
"AdGroupName": "ValueHere",
"CampaignId": "LongValueHere",
"CampaignName": "ValueHere",
"Competition": DoubleValueHere,
"EstimatedIncreaseInClicks": DoubleValueHere,
"EstimatedIncreaseInCost": DoubleValueHere,
"EstimatedIncreaseInImpressions": "LongValueHere",
"MatchType": IntValueHere,
"MonthlySearches": "LongValueHere",
"SuggestedBid": DoubleValueHere,
"SuggestedKeyword": "ValueHere",
"Type": "BroadMatchKeywordOpportunity",
"AverageCPC": DoubleValueHere,
"AverageCTR": DoubleValueHere,
"ClickShare": DoubleValueHere,
"ImpressionShare": DoubleValueHere,
"ReferenceKeywordBid": DoubleValueHere,
"ReferenceKeywordId": "LongValueHere",
"ReferenceKeywordMatchType": IntValueHere,
"SearchQueryKPIs": [
{
"AverageCTR": DoubleValueHere,
"Clicks": DoubleValueHere,
"Impressions": "LongValueHere",
"SearchQuery": "ValueHere",
"SRPV": "LongValueHere"
}
]
}
]
}
Code Syntax
To call REST API through SDKs, you need to upgrade SDK to a certain version and configure the system parameters.The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.
public async Task<GetKeywordOpportunitiesResponse> GetKeywordOpportunitiesAsync(
long? adGroupId,
long? campaignId,
KeywordOpportunityType opportunityType)
{
var request = new GetKeywordOpportunitiesRequest
{
AdGroupId = adGroupId,
CampaignId = campaignId,
OpportunityType = opportunityType
};
return (await AdInsightService.CallAsync((s, r) => s.GetKeywordOpportunitiesAsync(r), request));
}
static GetKeywordOpportunitiesResponse getKeywordOpportunities(
java.lang.Long adGroupId,
java.lang.Long campaignId,
ArrayList<KeywordOpportunityType> opportunityType) throws RemoteException, Exception
{
GetKeywordOpportunitiesRequest request = new GetKeywordOpportunitiesRequest();
request.setAdGroupId(adGroupId);
request.setCampaignId(campaignId);
request.setOpportunityType(opportunityType);
return AdInsightService.getService().getKeywordOpportunities(request);
}
static function GetKeywordOpportunities(
$adGroupId,
$campaignId,
$opportunityType)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetKeywordOpportunitiesRequest();
$request->AdGroupId = $adGroupId;
$request->CampaignId = $campaignId;
$request->OpportunityType = $opportunityType;
return $GLOBALS['AdInsightProxy']->GetService()->GetKeywordOpportunities($request);
}
response=adinsight_service.GetKeywordOpportunities(
AdGroupId=AdGroupId,
CampaignId=CampaignId,
OpportunityType=OpportunityType)