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 3 月”，但“Q1”却未显示，因为它与前几行重复。如果将 repeatHeadings 设置为 true，会导致“Feb”和“Mar”重复出现“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，则 sourceColumnOffset 为 0 表示该组引用了 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

项被放入恒定大小的存储分区中的最大值。高于 end 的值将汇总到一个存储分区中。此字段是选填字段。

{
  "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。

列标题名称可以引用数据透视表的源数据。例如，如果源数据包含名为“Revenue”和“Cost”的列，并且对类型为 NUMBER_GREATER 且值为 =Cost 的“Revenue”列应用条件，则只有“Revenue”>“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)

如果指定，则表示数据透视值应作为使用另一个数据透视值的计算结果来显示。例如，如果 computeDisplayType 指定为 PERCENT_OF_GRAND_TOTAL，则所有数据透视值都会显示为占总计的百分比。在表格编辑器中，这在数据透视表的值部分称为“显示为”。

integer

用于读取此值的来源范围的列偏移量。

例如，如果来源为 C10:E15，则 sourceColumnOffset 为 0 表示此值引用列 C，而偏移量 1 引用列 D。

string

用于计算值的自定义公式。公式必须以 = 字符开头。

object (DataSourceColumnReference)

对该值从中读取数据的数据源列的引用。