Google Cloud Channel V1 Client - Class RunReportJobRequest (1.8.2)

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

Request message for CloudChannelReportsService.RunReportJob.

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

Namespace

Google \ Cloud \ Channel \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The report's resource name. Specifies the account and report used to generate report data. The report_id identifier is a UID (for example, 613bf59q). Name uses the format: accounts/{account_id}/reports/{report_id}

↳ date_range Google\Cloud\Channel\V1\DateRange

Optional. The range of usage or invoice dates to include in the result.

↳ filter string

Optional. A structured string that defines conditions on dimension columns to restrict the report output. Filters support logical operators (AND, OR, NOT) and conditional operators (=, !=, <, >, <=, and >=) using column_id as keys. For example: (customer:"accounts/C123abc/customers/S456def" OR customer:"accounts/C123abc/customers/S789ghi") AND invoice_start_date.year >= 2022

↳ language_code string

Optional. The BCP-47 language code, such as "en-US". If specified, the response is localized to the corresponding language code if the original data sources support it. Default is "en-US".

getName

Required. The report's resource name. Specifies the account and report used to generate report data. The report_id identifier is a UID (for example, 613bf59q).

Name uses the format: accounts/{account_id}/reports/{report_id}

Returns
TypeDescription
string

setName

Required. The report's resource name. Specifies the account and report used to generate report data. The report_id identifier is a UID (for example, 613bf59q).

Name uses the format: accounts/{account_id}/reports/{report_id}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDateRange

Optional. The range of usage or invoice dates to include in the result.

Returns
TypeDescription
Google\Cloud\Channel\V1\DateRange|null

hasDateRange

clearDateRange

setDateRange

Optional. The range of usage or invoice dates to include in the result.

Parameter
NameDescription
var Google\Cloud\Channel\V1\DateRange
Returns
TypeDescription
$this

getFilter

Optional. A structured string that defines conditions on dimension columns to restrict the report output.

Filters support logical operators (AND, OR, NOT) and conditional operators (=, !=, <, >, <=, and >=) using column_id as keys. For example: (customer:"accounts/C123abc/customers/S456def" OR customer:"accounts/C123abc/customers/S789ghi") AND invoice_start_date.year >= 2022

Returns
TypeDescription
string

setFilter

Optional. A structured string that defines conditions on dimension columns to restrict the report output.

Filters support logical operators (AND, OR, NOT) and conditional operators (=, !=, <, >, <=, and >=) using column_id as keys. For example: (customer:"accounts/C123abc/customers/S456def" OR customer:"accounts/C123abc/customers/S789ghi") AND invoice_start_date.year >= 2022

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLanguageCode

Optional. The BCP-47 language code, such as "en-US". If specified, the response is localized to the corresponding language code if the original data sources support it.

Default is "en-US".

Returns
TypeDescription
string

setLanguageCode

Optional. The BCP-47 language code, such as "en-US". If specified, the response is localized to the corresponding language code if the original data sources support it.

Default is "en-US".

Parameter
NameDescription
var string
Returns
TypeDescription
$this