Method: properties.getMetadata

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

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

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)
    }
  ],
  "comparisons": [
    {
      object (ComparisonMetadata)
    }
  ]
}
フィールド
name

string

このメタデータのリソース名。
dimensions[]

object (DimensionMetadata)

ディメンションの説明。
metrics[]

object (MetricMetadata)

指標の説明。
comparisons[]

object (ComparisonMetadata)

比較の説明。

認可スコープ

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

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

ComparisonMetadata

1 つの比較のメタデータ。

JSON 表現 
{
  "apiName": string,
  "uiName": string,
  "description": string
}
フィールド
apiName

string

この比較のリソース名。Comparison の comparison フィールドで使用できます。例: 「comparisons/1234」。
uiName

string

Google アナリティクスの管理画面でこの比較の名前が表示されます。
description

string

この比較の説明です。