Microsoft Advertising APIs
KeywordPerformanceReportColumn Value Set

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

Syntax

<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:restriction>
</xs:simpleType>
<xs:element name="KeywordPerformanceReportColumn" nillable="true" type="tns:KeywordPerformanceReportColumn"/>
Values

Value Description

AccountId

The account identifier.

AccountName

The account name.

AccountNumber

The account number.

AdDistribution

The ad distribution medium.

AdGroupId

The ad group identifier.

AdGroupName

The ad group name.

AdId

The ad identifier.

AdType

The ad type.

AverageCpc

The average cost-per-click (CPC).

AverageCpm

The cost-per-thousand-impressions.

Bb672087.note(en-US,MSADS.60).gifNote:
This column can be requested only if you belong to the CPM pilot program.

AveragePosition

The average position of the ad in paid results.

CampaignId

The campaign identifier.

CampaignName

The campaign name.

Clicks

The number of times that the ad was clicked.

ConversionRate

The conversion rate.

Conversions

The number of conversions.

CostPerConversion

The cost per conversion.

Ctr

The click-through rate (CTR).

CurrencyCode

The currency code.

CurrentMaxCpc

The maximum cost-per-click.

DestinationUrl

The destination URL.

Impressions

The number of impressions.

Keyword

The keyword.

KeywordId

The keyword identifier.

LanguageAndRegion

The language and country/region.

MatchType

The match type.

PricingModel

The pricing model of the keyword.

Spend

The total amount spent for the time period.

TimePeriod

The time period of each report row.

Bb672087.note(en-US,MSADS.60).gifNote:
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 contained in a keyword performance report.

Column

AccountName

CampaignName

Keyword

Optional Columns

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

Column

AccountId

AccountNumber

AdDistribution

AdGroupId

AdGroupName

AdId

AdType

AverageCpc

AverageCpm

AveragePosition

CampaignId

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 contained 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 contains 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.

See Also

Reference

KeywordPerformanceReportRequest Data Object

Page view tracker