Google Analytics Data V1alpha Client - Class ReportTask (0.20.1)

Reference documentation and code samples for the Google Analytics Data V1alpha Client class ReportTask.

A specific report task configuration.

Generated from protobuf message google.analytics.data.v1alpha.ReportTask

Namespace

Google \ Analytics \ Data \ V1alpha

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Output only. Identifier. The report task resource name assigned during creation. Format: "properties/{property}/reportTasks/{report_task}"

↳ report_definition ReportTask\ReportDefinition

Optional. A report definition to fetch report data, which describes the structure of a report. It typically includes the fields that will be included in the report and the criteria that will be used to filter the data.

↳ report_metadata ReportTask\ReportMetadata

Output only. The report metadata for a specific report task, which provides information about a report. It typically includes the following information: the resource name of the report, the state of the report, the timestamp the report was created, etc,

getName

Output only. Identifier. The report task resource name assigned during creation. Format: "properties/{property}/reportTasks/{report_task}"

Returns
Type Description
string

setName

Output only. Identifier. The report task resource name assigned during creation. Format: "properties/{property}/reportTasks/{report_task}"

Parameter
Name Description
var string
Returns
Type Description
$this

getReportDefinition

Optional. A report definition to fetch report data, which describes the structure of a report. It typically includes the fields that will be included in the report and the criteria that will be used to filter the data.

Returns
Type Description
ReportTask\ReportDefinition|null

hasReportDefinition

clearReportDefinition

setReportDefinition

Optional. A report definition to fetch report data, which describes the structure of a report. It typically includes the fields that will be included in the report and the criteria that will be used to filter the data.

Parameter
Name Description
var ReportTask\ReportDefinition
Returns
Type Description
$this

getReportMetadata

Output only. The report metadata for a specific report task, which provides information about a report. It typically includes the following information: the resource name of the report, the state of the report, the timestamp the report was created, etc,

Returns
Type Description
ReportTask\ReportMetadata|null

hasReportMetadata

clearReportMetadata

setReportMetadata

Output only. The report metadata for a specific report task, which provides information about a report. It typically includes the following information: the resource name of the report, the state of the report, the timestamp the report was created, etc,

Parameter
Name Description
var ReportTask\ReportMetadata
Returns
Type Description
$this