Pivot Tables

{
  "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.
}

object (PivotGroup)

資料透視表中的每個資料列分組。

object (PivotGroup)

資料透視表中的每個欄分組。

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

可選擇是否在每個來源資料欄偏移的篩選器對應。

系統會先套用篩選器，再將資料匯總至資料透視表。地圖鍵是您要篩選的來源範圍的資料欄偏移值，這個值則為該資料欄的條件。

舉例來說，如果來源為 C10:E15，則 0 的索引鍵將會有 C 欄的篩選器，鍵 1 則代表 D 欄。

這個欄位已淘汰，並改用 filterSpecs。

object (PivotFilterSpec)

系統會先對來源資料欄套用篩選器，再匯總資料透視表的資料。

在回應中，系統會填入 criteria 和 filterSpecs。如果在更新要求中同時指定這兩個欄位，系統會優先採用這個欄位。

object (PivotValue)

要在資料透視表中加入的值清單。

enum (PivotValueLayout)

是否應水平或垂直列出這些值 (以欄的形式) 列出。

object (DataExecutionStatus)

僅供輸出。資料來源資料透視表的資料執行狀態。

object (GridRange)

資料透視表讀取的資料範圍。

string

資料透視表會從其中讀取資料的資料來源 ID。

{
  "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.
}

boolean

如果資料透視表包含此分組的總計，則為 True。

object (PivotGroupValueMetadata)

分類中值的中繼資料。

enum (SortOrder)

這個群組中的值應排序。

object (PivotGroupSortValueBucket)

要套用反向資料透視表群組的值區。如果未指定，會依照這個群組的值依字母順序排序。

boolean

如果此資料透視表中的標題應重複，則為 True。這僅適用於列分組，且遭到欄忽略。

根據預設，我們會盡量避免重複標題，而不會顯示相同的標題。例如，即使第三列與「Q1 月第 1 季」對應，但「Q1」和先前的資料列重複，因此不會顯示。將重複標題設為 true 時，「2」和「3」都會重複「Q1」。

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

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 |
+--------------+---------+-------+

object (PivotGroupRule)

要套用至這個資料列/資料欄群組的群組規則。

object (PivotGroupLimit)

要套用至這個資料透視表的資料列或資料欄數量限制。

integer

這個分組依據的來源範圍的資料欄偏移。

舉例來說，如果來源為 C10:E15，則 0 的 sourceColumnOffset 代表這個群組參照了 C 欄，而偏移 1 參照 D 欄。

object (DataSourceColumnReference)

這個分組依據的資料來源欄參照。

{
  "value": {
    object (ExtendedValue)
  },
  "collapsed": boolean
}

object (ExtendedValue)

中繼資料對應的計算值。請注意，formulaValue 無效，因為系統會計算值。

boolean

如果與值對應的資料已收合，則為 True。

{
  "valuesIndex": integer,
  "buckets": [
    {
      object (ExtendedValue)
    }
  ]
}

integer

PivotTable.values 清單中的偏移值，此分組中的值應排序。

object (ExtendedValue)

決定要排序的值所屬的值區。

舉例來說，如果資料透視表中有一個資料列群組和兩個欄群組，則資料列群組最多可以列出兩個值。第一個值會對應至第一個資料欄群組的值，第二個值則對應至第二個資料欄群組的值。如未列出任何值，表示資料列應根據資料欄群組的「總計」排序資料。如果只列出一個值，這個值就會反映該值區的「總計」值。

{

  // 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.
}

object (ManualRule)

ManualRule。

object (HistogramRule)

HistogramRule。

object (DateTimeRule)

DateTimeRule。

{
  "groups": [
    {
      object (ManualRuleGroup)
    }
  ]
}

object (ManualRuleGroup)

群組名稱清單，以及來源資料中對應至各個群組名稱的對應項目。

{
  "groupName": {
    object (ExtendedValue)
  },
  "items": [
    {
      object (ExtendedValue)
    }
  ]
}

object (ExtendedValue)

群組名稱，必須是字串。特定 ManualRule 中的每個群組都必須有不重複的群組名稱。

object (ExtendedValue)

來源資料中應加入這個群組的項目。每個項目都可以是字串、數字或布林值。特定 ManualRule 中的項目最多可能會顯示在一個群組中。不屬於任何群組的項目都會自行顯示。

{
  "interval": number,
  "start": number,
  "end": number
}

number

建立的值區大小，必須為正數。

number

將項目放在固定大小的值區中的最小值。下方值會展開為單一值區。這是選填欄位。

number

項目固定於常數大小範圍內的最大值。系統會將上方值加總為單一值區。這是選填欄位。

{
  "type": enum (DateTimeRuleType)
}

enum (DateTimeRuleType)

要套用的日期時間分組類型。

{
  "countLimit": integer,
  "applyOrder": integer
}

integer

數量限制。

integer

資料透視表套用群組限制的順序。

資料透視表的限制會由較低至較高的訂單編號套用。訂單編號會標準化為 0 中的連續整數。

針對寫入要求，如要完整自訂套用的訂單，所有資料透視表群組均應設定不重複的數字。否則，順序取決於 PivotTable.rows 清單中的索引，然後是 PivotTable.columns 清單。

{
  "visibleValues": [
    string
  ],
  "condition": {
    object (BooleanCondition)
  },
  "visibleByDefault": boolean
}

string

應包含的值。系統會排除此處未列出的值。

object (BooleanCondition)

條件結果為 true，才能顯示值。(visibleValues 不會覆寫這項資訊，即使清單中列出一個值，即便不符合條件，仍會處於隱藏狀態)。

以 A1 標記表示範圍的條件值將根據資料透視表工作表進行評估。系統會一律參照參照，因此請不要填寫資料透視表。舉例來說，「資料透視表 1」中的 =A1 條件值會視為 'Pivot Table 1'!$A$1。

欄標題名稱可參照資料透視表的來源資料。舉例來說，如果來源資料含有名為「收益」和「費用」的欄，且條件為「收益」欄 (類型為 NUMBER_GREATER 和「=Cost」) 套用條件，則只有「收益」>「費用」欄包含。

boolean

值是否預設為顯示。如為 true，系統會忽略 visibleValues，並顯示符合 condition (如有) 的所有值。設為 false 時，系統會顯示 visibleValues 中的值和 condition 的值。

{
  "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.
}

object (PivotFilterCriteria)

資料欄條件。

integer

來源範圍的零欄偏移。

object (DataSourceColumnReference)

資料來源欄的參照。

{
  "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.
}

enum (PivotValueSummarizeFunction)

用於總結值的函式。如果設定了 formula，唯一支援的值為 SUM 和 CUSTOM。如果設定了 sourceColumnOffset，則不支援 CUSTOM。

string

用於值的名稱。

enum (PivotValueCalculatedDisplayType)

指定時，表示資料值應與另一個資料透視值一併顯示。舉例來說，如果計算的 DisplayTypeType 指定為 PERCENT_OF_GRAND_TOTAL，所有資料透視值都會顯示為總總計的百分比。在試算表編輯器中，資料透視表的值部分會顯示為「顯示為」。

integer

這個值的來源來源資料列偏移。

舉例來說，如果來源為 C10:E15，則 0 的 sourceColumnOffset 表示這個值為 C 欄，而偏移 1 會參照 D 欄。

string

用來計算值的自訂公式。公式的開頭須為 = 字元。

object (DataSourceColumnReference)

這個值所參照的資料來源欄參照。