Method: properties.reportingDataAnnotations.list

プロパティのすべてのレポートデータ アノテーションを一覧表示します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。プロパティのリソース名。形式: properties/property_id 例: properties/123

クエリ パラメータ

パラメータ
filter

string

省略可。親プロパティのレポートデータ アノテーションの表示を制限するフィルタ。

サポートされているフィールドは次のとおりです。

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

また、この API には次のヘルパー関数があります。

  • annotation_duration() : このアノテーションがマークする時間（durations）。秒数を数値で指定し、末尾に s を付けます。
  • is_annotation_in_range(startDate, endDate) : アノテーションが startDate と endDate で指定された範囲内にあるかどうか。日付は ISO-8601 形式で指定します（例: 2031-06-28）。

サポートされているオペレーション:

  • = : 等しい
  • != : 等しくない
  • < : 小さい
  • > : 大きい
  • <= : 小さいまたは等しい
  • >= : 大きいまたは同じ
  • : : has 演算子
  • =~ : 正規表現の一致
  • !~ : 正規表現が一致しない
  • NOT : 論理否定
  • AND : 論理 AND
  • OR : 論理 OR

例:

  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

省略可。返すリソースの最大数。ページが他にあっても、サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です（それ以上の値は最大値に強制変換されます）。
pageToken

string

省略可。前回の reportingDataAnnotations.list 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。ページネーションを行う場合、reportingDataAnnotations.list に指定する他のすべてのパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

ListReportingDataAnnotation RPC に対するレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "reportingDataAnnotations": [
    {
      object (ReportingDataAnnotation)
    }
  ],
  "nextPageToken": string
}
フィールド
reportingDataAnnotations[]

object (ReportingDataAnnotation)

レポートデータ アノテーションのリスト。
nextPageToken

string

次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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