REST Resource: properties.reportTasks

{
  "name": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "reportMetadata": {
    object (ReportMetadata)
  }
}

string

出力専用。ID。作成時に割り当てられたレポートタスクのリソース名。形式: 「properties/{property}/reportTasks/{reportTask}」

object (ReportDefinition)

省略可。レポートデータを取得するためのレポート定義。レポートの構造を記述します。通常は、レポートに含めるフィールドと、データのフィルタに使用する条件が含まれます。

object (ReportMetadata)

出力専用。特定のレポートタスクのレポートのメタデータ。レポートに関する情報を提供します。通常は、レポートのリソース名、レポートの状態、レポートが作成されたタイムスタンプなどの情報が含まれます。

{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean
}

object (Dimension)

省略可。リクエストして表示されたディメンション。

object (Metric)

省略可。リクエストされ、表示される指標。

object (DateRange)

省略可。読み取るデータの期間。複数の期間がリクエストされた場合、レスポンスの各行には 0 を基準とした期間インデックスが含まれます。2 つの期間が重複する場合、重複する日付のイベントデータが両方の期間のレスポンス行に含まれます。コホート リクエストでは、この dateRanges を指定しないでください。

object (FilterExpression)

省略可。ディメンション フィルタを使用すると、レポート内の特定のディメンション値のみを要求することができます。詳しくは、ディメンション フィルタの基礎で例をご覧ください。このフィルタでは指標を使用できません。

object (FilterExpression)

省略可。指標のフィルタ句。SQL の has 句と同様に、レポートの行の集計後に適用されます。このフィルタではディメンションを使用できません。

string (int64 format)

省略可。Google アナリティクス ストレージの開始行の行数。最初の行は行 0 としてカウントされます。

レポートタスクを作成する際、offset パラメータと limit パラメータでは、生成されるレポートに含める Google アナリティクス ストレージのデータ行のサブセットを定義します。たとえば、Google アナリティクスのストレージに合計 300,000 行がある場合、最初のレポートタスクの最初の 10,000 行は上限が 10,000、オフセットが 0 になります。その後、別のレポート・タスクが次の 10,000 行を対象とし、上限は 10,000 行、オフセットは 10,000 行に設定されます。

string (int64 format)

省略可。レポートで返される行数です。指定しない場合は、10,000 行が返されます。指定した行数にかかわらず、API はリクエストごとに最大 250,000 行を返します。limit は正数で指定してください。

また、ディメンション値が limit の数より少ない場合、API はリクエストされた limit よりも少ない行を返すこともあります。たとえば、ディメンション country の有効な値が 300 個未満の場合、country のみに関するレポートでは、limit により大きな値を設定しても、取得できる行は 300 行までです。

enum (MetricAggregation)

省略可。指標の集計。集計された指標値は、dimensionValues が「RESERVED_(MetricAggregation)」に設定されている行に表示されます。

object (OrderBy)

省略可。レスポンスの行の順序を指定します。

string

省略可。ISO 4217 形式の通貨コード（「AED」、「USD」、「JPY」など）。このフィールドが空の場合、レポートにはプロパティのデフォルトの通貨が使用されます。

object (CohortSpec)

省略可。このリクエストに関連付けられているコホート グループ。リクエストにコホート グループがある場合は、「コホート」をディメンションが必要です。

boolean

省略可。false または指定されていない場合、すべての指標が 0 に等しい各行は返されません。true の場合、これらの行は、フィルタで個別に削除されない場合に返されます。

この keepEmptyRows の設定にかかわらず、レポートに表示されるのは Google アナリティクス（GA4）プロパティで記録されたデータのみです。

たとえば、あるプロパティで purchase イベントがログに記録されない場合、eventName ディメンションと eventCount 指標のクエリには、eventName「purchase」を含む行は含まれませんeventCount: 0 です。

{
  "name": string,
  "dimensionExpression": {
    object (DimensionExpression)
  }
}

string

