com.google.api.ads.adwords.lib.client.reporting

Class ReportingConfiguration

java.lang.Object

com.google.api.ads.adwords.lib.client.reporting.ReportingConfiguration

@ThreadSafe
public class ReportingConfiguration
extends Object

Additional AdWords report configuration options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReportingConfiguration.Builder Mutable builder for ReportingConfiguration objects.

Method Summary

Modifier and Type	Method and Description
Integer	getReportDownloadTimeout() Return the non-negative download timeout in milliseconds.
Boolean	isIncludeZeroImpressions() Return if report responses should include zero impression rows.
Boolean	isSkipColumnHeader() Return if report responses should skip the header row containing the column names.
Boolean	isSkipReportHeader() Return if report responses should skip the header row containing the report name and date range.
Boolean	isSkipReportSummary() Return if report responses should skip the summary row containing totals.
Boolean	isUseRawEnumValues() Return if report responses should return enum values instead of enum display values.
String	toString()
void	validate(String version) Validates this object for the specified version of the AdWords API.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

isSkipReportHeader

@Nullable
public Boolean isSkipReportHeader()

Return if report responses should skip the header row containing the report name and date range.

isSkipColumnHeader

@Nullable
public Boolean isSkipColumnHeader()

Return if report responses should skip the header row containing the column names.

isSkipReportSummary

@Nullable
public Boolean isSkipReportSummary()

Return if report responses should skip the summary row containing totals.

isIncludeZeroImpressions

@Nullable
public Boolean isIncludeZeroImpressions()

Return if report responses should include zero impression rows.

isUseRawEnumValues

@Nullable
public Boolean isUseRawEnumValues()

Return if report responses should return enum values instead of enum display values.

getReportDownloadTimeout

@Nullable
public Integer getReportDownloadTimeout()

Return the non-negative download timeout in milliseconds. A value of 0 (zero) indicates infinite timeout. A value of null indicates that the default timeout from AdWordsLibConfiguration.getReportDownloadTimeout() should be used.

Returns:

the timeout in milliseconds, or null if no timeout was specified.

validate

public void validate(@Nullable
                     String version)

Validates this object for the specified version of the AdWords API.

Parameters:

version - the v20YYMM version of the API to validate against.

Throws:

IllegalArgumentException - if validation fails

toString

public String toString()

Overrides:

toString in class Object