- リソース: ReportTask
- ReportDefinition
- ディメンション
- DimensionExpression
- CaseExpression
- ConcatenateExpression
- 指標
- DateRange
- FilterExpression
- FilterExpressionList
- Filter
- StringFilter
- MatchType
- InListFilter
- NumericFilter
- オペレーション
- NumericValue
- BetweenFilter
- MetricAggregation
- OrderBy
- MetricOrderBy
- DimensionOrderBy
- OrderType
- CohortSpec
- コホート
- CohortsRange
- 粒度
- CohortReportSettings
- ReportMetadata
- 状態
- メソッド
リソース: ReportTask
特定のレポートタスクの構成。
JSON 表現 |
---|
{ "name": string, "reportDefinition": { object ( |
フィールド | |
---|---|
name |
出力専用。ID。作成時に割り当てられたレポートタスクのリソース名。形式: 「properties/{property}/reportTasks/{reportTask}」 |
reportDefinition |
省略可。レポートデータを取得するためのレポート定義。レポートの構造を記述します。これには通常、レポートに含めるフィールドと、データのフィルタに使用される条件が含まれます。 |
reportMetadata |
出力専用。特定のレポートタスクのレポート メタデータ。レポートに関する情報を提供します。通常、レポートのリソース名、レポートの状態、レポートが作成されたタイムスタンプなどの情報が含まれます。 |
ReportDefinition
レポートの実行方法の定義。
JSON 表現 |
---|
{ "dimensions": [ { object ( |
フィールド | |
---|---|
dimensions[] |
省略可。リクエストされ、表示されたディメンション。 |
metrics[] |
省略可。リクエストされ、表示される指標。 |
dateRanges[] |
省略可。読み取るデータの期間。複数の期間をリクエストすると、各レスポンス行にゼロから始まる期間のインデックスが含まれます。2 つの期間が重複している場合は、重複する日のイベントデータが両方の期間のレスポンス行に含まれます。コホート リクエストでは、この |
dimensionFilter |
省略可。ディメンション フィルタを使用すると、特定のディメンション値のみをレポートに表示できます。詳細については、ディメンション フィルタの基礎で例をご覧ください。このフィルタでは指標を使用できません。 |
metricFilter |
省略可。指標のフィルタ句。SQL with 句と同様に、レポートの行を集計した後に適用されます。このフィルタではディメンションを使用できません。 |
offset |
省略可。Google アナリティクス ストレージにある開始行の行数。最初の行は行 0 としてカウントされます。 レポートタスクを作成する際、 |
limit |
省略可。レポートで返す行数。指定しない場合は、10,000 行が返されます。API は、リクエストした数に関係なく、リクエストあたり最大 250,000 行を返します。 また、ディメンション値の数が |
metricAggregations[] |
省略可。指標の集計。集計された指標値は、dimensionValue が「RESERVED_(MetricAggregation)」に設定されている行に表示されます。 |
orderBys[] |
省略可。レスポンス内の行の順序を指定します。 |
currencyCode |
省略可。ISO4217 形式の通貨コード(「AED」、「USD」、「JPY」など)。このフィールドが空の場合、レポートではプロパティのデフォルトの通貨が使用されます。 |
cohortSpec |
省略可。このリクエストに関連付けられているコホート グループ。リクエストにコホート グループがある場合は、「コホート」ディメンションを指定する必要があります。 |
keepEmptyRows |
省略可。false または指定されていない場合、すべての指標が 0 に等しい各行は返されません。true の場合、これらの行がフィルタによって個別に削除されない場合に返されます。 この たとえば、あるプロパティで |
ディメンション
ディメンションはデータの属性です。たとえば、ディメンション「city」はイベントが発生した都市を示します。レポートのレスポンスのディメンション値は文字列です。たとえば、都市は「パリ」や「ニューヨーク」です。
JSON 表現 |
---|
{
"name": string,
"dimensionExpression": {
object ( |
フィールド | |
---|---|
name |
ディメンションの名前。
ディメンションは、 |
dimensionExpression |
1 つのディメンションは、複数のディメンションの式の結果になることがあります。たとえば、ディメンション「country, city」の場合は concatenate(country, ", ", city)。 |
DimensionExpression
複数のディメンションの式の結果であるディメンションを表現するために使用します。使用例: 1)lowerCase(dimension) 2) concatenate(dimension1, symbol, dimension2)。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド one_expression 。DimensionExpression に 1 つのディメンション式を指定します。one_expression は次のいずれかになります。 |
|
lowerCase |
ディメンション値を小文字に変換するために使用します。 |
upperCase |
ディメンション値を大文字に変換するために使用します。 |
concatenate |
ディメンション値を 1 つのディメンションにまとめるために使用します。たとえば、ディメンション「country, city」の場合は concatenate(country, ", ", city)。 |
CaseExpression
ディメンション値を 1 つの大文字 / 小文字に変換するために使用します。
JSON 表現 |
---|
{ "dimensionName": string } |
フィールド | |
---|---|
dimensionName |
ディメンションの名前。この名前は、リクエストのディメンション フィールド内の名前を参照する必要があります。 |
ConcatenateExpression
ディメンション値を 1 つのディメンションにまとめるために使用します。
JSON 表現 |
---|
{ "dimensionNames": [ string ], "delimiter": string } |
フィールド | |
---|---|
dimensionNames[] |
ディメンションの名前。この名前は、リクエストのディメンション フィールド内の名前を参照する必要があります。 |
delimiter |
ディメンション名の間に配置される区切り文字。 区切り文字は多くの場合、| や "," などの 1 文字ですが、より長い文字列にすることもできます。ディメンション値に区切り文字が含まれている場合は、レスポンスに両方が区別なく含まれます。たとえば、ディメンション 1 の値が「US,FR」、ディメンション 2 の値が「JP」、区切り文字が「,」の場合、レスポンスには「US,FR,JP」が含まれます。 |
指標
レポートの定量的測定値。たとえば、指標 eventCount
はイベントの合計数です。リクエストは最大 10 個の指標を使用できます。
JSON 表現 |
---|
{ "name": string, "expression": string, "invisible": boolean } |
フィールド | |
---|---|
name |
指標の名前。
指標は、 |
expression |
派生指標の数式。たとえば、ユーザーあたりのイベント数の指標は |
invisible |
レポートのレスポンスに指標が表示されないかどうかを示します。指標が表示されない場合、その指標はレスポンスに列を生成しませんが、 |
DateRange
連続する日付セット: startDate
、startDate + 1
、...、endDate
。リクエストは最大 4 つの期間を指定できます。
JSON 表現 |
---|
{ "startDate": string, "endDate": string, "name": string } |
フィールド | |
---|---|
startDate |
クエリの開始日(この日付を含む)。 |
endDate |
クエリの終了日(両端を含む)。 |
name |
この期間に名前を割り当てます。レポート レスポンスでは、ディメンション |
FilterExpression
ディメンション フィルタまたは指標フィルタを表現するため。同じ FilterExpression 内のフィールドは、すべてのディメンションまたはすべての指標である必要があります。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド expr 。FilterExpression に 1 種類のフィルタ式を指定します。expr は次のいずれかになります。 |
|
andGroup |
andGroup の FilterExpressions は AND 関係です。 |
orGroup |
orGroup の FilterExpressions は OR 関係にあります。 |
notExpression |
FilterExpression が notExpression の NOT である。 |
filter |
プリミティブ フィルタ。同じ FilterExpression で、フィルタのフィールド名はすべて、すべてのディメンションまたはすべての指標にする必要があります。 |
FilterExpressionList
フィルタ式のリスト。
JSON 表現 |
---|
{
"expressions": [
{
object ( |
フィールド | |
---|---|
expressions[] |
フィルタ式のリスト。 |
フィルタ
ディメンションまたは指標の値をフィルタする式。
JSON 表現 |
---|
{ "fieldName": string, // Union field |
フィールド | |
---|---|
fieldName |
ディメンション名または指標名。ディメンションまたは指標で定義された名前を指定する必要があります。 |
共用体フィールド one_filter 。Filter のフィルタの種類を 1 つ指定します。one_filter は次のいずれかになります。 |
|
stringFilter |
文字列関連のフィルタ。 |
inListFilter |
リスト内の値のフィルタ。 |
numericFilter |
数値または日付の値のフィルタ。 |
betweenFilter |
2 つの値の間のフィルタ。 |
StringFilter
文字列のフィルタ
JSON 表現 |
---|
{
"matchType": enum ( |
フィールド | |
---|---|
matchType |
このフィルタのマッチタイプ。 |
value |
照合に使用される文字列値。 |
caseSensitive |
true の場合、文字列値の大文字と小文字は区別されます。 |
MatchType
文字列フィルタのマッチタイプ
列挙型 | |
---|---|
MATCH_TYPE_UNSPECIFIED |
未指定 |
EXACT |
文字列値との完全一致。 |
BEGINS_WITH |
文字列値で始まります。 |
ENDS_WITH |
文字列値で終わる。 |
CONTAINS |
文字列値が含まれます。 |
FULL_REGEXP |
正規表現と文字列値との完全一致。 |
PARTIAL_REGEXP |
正規表現と文字列値との部分一致。 |
InListFilter
結果は文字列値のリストに入っている必要があります。
JSON 表現 |
---|
{ "values": [ string ], "caseSensitive": boolean } |
フィールド | |
---|---|
values[] |
文字列値のリスト。空でない必要があります。 |
caseSensitive |
true の場合、文字列値の大文字と小文字は区別されます。 |
NumericFilter
数値または日付の値をフィルタします。
JSON 表現 |
---|
{ "operation": enum ( |
フィールド | |
---|---|
operation |
このフィルタのオペレーション タイプ。 |
value |
数値または日付値。 |
オペレーション
数値フィルタに適用される演算
列挙型 | |
---|---|
OPERATION_UNSPECIFIED |
(指定なし) |
EQUAL |
等しい |
LESS_THAN |
次より小さい |
LESS_THAN_OR_EQUAL |
次の値以下 |
GREATER_THAN |
次の値を上回る |
GREATER_THAN_OR_EQUAL |
次の値以上 |
NumericValue
数値を表すため。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド one_value 。数値 one_value には次のいずれか 1 つだけを指定できます。 |
|
int64Value |
整数値 |
doubleValue |
double 値 |
BetweenFilter
結果が 2 つの数値の間にある必要があることを示す場合。
JSON 表現 |
---|
{ "fromValue": { object ( |
フィールド | |
---|---|
fromValue |
この番号で始まります。 |
toValue |
末尾がこの番号。 |
MetricAggregation
指標の集計を表します。
列挙型 | |
---|---|
METRIC_AGGREGATION_UNSPECIFIED |
演算子が指定されていません。 |
TOTAL |
SUM 演算子。 |
MINIMUM |
最小演算子。 |
MAXIMUM |
最大の演算子。 |
COUNT |
カウント演算子。 |
OrderBy
Order by は、レスポンスで行がどのように並べ替えられるかを定義します。たとえば、イベント数の降順で行を並べ替えると、イベント名の文字列で行を並べ替えると、異なる順序になります。
JSON 表現 |
---|
{ "desc": boolean, // Union field |
フィールド | |
---|---|
desc |
true の場合、降順で並べ替えます。 |
共用体フィールド one_order_by 。OrderBy に対して 1 つの順序を指定します。one_order_by は次のいずれかになります。 |
|
metric |
結果を指標の値で並べ替えます。 |
dimension |
ディメンションの値で結果を並べ替えます。 |
MetricOrderBy
指標値で並べ替えます。
JSON 表現 |
---|
{ "metricName": string } |
フィールド | |
---|---|
metricName |
並べ替えるリクエストの指標名。 |
DimensionOrderBy
ディメンションの値で並べ替えます。
JSON 表現 |
---|
{
"dimensionName": string,
"orderType": enum ( |
フィールド | |
---|---|
dimensionName |
並べ替えるリクエスト内のディメンション名。 |
orderType |
ディメンションの値の順序に関するルールを制御します。 |
OrderType
文字列ディメンションの値を並べ替えるためのルール。
列挙型 | |
---|---|
ORDER_TYPE_UNSPECIFIED |
(指定なし) |
ALPHANUMERIC |
Unicode コードポイントによる英数字の並べ替え。例: "2" < "A" < "X" < "b" < "z"。 |
CASE_INSENSITIVE_ALPHANUMERIC |
大文字と小文字を区別しない英数字を、小文字の Unicode コードポイントで並べ替えます。例: "2" < "A" < "b" < "X" < "z"。 |
NUMERIC |
ディメンション値は並べ替え前に数値に変換されます。たとえば、NUMERIC 並べ替えでは "25" < "100"、ALPHANUMERIC 並べ替えでは "100" < "25" です。数値以外のディメンション値はすべて、すべての数値の下の同じ順序値です。 |
CohortSpec
コホート レポートのコホートの仕様。
コホート レポートでは、コホートのユーザー維持率の時系列が作成されます。たとえば、9 月の第 1 週に獲得したユーザーのコホートを選択して、そのコホートを次の 6 週間フォローします。9 月のコホートの最初の週に獲得したユーザーの選択は、cohort
オブジェクトで指定します。その後、次の 6 週間のコホートを cohortsRange
オブジェクトで指定します。
例については、コホート レポートの例をご覧ください。
レポートの回答では、アプリがこのコホートの 60% を 3 週間後に、このコホートの 25% が 6 週間後に保持しているという週単位の時系列を表示できます。この 2 つの割合は指標 cohortActiveUsers/cohortTotalUsers
で計算でき、レポートでは別々の行に表示されます。
JSON 表現 |
---|
{ "cohorts": [ { object ( |
フィールド | |
---|---|
cohorts[] |
ユーザーをコホートにグループ化するための選択条件を定義します。 ほとんどのコホート レポートでは、定義されるコホートは 1 つのみです。複数のコホートを指定すると、レポートで各コホートを名前で識別できます。 |
cohortsRange |
コホート レポートは、レポートの期間を延長したものです。この範囲では、コホートを追跡するオフセット期間を指定します。 |
cohortReportSettings |
コホート レポートのオプション設定。 |
コホート
コホートの選択基準を定義します。コホートとは、共通の特性を持つユーザーのグループです。たとえば、firstSessionDate
が同じユーザーは同じコホートに属します。
JSON 表現 |
---|
{
"name": string,
"dimension": string,
"dateRange": {
object ( |
フィールド | |
---|---|
name |
このコホートに名前を割り当てます。レポート レスポンスでは、ディメンション |
dimension |
コホートで使用されるディメンション。必須。 |
dateRange |
コホートでは、最初の接触日が コホート リクエストでは、この 通常、この |
CohortsRange
コホート レポートの拡張レポート期間を設定します。コホートを追跡するオフセット期間を指定します。
JSON 表現 |
---|
{
"granularity": enum ( |
フィールド | |
---|---|
granularity |
必須。コホート レポートの拡張レポートの期間の |
startOffset |
|
endOffset |
必須。
|
粒度
コホート レポートの拡張レポートの期間の startOffset
と endOffset
の解釈に使用する粒度。
列挙型 | |
---|---|
GRANULARITY_UNSPECIFIED |
指定しないでください。 |
DAILY |
日単位の粒度。一般的に、コホートの dateRange が 1 日で、リクエストに cohortNthDay が含まれている場合に使用されます。 |
WEEKLY |
週単位の粒度。一般的に、コホートの dateRange が 1 週間(日曜日から土曜日まで)で、リクエストに cohortNthWeek が含まれている場合に使用されます。 |
MONTHLY |
月単位の粒度。一般的に、コホートの dateRange の期間が 1 か月で、リクエストに cohortNthMonth が含まれている場合に使用されます。 |
CohortReportSettings
コホート レポートのオプション設定。
JSON 表現 |
---|
{ "accumulate": boolean } |
フィールド | |
---|---|
accumulate |
true の場合、最初の接触日から終了日までの結果が累積されます。 |
ReportMetadata
特定のレポートタスクのレポート メタデータ。
JSON 表現 |
---|
{
"creationQuotaTokensCharged": integer,
"state": enum ( |
フィールド | |
---|---|
creationQuotaTokensCharged |
出力専用。レポートの作成中に請求されたトークン割り当て量の合計。このトークン数は |
state |
出力専用。このレポートタスクの現在の状態。 |
beginCreatingTime |
出力専用。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
taskRowCount |
出力専用。レポート結果の総行数。このフィールドは、状態がアクティブになると入力されます。 |
errorMessage |
出力専用。エラー メッセージは、作成中にレポートタスクが失敗した場合に入力されます。 |
totalRowCount |
出力専用。Google アナリティクスのストレージ内の行数の合計。現在のレポート以外の追加のデータ行に対してクエリを実行する場合は、
たとえば、現在のレポートの |
状態
処理状態。
列挙型 | |
---|---|
STATE_UNSPECIFIED |
未指定の状態は使用されません。 |
CREATING |
このレポートは現在作成中で、今後利用可能になる予定です。作成は、CreateReport 呼び出しの直後に行われます。 |
ACTIVE |
レポートが完全に作成され、クエリを行う準備が整いました。 |
FAILED |
レポートを作成できませんでした。 |
メソッド |
|
---|---|
|
レポートタスクの作成を開始します。 |
|
特定のレポートタスクに関するレポート メタデータを取得します。 |
|
プロパティのすべてのレポートタスクを一覧表示します。 |
|
レポートタスクの内容を取得します。 |