Edit

SearchTermLandingPageReportRequest Data Object - Reporting

Defines a Search Term Landing Page report request. Use this request with the SubmitGenerateReport operation to generate a report that includes the search term, delivered headline, and landing page URL for each ad impression.

Syntax

<xs:complexType name="SearchTermLandingPageReportRequest" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:ReportRequest">
      <xs:sequence>
        <xs:element name="Aggregation" type="tns:ReportAggregation" />
        <xs:element name="Columns" nillable="true" type="tns:ArrayOfSearchTermLandingPageReportColumn" />
        <xs:element minOccurs="0" name="Filter" nillable="true" type="tns:SearchTermLandingPageReportFilter" />
        <xs:element name="Scope" nillable="true" type="tns:AccountThroughCampaignReportScope" />
        <xs:element name="Time" nillable="true" type="tns:ReportTime" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

The SearchTermLandingPageReportRequest object has the following elements: Aggregation, Columns, Filter, Scope, Time.

Element Description Data Type
Aggregation The type of aggregation to use to aggregate the report data. For example, you can aggregate the report data by day or week.

Supported values are Hourly, Daily, We*ekly, Monthly, Yearly, DayOfWeek, and HourOfDay.

This element is required.		 ReportAggregation
Columns The list of attributes and performance statistics to include in the report. The report will include the columns in the order that you specify them.

You must specify Final URL and at least one performance statistics column, e.g., Impressions.

This element is required.		 SearchTermLandingPageReportColumn array
Filter The filter information to use to filter the report data.

This element is optional.		 SearchTermLandingPageReportFilter
Scope The entities and their scope to include in the report. Use this element to limit the report data to specific accounts and campaigns.

This element is required.		 AccountThroughCampaignReportScope
Time The time frame to use to aggregate the report data. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

This element is required.		 ReportTime

The SearchTermLandingPageReportRequest object has Inherited Elements.

Inherited Elements

Inherited Elements from ReportRequest

The SearchTermLandingPageReportRequest object derives from the ReportRequest object, and inherits the following elements: ExcludeColumnHeaders, ExcludeReportFooter, ExcludeReportHeader, Format, FormatVersion, ReportName, ReturnOnlyCompleteData. The descriptions below are specific to SearchTermLandingPageReportRequest, and might not apply to other objects that inherit the same elements from the ReportRequest object.

Element Description Data Type
ExcludeColumnHeaders Determines whether or not the report includes header descriptions for each column of data.

This element is optional and defaults to false.		 boolean
ExcludeReportFooter Determines whether or not the report includes footer information such as copyright.

This element is optional and defaults to false.		 boolean
ExcludeReportHeader Determines whether or not the report includes header information such as the report name and date range.

This element is optional and defaults to false.		 boolean
Format The format of the report file. For example you can specify to have the report data written to a file that uses comma-separated values (CSV).

This element is optional and defaults to Csv.		 ReportFormat
FormatVersion The format version of the report file.

This element is optional.		 string
ReportName The name of the report. The name will be used as the name of the download file.

This element is optional.		 string
ReturnOnlyCompleteData Determines whether the operation returns data for only fully processed time periods.

This element is optional and defaults to false.		 boolean

Requirements

Service: ReportingService.svc v13
Namespace: https://bingads.microsoft.com/Reporting/v13

  • Last updated on