Google Cloud Channel V1 Client - Class FetchReportResultsRequest (1.4.0)

Reference documentation and code samples for the Google Cloud Channel V1 Client class FetchReportResultsRequest.

Request message for CloudChannelReportsService.FetchReportResults.

Generated from protobuf message google.cloud.channel.v1.FetchReportResultsRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ report_job string

Required. The report job created by CloudChannelReportsService.RunReportJob. Report_job uses the format: accounts/{account_id}/reportJobs/{report_job_id}

↳ page_size int

Optional. Requested page size of the report. The server may return fewer results than requested. If you don't specify a page size, the server uses a sensible default (may change over time). The maximum value is 30,000; the server will change larger values to 30,000.

↳ page_token string

Optional. A token that specifies a page of results beyond the first page. Obtained through FetchReportResultsResponse.next_page_token of the previous CloudChannelReportsService.FetchReportResults call.

↳ partition_keys array

Optional. List of keys specifying which report partitions to return. If empty, returns all partitions.

getReportJob

Required. The report job created by CloudChannelReportsService.RunReportJob.

Report_job uses the format: accounts/{account_id}/reportJobs/{report_job_id}

Returns
TypeDescription
string

setReportJob

Required. The report job created by CloudChannelReportsService.RunReportJob.

Report_job uses the format: accounts/{account_id}/reportJobs/{report_job_id}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

Optional. Requested page size of the report. The server may return fewer results than requested. If you don't specify a page size, the server uses a sensible default (may change over time).

The maximum value is 30,000; the server will change larger values to 30,000.

Returns
TypeDescription
int

setPageSize

Optional. Requested page size of the report. The server may return fewer results than requested. If you don't specify a page size, the server uses a sensible default (may change over time).

The maximum value is 30,000; the server will change larger values to 30,000.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

Optional. A token that specifies a page of results beyond the first page.

Obtained through FetchReportResultsResponse.next_page_token of the previous CloudChannelReportsService.FetchReportResults call.

Returns
TypeDescription
string

setPageToken

Optional. A token that specifies a page of results beyond the first page.

Obtained through FetchReportResultsResponse.next_page_token of the previous CloudChannelReportsService.FetchReportResults call.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPartitionKeys

Optional. List of keys specifying which report partitions to return.

If empty, returns all partitions.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setPartitionKeys

Optional. List of keys specifying which report partitions to return.

If empty, returns all partitions.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this