Method: properties.getMetadata

レポート メソッドで使用可能なディメンションと指標のメタデータを返します。ディメンションと指標を確認する場合に使用します。この方法では、リクエストで Google アナリティクス GA4 プロパティ識別子が指定され、メタデータ レスポンスには、カスタム ディメンションとカスタム指標、ユニバーサル メタデータが含まれます。

たとえば、パラメータ名 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 を確認する方法をご覧ください。

例: 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。