REST Resource: properties.reportingDataAnnotations

Ресурс: ReportingDataAnnotation

Аннотация к данным отчета — это комментарий, связанный с определенными датами данных отчета.

JSON-представление 
{
  "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.
}
Поля
name

string

Необходимый. Идентификатор. Имя ресурса этой аннотации к данным отчетов. Формат: 'properties/{property_id}/reportingDataAnnotations/{reportingDataAnnotation}' Формат: 'properties/123/reportingDataAnnotations/456'

title

string

Необходимый. Понятное название для этой аннотации к данным отчетности.

description

string

Необязательный. Описание этой аннотации к данным отчетов.

color

enum ( Color )

Необходимый. Цвет, используемый для отображения этой аннотации к данным отчетности.

systemGenerated

boolean

Только вывод. Если это правда, эта аннотация была создана системой Google Analytics. Созданные системой аннотации невозможно обновить или удалить.

target мишень Союза. Целью для этой target аннотации к данным отчетов может быть только одно из следующих:
annotationDate

object ( Date )

Если установлено, аннотация к данным отчета относится к определенной дате, представленной этим полем. Дата должна быть действительной датой с установленными годом, месяцем и днем. Дата может быть в прошлом, настоящем или будущем.

annotationDateRange

object ( DateRange )

Если установлено, аннотация к данным отчета предназначена для диапазона дат, представленных этим полем.

Дата

Представляет полную или частичную календарную дату, например день рождения. Время суток и часовой пояс либо указаны в другом месте, либо не имеют значения. Дата указана по григорианскому календарю. Это может представлять собой одно из следующих действий:

  • Полная дата с ненулевыми значениями года, месяца и дня.
  • Месяц и день с нулевым годом (например, годовщина).
  • Год сам по себе, с нулевым месяцем и нулевым днем.
  • Год и месяц с нулевым днем ​​(например, дата истечения срока действия кредитной карты).

Связанные типы:

JSON-представление 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Поля
year

integer

Год даты. Должно быть от 1 до 9999 или 0, чтобы указать дату без года.

month

integer

Месяц года. Должно быть от 1 до 12 или 0, чтобы указать год без месяца и дня.

day

integer

День месяца. Должно быть от 1 до 31 и действительно для года и месяца, или 0, чтобы указать год отдельно или год и месяц, если день не имеет значения.

Диапазон дат

Представляет диапазон дат аннотации к данным отчетов, включая даты начала и окончания. Часовые пояса основаны на родительском свойстве.

JSON-представление 
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Поля
startDate

object ( Date )

Необходимый. Дата начала для этого диапазона. Должна быть действительная дата с установленными годом, месяцем и днем. Дата может быть в прошлом, настоящем или будущем.

endDate

object ( Date )

Необходимый. Конечная дата для этого диапазона. Должна быть действительная дата с установленными годом, месяцем и днем. Эта дата должна быть больше или равна дате начала.

Цвет

Цвета, которые можно использовать для этой аннотации к данным отчетности.

Перечисления
COLOR_UNSPECIFIED Цвет неизвестен или не указан.
PURPLE Фиолетовый цвет.
BROWN Коричневый цвет.
BLUE Синий цвет.
GREEN Зеленый цвет.
RED Красный цвет.
CYAN Голубой цвет.
ORANGE Оранжевый цвет. (Используется только для аннотаций, созданных системой)

Методы

create

 Создает аннотацию данных отчетов.

delete

 Удаляет аннотацию данных отчетов.

get

 Найдите одну аннотацию к данным отчетов.

list

 Перечислите все аннотации к данным отчетов для свойства.

patch

 Обновляет аннотацию данных отчетов.