CampaignPerformanceReportColumn Value Set

Microsoft Advertising APIs

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

Syntax

<xs:complexType name="ArrayOfCampaignPerformanceReportColumn">
  <xs:sequence>
    <xs:element minOccurs="0" maxOccurs="unbounded" name="CampaignPerformanceReportColumn" type="tns:CampaignPerformanceReportColumn"/>
  </xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfCampaignPerformanceReportColumn" nillable="true" type="tns:ArrayOfCampaignPerformanceReportColumn"/>
<xs:simpleType name="CampaignPerformanceReportColumn">
  <xs:restriction base="xs:string">
    <xs:enumeration value="AccountName"/>
    <xs:enumeration value="AccountNumber"/>
    <xs:enumeration value="TimePeriod"/>
    <xs:enumeration value="Status"/>
    <xs:enumeration value="CampaignName"/>
    <xs:enumeration value="CampaignId"/>
    <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="LowQualityClicks"/>
    <xs:enumeration value="LowQualityClicksPercent"/>
    <xs:enumeration value="LowQualityImpressions"/>
    <xs:enumeration value="LowQualityImpressionsPercent"/>
    <xs:enumeration value="LowQualityConversions"/>
    <xs:enumeration value="LowQualityConversionRate"/>
    <xs:enumeration value="AverageCpm"/>
  </xs:restriction>
</xs:simpleType>
<xs:element name="CampaignPerformanceReportColumn" nillable="true" type="tns:CampaignPerformanceReportColumn"/>

Values

Value	Description
AccountName	The account name.
AccountNumber	The account number.
AdDistribution	The ad distribution medium.
AverageCpc	The average cost-per-click.
AverageCpm	The cost-per-thousand-impressions. Note: 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 identifier of the campaign.
CampaignName	The name of the campaign.
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.
LowQualityClicks	The number of low-quality clicks.
LowQualityClicksPercent	The percentage of low-quality clicks.
LowQualityConversionRate	The low-quality conversion rate.
LowQualityConversions	The number of low-quality conversions.
LowQualityImpressions	The number of low-quality impressions.
LowQualityImpressionsPercent	The percentage of low-quality impressions.
Impressions	The number of impressions.
Spend	The total amount of money spent for the time period.
Status	The status of the campaign.
TimePeriod	The time period of each report row. Note: The TimePeriod column cannot be requested if the `CampaignPerformanceReportRequest.Aggregation` element contains "Summary".

Required Columns

The columns in the following table will always be contained in a campaign performance report.

Column
AccountName
CampaignName

Optional Columns

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

Column
AccountNumber
AdDistribution
AverageCpc
AverageCpm
AveragePosition
CampaignId
Clicks
ConversionRate
Conversions
CostPerConversion
Ctr
CurrencyCode
Impressions
LowQualityClicks
LowQualityClicksPercent
LowQualityConversionRate
LowQualityConversions
LowQualityImpressions
LowQualityImpressionsPercent
Spend
Status
TimePeriod

The 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, a campaign 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.

Reference

CampaignPerformanceReportRequest Data Object