REST Resource: properties.reportingDataAnnotations

Ressource: ReportingDataAnnotation

Une annotation de données de rapport est un commentaire associé à certaines dates pour les données de rapport.

Représentation 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.
}
Champs
name

string

Obligatoire. Identifiant. Nom de la ressource de cette annotation de données de rapport. Format: 'properties/{property_id}/reportingDataAnnotations/{reportingDataAnnotation}' Format: 'properties/123/reportingDataAnnotations/456'
title

string

Obligatoire. Titre lisible pour cette annotation de données de rapport.
description

string

Facultatif. Description de cette annotation de données de rapport.
color

enum (Color)

Obligatoire. Couleur utilisée pour afficher cette annotation de données de rapport.
systemGenerated

boolean

Uniquement en sortie. Si la valeur est "true", cette annotation a été générée par le système Google Analytics. Les annotations générées par le système ne peuvent pas être modifiées ni supprimées.
Champ d'union target. La cible de cette annotation de données de rapport target ne peut être que l'une des suivantes:
annotationDate

object (Date)

Si ce champ est défini, l'annotation des données de rapport concerne une date spécifique représentée par ce champ. La date doit être valide, avec l'année, le mois et le jour définis. dans le passé, le présent ou le futur.
annotationDateRange

object (DateRange)

Si elle est définie, l'annotation des données de reporting s'applique à une plage de dates représentée par ce champ.

Date

Représente une date du calendrier entière ou partielle, par exemple un anniversaire. L'heure de la journée et le fuseau horaire sont spécifiés ailleurs, ou ne sont pas significatifs. La date est donnée selon le calendrier grégorien. Il peut s'agir de l'un des éléments suivants:

  • Une date complète, avec des valeurs non nulles pour l'année, le mois et le jour.
  • un mois et un jour, avec une année nulle (par exemple, un anniversaire).
  • une année seule, avec un mois et un jour nuls ;
  • Une année et un mois, avec un jour zéro (par exemple, la date d'expiration d'une carte de crédit).

Types associés:

Représentation JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Champs
year

integer

Année de la date. Elle doit être comprise entre 1 et 9999, ou égale à 0 si vous spécifiez une date sans année.
month

integer

Mois d'une année. Il doit être compris entre 1 et 12, ou égal à 0 pour spécifier une année sans mois ni jour.
day

integer

Jour d'un mois. Il doit être compris entre 1 et 31, et valide pour l'année et le mois, ou égal à 0 pour spécifier une année seule, ou une année et un mois où le jour n'est pas significatif.

DateRange

Représente la plage de dates d'une annotation de données de rapport. Les dates de début et de fin sont incluses. Les fuseaux horaires sont basés sur la propriété parente.

Représentation JSON 
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Champs
startDate

object (Date)

Obligatoire. Date de début de cette plage. Il doit s'agir d'une date valide avec l'année, le mois et le jour définis. dans le passé, le présent ou le futur.
endDate

object (Date)

Obligatoire. Date de fin de cette plage. Il doit s'agir d'une date valide avec l'année, le mois et le jour définis. Cette date doit être supérieure ou égale à la date de début.

Couleur

Couleurs pouvant être utilisées pour cette annotation de données de rapport

Enums
COLOR_UNSPECIFIED Couleur inconnue ou non spécifiée.
PURPLE Couleur violette.
BROWN Couleur marron.
BLUE Couleur bleue.
GREEN Couleur verte.
RED Couleur rouge.
CYAN Couleur cyan.
ORANGE Couleur orange. (Utilisé uniquement pour les annotations générées par le système)

Méthodes

create

 Crée une annotation de données de reporting.

delete

 Supprime une annotation de données de rapport.

get

 Recherchez une seule annotation de données de rapport.

list

 Répertoriez toutes les annotations des données de rapport d'une propriété.

patch

 Met à jour une annotation de données de rapport.