Method: properties.getMetadata

レポート メソッドで使用できるディメンションと指標のメタデータを返します。ディメンションと指標を調べるために使用します。この方法では、リクエストで Google アナリティクス GA4 プロパティ ID が指定され、メタデータ レスポンスにカスタム ディメンションとカスタム指標、ユニバーサル メタデータが含まれます。

たとえば、パラメータ名が levels_unlocked のカスタム指標がプロパティに登録されている場合、メタデータのレスポンスには customEvent:levels_unlocked が含まれます。ユニバーサル メタデータは、countrytotalUsers など、あらゆるプロパティに適用できるディメンションと指標です。

HTTP リクエスト

GET https://analyticsdata.googleapis.com/v1beta/{name=properties/*/metadata}

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

パスパラメータ

パラメータ
name

string

必須。取得するメタデータのリソース名。この名前フィールドは URL パラメータではなく URL パスで指定します。プロパティは、Google アナリティクス GA4 プロパティの数値 ID です。詳しくは、プロパティ ID を確認する方法をご覧ください。

例: properties/1234/metadata

すべてのプロパティに共通のディメンションと指標については、プロパティ ID を 0 に設定します。この特別なモードでは、このメソッドでカスタム ディメンションとカスタム指標は返されません。

リクエスト本文

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

レスポンスの本文

現在レポートで使用できるディメンション、指標、比較。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現
{
  "name": string,
  "dimensions": [
    {
      object (DimensionMetadata)
    }
  ],
  "metrics": [
    {
      object (MetricMetadata)
    }
  ]
}
フィールド
name

string

このメタデータのリソース名。

dimensions[]

object (DimensionMetadata)

ディメンションの説明。

metrics[]

object (MetricMetadata)

指標の説明。

認可スコープ

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

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