KeywordKPI Data Object - Ad Insight

Defines a key performance index object for a keyword. The object contains the historical performance statistics of the keyword for the corresponding match type, ad position, device, and network.

XML

<xs:complexType name="KeywordKPI" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="Device" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="MatchType" type="tns:MatchType" />
    <xs:element minOccurs="0" name="AdPosition" type="tns:AdPosition" />
    <xs:element minOccurs="0" name="Clicks" type="xs:int" />
    <xs:element minOccurs="0" name="Impressions" type="xs:long" />
    <xs:element minOccurs="0" name="AverageCPC" type="xs:double" />
    <xs:element minOccurs="0" name="CTR" type="xs:double" />
    <xs:element minOccurs="0" name="TotalCost" type="xs:double" />
    <xs:element minOccurs="0" name="AverageBid" type="xs:double" />
  </xs:sequence>
</xs:complexType>

JSON

{
  "AdPosition": "ValueHere",
  "AverageBid": DoubleValueHere,
  "AverageCPC": DoubleValueHere,
  "Clicks": IntValueHere,
  "CTR": DoubleValueHere,
  "Device": "ValueHere",
  "Impressions": "LongValueHere",
  "MatchType": "ValueHere",
  "TotalCost": DoubleValueHere
}

Elements

The KeywordKPI object has the following elements: AdPosition, AverageBid, AverageCPC, Clicks, CTR, Device, Impressions, MatchType, TotalCost.

Element	Description	Data Type
AdPosition	The position in the search results in which the ad appeared.	AdPosition
AverageBid	The average bid of the keyword.	double
AverageCPC	The average cost per click (CPC). The average CPC is calculated by dividing the cost of all clicks by the number of clicks.	double
Clicks	The number of clicks that the keyword and match type generated during the specified time interval.	int
CTR	The click-through rate (CTR) as a percentage. The CTR is calculated by dividing the number of clicks by the number of impressions and multiplying the result by 100.	double
Device	The device where the ad appeared.	string
Impressions	The number of impressions that the keyword and match type generated during the specified time interval.	long
MatchType	The match type that you specified in the request.	MatchType
TotalCost	The cost of using the specified keyword and match type during the specified time interval. The service determines the currency from the account specified in the CustomerAccountId header element. If CustomerAccountId is not set, the service uses USDollar.	double

Requirements

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

Used By

KeywordHistoricalPerformance