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
Namespace
Google \ Cloud \ Channel \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
string | |
setReportJob
Required. The report job created by CloudChannelReportsService.RunReportJob.
Report_job uses the format: accounts/{account_id}/reportJobs/{report_job_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPartitionKeys
Optional. List of keys specifying which report partitions to return.
If empty, returns all partitions.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setPartitionKeys
Optional. List of keys specifying which report partitions to return.
If empty, returns all partitions.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameter | |
|---|---|
| Name | Description |
reportJob |
string
Required. The report job created by CloudChannelReportsService.RunReportJob. Report_job uses the format: accounts/{account_id}/reportJobs/{report_job_id} Please see Google\Cloud\Channel\V1\CloudChannelReportsServiceClient::reportJobName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Channel\V1\FetchReportResultsRequest | |