ディメンションの名前。runReport や batchRunReports などの主要なレポート方法でサポートされているディメンション名の一覧については、API のディメンションをご覧ください。runRealtimeReport メソッドでサポートされているディメンション名の一覧については、リアルタイム ディメンションをご覧ください。runFunnelReport メソッドでサポートされているディメンション名の一覧については、ファネルのディメンションをご覧ください。

dimensionExpression を指定する場合は、name に使用可能な文字セット内の任意の文字列を指定できます。たとえば、dimensionExpression が country と city を連結する場合、そのディメンションには countryAndCity という名前を付けます。選択するディメンション名は、正規表現 ^[a-zA-Z0-9_]$ と一致する必要があります。

ディメンションは、dimensionFilter、orderBys、dimensionExpression、pivots の name によって参照されます。

object (DimensionExpression)

複数のディメンションの式の結果が 1 つのディメンションになることもあります。たとえば、ディメンション「国, 都市」の場合: concatenate(country, ", ", city)。

{

  // Union field one_expression can be only one of the following:
  "lowerCase": {
    object (CaseExpression)
  },
  "upperCase": {
    object (CaseExpression)
  },
  "concatenate": {
    object (ConcatenateExpression)
  }
  // End of list of possible types for union field one_expression.
}

object (CaseExpression)

ディメンションの値を小文字に変換するために使用します。

object (CaseExpression)

ディメンションの値を大文字に変換するために使用します。

object (ConcatenateExpression)

ディメンション値を 1 つのディメンションにまとめるために使用します。たとえば、ディメンション「国, 都市」の場合: concatenate(country, ", ", city)。

{
  "dimensionName": string
}

string

ディメンションの名前。この名前は、リクエストのディメンション フィールド内の名前を参照する必要があります。

{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}

string

ディメンションの名前。名前は、リクエストのディメンション フィールド内の名前を参照する必要があります。

string

ディメンション名の間に配置される区切り文字。

多くの場合、区切り文字は "|" のように 1 文字です。または「,」長い文字列でもかまいませんディメンション値に区切り文字が含まれている場合、両方が区別なくレスポンスに存在します。たとえば、ディメンション 1 の値が「US,FR」、ディメンション 2 の値が「JP」、区切り文字が「,」の場合、レスポンスには「US,FR,JP」が含まれます。

{
  "name": string,
  "expression": string,
  "invisible": boolean
}

string

指標の名前。runReport や batchRunReports などの主要なレポート メソッドでサポートされている指標名の一覧については、API の指標をご覧ください。runRealtimeReport メソッドでサポートされている指標名の一覧については、リアルタイム指標をご覧ください。runFunnelReport メソッドでサポートされている指標名の一覧については、ファネルの指標をご覧ください。

expression を指定する場合は、name に使用可能な文字セット内の任意の文字列を指定できます。たとえば、expression が screenPageViews/sessions の場合、その指標の名前を viewsPerSession にできます。選択する指標名は、正規表現 ^[a-zA-Z0-9_]$ と一致する必要があります。

指標は、metricFilter、orderBys、および指標 expression の name によって参照されます。

string

派生指標の数式。たとえば、指標のユーザーあたりのイベント数は eventCount/totalUsers です。

boolean

レポート レスポンス内で指標が非表示かどうかを示します。指標が非表示の場合、その指標はレスポンスに列を生成しませんが、metricFilter、orderBys、指標 expression で使用できます。

{
  "startDate": string,
  "endDate": string,
  "name": string
}

string

クエリの開始日（両端を含む）。形式は YYYY-MM-DD です。endDate より後の日付を指定してください。NdaysAgo、yesterday、today の形式も使用できます。この場合、日付はプロパティのレポートのタイムゾーンに基づいて推測されます。

string

クエリの終了日（両端を含む）。形式は YYYY-MM-DD です。startDate より前の日付は指定できません。NdaysAgo、yesterday、today の形式も使用できます。この場合、日付はプロパティのレポートのタイムゾーンに基づいて推測されます。

string

この期間に名前を割り当てます。レポート レスポンスでは、ディメンション dateRange はこの名前に設定されます。設定する場合、date_range_ または RESERVED_ で始めることはできません。設定しない場合、日付範囲はリクエストのゼロベースのインデックス（date_range_0、date_range_1 など）で指定されます。

