Method: properties.getMetadata

レポート作成メソッドで使用できるディメンションと指標のメタデータを返します。ディメンションと指標の探索に使用されます。このメソッドでは、リクエストで Google アナリティクスのプロパティ 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 パスで指定されます。Property は、Google アナリティクスのプロパティの数値識別子です。詳しくは、プロパティ ID を確認するをご覧ください。

例: properties/1234/metadata

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

リクエストの本文

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

レスポンスの本文

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

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

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

string

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

object (DimensionMetadata)

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

object (MetricMetadata)

指標の説明。
comparisons[]

object (ComparisonMetadata)

比較の説明。
conversions[]

object (ConversionMetadata)

コンバージョンの説明。

認可スコープ

次の 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,
  "category": string,
  "sections": [
    enum (Section)
  ]
}
フィールド
apiName

string

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

string

Google アナリティクスの管理画面に表示されるディメンションの名前。例: Event name
description

string

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

string

このディメンションの非推奨の名前ですが、引き続き使用できます。このディメンションが入力されている場合、apiName または deprecatedApiNames のいずれかによって一定期間利用できます。非推奨期間が終了すると、ディメンションは apiName でのみ使用できるようになります。
customDefinition

boolean

ディメンションがこのプロパティのカスタム ディメンションである場合は true。これには、ユーザー、イベント、アイテムのスコープのカスタム ディメンションが含まれます。カスタム ディメンションについて詳しくは、https://support.google.com/analytics/answer/14240153 をご覧ください。カスタム チャネル グループも含まれます。カスタム チャネル グループについて詳しくは、https://support.google.com/analytics/answer/13051316 をご覧ください。
category

string

このディメンションが属するカテゴリの表示名。類似のディメンションと指標は同じカテゴリに分類されます。
sections[]

enum (Section)

このディメンションが適用される Google アナリティクスのセクションを指定します。

MetricMetadata

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

JSON 表現 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean,
  "blockedReasons": [
    enum (BlockedReason)
  ],
  "category": string,
  "sections": [
    enum (Section)
  ]
}
フィールド
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。
blockedReasons[]

enum (BlockedReason)

理由を指定すると、このプロパティのこの指標へのアクセスがブロックされます。この指標に対するこのプロパティへの API リクエストは成功しますが、レポートにはこの指標のゼロのみが含まれます。ブロックされた指標に対して指標フィルタを使用した API リクエストは失敗します。理由が空の場合、この指標にアクセスできます。

詳しくは、アクセスとデータ制限の管理をご覧ください。
category

string

この指標が属するカテゴリの表示名。類似のディメンションと指標は同じカテゴリに分類されます。
sections[]

enum (Section)

この指標が適用される Google アナリティクスのセクションを指定します。

BlockedReason

この指標がブロックされる理由。

列挙型
BLOCKED_REASON_UNSPECIFIED API レスポンスで指定されることはありません。
NO_REVENUE_METRICS このプロパティの収益関連の指標へのアクセス権がなく、この指標が収益関連の指標である場合、アクセスはブロックされます。
NO_COST_METRICS このプロパティの費用関連の指標へのアクセス権がなく、この指標が費用に関連している場合、このメッセージが表示されます。

ComparisonMetadata

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

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

string

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

string

Google アナリティクスの管理画面に表示される比較の名前。
description

string

この比較の説明。

ConversionMetadata

1 回のコンバージョンのメタデータ。

JSON 表現 
{
  "conversionAction": string,
  "displayName": string
}
フィールド
conversionAction

string

コンバージョン アクションの固有識別子。この ID は、レポート リクエストの ConversionsSpec の conversionActions フィールドに入力することで、レポートに含めるコンバージョンを指定するために使用されます。例: 「conversionActions/1234」。
displayName

string

Google アナリティクスの管理画面に表示されるコンバージョン名。