# REST Resource: properties.reportingDataAnnotations

- [Resource: ReportingDataAnnotation](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.reportingDataAnnotations#ReportingDataAnnotation)
  - [JSON representation](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.reportingDataAnnotations#ReportingDataAnnotation.SCHEMA_REPRESENTATION)
- [Date](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.reportingDataAnnotations#Date)
  - [JSON representation](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.reportingDataAnnotations#Date.SCHEMA_REPRESENTATION)
- [DateRange](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.reportingDataAnnotations#DateRange)
  - [JSON representation](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.reportingDataAnnotations#DateRange.SCHEMA_REPRESENTATION)
- [Color](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.reportingDataAnnotations#Color)
- [Methods](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.reportingDataAnnotations#METHODS_SUMMARY)

## 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 (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.reportingDataAnnotations#Color`), "systemGenerated": boolean, // Union field `target` can be only one of the following: "annotationDate": { object (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.reportingDataAnnotations#Date`) }, "annotationDateRange": { object (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.reportingDataAnnotations#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 (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.reportingDataAnnotations#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 (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.reportingDataAnnotations#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 (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.reportingDataAnnotations#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:

- `google.type.TimeOfDay`
- `google.type.DateTime`
- `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp`

| 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 (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.reportingDataAnnotations#Date`) }, "endDate": { object (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.reportingDataAnnotations#Date`) } } ``` |

| Fields ||
|---|---|
| `startDate` | ``object (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.reportingDataAnnotations#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 (`https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.reportingDataAnnotations#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 ||
|---|---|
| ### `https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.reportingDataAnnotations/create` | Creates a Reporting Data Annotation. |
| ### `https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.reportingDataAnnotations/delete` | Deletes a Reporting Data Annotation. |
| ### `https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.reportingDataAnnotations/get` | Lookup a single Reporting Data Annotation. |
| ### `https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.reportingDataAnnotations/list` | List all Reporting Data Annotations on a property. |
| ### `https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.reportingDataAnnotations/patch` | Updates a Reporting Data Annotation. |