{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FilterExpressionList)
  },
  "orGroup": {
    object (FilterExpressionList)
  },
  "notExpression": {
    object (FilterExpression)
  },
  "filter": {
    object (Filter)
  }
  // End of list of possible types for union field expr.
}

object (FilterExpressionList)

andGroup の FilterExpressions は AND 関係にあります。

object (FilterExpressionList)

orGroup の FilterExpressions は OR 関係です。

object (FilterExpression)

FilterExpression が notExpression の NOT になっています。

object (Filter)

プリミティブ フィルタ。同じ FilterExpression で、フィルタのすべてのフィールド名が、すべてのディメンションまたは指標のいずれかである必要があります。

{
  "expressions": [
    {
      object (FilterExpression)
    }
  ]
}

object (FilterExpression)

フィルタ式のリスト。

{
  "fieldName": string,

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}

string

ディメンション名または指標名。ディメンションまたは指標で定義された名前を指定する必要があります。

object (StringFilter)

文字列関連のフィルタ。

object (InListFilter)

リスト値のフィルタ。

object (NumericFilter)

数値または日付の値のフィルタ。

object (BetweenFilter)

2 つの値の間のフィルタ。

{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}

enum (MatchType)

このフィルタのマッチタイプ。

string

照合に使用される文字列値。

boolean

true の場合、文字列値の大文字と小文字は区別されます。

{
  "values": [
    string
  ],
  "caseSensitive": boolean
}

string

文字列値のリスト。空でない必要があります。

boolean

true の場合、文字列値の大文字と小文字は区別されます。

{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}

enum (Operation)

このフィルタのオペレーション タイプ。

object (NumericValue)

数値または日付値。

{

  // Union field one_value can be only one of the following:
  "int64Value": string,
  "doubleValue": number
  // End of list of possible types for union field one_value.
}

string (int64 format)

整数値

number

double 値

{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}

object (NumericValue)

この数字で始まります。

object (NumericValue)

末尾はこの数字です。

{
  "desc": boolean,

  // Union field one_order_by can be only one of the following:
  "metric": {
    object (MetricOrderBy)
  },
  "dimension": {
    object (DimensionOrderBy)
  }
  // End of list of possible types for union field one_order_by.
}

boolean

true の場合、降順で並べ替えます。

object (MetricOrderBy)

結果を指標の値で並べ替えます。

object (DimensionOrderBy)

ディメンションの値で結果を並べ替えます。

{
  "metricName": string
}

string

並べ替えるリクエストの指標名。

{
  "dimensionName": string,
  "orderType": enum (OrderType)
}

string

並べ替えるリクエストのディメンション名。

enum (OrderType)

ディメンション値の順序付けのルールを制御します。

{
  "cohorts": [
    {
      object (Cohort)
    }
  ],
  "cohortsRange": {
    object (CohortsRange)
  },
  "cohortReportSettings": {
    object (CohortReportSettings)
  }
}

object (Cohort)

ユーザーをコホートにグループ化する選択条件を定義します。

ほとんどのコホート レポートで定義されるコホートは 1 つのみです。複数のコホートが指定されている場合、レポートで各コホートを名前で識別できます。

object (CohortsRange)

コホート レポートでは、長いレポート対象期間のコホートについてレポートを作成できます。この範囲は、コホートを追跡するオフセット期間を指定します。

object (CohortReportSettings)

コホート レポートのオプション設定。

{
  "name": string,
  "dimension": string,
  "dateRange": {
    object (DateRange)
  }
}

string

このコホートに名前を割り当てます。レポート レスポンスでは、ディメンション cohort はこの名前に設定されます。設定する場合、cohort_ または RESERVED_ で始めることはできません。設定しない場合、コホートにはゼロベースのインデックス（cohort_0、cohort_1 など）の名前が付けられます。

string

コホートで使用されるディメンション。必須で、firstSessionDate のみをサポートしています。

object (DateRange)

