Method: properties.reportingDataAnnotations.list

Mencantumkan semua Anotasi Data Pelaporan di properti.

Permintaan HTTP

GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/reportingDataAnnotations

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Nama resource properti. Format: properties/property_id Contoh: properties/123

Parameter kueri

Parameter
filter

string

Opsional. Filter yang membatasi anotasi data pelaporan yang tercantum di properti induk.

Kolom yang didukung adalah:

  • 'name'
  • title
  • description
  • annotationDate
  • annotationDateRange
  • color

Selain itu, API ini menyediakan fungsi bantuan berikut:

  • annotation_duration() : durasi yang ditandai anotasi ini, durations. mengharapkan representasi numerik detik yang diikuti dengan akhiran s.
  • is_annotation_in_range(startDate, endDate) : jika anotasi berada dalam rentang yang ditentukan oleh startDate dan endDate. Tanggal dalam format ISO-8601, misalnya 2031-06-28.

Operasi yang didukung:

  • = : sama dengan
  • != : tidak sama dengan
  • < : kurang dari
  • > : lebih besar dari
  • <= : kurang dari atau sama dengan
  • >= : lebih besar dari atau sama dengan
  • : : operator has
  • =~ : Kecocokan ekspresi reguler
  • !~ : ekspresi reguler tidak cocok
  • NOT : Logika bukan
  • AND : Logika dan
  • OR : Logika atau

Contoh:

  1. title="Holiday Sale"
  2. description=~"[Bb]ig [Gg]ame.*[Ss]ale"
  3. is_annotation_in_range("2025-12-25", "2026-01-16") = true
  4. annotation_duration() >= 172800s AND title:BOGO
pageSize

integer

Opsional. Jumlah maksimum resource yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini, meskipun ada halaman tambahan. Jika tidak ditentukan, paling banyak 50 resource akan ditampilkan. Nilai maksimumnya adalah 200; (nilai yang lebih tinggi akan dikonversi menjadi maksimum)
pageToken

string

Opsional. Token halaman, diterima dari panggilan reportingDataAnnotations.list sebelumnya. Berikan ini untuk mengambil halaman berikutnya. Saat melakukan penomoran halaman, semua parameter lain yang diberikan untuk reportingDataAnnotations.list harus sesuai dengan panggilan yang menyediakan token halaman.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Pesan respons untuk RPC ListReportingDataAnnotation.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "reportingDataAnnotations": [
    {
      object (ReportingDataAnnotation)
    }
  ],
  "nextPageToken": string
}
Kolom
reportingDataAnnotations[]

object (ReportingDataAnnotation)

Daftar Anotasi Data Pelaporan.
nextPageToken

string

Token yang dapat dikirim sebagai pageToken untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit