Pivot Tables

PivotTable

ピボット テーブル。

JSON 表現 
{
  "rows": [
    {
      object (PivotGroup)
    }
  ],
  "columns": [
    {
      object (PivotGroup)
    }
  ],
  "criteria": {
    integer: {
      object (PivotFilterCriteria)
    },
    ...
  },
  "filterSpecs": [
    {
      object (PivotFilterSpec)
    }
  ],
  "values": [
    {
      object (PivotValue)
    }
  ],
  "valueLayout": enum (PivotValueLayout),
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  },

  // Union field source_data can be only one of the following:
  "source": {
    object (GridRange)
  },
  "dataSourceId": string
  // End of list of possible types for union field source_data.
}
フィールド
rows[]

object (PivotGroup)

ピボット テーブル内の各行グループ。
columns[]

object (PivotGroup)

ピボット テーブル内の各列のグループ化。
criteria
(deprecated)

map (key: integer, value: object ( PivotFilterCriteria))

ソース列オフセットごとのフィルタのマッピング（省略可）。

フィルタは、データをピボット テーブルに集計する前に適用されます。マップのキーは、フィルタするソース範囲の列オフセットで、値はその列の条件です。

たとえば、ソースが C10:E15 の場合、0 のキーには列 C のフィルタが含まれ、1 のキーには列 D のフィルタが含まれます。

このフィールドは非推奨になりました。代わりに filterSpecs を使用してください。
filterSpecs[]

object (PivotFilterSpec)

ピボット テーブルのデータの集計前にソース列に適用されたフィルタ。

レスポンスには criteria と filterSpecs の両方が入力されます。更新リクエストで両方のフィールドが指定されている場合、このフィールドが優先されます。
values[]

object (PivotValue)

ピボット テーブルに含める値のリスト。
valueLayout

enum (PivotValueLayout)

値を横方向（列として）に表示するか、縦方向（行として）に表示するか。

dataExecutionStatus

object (DataExecutionStatus)

出力専用。データソースのピボット テーブルのデータ実行ステータス。
共用体フィールド source_data。ピボット テーブルのデータのソース。source_data は次のいずれかになります。
source

object (GridRange)

ピボット テーブルがデータを読み取る範囲。
dataSourceId

string

ピボット テーブルがデータを読み取るデータソースの ID。

PivotGroup

ピボット テーブル内の 1 つのグループ（行または列）。

JSON 表現 
{
  "showTotals": boolean,
  "valueMetadata": [
    {
      object (PivotGroupValueMetadata)
    }
  ],
  "sortOrder": enum (SortOrder),
  "valueBucket": {
    object (PivotGroupSortValueBucket)
  },
  "repeatHeadings": boolean,
  "label": string,
  "groupRule": {
    object (PivotGroupRule)
  },
  "groupLimit": {
    object (PivotGroupLimit)
  },

  // Union field source can be only one of the following:
  "sourceColumnOffset": integer,
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
  // End of list of possible types for union field source.
}
フィールド
showTotals

boolean

ピボット テーブルにこのグループの合計を含める場合は true にします。
valueMetadata[]

object (PivotGroupValueMetadata)

グループ内の値に関するメタデータ。
sortOrder

enum (SortOrder)

このグループ内の値の並べ替え順序。
valueBucket

object (PivotGroupSortValueBucket)

並べ替える反対側のピボット グループのバケット。指定しない場合、このグループの値でアルファベット順に並べ替えられます。
repeatHeadings

boolean

このピボット グループの見出しを繰り返す必要がある場合は true にします。これは行のグループ化にのみ有効で、列では無視されます。

デフォルトでは、同じレベルの見出しが重複している場合は、上位レベルの見出しは表示されません。これにより、見出しの重複を最小限に抑えています。たとえば、下の 3 番目の行は「Q1 3 月」に対応していますが、「Q1」は前の行と重複するため表示されません。repeatHeadings を true に設定すると、「Q1」が「2 月」と「3 月」に繰り返されます。 

+--------------+
| Q1     | Jan |
|        | Feb |
|        | Mar |
+--------+-----+
| Q1 Total     |
+--------------+
label

string