このコホートでは、最初の接触日が dateRange で定義された開始日から終了日までの間にあるユーザーが選択されます。このdateRangeは、コホート レポートのイベントデータの完全な期間を指定しません。コホート レポートでは、この dateRange は cohortsRange に含まれる粒度とオフセットで拡張されます。延長レポート期間のイベントデータがコホート レポートに含まれている。

コホート リクエストでは、この dateRange は必須であり、RunReportRequest または RunPivotReportRequest の dateRanges は指定しないでください。

通常、この dateRange はコホートの粒度と一致する必要があります。CohortsRange で日単位の粒度を使用する場合、この dateRange には 1 日を指定できます。CohortsRange で週単位の粒度を使用する場合、この dateRange を、日曜日から土曜日まで、週の境界に揃えることができます。CohortsRange で月別の粒度を使用する場合、この dateRange を月の 1 日から最終日に 1 か月単位で調整できます。

{
  "granularity": enum (Granularity),
  "startOffset": integer,
  "endOffset": integer
}

enum (Granularity)

必須。コホート レポートの延長レポート期間の startOffset と endOffset の解釈に使用される粒度。

integer

startOffset には、コホート レポートの延長レポート期間の開始日を指定します。通常、startOffset は 0 に設定されるため、レポートにはコホートのユーザー獲得以降のデータが含まれます。

granularity が DAILY の場合、延長されたレポート期間のstartDateは、コホートの startDate + startOffset 日間となります。

granularity が WEEKLY の場合、延長されたレポート期間のstartDateは、コホートの startDate + startOffset * 7 日間となります。

granularity が MONTHLY の場合、延長されたレポート期間のstartDateは、コホートの startDate + startOffset * 30 日間となります。

integer

必須。endOffset は、コホート レポートの延長レポート期間の終了日を指定します。endOffset には任意の正の整数を指定できますが、通常は 5 ～ 10 に設定することで、コホートに関する次の複数の粒度の期間のデータがレポートに含まれるようになります。

granularity が DAILY の場合、延長されたレポート期間のendDateは、コホートの endDate + endOffset 日間となります。

granularity が WEEKLY の場合、延長されたレポート期間のendDateは、コホートの endDate + endOffset * 7 日間となります。

granularity が MONTHLY の場合、延長されたレポート期間のendDateは、コホートの endDate + endOffset * 30 日間となります。

{
  "accumulate": boolean
}

boolean

true の場合、最初の接触日から終了日までの結果を累積します。RunReportRequest ではサポートされていません。

{
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "taskRowCount": integer,
  "errorMessage": string,
  "totalRowCount": integer
}

integer

出力専用。レポートの作成時に課金されるクォータ トークンの合計。このトークン数は CREATING 状態のアクティビティに基づいているため、レポートタスクが ACTIVE 状態または FAILED 状態になると、このトークンの料金は固定されます。

enum (State)

出力専用。このレポートタスクの現在の状態。

string (Timestamp format)

出力専用。reportTasks.create が呼び出され、レポートが CREATING 状態を開始した時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

integer

出力専用。レポート結果の総行数。このフィールドは、状態がアクティブになると入力されます。既存のレポートの範囲内でページ分割に taskRowCount を使用できます。

string

出力専用。作成中にレポートタスクが失敗した場合に、エラー メッセージが入力されます。

integer

出力専用。Google アナリティクス ストレージ内の行数の合計。現在のレポートとは別のデータ行をクエリしたい場合は、totalRowCount に基づいて新しいレポートタスクを開始できます。

taskRowCount は現在のレポートに関係する行数を表し、totalRowCount は Google アナリティクスのストレージから取得した全データの行数の合計を表します。

たとえば、現在のレポートの taskRowCount が 20 で、最初の 20 行のデータが表示されているとします。同時に、totalRowCount が 30 になり、30 行すべてのデータが存在することが示されます。taskRowCount は、最初の 20 行までページ分割に使用できます。レポートを拡張して 30 行すべてのデータを含めるには、totalRowCount を使用して新しいレポートタスクを作成し、30 行すべてにアクセスします。大量のデータです。