REST Resource: properties.reportingDataAnnotations

Resource: ReportingDataAnnotation

Anotasi Data Pelaporan adalah komentar yang terhubung ke tanggal tertentu untuk data pelaporan.

Representasi 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.
}
Kolom
name

string

Wajib. ID. Nama resource Anotasi Data Pelaporan ini. Format: 'properties/{property_id}/reportingDataAnnotations/{reportingDataAnnotation}' Format: 'properties/123/reportingDataAnnotations/456'
title

string

Wajib. Judul yang dapat dibaca manusia untuk Anotasi Data Pelaporan ini.
description

string

Opsional. Deskripsi untuk Anotasi Data Pelaporan ini.
color

enum (Color)

Wajib. Warna yang digunakan untuk menampilkan Anotasi Data Pelaporan ini.
systemGenerated

boolean

Hanya output. Jika benar, anotasi ini dibuat oleh sistem Google Analytics. Anotasi yang dibuat sistem tidak dapat diperbarui atau dihapus.
Kolom union target. Target untuk Anotasi Data Pelaporan target ini hanya dapat berupa salah satu dari hal berikut:
annotationDate

object (Date)

Jika ditetapkan, Anotasi Data Pelaporan adalah untuk tanggal tertentu yang diwakili oleh kolom ini. Tanggal harus berupa tanggal yang valid dengan tahun, bulan, dan hari yang ditetapkan. Tanggal dapat berupa tanggal di masa lalu, sekarang, atau mendatang.
annotationDateRange

object (DateRange)

Jika ditetapkan, Anotasi Data Pelaporan adalah untuk rentang tanggal yang diwakili oleh kolom ini.

Tanggal

Menampilkan seluruh atau sebagian tanggal kalender, seperti ulang tahun. Waktu dan zona waktu ditentukan di tempat lain atau dianggap tidak signifikan. Tanggal ini terkait dengan Kalender Gregorian. Ini dapat mewakili salah satu dari hal berikut:

  • Tanggal lengkap, dengan nilai tahun, bulan, dan hari bukan nol.
  • Bulan dan hari, dengan tahun nol (misalnya, hari jadi).
  • Tahun saja, dengan bulan nol dan hari nol.
  • Tahun dan bulan, dengan hari nol (misalnya, tanggal habis masa berlaku kartu kredit).

Jenis terkait:

Representasi JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Kolom
year

integer

Tahun dalam tanggal. Harus dari 1 hingga 9999, atau 0 untuk menentukan tanggal tanpa tahun.
month

integer

Bulan dalam setahun. Harus dari 1 hingga 12, atau 0 untuk menentukan tahun tanpa bulan dan hari.
day

integer

Hari dalam bulan. Harus dari 1 hingga 31 dan berlaku untuk tahun dan bulan, atau 0 untuk menentukan tahun saja atau tahun dan bulan jika hari dianggap tidak signifikan.

DateRange

Merepresentasikan rentang tanggal Anotasi Data Pelaporan, baik tanggal mulai maupun akhir bersifat inklusif. Zona waktu didasarkan pada properti induk.

Representasi JSON 
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Kolom
startDate

object (Date)

Wajib. Tanggal mulai untuk rentang ini. Harus berupa tanggal yang valid dengan tahun, bulan, dan hari yang ditetapkan. Tanggal dapat berupa tanggal di masa lalu, sekarang, atau mendatang.
endDate

object (Date)

Wajib. Tanggal akhir untuk rentang ini. Harus berupa tanggal yang valid dengan tahun, bulan, dan hari yang ditetapkan. Tanggal ini harus lebih besar dari atau sama dengan tanggal mulai.

Warna

Warna yang dapat digunakan untuk Anotasi Data Pelaporan ini

Enum
COLOR_UNSPECIFIED Warna tidak diketahui atau tidak ditentukan.
PURPLE Warna ungu.
BROWN Warna cokelat.
BLUE Warna biru.
GREEN Warna hijau.
RED Warna merah.
CYAN Warna sian.
ORANGE Warna oranye. (Hanya digunakan untuk anotasi yang dibuat sistem)

Metode

create

 Membuat Anotasi Data Pelaporan.

delete

 Menghapus Anotasi Data Pelaporan.

get

 Mencari satu Anotasi Data Pelaporan.

list

 Mencantumkan semua Anotasi Data Pelaporan di properti.

patch

 Memperbarui Anotasi Data Pelaporan.