KeywordPerformanceReportColumn Value Set

MSDN Library
Online Services
Microsoft Advertising Services
Microsoft adCenter APIs
Microsoft adCenter API Version 6
Microsoft adCenter Reporting API
Microsoft adCenter Reporting API Reference
Reporting Value Sets

LanguageAndRegionReportFilter Value Set
MetroAreaDemographicReportColumn Value Set
NonHourlyReportAggregation Value Set
PublisherUsagePerformanceReportColumn Value Set
ReportAggregation Value Set
ReportFormat Value Set
ReportLanguage Value Set
ReportRequestStatusType Value Set
ReportTimePeriod Value Set
SearchQueryPerformanceReportColumn Value Set
SearchQueryReportAggregation Value Set
SitePerformanceReportColumn Value Set

KeywordPerformanceReportColumn Value Set

KeywordPerformanceReportColumn Value Set

Specifies the data columns to include in a keyword performance report.

<xs:complexType name="ArrayOfKeywordPerformanceReportColumn">
  <xs:sequence>
    <xs:element minOccurs="0" maxOccurs="unbounded" name="KeywordPerformanceReportColumn" type="tns:KeywordPerformanceReportColumn" />
  </xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfKeywordPerformanceReportColumn" nillable="true" type="tns:ArrayOfKeywordPerformanceReportColumn" />
<xs:simpleType name="KeywordPerformanceReportColumn">
  <xs:restriction base="xs:string">
    <xs:enumeration value="AccountName" />
    <xs:enumeration value="AccountNumber" />
    <xs:enumeration value="AccountId" />
    <xs:enumeration value="TimePeriod" />
    <xs:enumeration value="LanguageAndRegion" />
    <xs:enumeration value="CampaignName" />
    <xs:enumeration value="CampaignId" />
    <xs:enumeration value="AdGroupName" />
    <xs:enumeration value="AdGroupId" />
    <xs:enumeration value="Keyword" />
    <xs:enumeration value="KeywordId" />
    <xs:enumeration value="AdId" />
    <xs:enumeration value="AdType" />
    <xs:enumeration value="DestinationUrl" />
    <xs:enumeration value="CurrentMaxCpc" />
    <xs:enumeration value="CurrencyCode" />
    <xs:enumeration value="MatchType" />
    <xs:enumeration value="AdDistribution" />
    <xs:enumeration value="Impressions" />
    <xs:enumeration value="Clicks" />
    <xs:enumeration value="Ctr" />
    <xs:enumeration value="AverageCpc" />
    <xs:enumeration value="Spend" />
    <xs:enumeration value="AveragePosition" />
    <xs:enumeration value="Conversions" />
    <xs:enumeration value="ConversionRate" />
    <xs:enumeration value="CostPerConversion" />
    <xs:enumeration value="AverageCpm" />
    <xs:enumeration value="PricingModel" />
    <xs:enumeration value="Cashback" />
  </xs:restriction>
</xs:simpleType>
<xs:element name="KeywordPerformanceReportColumn" nillable="true" type="tns:KeywordPerformanceReportColumn" />

Values

Value	Description
AccountId	Specifies the account identifier.
AccountName	Specifies the account name.
AccountNumber	Specifies the account number.
AdDistribution	Specifies the ad distribution medium.
AdGroupId	Specifies the ad group identifier.
AdGroupName	Specifies the ad group name.
AdId	Specifies the ad identifier.
AdType	Specifies the ad type.
AverageCpc	Specifies the average cost-per-click (CPC).
AverageCpm	Specifies the cost-per-thousand-impressions. Note This column can be requested only if you belong to the CPM pilot program.
AveragePosition	Specifies the average position of the ad in paid results.
CampaignId	Specifies the campaign identifier.
CampaignName	Specifies the campaign name.
Cashback	Specifies the cashback rebate status of the keyword.
Clicks	Specifies the number of times that the ad was clicked.
ConversionRate	Specifies the conversion rate.
Conversions	Specifies the number of conversions.
CostPerConversion	Specifies the cost per conversion.
Ctr	Specifies the click-through rate. The click-through rate (CTR) is the ratio of the number of times that an ad is clicked to the number of ad impressions.
CurrencyCode	Specifies the currency code.
CurrentMaxCpc	Specifies the maximum cost-per-click.
DestinationUrl	Specifies the destination URL.
Impressions	Specifies the number of impressions.
Keyword	Specifies the keyword.
KeywordId	Specifies the keyword identifier.
LanguageAndRegion	Specifies the language and country/region.
MatchType	Specifies the match type.
PricingModel	Specifies the pricing model of the keyword.
Spend	Specifies the total amount spent for the time period.
TimePeriod	Specifies the time period of each report row. Note The TimePeriod column cannot be requested if the `Aggregation` element of the KeywordPerformanceReportRequest object contains "Summary".

Required Columns

The columns in the following table will always be included in a keyword performance report.

Column
AccountName
CampaignName
Keyword

Optional Columns

The columns in the following table can optionally be included in a keyword performance report.

Column
AccountId
AccountNumber
AdDistribution
AdGroupId
AdGroupName
AdId
AdType
AverageCpc
AverageCpm
AveragePosition
CampaignId
Cashback
Clicks
ConversionRate
Conversions
CostPerConversion
Ctr
CurrencyCode
CurrentMaxCpc
DestinationUrl
Impressions
KeywordId
LanguageAndRegion
MatchType
PricingModel
Spend
TimePeriod

At least one of the optional columns in the following table must be included in a keyword performance report.

Column
AverageCpc
AverageCpm
AveragePosition
Clicks
Ctr
Impressions
Spend

Time-Period Columns

If the TimePeriod column is requested, a keyword performance report includes at least one of the following time-period columns. They specify the time period of the report row.

Time-Period Column Label	Aggregation	Description
GregorianDate	Daily Hourly	Specifies the date of the report row.
Hour	Hourly	Specifies the hour of the report row.
MonthStartDate	Monthly	Specifies the first day of the month of the report row.
WeekStartDate	Weekly	Specifies the first day of the week of the report row.
Year	Yearly	Specifies the year of the report row.

Requirements

WSDL: ReportingService.svc in version 6.

Reference

KeywordPerformanceReportRequest Data Object