REST Resource: properties.reportingDataAnnotations

Recurso: ReportingDataAnnotation

Uma anotação de dados de relatórios é um comentário conectado a determinadas datas para dados de relatórios.

Representação 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

Obrigatório. Identificador. Nome do recurso dessa anotação de dados de relatórios. Formato: 'properties/{property_id}/reportingDataAnnotations/{reportingDataAnnotation}' Formato: 'properties/123/reportingDataAnnotations/456'
title

string

Obrigatório. Título legível para humanos dessa anotação de dados de relatórios.
description

string

Opcional. Descrição da anotação de dados do relatório.
color

enum (Color)

Obrigatório. A cor usada para mostrar essa anotação de dados de relatórios.
systemGenerated

boolean

Apenas saída. Se for "True", a anotação foi gerada pelo sistema do Google Analytics. Não é possível atualizar ou excluir anotações geradas pelo sistema.
Campo de união target. O destino da anotação target dos dados de relatórios só pode ser um dos seguintes:
annotationDate

object (Date)

Se definido, a anotação de dados de relatórios é para uma data específica representada por esse campo. A data precisa ser válida e ter ano, mês e dia definidos. A data pode ser passada, presente ou futura.
annotationDateRange

object (DateRange)

Se definido, a anotação de dados de relatórios é para um período de datas representado por este campo.

Data

Representa uma data inteira ou parcial do calendário, como um aniversário. A hora do dia e o fuso horário são especificados em outro lugar ou são insignificantes. A data é referente ao calendário gregoriano. Isso pode representar uma das seguintes opções:

  • uma data completa, com valores de ano, mês e dia diferentes de zero;
  • um mês e dia, com um ano zero (por exemplo, uma data comemorativa);
  • um ano sozinho, com um mês zero e um dia zero;
  • um ano e mês, com um dia zero (por exemplo, uma data de validade de cartão de crédito).

Tipos relacionados:

Representação JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Campos
year

integer

Ano da data. Precisa ser de 1 a 9.999 ou 0 para especificar uma data sem ano.
month

integer

Mês do ano. Precisa ser de 1 a 12, ou 0 para especificar um ano sem um mês e dia.
day

integer

Dia do mês. Precisa ser de 1 a 31 e válido para o ano e o mês, ou 0 para especificar um ano sozinho ou um ano e mês em que o dia não é significativo.

DateRange

Representa o período de uma anotação de dados de relatórios, incluindo as datas de início e término. Os fusos horários são baseados na propriedade pai.

Representação JSON 
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Campos
startDate

object (Date)

Obrigatório. A data de início do período. Precisa ser uma data válida com ano, mês e dia definidos. A data pode ser passada, presente ou futura.
endDate

object (Date)

Obrigatório. A data de término do período. Precisa ser uma data válida com ano, mês e dia definidos. Essa data precisa ser posterior ou igual à data de início.

Cor

Cores que podem ser usadas para essa anotação de dados de relatórios

Enums
COLOR_UNSPECIFIED Cor desconhecida ou não especificada.
PURPLE Cor roxa.
BROWN Cor marrom.
BLUE Cor azul.
GREEN Cor verde.
RED Cor vermelha.
CYAN Cor ciano.
ORANGE Cor laranja. (Somente usado para anotações geradas pelo sistema)

Métodos

create

 Cria uma anotação de dados de relatórios.

delete

 Exclui uma anotação de dados de relatórios.

get

 Consultar uma única anotação de dados de relatórios.

list

 Listar todas as anotações de dados de relatórios em uma propriedade.

patch

 Atualiza uma anotação de dados de relatórios.