カスタマイズ可能な行/列グループに使用するラベル。たとえば、次のピボット テーブルでは、行ラベルは Region（State に変更可能）で、列ラベルは Product（Item に変更可能）です。2017 年 12 月より前に作成されたピボット テーブルにはヘッダーラベルがありません。既存のピボット テーブルにヘッダーラベルを追加する場合は、既存のピボット テーブルを削除してから、同じパラメータで新しいピボット テーブルを作成してください。 

+--------------+---------+-------+
| SUM of Units | Product |       |
| Region       | Pen     | Paper |
+--------------+---------+-------+
| New York     |     345 |    98 |
| Oregon       |     234 |   123 |
| Tennessee    |     531 |   415 |
+--------------+---------+-------+
| Grand Total  |    1110 |   636 |
+--------------+---------+-------+
groupRule

object (PivotGroupRule)

この行/列グループに適用するグループルール。
groupLimit

object (PivotGroupLimit)

このピボット グループに適用する行または列のカウントの上限。

共用体フィールド source。ピボット グループのデータソース。source は次のいずれかになります。
sourceColumnOffset

integer

このグループ化のベースとなるソース範囲の列オフセット。

たとえば、ソースが C10:E15 の場合、0 の sourceColumnOffset は、このグループが列 C を参照することを意味します。一方、オフセット 1 は列 D を参照します。
dataSourceColumnReference

object (DataSourceColumnReference)

このグループ化の基になるデータソース列への参照。

PivotGroupValueMetadata

ピボット グループ内の値に関するメタデータ。

JSON 表現 
{
  "value": {
    object (ExtendedValue)
  },
  "collapsed": boolean
}
フィールド
value

object (ExtendedValue)

メタデータに対応する計算値。（値は計算されるため、formulaValue は有効ではありません）。
collapsed

boolean

値に対応するデータが折りたたまれている場合は true。

PivotGroupSortValueBucket

ピボット グループ内のどの値をソートに使用するかに関する情報。

JSON 表現 
{
  "valuesIndex": integer,
  "buckets": [
    {
      object (ExtendedValue)
    }
  ]
}
フィールド
valuesIndex

integer

このグループ内の値を並べ替える PivotTable.values リスト内のオフセット。
buckets[]

object (ExtendedValue)

並べ替える値を選択するバケットを決定します。

たとえば、行グループが 1 つ、列グループが 2 つのピボット テーブルでは、行グループに最大 2 つの値を表示できます。最初の値は最初の列グループ内の値に対応し、2 番目の値は 2 番目の列グループ内の値に対応します。値が表示されない場合は、列グループの「合計」に従って行を並べ替える必要があります。単一の値がリストされている場合は、そのバケットの「合計」を使用します。

PivotGroupRule

PivotGroup のオプション設定。個々の値を分割するのではなく、ソースデータ列の値のバケットを定義します。ソースデータの列ごとに、グループルールを含む PivotGroup を 1 つだけ追加できます。ただし、特定の列には、ルールを含む PivotGroup とルールを含まない PivotGroup の両方を追加できます。

JSON 表現 
{

  // Union field rule can be only one of the following:
  "manualRule": {
    object (ManualRule)
  },
  "histogramRule": {
    object (HistogramRule)
  },
  "dateTimeRule": {
    object (DateTimeRule)
  }
  // End of list of possible types for union field rule.
}
フィールド
共用体フィールド rule。PivotGroup に適用するルール。rule は次のいずれかになります。
manualRule

object (ManualRule)

ManualRule。
histogramRule

object (HistogramRule)

HistogramRule。
dateTimeRule

object (DateTimeRule)

DateTimeRule。

ManualRule

ソースデータ列の値を手動で、任意の名前のバケットに整理できます。たとえば、州別に人口を集計したピボット テーブルは次のようになります。

+-------+-------------------+
| State | SUM of Population |
+-------+-------------------+
| AK    |               0.7 |
| AL    |               4.8 |
| AR    |               2.9 |
...
+-------+-------------------+

手動グループルールにグループのリスト（例: groupName = 'Central', items = ['AL', 'AR', 'IA', ...]）を指定すると、時差別に人口を集計するピボット テーブルに変換できます。同様の効果は、ソースデータにタイムゾーン列を追加してピボット テーブルを調整することでも実現できます。

