Method: properties.reportingDataAnnotations.list

Bir mülkle ilgili tüm raporlama veri ek açıklamalarını listeleme.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
parent

string

Zorunlu. Tesisin kaynak adı. Biçim: mülkler/mülk_kimliği Örnek: mülkler/123

Sorgu parametreleri

Parametreler
filter

string

İsteğe bağlı. Üst mülk altındaki hangi raporlama veri ek açıklamalarının listeleneceğini kısıtlayan filtre.

Desteklenen alanlar şunlardır:

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

Ayrıca bu API aşağıdaki yardımcı işlevleri sağlar:

  • annotation_duration() : Bu ek açıklamanın işaretlediği süre, durations. saniyelerin sayısal temsilini ve ardından s son ekini bekler.
  • is_annotation_in_range(startDate, endDate) : Ek açıklama, startDate ve endDate tarafından belirtilen aralıktaysa. Tarihler ISO-8601 biçimindedir (ör. 2031-06-28).

Desteklenen işlemler:

  • = : eşittir
  • != : eşit değil
  • < : küçüktür
  • > : büyüktür
  • <= : küçüktür veya eşittir
  • >= : büyüktür veya eşittir
  • : : has operatörü
  • =~ : normal ifade eşleşmesi
  • !~ : normal ifade eşleşmiyor
  • NOT : Mantıksal değil
  • AND : Mantıksal ve
  • OR : Mantıksal veya

Örnekler:

  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

İsteğe bağlı. Döndürülecek maksimum kaynak sayısı. Ek sayfalar olsa bile hizmet bu değerden daha az sonuç döndürebilir. Belirtilmemişse en fazla 50 kaynak döndürülür. Maksimum değer 200'dür; (daha yüksek değerler maksimum değere zorlanacaktır)
pageToken

string

İsteğe bağlı. Önceki bir reportingDataAnnotations.list çağrısından alınan sayfa jetonu. Sonraki sayfayı almak için bunu sağlayın. Sayfalandırma yapılırken reportingDataAnnotations.list parametresine sağlanan diğer tüm parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

ListReportingDataAnnotation RPC için yanıt mesajı.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "reportingDataAnnotations": [
    {
      object (ReportingDataAnnotation)
    }
  ],
  "nextPageToken": string
}
Alanlar
reportingDataAnnotations[]

object (ReportingDataAnnotation)

Raporlama Veri Ek Açıklamalarının listesi.
nextPageToken

string

Sonraki sayfayı almak için pageToken olarak gönderilebilen bir jeton. Bu alan atlanırsa sonraki sayfa olmaz.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

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