\Google\AdsApi\AdWordsReportSettingsBuilder

__construct()

__construct(null|\Google\AdsApi\AdWords\ReportSettings  $reportSettings = null)

Create a report settings builder using the user-provided report settings if it's not null.

Parameters

from()

from(\Google\AdsApi\Common\Configuration  $configuration): \Google\AdsApi\Common\AdsBuilder

Populates this builder from the specified configuration object.

Parameters

Returns

this builder populated from the configuration

skipReportHeader()

skipReportHeader(boolean|null  $isSkipReportHeader): \Google\AdsApi\AdWords\ReportSettingsBuilder

Whether report responses should skip the header row containing the report name and date range. This is optional and defaults to false.

Parameters

Returns

this builder

skipColumnHeader()

skipColumnHeader(boolean|null  $isSkipColumnHeader): \Google\AdsApi\AdWords\ReportSettingsBuilder

Whether report responses should skip the header row containing the column names. This is optional and defaults to false.

Parameters

Returns

this builder

skipReportSummary()

skipReportSummary(boolean|null  $isSkipReportSummary): \Google\AdsApi\AdWords\ReportSettingsBuilder

Whether report responses should skip the summary row containing totals.

This is optional and defaults to false.

Parameters

Returns

this builder

useRawEnumValues()

useRawEnumValues(boolean|null  $isUseRawEnumValues): \Google\AdsApi\AdWords\ReportSettingsBuilder

Whether report responses should return enum values instead of enum display values. This is optional and defaults to false.

Parameters

Returns

this builder

includeZeroImpressions()

includeZeroImpressions(boolean|null  $isIncludeZeroImpressions): \Google\AdsApi\AdWords\ReportSettingsBuilder

Whether report responses should include zero impression rows. This is optional and defaults to `null`.

Parameters

Returns

this builder

build()

build(): mixed

Creates a new instance of the data object being populated. This method should call defaultOptionals() and validate().

Returns

the data object

defaultOptionals()

defaultOptionals()

Sets all optional fields to their default if they are `null`.

validate()

validate()

Checks that required fields have been included and all included fields are valid (e.g., URIs are valid).

isSkipReportHeader()

isSkipReportHeader(): boolean

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

Returns

isSkipColumnHeader()

isSkipColumnHeader(): boolean

Whether report responses should skip the header row containing the column names.

Returns

isSkipReportSummary()

isSkipReportSummary(): boolean

Whether report responses should skip the summary row containing totals.

Returns

isUseRawEnumValues()

isUseRawEnumValues(): boolean

Whether report responses should return enum values instead of enum display values.

Returns

isIncludeZeroImpressions()

isIncludeZeroImpressions(): boolean|null

Whether report responses should include zero impression rows.

Returns