Google Ads Ad Manager V1 Client - Class FetchReportResultRowsResponse (0.1.1)

Reference documentation and code samples for the Google Ads Ad Manager V1 Client class FetchReportResultRowsResponse.

The response message for the fetch report result rows endpoint.

Generated from protobuf message google.ads.admanager.v1.FetchReportResultRowsResponse

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ rows array<Google\Ads\AdManager\V1\Report\DataTable\Row>

Up to page_size rows of report data.

↳ run_time Google\Protobuf\Timestamp

The time at which the report was scheduled to run. For non-scheduled reports, this is the time at which the report was requested to be run.

↳ date_ranges array<Google\Ads\AdManager\V1\Report\DateRange\FixedDateRange>

The computed fixed date ranges this report includes. Only returned with the first page of results (when page_token is not included in the request).

↳ comparison_date_ranges array<Google\Ads\AdManager\V1\Report\DateRange\FixedDateRange>

The computed comparison fixed date ranges this report includes. Only returned with the first page of results (when page_token is not included in the request).

↳ total_row_count int

The total number of rows available from this report. Useful for pagination. Only returned with the first page of results (when page_token is not included in the request).

↳ next_page_token string

A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

getRows

Up to page_size rows of report data.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setRows

Up to page_size rows of report data.

Parameter
Name Description
var array<Google\Ads\AdManager\V1\Report\DataTable\Row>
Returns
Type Description
$this

getRunTime

The time at which the report was scheduled to run. For non-scheduled reports, this is the time at which the report was requested to be run.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasRunTime

clearRunTime

setRunTime

The time at which the report was scheduled to run. For non-scheduled reports, this is the time at which the report was requested to be run.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getDateRanges

The computed fixed date ranges this report includes.

Only returned with the first page of results (when page_token is not included in the request).

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setDateRanges

The computed fixed date ranges this report includes.

Only returned with the first page of results (when page_token is not included in the request).

Parameter
Name Description
var array<Google\Ads\AdManager\V1\Report\DateRange\FixedDateRange>
Returns
Type Description
$this

getComparisonDateRanges

The computed comparison fixed date ranges this report includes.

Only returned with the first page of results (when page_token is not included in the request).

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setComparisonDateRanges

The computed comparison fixed date ranges this report includes.

Only returned with the first page of results (when page_token is not included in the request).

Parameter
Name Description
var array<Google\Ads\AdManager\V1\Report\DateRange\FixedDateRange>
Returns
Type Description
$this

getTotalRowCount

The total number of rows available from this report. Useful for pagination.

Only returned with the first page of results (when page_token is not included in the request).

Returns
Type Description
int

setTotalRowCount

The total number of rows available from this report. Useful for pagination.

Only returned with the first page of results (when page_token is not included in the request).

Parameter
Name Description
var int
Returns
Type Description
$this

getNextPageToken

A token that can be sent as page_token to retrieve the next page.

If this field is omitted, there are no subsequent pages.

Returns
Type Description
string

setNextPageToken

A token that can be sent as page_token to retrieve the next page.

If this field is omitted, there are no subsequent pages.

Parameter
Name Description
var string
Returns
Type Description
$this