REST Resource: properties.reportingDataAnnotations

Ressource: ReportingDataAnnotation

Eine Anmerkung zu Berichtsdaten ist ein Kommentar, der mit bestimmten Datumsangaben für Berichtsdaten verknüpft ist.

JSON-Darstellung 
{
  "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.
}
Felder
name

string

Erforderlich. Kennung. Ressourcenname dieser Anmerkung zu Berichtsdaten. Format: „properties/{property_id}/reportingDataAnnotations/{reportingDataAnnotation}“ Format: „properties/123/reportingDataAnnotations/456“
title

string

Erforderlich. Für Menschen lesbarer Titel für diese Anmerkung zu Berichtsdaten.
description

string

Optional. Beschreibung für diesen Vermerk zu Berichtsdaten.
color

enum (Color)

Erforderlich. Die Farbe, die für die Anzeige dieser Anmerkung zu Berichtsdaten verwendet wird.
systemGenerated

boolean

Nur Ausgabe. Wenn „wahr“ ist, wurde diese Anmerkung vom Google Analytics-System generiert. Systemgenerierte Anmerkungen können nicht aktualisiert oder gelöscht werden.
Union-Feld target. Das Ziel für diese Anmerkung zu Berichtsdaten target kann nur eines der folgenden sein:
annotationDate

object (Date)

Wenn diese Option festgelegt ist, bezieht sich die Anmerkung zu Berichtsdaten auf ein bestimmtes Datum, das durch dieses Feld dargestellt wird. Das Datum muss gültig sein und Jahr, Monat und Tag müssen festgelegt sein. Das Datum kann in der Vergangenheit, Gegenwart oder Zukunft liegen.
annotationDateRange

object (DateRange)

Wenn diese Option festgelegt ist, bezieht sich die Anmerkung zu Berichtsdaten auf einen Zeitraum, der durch dieses Feld dargestellt wird.

Datum

Stellt ein ganzes Kalenderdatum oder einen Teil davon dar, z. B. einen Geburtstag. Die Uhrzeit und die Zeitzone werden entweder an einer anderen Stelle angegeben oder sind nicht relevant. Das Datum wird relativ zum gregorianischen Kalender angegeben. Das kann Folgendes bedeuten:

  • Ein vollständiges Datum mit Werten für Jahr, Monat und Tag, die nicht 0 sind.
  • Einen Monat und Tag mit dem Wert „0“ für das Jahr (z. B. ein Jahrestag).
  • Ein Jahr für sich, mit dem Wert „0“ für Monat und Tag.
  • Ein Jahr und ein Monat mit dem Wert „0“ für den Tag (z. B. das Ablaufdatum einer Kreditkarte).

Ähnliche Typen:

JSON-Darstellung 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Felder
year

integer

Das Jahr des Datums. Es muss zwischen 1 und 9999 liegen oder kann 0 sein, wenn ein Datum ohne Jahresangabe angegeben wird.
month

integer

Monat eines Jahres. Die Angabe muss zwischen 1 und 12 liegen. Sie kann auch 0 sein, wenn ein Jahr ohne Monat und Tag angegeben wird.
day

integer

Tag des Monats. Die Angabe muss zwischen 1 und 31 liegen und für das Jahr und den Monat gültig sein. Sie kann auch 0 sein, wenn das Jahr bzw. der Monat angegeben wird, der Tag selbst jedoch nicht von Belang ist.

DateRange

Der Zeitraum einer Anmerkung zu Berichtsdaten. Start- und Enddatum sind inklusiv. Zeitzonen basieren auf der übergeordneten Property.

JSON-Darstellung 
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Felder
startDate

object (Date)

Erforderlich. Das Startdatum dieses Zeitraums. Es muss ein gültiges Datum mit Jahr, Monat und Tag sein. Das Datum kann in der Vergangenheit, Gegenwart oder Zukunft liegen.
endDate

object (Date)

Erforderlich. Das Enddatum dieses Zeitraums. Es muss ein gültiges Datum mit Jahr, Monat und Tag sein. Dieses Datum muss größer oder gleich dem Startdatum sein.

Farbe

Farben, die für diese Anmerkung zu Berichtsdaten verwendet werden können

Enums
COLOR_UNSPECIFIED Farbe unbekannt oder nicht angegeben.
PURPLE Lila
BROWN Braun
BLUE Blaue Farbe
GREEN Grüne Farbe
RED Rot
CYAN Cyan
ORANGE Orange (Nur für systemgenerierte Anmerkungen verwendet)

Methoden

create

 Erstellt eine Anmerkung zu Berichtsdaten.

delete

 Löscht eine Datenannotation für Berichte.

get

 Eine einzelne Anmerkung zu Berichtsdaten abrufen

list

 Listet alle Vermerke zu Berichtsdaten für eine Property auf.

patch

 Aktualisiert eine Anmerkung zu Berichtsdaten.