Reference documentation and code samples for the Google Analytics Admin V1alpha Client class ReportingDataAnnotation.
A Reporting Data Annotation is a comment connected to certain dates for reporting data.
Generated from protobuf message google.analytics.admin.v1alpha.ReportingDataAnnotation
Namespace
Google \ Analytics \ Admin \ V1alphaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ annotation_date |
Google\Type\Date
If set, the Reporting Data Annotation is for a specific date represented by this field. The date must be a valid date with year, month and day set. The date may be in the past, present, or future. |
↳ annotation_date_range |
ReportingDataAnnotation\DateRange
If set, the Reporting Data Annotation is for a range of dates represented by this field. |
↳ name |
string
Required. Identifier. Resource name of this Reporting Data Annotation. Format: 'properties/{property_id}/reportingDataAnnotations/{reporting_data_annotation}' Format: 'properties/123/reportingDataAnnotations/456' |
↳ title |
string
Required. Human-readable title for this Reporting Data Annotation. |
↳ description |
string
Optional. Description for this Reporting Data Annotation. |
↳ color |
int
Required. The color used for display of this Reporting Data Annotation. |
↳ system_generated |
bool
Output only. If true, this annotation was generated by the Google Analytics system. System-generated annotations cannot be updated or deleted. |
getAnnotationDate
If set, the Reporting Data Annotation is for a specific date represented by this field. The date must be a valid date with year, month and day set. The date may be in the past, present, or future.
| Returns | |
|---|---|
| Type | Description |
Google\Type\Date|null |
|
hasAnnotationDate
setAnnotationDate
If set, the Reporting Data Annotation is for a specific date represented by this field. The date must be a valid date with year, month and day set. The date may be in the past, present, or future.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Type\Date
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAnnotationDateRange
If set, the Reporting Data Annotation is for a range of dates represented by this field.
| Returns | |
|---|---|
| Type | Description |
ReportingDataAnnotation\DateRange|null |
|
hasAnnotationDateRange
setAnnotationDateRange
If set, the Reporting Data Annotation is for a range of dates represented by this field.
| Parameter | |
|---|---|
| Name | Description |
var |
ReportingDataAnnotation\DateRange
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getName
Required. Identifier. Resource name of this Reporting Data Annotation.
Format: 'properties/{property_id}/reportingDataAnnotations/{reporting_data_annotation}' Format: 'properties/123/reportingDataAnnotations/456'
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. Identifier. Resource name of this Reporting Data Annotation.
Format: 'properties/{property_id}/reportingDataAnnotations/{reporting_data_annotation}' Format: 'properties/123/reportingDataAnnotations/456'
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTitle
Required. Human-readable title for this Reporting Data Annotation.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTitle
Required. Human-readable title for this Reporting Data Annotation.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. Description for this Reporting Data Annotation.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. Description for this Reporting Data Annotation.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getColor
Required. The color used for display of this Reporting Data Annotation.
| Returns | |
|---|---|
| Type | Description |
int |
|
setColor
Required. The color used for display of this Reporting Data Annotation.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSystemGenerated
Output only. If true, this annotation was generated by the Google Analytics system. System-generated annotations cannot be updated or deleted.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setSystemGenerated
Output only. If true, this annotation was generated by the Google Analytics system. System-generated annotations cannot be updated or deleted.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTarget
| Returns | |
|---|---|
| Type | Description |
string |
|