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