Edit

KeywordIdea Data Object - Ad Insight

  • Article

Defines an object that contains a suggested keyword with historical statistics, like monthly search volume, competition, suggested minimum bid, and ad impression share.

Syntax

<xs:complexType name="KeywordIdea" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="AdGroupId" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="AdGroupName" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="AdImpressionShare" nillable="true" type="xs:double" />
    <xs:element minOccurs="0" name="Competition" nillable="true" type="tns:CompetitionLevel" />
    <xs:element minOccurs="0" name="Keyword" nillable="true" type="xs:string" />
    <xs:element xmlns:q24="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="MonthlySearchCounts" nillable="true" type="q24:ArrayOflong" />
    <xs:element minOccurs="0" name="Relevance" nillable="true" type="xs:double" />
    <xs:element minOccurs="0" name="Source" nillable="true" type="tns:SourceType" />
    <xs:element minOccurs="0" name="SuggestedBid" nillable="true" type="xs:double" />
  </xs:sequence>
</xs:complexType>

Elements

The KeywordIdea object has the following elements: AdGroupId, AdGroupName, AdImpressionShare, Competition, Keyword, MonthlySearchCounts, Relevance, Source, SuggestedBid.

Element Description Data Type
AdGroupId The negative ad group identifier that groups keyword ideas into suggested new ad groups. Keyword ideas for existing ad group identifiers is not supported.

If the ad group ID is null then the keyword idea Source element is set to Seed, and there is not any specific recommended ad group.		 long
AdGroupName The suggested name of the ad group for the keyword idea.

If the ad group name is null then the keyword idea Source element is set to Seed, and there is not any specific recommended ad group.		 string
AdImpressionShare Ad impression share is the number of impressions you've received divided by the total number of searches for the location and network you're targeting that matched the keyword exactly in the last calendar month. double
Competition Determined by the number of advertisers bidding on this keyword, relative to all other keywords across Microsoft Advertising. CompetitionLevel
Keyword The suggested keyword. string
MonthlySearchCounts The number of times this keyword was used as a search term for each month within the date range and targeting settings you've selected.

By default the size of the list is 12 and the last 12 months of available data are returned. The search counts are sorted in order starting with the most recent month's data at MonthlySeachCounts[0].

It can take up to 72 hours for the previous calendar month's data to be available. For example, if you request keyword ideas on August 1st, 2nd or 3rd, and July's data is not ready, the response will be based on June's data. If you do not include the DateRangeSearchParameter in the GetKeywordIdeas request, then you will not be able to confirm whether the first list item is data for the previous month, or the month prior. If the date range is specified and the most recent month's data is not yet available, then GetKeywordIdeas will return an error.		 long array
Relevance The keyword relevance score.

Higher relevance means "more relevant". There is no defined range, but as an example you might see values such as 1.00 or 87,083.82. Although the values are not displayed, relevance is used to sort Keyword Planner results by relevance in the Microsoft Advertising UI.		 double
Source The source or seed for the keyword. SourceType
SuggestedBid The suggested minimum bid for this keyword. We create this suggestion using the location and network criterion you included, along with the average cost-per-click (CPC) advertisers are paying for this keyword. This amount is only an estimate and your actual CPC may vary. double

Requirements

Service: AdInsightService.svc v13
Namespace: https://bingads.microsoft.com/AdInsight/v13

Used By

GetKeywordIdeas