REST Resource: properties.reportingDataAnnotations

  • Reporting Data Annotations are comments linked to specific dates or date ranges for reporting data.

  • Each annotation includes required fields like name, title, color, and can target either a single date or a date range.

  • The Date object represents a calendar date, which can be partial or full.

  • The DateRange object represents a start and end date inclusive for an annotation.

  • Several standard colors are available for Reporting Data Annotations, with 'ORANGE' reserved for system-generated ones.

  • Standard methods are available for creating, deleting, getting, listing, and patching Reporting Data Annotations.

Resource: ReportingDataAnnotation

A Reporting Data Annotation is a comment connected to certain dates for reporting data.

JSON representation 
{
  "name": string,
  "title": string,
  "description": string,
  "color": enum (Color),
  "systemGenerated": boolean,

  // Union field target can be only one of the following:
  "annotationDate": {
    object (Date)
  },
  "annotationDateRange": {
    object (DateRange)
  }
  // End of list of possible types for union field target.
}
Fields
name

string

Required. Identifier. Resource name of this Reporting Data Annotation. Format: 'properties/{property_id}/reportingDataAnnotations/{reportingDataAnnotation}' 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

enum (Color)

Required. The color used for display of this Reporting Data Annotation.
systemGenerated

boolean

Output only. If true, this annotation was generated by the Google Analytics system. System-generated annotations cannot be updated or deleted.
Union field target. Target for this Reporting Data Annotation target can be only one of the following:
annotationDate

object (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.
annotationDateRange

object (DateRange)

If set, the Reporting Data Annotation is for a range of dates represented by this field.

Date

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:

  • A full date, with non-zero year, month, and day values.
  • A month and day, with a zero year (for example, an anniversary).
  • A year on its own, with a zero month and a zero day.
  • A year and month, with a zero day (for example, a credit card expiration date).

Related types:

JSON representation 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Fields
year

integer

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
month

integer

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
day

integer

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

DateRange

Represents a Reporting Data Annotation's date range, both start and end dates are inclusive. Time zones are based on the parent property.

JSON representation 
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Fields
startDate

object (Date)

Required. The start date for this range. Must be a valid date with year, month, and day set. The date may be in the past, present, or future.
endDate

object (Date)

Required. The end date for this range. Must be a valid date with year, month, and day set. This date must be greater than or equal to the start date.

Color

Colors that may be used for this Reporting Data Annotation

Enums
COLOR_UNSPECIFIED Color unknown or not specified.
PURPLE Purple color.
BROWN Brown color.
BLUE Blue color.
GREEN Green color.
RED Red color.
CYAN Cyan color.
ORANGE Orange color. (Only used for system-generated annotations)

Methods

create

 Creates a Reporting Data Annotation.

delete

 Deletes a Reporting Data Annotation.

get

 Lookup a single Reporting Data Annotation.

list

 List all Reporting Data Annotations on a property.

patch

 Updates a Reporting Data Annotation.