Google アナリティクスの MCP サーバーを試します。
GitHub からインストールし、詳細については
お知らせをご覧ください。
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
例:
title="Holiday Sale"
description=~"[Bb]ig [Gg]ame.*[Ss]ale"
is_annotation_in_range("2025-12-25", "2026-01-16") = true
annotation_duration() >= 172800s AND title:BOGO
|
pageSize |
integer
省略可。返すリソースの最大数。ページが他にあっても、サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。
|
pageToken |
string
省略可。前回の reportingDataAnnotations.list 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。ページネーションを行う場合、reportingDataAnnotations.list に指定する他のすべてのパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。
|
リクエストの本文
リクエストの本文は空にする必要があります。
レスポンスの本文
ListReportingDataAnnotation RPC に対するレスポンス メッセージ。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
フィールド |
reportingDataAnnotations[] |
object (ReportingDataAnnotation )
レポートデータ アノテーションのリスト。
|
nextPageToken |
string
次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。
|
認可スコープ
以下のいずれかの OAuth スコープが必要です。
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics.edit
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-07-26 UTC。
[null,null,["最終更新日 2025-07-26 UTC。"],[],[],null,["# Method: properties.reportingDataAnnotations.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListReportingDataAnnotationsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nList all Reporting Data Annotations on a property.\n\n### HTTP request\n\n`GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/reportingDataAnnotations`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. Resource name of the property. Format: properties/property_id Example: properties/123 |\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `filter` | `string` Optional. Filter that restricts which reporting data annotations under the parent property are listed. Supported fields are: - 'name' - `title` - `description` - `annotationDate` - `annotationDateRange` - `color` Additionally, this API provides the following helper functions: - annotation_duration() : the duration that this annotation marks, [durations](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/duration.proto). expect a numeric representation of seconds followed by an `s` suffix. - is_annotation_in_range(startDate, endDate) : if the annotation is in the range specified by the `startDate` and `endDate`. The dates are in ISO-8601 format, for example `2031-06-28`. Supported operations: - `=` : equals - `!=` : not equals - `\u003c` : less than - `\u003e` : greater than - `\u003c=` : less than or equals - `\u003e=` : greater than or equals - `:` : has operator - `=~` : [regular expression](https://github.com/google/re2/wiki/Syntax) match - `!~` : [regular expression](https://github.com/google/re2/wiki/Syntax) does not match - `NOT` : Logical not - `AND` : Logical and - `OR` : Logical or Examples: 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() \u003e= 172800s AND title:BOGO` |\n| `pageSize` | `integer` Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) |\n| `pageToken` | `string` Optional. A page token, received from a previous `reportingDataAnnotations.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `reportingDataAnnotations.list` must match the call that provided the page token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for ListReportingDataAnnotation RPC.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"reportingDataAnnotations\": [ { object (/analytics/devguides/config/admin/v1/rest/v1alpha/properties.reportingDataAnnotations#ReportingDataAnnotation) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `reportingDataAnnotations[]` | `object (`[ReportingDataAnnotation](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.reportingDataAnnotations#ReportingDataAnnotation)`)` List of Reporting Data Annotations. |\n| `nextPageToken` | `string` A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/analytics.readonly`\n- `https://www.googleapis.com/auth/analytics.edit`"]]