Microsoft Advertising APIs
AdPerformanceReportColumn Value Set

Specifies the data columns to include in an ad performance report.

Syntax

<xs:complexType name="ArrayOfAdPerformanceReportColumn">
  <xs:sequence>
    <xs:element minOccurs="0" maxOccurs="unbounded" name="AdPerformanceReportColumn" type="tns:AdPerformanceReportColumn"/>
  </xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfAdPerformanceReportColumn" nillable="true" type="tns:ArrayOfAdPerformanceReportColumn"/>

<xs:simpleType name="AdPerformanceReportColumn">
  <xs:restriction base="xs:string">
    <xs:enumeration value="AccountName"/>
    <xs:enumeration value="AccountNumber"/>
    <xs:enumeration value="TimePeriod"/>
    <xs:enumeration value="LanguageAndRegion"/>
    <xs:enumeration value="CampaignName"/>
    <xs:enumeration value="AdGroupName"/>
    <xs:enumeration value="AdId"/>
    <xs:enumeration value="AdGroupId"/>
    <xs:enumeration value="AdTitle"/>
    <xs:enumeration value="AdDescription"/>
    <xs:enumeration value="AdType"/>
    <xs:enumeration value="CurrencyCode"/>
    <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="AdPerformanceReportColumn" nillable="true" type="tns:AdPerformanceReportColumn"/>
Values

Value Description

AccountName

The account name.

AccountNumber

The account number.

AdDescription

The ad text.

AdDistribution

The ad distribution medium.

AdGroupId

The ad group identifier.

AdGroupName

The ad group name.

AdId

The ad identifier.

AdTitle

The ad title.

AdType

The ad type.

AverageCpc

The average cost-per-click.

AverageCpm

The cost-per-thousand-impressions.

Bb671923.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.

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.

CurrencyCode

The currency code.

Impressions

The number of impressions.

LanguageAndRegion

The language and country/region.

PricingModel

The pricing model of the ad.

Spend

The total amount of money spent for the time period.

TimePeriod

The time period of each report row.

Bb671923.note(en-US,MSADS.60).gifNote:
The TimePeriod column cannot be requested if the Aggregation element of the AdPerformanceReportRequest object contains "Summary".

Required Columns

The columns in the following table will always be contained in an ad performance report.

Column

AccountName

CampaignName

Optional Columns

The columns in the following table can optionally be contained in an ad performance report.

Column

AccountNumber

AdDescription

AdDistribution

AdGroupId

AdGroupName

AdId

AdTitle

AdType

AverageCpc

AverageCpm

AveragePosition

Clicks

ConversionRate

Conversions

CostPerConversion

Ctr

CurrencyCode

Impressions

LanguageAndRegion

PricingModel

Spend

TimePeriod

An ad performance report must contain at least one of the optional columns as shown in the following table.

Column

AverageCpc

AverageCpm

AveragePosition

Clicks

Ctr

Impressions

Spend

Time-Period Columns

If the TimePeriod column is requested, an ad 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

Specifies the date 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

AdPerformanceReportRequest Data Object

Page view tracker