ResponseMetaData

レポートの内容に関する追加情報を含むレスポンスのメタデータ。

JSON 表現
{
  "dataLossFromOtherRow": boolean,
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ],
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
フィールド
dataLossFromOtherRow

boolean

true の場合、ディメンションの組み合わせのバケットの一部が「(other)」行にロールアップされていることを示します。これは、基数の大きいレポートで発生する可能性があります。

メタデータ パラメータ dataLossFromOtherRow は、レポートで使用される集計データテーブルに基づいて入力されます。レポートのフィルタや上限に関係なく、パラメータは正確に設定されます。

たとえば、リクエストに sessionSource = google のフィルタが含まれている場合、(other)行がレポートから削除されることがあります。このレポートの生成に使用された入力集計データに他の行からのデータ損失が含まれている場合、このパラメータは引き続き入力されます。

詳しくは、「(other)」行とデータ サンプリングについてをご覧ください。

samplingMetadatas[]

object (SamplingMetadata)

このレポートの結果がサンプリングされている場合、このレポートで使用されたイベントの割合が表示されます。各期間に対して 1 つの samplingMetadatas が入力されます。各 samplingMetadatas は、リクエストで指定された順序で期間に対応します。

ただし、結果がサンプリングされていない場合、このフィールドは定義されません。

schemaRestrictionResponse

object (SchemaRestrictionResponse)

このレポートの作成時に積極的に適用されたスキーマの制限について説明します。詳しくは、アクセスとデータ制限の管理をご覧ください。

currencyCode

string

このレポートで使用されている通貨コード。ビジュアリゼーションの purchaseRevenue などの通貨指標の書式設定で使用することを想定しています。リクエストで currencyCode が指定されている場合、このレスポンス パラメータはリクエスト パラメータをエコーします。それ以外の場合、このレスポンス パラメータはプロパティの現在の currencyCode です。

通貨コードは、ISO 4217 標準(https://en.wikipedia.org/wiki/ISO_4217)の通貨タイプの文字列エンコードです(例: 「USD」、「EUR」、「JPY」)。詳しくは、https://support.google.com/analytics/answer/9796179 をご覧ください。

timeZone

string

プロパティの現在のタイムゾーン。hourminute などの時間ベースのディメンションを解釈するために使用することを目的としています。IANA タイムゾーン データベース(https://www.iana.org/time-zones)の文字列としてフォーマットされます(例: 「America/New_York」、「Asia/Tokyo」)。

emptyReason

string

空の理由が指定されている場合、レポートはこの理由で空になります。

subjectToThresholding

boolean

subjectToThresholding が true の場合、このレポートにはしきい値が適用され、データ集計の最小値を満たすデータのみが返されます。リクエストがしきい値処理の対象となり、レポートにデータが欠落していない場合があります。これは、すべてのデータがしきい値を超えている場合に発生します。詳しくは、データのしきい値をご覧ください。

SchemaRestrictionResponse

このレポートの作成時に積極的に適用されたスキーマの制限。詳しくは、アクセスとデータ制限の管理をご覧ください。

JSON 表現
{
  "activeMetricRestrictions": [
    {
      object (ActiveMetricRestriction)
    }
  ]
}
フィールド
activeMetricRestrictions[]

object (ActiveMetricRestriction)

レポートの作成時にアクティブに適用されるすべての制限。たとえば、purchaseRevenue には常に制限タイプ REVENUE_DATA があります。ただし、このアクティブなレスポンスの制限は、ユーザーのカスタムロールで REVENUE_DATA へのアクセスが禁止されている場合にのみ入力されます。

ActiveMetricRestriction

レポートの作成時に積極的に制限されている指標。

JSON 表現
{
  "restrictedMetricTypes": [
    enum (RestrictedMetricType)
  ],
  "metricName": string
}
フィールド
restrictedMetricTypes[]

enum (RestrictedMetricType)

この指標の制限の理由。

metricName

string

制限付き指標の名前。

RestrictedMetricType

特定の Google アナリティクス プロパティで閲覧が制限される可能性のあるデータのカテゴリ。

列挙型
RESTRICTED_METRIC_TYPE_UNSPECIFIED 未指定のタイプ。
COST_DATA adCost などの費用指標。
REVENUE_DATA 収益指標(purchaseRevenue など)。

SamplingMetadata

このレポートの結果がサンプリングされている場合、このレポートで使用されたイベントの割合が表示されます。サンプリングとは、大規模なデータセットの中から有意な情報を得るため、すべてのデータの一部を抽出して分析することです。

JSON 表現
{
  "samplesReadCount": string,
  "samplingSpaceSize": string
}
フィールド
samplesReadCount

string (int64 format)

このサンプル レポートで読み取られたイベントの合計数(期間別)。これは、このレポートで分析されたこのプロパティのデータのサブセットのサイズです。

samplingSpaceSize

string (int64 format)

このプロパティのデータに存在するイベントの合計数。このレポートで分析可能なイベントの数(期間指定あり)。サンプリングによって大規模なデータセットに関する有意な情報が明らかになります。これは、大規模なデータセットのサイズです。

このレポートで使用された利用可能なデータの割合を計算するには、samplesReadCount/samplingSpaceSize を計算します。