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

特定の GA4 プロパティで表示が制限される可能性があるデータのカテゴリ。

列挙型
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 を計算します。