REST Resource: properties.reportingDataAnnotations

Zasób: ReportingDataAnnotation

Adnotacja danych do raportowania to komentarz powiązany z określonymi datami raportowania danych.

Zapis 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.
}
Pola
name

string

Wymagane. Identyfikator. Nazwa zasobu tej adnotacji danych raportowania. Format: „usługi/{identyfikator_usługi}/annotacje_danych_raportowania/{annotacja_danych_raportowania}”. Format: „usługi/123/annotacje_danych_raportowania/456”.
title

string

Wymagane. Zrozumiały dla człowieka tytuł tej adnotacji danych w raportach.
description

string

Opcjonalnie: Opis adnotacji danych raportowania.
color

enum (Color)

Wymagane. Kolor używany do wyświetlania tej adnotacji danych raportowania.
systemGenerated

boolean

Tylko dane wyjściowe. Jeśli ma wartość Prawda, oznacza to, że ta adnotacja została wygenerowana przez system Google Analytics. Adnotacji wygenerowanych przez system nie można aktualizować ani usuwać.
Pole unii target. Docelowy obiekt adnotacji danych do raportowania target może być tylko jednym z tych:
annotationDate

object (Date)

Jeśli to pole jest ustawione, adnotacja danych do raportu dotyczy konkretnej daty reprezentowanej przez to pole. Data musi być prawidłowa i zawierać rok, miesiąc i dzień. Data może przypadać w przeszłości, teraźniejszości lub przyszłości.
annotationDateRange

object (DateRange)

Jeśli to pole jest ustawione, adnotacja danych raportowania dotyczy zakresu dat reprezentowanego przez to pole.

Data

Reprezentuje całą lub częściową datę kalendarzową, np. urodziny. Godzina i strefa czasowa są określone w innym miejscu lub nie mają znaczenia. Data jest podawana w kalendarzu gregoriańskim. Może to być:

  • Pełna data z wartościami roku, miesiąca i dnia innymi niż 0.
  • miesiąc i dzień z zerowym rokiem (np. rocznica).
  • Rok bez miesiąca i dnia.
  • Rok i miesiąc z zerowym dniem (np. data ważności karty kredytowej).

Powiązane typy:

Zapis JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Pola
year

integer

Rok daty. Musi być liczbą z zakresu od 1 do 9999 lub 0, jeśli chcesz podać datę bez roku.
month

integer

Miesiąc w roku. Wartość musi mieścić się w przedziale od 1 do 12, lub 0, jeśli chcesz określić rok bez miesiąca i dnia.
day

integer

Dzień miesiąca. Musi zawierać wartość od 1 do 31 i być prawidłową dla roku lub miesiąca albo 0, aby określić tylko rok lub rok i miesiąc, w których przypadku dzień nie ma znaczenia.

Zakres dat

Reprezentuje zakres dat adnotacji danych raportowania. Obejmuje zarówno datę rozpoczęcia, jak i zakończenia. Strefy czasowe są określane na podstawie właściwości nadrzędnej.

Zapis JSON 
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Pola
startDate

object (Date)

Wymagane. Data rozpoczęcia tego zakresu. Musi być prawidłową datą z określonym rokiem, miesiącem i dniem. Data może przypadać w przeszłości, teraźniejszości lub przyszłości.
endDate

object (Date)

Wymagane. Data zakończenia tego zakresu. Musi być prawidłową datą z określonym rokiem, miesiącem i dniem. Ta data musi być równa lub późniejsza od daty rozpoczęcia.

Kolor

Kolory, które mogą być używane do adnotacji danych w raportach

Wartości w polu enum
COLOR_UNSPECIFIED Kolor jest nieznany lub nieokreślony.
PURPLE Kolor fioletowy.
BROWN Kolor brązowy.
BLUE Niebieski.
GREEN Kolor zielony.
RED Czerwony.
CYAN Cyjan
ORANGE Pomarańczowy. (używane tylko w przypadku adnotacji generowanych przez system)

Metody

create

 Tworzy adnotację danych raportowania.

delete

 Usuwa adnotację danych raportowania.

get

 wyszukiwać pojedynczą adnotację danych raportowania;

list

 Wyświetla listę wszystkich adnotacji danych raportowania dotyczących usługi.

patch

 Aktualizuje adnotację danych raportowania.