REST Resource: properties.reportTasks

リソース: ReportTask

特定のレポートタスクの構成。

JSON 表現 
{
  "name": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "reportMetadata": {
    object (ReportMetadata)
  }
}
フィールド
name

string

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

object (ReportDefinition)

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

object (ReportMetadata)

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

ReportDefinition

レポートの実行方法の定義。

JSON 表現 
{
  "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,
  "samplingLevel": enum (SamplingLevel)
}
フィールド
dimensions[]

object (Dimension)

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

object (Metric)

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

object (DateRange)

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

object (FilterExpression)

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

object (FilterExpression)

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

string (int64 format)

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

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

string (int64 format)

省略可。レポートで返す行数。指定しない場合、10,000 行が返されます。API は、リクエストに応じて最大 250,000 行を返します。limit には正の値を指定してください。

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

enum (MetricAggregation)

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

object (OrderBy)

省略可。レスポンスで行の並べ替え順序を指定します。
currencyCode

string

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

object (CohortSpec)

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

boolean

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

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

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

enum (SamplingLevel)

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

ディメンション

ディメンションはデータの属性です。たとえば、ディメンション「市区町村」は、イベントが発生した市区町村を表します。レポート レスポンスのディメンション値は文字列です。たとえば、市区町村は「パリ」や「ニューヨーク」などです。

JSON 表現 
{
  "name": string,
  "dimensionExpression": {
    object (DimensionExpression)
  }
}
フィールド
name

string

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

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

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

object (DimensionExpression)

1 つのディメンションは、複数のディメンションの式の結果にすることができます。たとえば、ディメンション「country, city」: concatenate(country, ", ", city)。

DimensionExpression

複数のディメンションの式の結果であるディメンションを表すために使用します。使用例: 1）lowerCase(ディメンション) 2）concatenate(ディメンション 1、記号、ディメンション 2)。

JSON 表現 
{

  // 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.
}
フィールド
共用体フィールド one_expression。DimensionExpression に 1 つのタイプのディメンション式を指定します。one_expression は次のいずれかになります。
lowerCase

object (CaseExpression)

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

object (CaseExpression)

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

object (ConcatenateExpression)

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

CaseExpression

ディメンション値を単一のケースに変換するために使用します。

JSON 表現 
{
  "dimensionName": string
}
フィールド
dimensionName

string

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

ConcatenateExpression

ディメンションの値を 1 つのディメンションに結合するために使用します。

JSON 表現 
{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}
フィールド
dimensionNames[]

string

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

string

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

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

指標

レポートの定量的な測定値。たとえば、指標 eventCount はイベントの合計数です。リクエストで指定できる指標は最大 10 個です。

JSON 表現 
{
  "name": string,
  "expression": string,
  "invisible": boolean
}
フィールド
name

string

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

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

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

string

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

boolean

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

DateRange

連続した日付のセット: startDate、startDate + 1、...、endDate。リクエストで指定できる期間は最大 4 つです。

JSON 表現 
{
  "startDate": string,
  "endDate": string,
  "name": string
}
フィールド
startDate

string

クエリの開始日（この値を含む）。YYYY-MM-DD 形式で指定します。endDate より後の日付にすることはできません。形式 NdaysAgo、yesterday、today も使用できます。この場合、日付は宿泊施設のレポート タイムゾーンに基づいて推測されます。
endDate

string

クエリの終了日（YYYY-MM-DD 形式）。指定した日も期間に含みます。startDate より前の日付は指定できません。形式 NdaysAgo、yesterday、today も使用できます。この場合、日付は宿泊施設のレポート タイムゾーンに基づいて推測されます。
name

string

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

FilterExpression

ディメンションまたは指標のフィルタを指定します。同じ FilterExpression 内のフィールドは、すべてディメンションか、すべて指標のいずれかにする必要があります。

JSON 表現 
{

  // 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.
}
フィールド
共用体フィールド expr。FilterExpression に 1 つのタイプのフィルタ式を指定します。expr は次のいずれかになります。
andGroup

object (FilterExpressionList)

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

object (FilterExpressionList)

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

object (FilterExpression)

FilterExpression が notExpression ではありません。
filter

object (Filter)

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

FilterExpressionList

フィルタ式のリスト。

JSON 表現 
{
  "expressions": [
    {
      object (FilterExpression)
    }
  ]
}
フィールド
expressions[]

object (FilterExpression)

フィルタ式のリスト。

フィルタ

ディメンション値または指標値をフィルタする式。

JSON 表現 
{
  "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)
  },
  "emptyFilter": {
    object (EmptyFilter)
  }
  // End of list of possible types for union field one_filter.
}
フィールド
fieldName

string

ディメンション名または指標名。ディメンションまたは指標で定義された名前にする必要があります。
共用体フィールド one_filter。Filter に 1 種類のフィルタを指定します。one_filter は次のいずれかになります。
stringFilter

object (StringFilter)

文字列関連のフィルタ。
inListFilter

object (InListFilter)

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

object (NumericFilter)

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

object (BetweenFilter)

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

object (EmptyFilter)

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

