com.google.api.ads.adwords.jaxws.v201809.cm

Interface ReportDefinitionServiceInterface

public interface ReportDefinitionServiceInterface

Note: As of v201109 this service is read-only. New report definitions are no longer allowed.

A report definition describes the report type, date range, and fields to include in the report. Additionally, you can specify predicates to filter which rows are returned in a generated report. Please note that sorting and paging are not supported for report downloads.

To find out which report fields are available based on report type, see the Report Types appendix or call getReportFields(com.google.api.ads.adwords.jaxws.v201809.cm.ReportDefinitionReportType).

For more information about retrieving reports, see Reporting Basics. This class was generated by the JAX-WS RI. JAX-WS RI 2.2.9-b130926.1035 Generated source version: 2.1

Method Summary

Modifier and Type	Method and Description
List<ReportDefinitionField>	getReportFields(ReportDefinitionReportType reportType) Returns the available report fields for a given report type.

Method Detail

getReportFields

@RequestWrapper(localName="getReportFields",
                targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                className="com.google.api.ads.adwords.jaxws.v201809.cm.ReportDefinitionServiceInterfacegetReportFields")
 @ResponseWrapper(localName="getReportFieldsResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.cm.ReportDefinitionServiceInterfacegetReportFieldsResponse")
List<ReportDefinitionField> getReportFields(ReportDefinitionReportType reportType)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               throws ApiException_Exception

Returns the available report fields for a given report type. When using this method the clientCustomerId header field is optional. Callers are discouraged from setting the clientCustomerId header field in calls to this method as its presence will trigger an authorization error if the caller does not have access to the customer with the included ID.

Parameters:

reportType - The type of report.

reportType -

Returns:

The list of available report fields. Each ReportDefinitionField encapsulates the field name, the field data type, and the enum values (if the field's type is enum).

Throws:

ApiException - if a problem occurred while fetching the ReportDefinitionField information.

ApiException_Exception