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.
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.
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.
$this
getAnnotationDateRange
If set, the Reporting Data Annotation is for a range of dates represented by this field.
hasAnnotationDateRange
setAnnotationDateRange
If set, the Reporting Data Annotation is for a range of dates represented by this field.
$this
getName
Required. Identifier. Resource name of this Reporting Data Annotation.
Format: 'properties/{property_id}/reportingDataAnnotations/{reporting_data_annotation}' Format: 'properties/123/reportingDataAnnotations/456'
string
setName
Required. Identifier. Resource name of this Reporting Data Annotation.
Format: 'properties/{property_id}/reportingDataAnnotations/{reporting_data_annotation}' Format: 'properties/123/reportingDataAnnotations/456'
var
string
$this
getTitle
Required. Human-readable title for this Reporting Data Annotation.
string
setTitle
Required. Human-readable title for this Reporting Data Annotation.
var
string
$this
getDescription
Optional. Description for this Reporting Data Annotation.
string
setDescription
Optional. Description for this Reporting Data Annotation.
var
string
$this
getColor
Required. The color used for display of this Reporting Data Annotation.
int
setColor
Required. The color used for display of this Reporting Data Annotation.
var
int
$this
getSystemGenerated
Output only. If true, this annotation was generated by the Google Analytics system. System-generated annotations cannot be updated or deleted.
bool
setSystemGenerated
Output only. If true, this annotation was generated by the Google Analytics system. System-generated annotations cannot be updated or deleted.
var
bool
$this
getTarget
string