StringFilter

文字列のフィルタ

JSON 表現 
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
フィールド
matchType

enum (MatchType)

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

string

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

boolean

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

MatchType

文字列フィルタのマッチタイプ

列挙型
MATCH_TYPE_UNSPECIFIED 指定なし
EXACT 文字列値の完全一致。
BEGINS_WITH 文字列値で始まる。
ENDS_WITH 文字列値で終わる。
CONTAINS 文字列値が含まれます。
FULL_REGEXP 文字列値を含む正規表現の完全一致。
PARTIAL_REGEXP 正規表現と文字列値の部分一致。

InListFilter

結果は文字列値のリストにする必要があります。

JSON 表現 
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
フィールド
values[]

string

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

boolean

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

NumericFilter

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

JSON 表現 
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
フィールド
operation

enum (Operation)

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

object (NumericValue)

数値または日付値。

オペレーション

数値フィルタに適用されるオペレーション

列挙型
OPERATION_UNSPECIFIED （指定なし）
EQUAL 等しい
LESS_THAN 次より小さい
LESS_THAN_OR_EQUAL 次の値以下
GREATER_THAN 次の値を上回る
GREATER_THAN_OR_EQUAL 次の値以上

NumericValue

数値を表す。

JSON 表現 
{

  // 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.
}
フィールド
共用体フィールド one_value。数値 one_value は、次のいずれか 1 つにする必要があります。
int64Value

string (int64 format)

整数値
doubleValue

number

double 値

BetweenFilter

結果が 2 つの数値の範囲内にある必要があることを表します。

JSON 表現 
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
フィールド
fromValue

object (NumericValue)

この番号で始まります。
toValue

object (NumericValue)

この番号で終わる。

EmptyFilter

この型にはフィールドがありません。

空の値をフィルタします。

MetricAggregation

指標の集計を表します。

列挙型
METRIC_AGGREGATION_UNSPECIFIED 演算子が指定されていません。
TOTAL SUM 演算子。
MINIMUM 最小演算子。
MAXIMUM 最大演算子。
COUNT カウント演算子。

OrderBy

順序指定では、レスポンスで行を並べ替える方法を定義します。たとえば、イベント数を降順で並べ替える順序と、イベント名の文字列で並べ替える順序は異なります。

JSON 表現 
{
  "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.
}
フィールド
desc

boolean

true の場合、降順で並べ替えます。
共用体フィールド one_order_by。OrderBy に 1 つの並べ替え順序を指定します。one_order_by は次のいずれかになります。
metric

object (MetricOrderBy)

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

object (DimensionOrderBy)

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

MetricOrderBy

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

JSON 表現 
{
  "metricName": string
}
フィールド
metricName

string

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

DimensionOrderBy

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

JSON 表現 
{
  "dimensionName": string,
  "orderType": enum (OrderType)
}
フィールド
dimensionName

string

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

enum (OrderType)

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

OrderType

文字列ディメンションの値を並べ替えるルール。

列挙型
ORDER_TYPE_UNSPECIFIED （指定なし）
ALPHANUMERIC 英数字は Unicode コードポイントで並べ替えられます。たとえば、「2」<「A」<「X」<「b」<「z」です。
CASE_INSENSITIVE_ALPHANUMERIC 大文字と小文字を区別しない英数字の並べ替え。小文字の Unicode コードポイントで並べ替えます。たとえば、「2」<「A」<「b」<「X」<「z」です。
NUMERIC ディメンション値は、並べ替える前に数値に変換されます。たとえば、数値の並べ替えでは「25」<「100」ですが、ALPHANUMERIC の並べ替えでは「100」<「25」です。数値以外のディメンション値はすべて、すべての数値の下に同じ並べ替え値が設定されます。

CohortSpec

コホート レポートのコホートの仕様。

コホート レポートでは、コホートのユーザー維持率の時系列が作成されます。たとえば、9 月の第 1 週に獲得したユーザーのコホートを選択し、そのコホートを次の 6 週間追跡できます。9 月の第 1 週に獲得したユーザーを選択するコホートは、cohort オブジェクトで指定します。その後の 6 週間のコホートについては、cohortsRange オブジェクトで指定します。

例については、コホート レポートの例をご覧ください。

レポートのレスポンスには、アプリがこのコホートの 60% を 3 週間後に維持し、6 週間後に 25% を維持したという、週単位の時系列が表示されます。これらの 2 つの割合は指標 cohortActiveUsers/cohortTotalUsers で計算でき、レポートでは別々の行に表示されます。

JSON 表現 
{
  "cohorts": [
    {
      object (Cohort)
    }
  ],
  "cohortsRange": {
    object (CohortsRange)
  },
  "cohortReportSettings": {
    object (CohortReportSettings)
  }
}
フィールド
cohorts[]

object (Cohort)

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

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

object (CohortsRange)

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

object (CohortReportSettings)

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

コホート

コホートの選択条件を定義します。コホートとは、共通の特性を持つユーザーのグループです。たとえば、firstSessionDate が同じユーザーは同じコホートに属します。