+-----------+-------------------+
| Time Zone | SUM of Population |
+-----------+-------------------+
| Central   |             106.3 |
| Eastern   |             151.9 |
| Mountain  |              17.4 |
...
+-----------+-------------------+
JSON 表現 
{
  "groups": [
    {
      object (ManualRuleGroup)
    }
  ]
}
フィールド
groups[]

object (ManualRuleGroup)

グループ名のリストと、各グループ名にマッピングされるソースデータの対応する項目。

ManualRuleGroup

グループ名と、この名前のグループに配置するソースデータの項目のリスト。

JSON 表現 
{
  "groupName": {
    object (ExtendedValue)
  },
  "items": [
    {
      object (ExtendedValue)
    }
  ]
}
フィールド
groupName

object (ExtendedValue)

グループ名。文字列にする必要があります。特定の ManualRule 内の各グループには、一意のグループ名が必要です。
items[]

object (ExtendedValue)

このグループに配置するソースデータ内のアイテム。各項目は文字列、数値、ブール値のいずれかです。アイテムは、特定の ManualRule 内のグループに最大 1 つ表示できます。どのグループにも表示されないアイテムは、単独で表示されます。

HistogramRule

ソースデータ列の数値を一定サイズのバケットに整理できます。HistogramRule.start～HistogramRule.end のすべての値は、サイズ HistogramRule.interval のグループに配置されます。また、HistogramRule.start 未満の値はすべて 1 つのグループに、HistogramRule.end を超える値はすべて別のグループに配置されます。HistogramRule.interval のみが必須ですが、HistogramRule.start と HistogramRule.end の両方を指定する場合は、HistogramRule.start が HistogramRule.end より小さくする必要があります。たとえば、年齢別の平均購入金額を示すピボット テーブルで、行数が 50 を超えている場合:

+-----+-------------------+
| Age | AVERAGE of Amount |
+-----+-------------------+
| 16  |            $27.13 |
| 17  |             $5.24 |
| 18  |            $20.15 |
...
+-----+-------------------+

HistogramRule.start が 25、HistogramRule.interval が 20、HistogramRule.end が 65 のヒストグラム グループルールを適用すると、次のピボット テーブルに変換できます。

+-------------+-------------------+
| Grouped Age | AVERAGE of Amount |
+-------------+-------------------+
| < 25        |            $19.34 |
| 25-45       |            $31.43 |
| 45-65       |            $35.87 |
| > 65        |            $27.55 |
+-------------+-------------------+
| Grand Total |            $29.12 |
+-------------+-------------------+
JSON 表現 
{
  "interval": number,
  "start": number,
  "end": number
}
フィールド
interval

number

作成されるバケットのサイズ。正の値を指定してください。
start

number

アイテムが一定サイズのバケットに配置される最小値。開始値より小さい値は 1 つのバケットにまとめられます。このフィールドは省略可能です。
end

number

アイテムが一定サイズのバケットに配置される最大値。終了値を超える値は 1 つのバケットにまとめられます。このフィールドは省略可能です。

DateTimeRule

ソースデータ列の日時値を、日付値または時刻値の選択した部分に基づいてバケットに整理できます。たとえば、日付別の販売トランザクションを示すピボット テーブルについて考えてみましょう。

+----------+--------------+
| Date     | SUM of Sales |
+----------+--------------+
| 1/1/2017 |      $621.14 |
| 2/3/2017 |      $708.84 |
| 5/8/2017 |      $326.84 |
...
+----------+--------------+

DateTimeRuleType が YEAR_MONTH の日時グループルールを適用すると、次のピボット テーブルが作成されます。

+--------------+--------------+
| Grouped Date | SUM of Sales |
+--------------+--------------+
| 2017-Jan     |   $53,731.78 |
| 2017-Feb     |   $83,475.32 |
| 2017-Mar     |   $94,385.05 |
...
+--------------+--------------+
JSON 表現 
{
  "type": enum (DateTimeRuleType)
}
フィールド
type

enum (DateTimeRuleType)

適用する日時のグループ化の種類。

DateTimeRuleType

