REST Resource: properties.reportTasks

string

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

object (ReportDefinition)

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

object (ReportMetadata)

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

object (Dimension)

省略可。リクエストされ、表示されるディメンション。

object (Metric)

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

object (DateRange)

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

object (FilterExpression)

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

object (FilterExpression)

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

string (int64 format)

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

レポートタスクを作成するときに、offset パラメータと limit パラメータを使用して、生成されるレポートに含める Google アナリティクス ストレージ内のデータ行のサブセットを定義します。たとえば、Google アナリティクスのストレージに合計 30 万行ある場合、最初のレポートタスクでは、上限が 10,000 行でオフセットが 0 の最初の 10,000 行が取得されます。その後、別のレポートタスクで、上限 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

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

object (CohortSpec)

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

boolean

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

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

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

enum (SamplingLevel)

省略可。レポートのサンプリング レベル。

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)。

object (CaseExpression)

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

object (CaseExpression)

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

object (ConcatenateExpression)

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

string

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

string

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

string

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

区切り文字は通常「|」や「,」などの 1 文字ですが、長い文字列にすることもできます。ディメンション値に区切り文字が含まれている場合、レスポンスには区切り文字が付加された値と区切り文字が付加されていない値の両方が含まれます。たとえば、ディメンション 1 の値が「US,FR」、ディメンション 2 の値が「JP」、区切り文字が「,」の場合、レスポンスには「US,FR,JP」が含まれます。

string

指標の名前。runReport や batchRunReports などのコア レポート メソッドでサポートされている指標名のリストについては、API 指標をご覧ください。runRealtimeReport メソッドでサポートされている指標名のリストについては、リアルタイム指標をご覧ください。runFunnelReport メソッドでサポートされている指標名の一覧については、目標到達プロセス指標をご覧ください。

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

指標は、metricFilter の name、orderBys、指標 expression で参照されます。

string

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

boolean

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

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 など）が付けられます。

object (FilterExpressionList)

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

object (FilterExpressionList)

orGroup 内の FilterExpressions は OR の関係にあります。

object (FilterExpression)

FilterExpression が notExpression ではありません。

object (Filter)

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

object (FilterExpression)

フィルタ式のリスト。

string

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

object (StringFilter)

文字列関連のフィルタ。

object (InListFilter)

リスト内の値のフィルタ。

object (NumericFilter)

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

object (BetweenFilter)

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

object (EmptyFilter)

「(not set)」や「"" などの空の値をフィルタする。

enum (MatchType)

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

string

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

boolean

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

string

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

boolean

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

enum (Operation)

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

object (NumericValue)

数値または日付値。

string (int64 format)

整数値

number

double 値

object (NumericValue)

この番号で始まります。

object (NumericValue)

この番号で終わる。

boolean

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

object (MetricOrderBy)

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

object (DimensionOrderBy)

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

string

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

string

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

enum (OrderType)

ディメンション値の並べ替えのルールを制御します。

object (Cohort)

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

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

object (CohortsRange)

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

object (CohortReportSettings)

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

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 か月単位に調整できます。

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 日を加えた値になります。

boolean

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

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 行分の全データセットにアクセスします。