JSON 表現 
{
  "name": string,
  "dimension": string,
  "dateRange": {
    object (DateRange)
  }
}
フィールド
name

string

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

string

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

object (DateRange)

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

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

通常、この dateRange はコホートの粒度に合わせて設定する必要があります。CohortsRange で日単位の粒度が使用されている場合、この dateRange は 1 日単位にできます。CohortsRange で週単位の粒度を使用している場合、この dateRange は日曜日から土曜日までの週の境界に合わせて調整できます。CohortsRange で月単位の粒度を使用している場合、この dateRange は 1 日から最終日までの 1 か月単位に調整できます。

CohortsRange

コホート レポートの拡張レポート期間を設定します。コホートを追跡するオフセット期間を指定します。

JSON 表現 
{
  "granularity": enum (Granularity),
  "startOffset": integer,
  "endOffset": integer
}
フィールド
granularity

enum (Granularity)

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

integer

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

granularity が DAILY の場合、レポートの期間の延長の startDate は、コホートの startDate に startOffset 日を加えた値になります。

granularity が WEEKLY の場合、レポートの期間の延長の startDate は、コホートの startDate に startOffset * 7 日を加えた値になります。

granularity が MONTHLY の場合、レポートの期間の延長の startDate は、コホートの startDate に startOffset * 30 日を加えた値になります。
endOffset

integer

必須。endOffset には、コホート レポートの拡張レポート期間の終了日を指定します。endOffset には任意の正の整数を指定できますが、通常は 5 ～ 10 に設定して、レポートに次の数期間の分割単位の対象グループのデータが含まれるようにします。

granularity が DAILY の場合、レポートの期間の延長の endDate は、コホートの endDate に endOffset 日を加えた値になります。

granularity が WEEKLY の場合、レポートの期間の延長の endDate は、コホートの endDate に endOffset * 7 日を加えた値になります。

granularity が MONTHLY の場合、レポートの期間の延長の endDate は、コホートの endDate に endOffset * 30 日を加えた値になります。

粒度

コホート レポートの拡張レポート期間の startOffset と endOffset の解釈に使用される粒度。

列挙型
GRANULARITY_UNSPECIFIED 指定しないでください。
DAILY 1 日単位の粒度。コホートの dateRange が 1 日で、リクエストに cohortNthDay が含まれている場合によく使用されます。
WEEKLY 週単位の粒度。コホートの dateRange が 1 週間（日曜日から土曜日まで）で、リクエストに cohortNthWeek が含まれている場合によく使用されます。
MONTHLY 月単位の粒度。コホートの dateRange が 1 か月で、リクエストに cohortNthMonth が含まれている場合によく使用されます。

CohortReportSettings

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

JSON 表現 
{
  "accumulate": boolean
}
フィールド
accumulate

boolean

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

SamplingLevel

リクエストのサンプリング レベルのカテゴリ。

列挙型
SAMPLING_LEVEL_UNSPECIFIED 未指定のタイプ。
LOW 標準プロパティには 1,000 万、Google アナリティクス 360 プロパティには 1 億のサンプリング レベルが適用されます。
MEDIUM サンプリング レベルが 10 億の Google アナリティクス 360 プロパティに限定されます。
UNSAMPLED Google アナリティクス 360 プロパティ専用です。非サンプリング データ探索は精度が高く、標準のデータ探索では表示されない分析情報を明らかにできます。詳しくは、https://support.google.com/analytics/answer/10896953 をご覧ください。

ReportMetadata

特定のレポートタスクのレポート メタデータ。

JSON 表現 
{
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "taskRowCount": integer,
  "errorMessage": string,
  "totalRowCount": integer
}
フィールド
creationQuotaTokensCharged

integer

出力専用。レポートの作成中に課金された割り当てトークンの合計数。このトークン数は CREATING 状態のアクティビティに基づいているため、レポートタスクが ACTIVE 状態または FAILED 状態になると、このトークンの請求は修正されます。
state

enum (State)

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

string (Timestamp format)

出力専用。reportTasks.create が呼び出され、レポートが CREATING 状態になった時刻。

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

integer

出力専用。レポート結果の行の合計数。このフィールドには、ステータスが有効な場合に値が入力されます。taskRowCount を使用すると、既存のレポートの範囲内でページネーションを設定できます。
errorMessage

string

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

integer

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

taskRowCount は、現在のレポートに固有の行数を表します。一方、totalRowCount は、Google アナリティクス ストレージから取得されたすべてのデータの行数の合計を表します。

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

州

処理ステータス。

列挙型
STATE_UNSPECIFIED 未指定の状態は使用されません。
CREATING このレポートは現在作成中であり、今後利用可能になる予定です。作成は、CreateReport 呼び出しの直後に行われます。
ACTIVE レポートが完全に作成され、クエリを実行できる状態になりました。
FAILED レポートを作成できませんでした。

メソッド

create

 レポートタスクの作成を開始します。

get

 特定のレポートタスクに関するレポート メタデータを取得します。

list

 プロパティのすべてのレポートタスクを一覧表示します。

query

 レポートタスクのコンテンツを取得します。