使用可能な日時のグループ化ルールの種類。このドキュメントでは、スプレッドシートのロケールが「en-US」であることを前提としています。ただし、日時を実際にレンダリングする際は、一部のルールタイプでスプレッドシートのロケールが使用されます。

列挙型
DATE_TIME_RULE_TYPE_UNSPECIFIED デフォルト タイプ。使用しないでください。
SECOND 日付を秒単位（0 ～ 59）でグループ化します。
MINUTE 日付を分単位（0 ～ 59）でグループ化します。
HOUR 24 時間制（0 ～ 23）で日付を時間単位でグループ化します。
HOUR_MINUTE 24 時間制（19:45 など）を使用して、日付を時間と分単位でグループ化します。
HOUR_MINUTE_AMPM 12 時間制の時刻（午後 7 時 45 分など）を使用して、日付を時間と分単位でグループ化します。午前/午後の指定は、スプレッドシートのロケールに基づいて変換されます。
DAY_OF_WEEK 日曜日など、曜日別に日付をグループ化します。曜日は、スプレッドシートの言語 / 地域に基づいて翻訳されます。
DAY_OF_YEAR 日付を 1 ～ 366 の年の日付でグループ化します。2 月 29 日以降の日付は、うるう年とうるう年でない年で異なるバケットに分類されます。
DAY_OF_MONTH 日付を 1 ～ 31 の月日別にグループ化します。
DAY_MONTH 日付を日と月でグループ化します（例: 22-Nov）。月はスプレッドシートの言語 / 地域に基づいて翻訳されます。
MONTH 日付を月別（11 月など）にグループ化します。月はスプレッドシートの言語 / 地域に基づいて翻訳されます。
QUARTER 日付を四半期ごとにグループ化します（例: Q1（1 月～ 3 月））。
YEAR 日付を年（2008 年など）でグループ化します。
YEAR_MONTH 日付を年と月でグループ化します（例: 2008-11）。月はスプレッドシートの言語 / 地域に基づいて変換されます。
YEAR_QUARTER 日付を年と四半期（2008 年第 4 四半期など）でグループ化します。
YEAR_MONTH_DAY 日付を年、月、日でグループ化します（例: 2008-11-22）。

PivotGroupLimit

ピボット グループ内の行または列のカウントの上限。

JSON 表現 
{
  "countLimit": integer,
  "applyOrder": integer
}
フィールド
countLimit

integer

カウントの上限。

applyOrder

integer

グループの上限がピボット テーブルに適用される順序。

ピボット グループの上限は、低い桁から高い桁に適用されます。注文番号は、0 から連続する整数に正規化されます。

書き込みリクエストで適用オーダーを完全にカスタマイズするには、すべてのピボット グループの上限にこのフィールドに一意の数値を設定する必要があります。それ以外の場合は、PivotTable.rows リストのインデックスと PivotTable.columns リストのインデックスによって順序が決まります。

PivotFilterCriteria

ピボット テーブルの行を表示または非表示にする条件。

JSON 表現 
{
  "visibleValues": [
    string
  ],
  "condition": {
    object (BooleanCondition)
  },
  "visibleByDefault": boolean
}
フィールド
visibleValues[]

string

含める必要がある値。ここに記載されていない値は除外されます。

condition

object (BooleanCondition)

値を表示するために満たす必要がある条件。（visibleValues はこれをオーバーライドしません。値がリストに含まれていても、条件を満たさない場合は非表示になります）。

A1 表記の範囲を参照する条件値は、ピボット テーブル シートを基準に評価されます。参照は絶対値として扱われるため、ピボット テーブルに下方向に入力されません。たとえば、「ピボット テーブル 1」の条件値 =A1 は 'Pivot Table 1'!$A$1 として扱われます。

ピボット テーブルのソースデータは、列ヘッダー名で参照できます。たとえば、ソースデータに「収益」と「費用」という名前の列があり、「収益」列にタイプ NUMBER_GREATER と値 =Cost の条件が適用されている場合、「収益」>「費用」の列のみが含まれます。
visibleByDefault

boolean

デフォルトで値を表示するかどうか。true の場合、visibleValues は無視され、condition（指定されている場合）に一致するすべての値が表示されます。false の場合、visibleValues に含まれ、かつ condition を満たす値が表示されます。

