Export (0) Print
Expand All

TrafficSourcesReportRequest Data Object

Defines a traffic sources report request, which shows the number of times that users reach the different stages of a conversion funnel, broken out by publisher website. You can use this report to get information about which website generates the most revenue for each account.

<xs:complexType name="TrafficSourcesReportRequest">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:ReportRequest">
      <xs:sequence>
        <xs:element name="Aggregation" type="tns:NonHourlyReportAggregation" />
        <xs:element name="Columns" nillable="true" type="tns:ArrayOfTrafficSourcesReportColumn" />
        <xs:element minOccurs="0" name="Filter" nillable="true" type="tns:TrafficSourcesReportFilter" />
        <xs:element name="Scope" nillable="true" type="tns:AccountReportScope" />
        <xs:element name="Time" nillable="true" type="tns:ReportTime" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

Element

Description

Data Type

Required/Optional

Aggregation

The type of aggregation to use to aggregate the report data. For example, you can aggregate the report data by day or month, or request a summary report. The Time element specifies the time period to use for the aggregation.

For a list of aggregation types, see Aggregation and Time Periods.

NonHourlyReportAggregation

Required

Columns

The list of columns to include in the report. The report will include the columns in the order that you specify them.

TrafficSourcesReportColumn[]

Required

Filter

The filter information to use to filter the report data.

System_CLiX_noteNote

The Filter element is not supported at this time.

TrafficSourcesReportFilter

Optional

Scope

The scope of the report. For example, you can limit the report to include data for a combination of accounts, ad groups, and campaigns.

AccountReportScope

Required

Time

The time period to use for the report. You can specify a custom date range or select a predefined date range (for example, Today, ThisWeek, or LastMonth).

For a list of the time periods that you can specify for each aggregation type, see Aggregation and Time Periods.

ReportTime

Required

This object derives from the ReportRequest object. For a list of additional elements that you can specify, see the ReportRequest object.

Business Rules

Aggregation and Time Periods

The following are the time periods that you can specify for each aggregation value.

Aggregation Type

Time Period

Daily

Today

Yesterday

LastSevenDays

ThisMonth

LastMonth

Custom date range

Monthly

ThisMonth

LastMonth

LastThreeMonths

LastSixMonths

LastYear

Custom date range

Summary

Today

Yesterday

LastSevenDays

ThisMonth

LastMonth

Custom date range

Weekly

ThisWeek

LastWeek

LastFourWeeks

Custom date range

Yearly

ThisYear

LastYear

Custom date range

Report data is available only to advertisers that deploy analytics tags on the relevant pages of their website.

To request a report of this type, pass this object to the SubmitGenerateReport service operation.

Requirements

ReportingService.svc v8

Namespace: https://adcenter.microsoft.com/v8

Community Additions

Show:
© 2014 Microsoft