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)

省略可。読み取るデータの期間。複数の期間をリクエストすると、各レスポンス行にゼロから始まる期間のインデックスが含まれます。2 つの期間が重複している場合は、重複する日のイベントデータが両方の期間のレスポンス行に含まれます。コホート リクエストでは、この dateRanges は指定できません。

object (FilterExpression)

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

object (FilterExpression)

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

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)

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

object (OrderBy)

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

string

省略可。ISO4217 形式の通貨コード（「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 つのディメンションは、複数のディメンションの式の結果になることがあります。たとえば、ディメンション「country, city」の場合は 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 つのディメンションにまとめるために使用します。たとえば、ディメンション「country, city」の場合は 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 か月にアライメントできます。

{
  "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 行分のデータすべてにアクセスします。