Method: properties.customDimensions.list
プロパティのカスタム ディメンションを一覧表示します。
HTTP リクエスト
GET https://analyticsadmin.googleapis.com/v1beta/{parent=properties/*}/customDimensions
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ |
parent |
string
必須。形式例: properties/1234
|
クエリ パラメータ
パラメータ |
pageSize |
integer
返されるリソースの最大数。指定されていない場合は、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。
|
pageToken |
string
前回の customDimensions.list 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。 ページ分割を行う場合、customDimensions.list に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。
|
リクエストの本文
リクエストの本文は空にする必要があります。
レスポンスの本文
customDimensions.list RPC のレスポンス メッセージ。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
JSON 表現 |
{
"customDimensions": [
{
object (CustomDimension )
}
],
"nextPageToken": string
} |
フィールド |
customDimensions[] |
object (CustomDimension )
CustomDimensions のリスト。
|
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-01-14 UTC。
[null,null,["最終更新日 2025-01-14 UTC。"],[[["Lists all CustomDimensions configured for a specified Google Analytics 4 property."],["Supports pagination to retrieve large lists of CustomDimensions."],["Requires `analytics.readonly` or `analytics.edit` authorization scopes for access."],["Provides details on the HTTP request structure, including path and query parameters."],["Response includes a list of CustomDimensions and a token for retrieving subsequent pages if available."]]],["This document details how to list CustomDimensions within a property using the Google Analytics Admin API. The core action is performing a `GET` request to the specified URL, which includes a required `parent` path parameter (e.g., properties/1234). Optional query parameters `pageSize` and `pageToken` enable pagination. The request body is empty. A successful response returns a JSON structure containing a list of `customDimensions` and a `nextPageToken` for further pages. Authorization requires specific OAuth scopes.\n"]]