PivotFilterSpec

特定のソース列オフセットに関連付けられたピボット テーブルのフィルタ条件。

JSON 表現 
{
  "filterCriteria": {
    object (PivotFilterCriteria)
  },

  // Union field source can be only one of the following:
  "columnOffsetIndex": integer,
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
  // End of list of possible types for union field source.
}
フィールド
filterCriteria

object (PivotFilterCriteria)

列の条件。

共用体フィールド source。このフィルタが適用されるソース列。source は次のいずれかになります。
columnOffsetIndex

integer

ソース範囲のゼロベースの列オフセット。
dataSourceColumnReference

object (DataSourceColumnReference)

データソース列への参照。

PivotValue

ピボット テーブルの値の計算方法の定義。

JSON 表現 
{
  "summarizeFunction": enum (PivotValueSummarizeFunction),
  "name": string,
  "calculatedDisplayType": enum (PivotValueCalculatedDisplayType),

  // Union field value can be only one of the following:
  "sourceColumnOffset": integer,
  "formula": string,
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
  // End of list of possible types for union field value.
}
フィールド
summarizeFunction

enum (PivotValueSummarizeFunction)

値を要約する関数。formula が設定されている場合、サポートされる値は SUM と CUSTOM のみです。sourceColumnOffset が設定されている場合、CUSTOM はサポートされません。
name

string

値に使用する名前。
calculatedDisplayType

enum (PivotValueCalculatedDisplayType)

指定すると、ピボット値が別のピボット値を使用した計算の結果として表示されます。たとえば、calculatedDisplayType が PERCENT_OF_GRAND_TOTAL に指定されている場合、すべてのピボット値は合計に対する割合として表示されます。スプレッドシート エディタでは、ピボット テーブルの値セクションで [表示形式] と呼ばれます。

共用体フィールド value。ピボット テーブルの値に使用するデータ。必ず 1 つの値を設定する必要があります。 value は次のいずれかになります。
sourceColumnOffset

integer

この値が読み取るソース範囲の列オフセット。

たとえば、ソースが C10:E15 の場合、0 の sourceColumnOffset は、この値が列 C を参照することを意味します。一方、オフセット 1 は列 D を参照します。
formula

string

値を計算するカスタム数式。式の先頭は = 文字にする必要があります。
dataSourceColumnReference

object (DataSourceColumnReference)

この値が読み取るデータソース列への参照。

PivotValueSummarizeFunction

ピボット値を要約する関数。

列挙型
PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED デフォルト。使用しないでください。
SUM SUM 関数に対応します。
COUNTA COUNTA 関数に対応します。
COUNT COUNT 関数に対応します。
COUNTUNIQUE COUNTUNIQUE 関数に対応しています。
AVERAGE AVERAGE 関数に対応しています。
MAX MAX 関数に対応しています。
MIN MIN 関数に対応します。
MEDIAN MEDIAN 関数に対応しています。
PRODUCT PRODUCT 関数に対応します。
STDEV STDEV 関数に対応します。
STDEVP STDEVP 関数に対応しています。
VAR VAR 関数に対応します。
VARP VARP 関数に対応します。
CUSTOM 数式をそのまま使用することを示します。PivotValue.formula が設定されている場合にのみ有効です。
NONE 値がすでに要約されており、要約関数が明示的に指定されていないことを示します。値がすでに集計されている Looker データソースのピボット テーブルに使用されます。

PivotValueCalculatedDisplayType

ピボット値を表示するために計算できる方法。

列挙型
PIVOT_VALUE_CALCULATED_DISPLAY_TYPE_UNSPECIFIED デフォルト値。使用しないでください。
PERCENT_OF_ROW_TOTAL ピボット値を行合計値の割合として表示します。
PERCENT_OF_COLUMN_TOTAL ピボット値を列の合計値の割合として表示します。
PERCENT_OF_GRAND_TOTAL ピボット値を総合計値の割合として表示します。

PivotValueLayout

ピボット値のレイアウト。

列挙型
HORIZONTAL 値は横方向（列として）に配置されます。
VERTICAL 値は縦方向（行として）に配置されます。