REST Resource: properties.reportingDataAnnotations

Recurso: ReportingDataAnnotation

Una anotación de datos de informes es un comentario conectado a ciertas fechas para los datos de informes.

Representación 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.
}
Campos
name

string

Obligatorio. Identificador. Es el nombre del recurso de esta anotación de datos de informes. Formato: 'properties/{property_id}/reportingDataAnnotations/{reportingDataAnnotation}' Formato: 'properties/123/reportingDataAnnotations/456'
title

string

Obligatorio. Es el título legible para esta anotación de datos de informes.
description

string

Opcional. Descripción de esta anotación de datos de informes.
color

enum (Color)

Obligatorio. Es el color que se usa para mostrar esta anotación de datos de informes.
systemGenerated

boolean

Solo salida. Si es verdadero, el sistema de Google Analytics generó esta anotación. No se pueden actualizar ni borrar las anotaciones generadas por el sistema.
Campo de unión target. El objetivo de esta anotación de datos de informes target puede ser solo uno de los siguientes:
annotationDate

object (Date)

Si se establece, la anotación de datos de informes corresponde a una fecha específica representada por este campo. La fecha debe ser válida y tener establecidos el año, el mes y el día. La fecha puede ser del pasado, presente o futuro.
annotationDateRange

object (DateRange)

Si se establece, la anotación de datos de informes corresponde a un período representado por este campo.

Fecha

Representa una fecha de calendario completa o parcial, como un cumpleaños. La hora del día y la zona horaria se especifican en otro lugar o son insignificantes. La fecha está relacionada con el calendario gregoriano. Puede representar una de las siguientes opciones:

  • Una fecha completa con valores para el año, mes y día que no sean cero.
  • Un mes y un día, con cero año (por ejemplo, un aniversario).
  • Un año por sí solo, con un mes cero y un día cero.
  • Es un año y un mes, con un día cero (por ejemplo, la fecha de vencimiento de una tarjeta de crédito).

Tipos relacionados:

Representación JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Campos
year

integer

Año de la fecha. Debe ser entre 1 y 9,999, o bien 0 para especificar una fecha sin año.
month

integer

Mes del año. Debe ser del 1 al 12 o 0 para especificar un año sin un mes ni un día.
day

integer

Día del mes. Debe ser entre 1 y 31 y ser válido para el año y el mes o bien 0 para especificar un año solo o un año y un mes en los que el día no sea significativo.

DateRange

Representa el período de una anotación de datos de informes, incluidas las fechas de inicio y finalización. Las zonas horarias se basan en la propiedad superior.

Representación JSON 
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Campos
startDate

object (Date)

Obligatorio. Es la fecha de inicio de este período. Debe ser una fecha válida con el año, el mes y el día establecidos. La fecha puede ser del pasado, presente o futuro.
endDate

object (Date)

Obligatorio. Es la fecha de finalización de este período. Debe ser una fecha válida con el año, el mes y el día establecidos. Esta fecha debe ser mayor o igual que la fecha de inicio.

Color

Colores que se pueden usar para esta anotación de datos de informes

Enumeraciones
COLOR_UNSPECIFIED El color es desconocido o no se especificó.
PURPLE Color púrpura.
BROWN Color marrón.
BLUE Color azul.
GREEN Color verde
RED Color rojo.
CYAN Color cian.
ORANGE Color naranja. (Solo se usa para anotaciones generadas por el sistema)

Métodos

create

 Crea una anotación de datos de informes.

delete

 Borra una anotación de datos de informes.

get

 Busca una sola anotación de datos de informes.

list

 Muestra una lista de todas las anotaciones de datos de informes de una propiedad.

patch

 Actualiza una anotación de datos de informes.