Method: properties.getMetadata

レポート作成メソッドで使用できるディメンションと指標のメタデータを返します。ディメンションと指標を調べるために使用します。このメソッドでは、リクエストで Google アナリティクスのプロパティ 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 パスで指定します。Property は、数値の Google アナリティクスのプロパティ 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

単一の比較のメタデータ。

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

string

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

string

Google アナリティクスの管理画面でのこの比較の名前。
description

string

この比較の説明。