Method: properties.getMetadata

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

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

HTTP リクエスト

GET https://analyticsdata.googleapis.com/v1alpha/{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

DimensionMetadata

ディメンションについて説明します。

JSON 表現 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "customDefinition": boolean
}
フィールド
apiName

string

このディメンションの名前。ディメンションの name で使用できます。例: eventName
uiName

string

Google アナリティクスの管理画面でのこのディメンションの名前。例: Event name
description

string

このディメンションの用途と計算方法の説明。
deprecatedApiNames[]

string

このディメンションの名前は引き続き使用できますが、サポートが終了しています。入力されている場合、このディメンションは一定期間、apiName または deprecatedApiNames のいずれかで使用できます。サポート終了期間を過ぎると、このディメンションは apiNameまで利用できるようになります。
customDefinition

boolean

ディメンションがこのプロパティのカスタム ディメンションである場合は true。

MetricMetadata

指標について説明します。

JSON 表現 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean
}
フィールド
apiName

string

指標名。指標の name で使用できます。例: eventCount
uiName

string

Google アナリティクスの管理画面でのこの指標の名前。例: Event count
description

string

この指標の使用方法と計算方法の説明。
deprecatedApiNames[]

string

この指標の名前は引き続き使用できますが、非推奨です。入力されている場合、この指標は一定期間、apiName または deprecatedApiNames のいずれかで使用できます。非推奨期間が終了した後、この指標を使用できるのは apiName までとなります。
type

enum (MetricType)

この指標のタイプ。
expression

string

この派生指標の数式。同等のレポートで、指標の expression フィールドで使用できます。ほとんどの指標は式ではありません。式以外の場合、このフィールドは空になります。
customDefinition

boolean

指標がこのプロパティのカスタム指標の場合は true。