REST Resource: spreadsheets

Ресурс: электронная таблица

Ресурс, представляющий электронную таблицу.

JSON-представление 
{
  "spreadsheetId": string,
  "properties": {
    object (SpreadsheetProperties)
  },
  "sheets": [
    {
      object (Sheet)
    }
  ],
  "namedRanges": [
    {
      object (NamedRange)
    }
  ],
  "spreadsheetUrl": string,
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "dataSources": [
    {
      object (DataSource)
    }
  ],
  "dataSourceSchedules": [
    {
      object (DataSourceRefreshSchedule)
    }
  ]
}
Поля
spreadsheetId

string

Идентификатор электронной таблицы. Это поле доступно только для чтения.

properties

object ( SpreadsheetProperties )

Общие свойства электронной таблицы.

sheets[]

object ( Sheet )

Листы, являющиеся частью электронной таблицы.

namedRanges[]

object ( NamedRange )

Именованные диапазоны, определенные в электронной таблице.

spreadsheetUrl

string

URL-адрес таблицы. Это поле доступно только для чтения.

developerMetadata[]

object ( DeveloperMetadata )

Метаданные разработчика, связанные с электронной таблицей.

dataSources[]

object ( DataSource )

Список внешних источников данных, связанных с электронной таблицей.

dataSourceSchedules[]

object ( DataSourceRefreshSchedule )

Только вывод. Список расписаний обновления источников данных.

Свойства электронной таблицы

Свойства электронной таблицы.

JSON-представление 
{
  "title": string,
  "locale": string,
  "autoRecalc": enum (RecalculationInterval),
  "timeZone": string,
  "defaultFormat": {
    object (CellFormat)
  },
  "iterativeCalculationSettings": {
    object (IterativeCalculationSettings)
  },
  "spreadsheetTheme": {
    object (SpreadsheetTheme)
  },
  "importFunctionsExternalUrlAccessAllowed": boolean
}
Поля
title

string

Название таблицы.

locale

string

Язык электронной таблицы в одном из следующих форматов:

  • код языка ISO 639-1, например en

  • код языка ISO 639-2, например fil , если код 639-1 не существует

  • комбинация кода языка ISO и кода страны, например en_US

Примечание. При обновлении этого поля поддерживаются не все локали/языки.

autoRecalc

enum ( RecalculationInterval )

Время ожидания перед перерасчетом энергозависимых функций.

timeZone

string

Часовой пояс электронной таблицы в формате CLDR, например America/New_York . Если часовой пояс не распознан, это может быть собственный часовой пояс, например GMT-07:00 .

defaultFormat

object ( CellFormat )

Формат по умолчанию для всех ячеек электронной таблицы. CellData.effectiveFormat не будет установлен, если формат ячейки равен формату по умолчанию. Это поле доступно только для чтения.

iterativeCalculationSettings

object ( IterativeCalculationSettings )

Определяет, разрешаются ли циклические ссылки с помощью итеративных вычислений и если да, то каким образом. Отсутствие этого поля означает, что циклические ссылки приводят к ошибкам вычислений.

spreadsheetTheme

object ( SpreadsheetTheme )

Тема применена к электронной таблице.

importFunctionsExternalUrlAccessAllowed

boolean

Разрешить ли доступ к внешним URL-адресам для функций изображений и импорта. Читать только тогда, когда это правда. Если значение false, вы можете установить значение true. Это значение будет пропущено и всегда будет возвращать значение true, если администратор включил функцию внесения в белый список .

Интервал перерасчета

Перечисление возможных вариантов интервала перерасчета.

Перечисления
RECALCULATION_INTERVAL_UNSPECIFIED Значение по умолчанию. Это значение нельзя использовать.
ON_CHANGE Волатильные функции обновляются при каждом изменении.
MINUTE Волатильные функции обновляются при каждом изменении и каждую минуту.
HOUR Волатильные функции обновляются при каждом изменении и ежечасно.

Формат ячейки

Формат ячейки.

JSON-представление 
{
  "numberFormat": {
    object (NumberFormat)
  },
  "backgroundColor": {
    object (Color)
  },
  "backgroundColorStyle": {
    object (ColorStyle)
  },
  "borders": {
    object (Borders)
  },
  "padding": {
    object (Padding)
  },
  "horizontalAlignment": enum (HorizontalAlign),
  "verticalAlignment": enum (VerticalAlign),
  "wrapStrategy": enum (WrapStrategy),
  "textDirection": enum (TextDirection),
  "textFormat": {
    object (TextFormat)
  },
  "hyperlinkDisplayType": enum (HyperlinkDisplayType),
  "textRotation": {
    object (TextRotation)
  }
}
Поля
numberFormat

object ( NumberFormat )

Формат, описывающий, как числовые значения должны быть представлены пользователю.

backgroundColor
(deprecated)

object ( Color )

Цвет фона ячейки. Устарело: используйте backgroundColorStyle .

backgroundColorStyle

object ( ColorStyle )

Цвет фона ячейки. Если также установлен backgroundColor , это поле имеет приоритет.

borders

object ( Borders )

Границы ячейки.

padding

object ( Padding )

Заполнение ячейки.

horizontalAlignment

enum ( HorizontalAlign )

Горизонтальное выравнивание значения в ячейке.

verticalAlignment

enum ( VerticalAlign )

Вертикальное выравнивание значения в ячейке.

wrapStrategy

enum ( WrapStrategy )

Стратегия переноса значения в ячейке.

textDirection

enum ( TextDirection )

Направление текста в ячейке.

textFormat

object ( TextFormat )

Формат текста в ячейке (если не переопределен при запуске формата). Установка здесь ссылки на уровне ячейки удаляет существующие связи ячейки. Установка поля ссылки в TextFormatRun имеет приоритет над ссылкой на уровне ячейки.

textRotation

object ( TextRotation )

Поворот применяется к тексту в ячейке.

Числовой формат

Числовой формат ячейки.

JSON-представление 
{
  "type": enum (NumberFormatType),
  "pattern": string
}
Поля
type

enum ( NumberFormatType )

Тип числового формата. При написании это поле должно быть задано.

pattern

string

Строка шаблона, используемая для форматирования. Если этот параметр не установлен, при необходимости для данного типа будет использоваться шаблон по умолчанию, основанный на языковом стандарте пользователя. Дополнительную информацию о поддерживаемых шаблонах см. в руководстве по форматам дат и чисел .

НомерФорматТип

Числовой формат ячейки. В этой документации предполагается, что локаль — en_US, но фактический формат зависит от локали электронной таблицы.

Перечисления
NUMBER_FORMAT_TYPE_UNSPECIFIED Числовой формат не указан и зависит от содержимого ячейки. Не используйте это явно.
TEXT Форматирование текста, например 1000.12
NUMBER Форматирование чисел, например 1,000.12
PERCENT Процентное форматирование, например 10.12%
CURRENCY Формат валюты, например $1,000.12
DATE Формат даты, например 9/26/2008
TIME Форматирование времени, например 3:59:00 PM
DATE_TIME Форматирование даты+времени, например 9/26/08 15:59:00
SCIENTIFIC Формат научного числа, например 1.01E+03

Цвет

Представляет цвет в цветовом пространстве RGBA. Это представление предназначено для простоты преобразования в цветовые представления на разных языках и обратно, а не для компактности. Например, поля этого представления можно тривиально передать конструктору java.awt.Color в Java; его также можно тривиально передать методу +colorWithRed:green:blue:alpha UIColor в iOS; и, приложив немного усилий, его можно легко отформатировать в строку CSS rgba() в JavaScript.

На этой справочной странице нет информации об абсолютном цветовом пространстве, которое следует использовать для интерпретации значения RGB, например sRGB, Adobe RGB, DCI-P3 и BT.2020. По умолчанию приложения должны использовать цветовое пространство sRGB.

Когда необходимо определить равенство цветов, реализации, если не указано иное, рассматривают два цвета как равные, если все их значения красного, зеленого, синего и альфа отличаются не более чем на 1e-5 .

Пример (Java):

 import com.google.type.Color;

 // ...
 public static java.awt.Color fromProto(Color protocolor) {
   float alpha = protocolor.hasAlpha()
       ? protocolor.getAlpha().getValue()
       : 1.0;

   return new java.awt.Color(
       protocolor.getRed(),
       protocolor.getGreen(),
       protocolor.getBlue(),
       alpha);
 }

 public static Color toProto(java.awt.Color color) {
   float red = (float) color.getRed();
   float green = (float) color.getGreen();
   float blue = (float) color.getBlue();
   float denominator = 255.0;
   Color.Builder resultBuilder =
       Color
           .newBuilder()
           .setRed(red / denominator)
           .setGreen(green / denominator)
           .setBlue(blue / denominator);
   int alpha = color.getAlpha();
   if (alpha != 255) {
     result.setAlpha(
         FloatValue
             .newBuilder()
             .setValue(((float) alpha) / denominator)
             .build());
   }
   return resultBuilder.build();
 }
 // ...

Пример (iOS/Obj-C):

 // ...
 static UIColor* fromProto(Color* protocolor) {
    float red = [protocolor red];
    float green = [protocolor green];
    float blue = [protocolor blue];
    FloatValue* alpha_wrapper = [protocolor alpha];
    float alpha = 1.0;
    if (alpha_wrapper != nil) {
      alpha = [alpha_wrapper value];
    }
    return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
 }

 static Color* toProto(UIColor* color) {
     CGFloat red, green, blue, alpha;
     if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
       return nil;
     }
     Color* result = [[Color alloc] init];
     [result setRed:red];
     [result setGreen:green];
     [result setBlue:blue];
     if (alpha <= 0.9999) {
       [result setAlpha:floatWrapperWithValue(alpha)];
     }
     [result autorelease];
     return result;
}
// ...

Пример (JavaScript):

// ...

var protoToCssColor = function(rgbColor) {
   var redFrac = rgbColor.red || 0.0;
   var greenFrac = rgbColor.green || 0.0;
   var blueFrac = rgbColor.blue || 0.0;
   var red = Math.floor(redFrac * 255);
   var green = Math.floor(greenFrac * 255);
   var blue = Math.floor(blueFrac * 255);

   if (!('alpha' in rgbColor)) {
      return rgbToCssColor(red, green, blue);
   }

   var alphaFrac = rgbColor.alpha.value || 0.0;
   var rgbParams = [red, green, blue].join(',');
   return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};

var rgbToCssColor = function(red, green, blue) {
  var rgbNumber = new Number((red << 16) | (green << 8) | blue);
  var hexString = rgbNumber.toString(16);
  var missingZeros = 6 - hexString.length;
  var resultBuilder = ['#'];
  for (var i = 0; i < missingZeros; i++) {
     resultBuilder.push('0');
  }
  resultBuilder.push(hexString);
  return resultBuilder.join('');
};

// ...
JSON-представление 
{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}
Поля
red

number

Количество красного цвета в цвете как значение в интервале [0, 1].

green

number

Количество зеленого цвета в цвете как значение в интервале [0, 1].

blue

number

Количество синего цвета в цвете как значение в интервале [0, 1].

alpha

number

Доля этого цвета, которая должна быть применена к пикселю. То есть конечный цвет пикселя определяется уравнением:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

Это означает, что значение 1,0 соответствует сплошному цвету, тогда как значение 0,0 соответствует полностью прозрачному цвету. При этом используется сообщение-оболочка, а не простой скаляр с плавающей запятой, чтобы можно было отличить значение по умолчанию от значения, которое не установлено. Если этот параметр опущен, этот цветовой объект отображается как сплошной цвет (как если бы значению альфа было явно присвоено значение 1,0).

ЦветСтиль

Значение цвета.

JSON-представление 
{

  // Union field kind can be only one of the following:
  "rgbColor": {
    object (Color)
  },
  "themeColor": enum (ThemeColorType)
  // End of list of possible types for union field kind.
}
Поля
kind поля Союза. Вид значения цвета. kind может быть только одним из следующих:
rgbColor

object ( Color )

Цвет RGB. Значение alpha в объекте Color обычно не поддерживается.

themeColor

enum ( ThemeColorType )

Цвет темы.

ТемаЦветТип

Цветовые типы темы.

SpreadsheetProperties содержит SpreadsheetTheme , который определяет сопоставление этих типов цветов темы с конкретными цветами.

Перечисления
THEME_COLOR_TYPE_UNSPECIFIED Неуказанный цвет темы
TEXT Представляет основной цвет текста
BACKGROUND Представляет основной цвет фона
ACCENT1 Представляет первый акцентный цвет
ACCENT2 Представляет второй акцентный цвет
ACCENT3 Представляет третий акцентный цвет.
ACCENT4 Представляет четвертый акцентный цвет.
ACCENT5 Представляет пятый акцентный цвет.
ACCENT6 Представляет шестой акцентный цвет.

Границы

Границы ячейки.

JSON-представление 
{
  "top": {
    object (Border)
  },
  "bottom": {
    object (Border)
  },
  "left": {
    object (Border)
  },
  "right": {
    object (Border)
  }
}
Поля
top

object ( Border )

Верхняя граница ячейки.

bottom

object ( Border )

Нижняя граница ячейки.

left

object ( Border )

Левая граница ячейки.

right

object ( Border )

Правая граница ячейки.

Граница

Граница вдоль ячейки.

JSON-представление 
{
  "style": enum (Style),
  "width": integer,
  "color": {
    object (Color)
  },
  "colorStyle": {
    object (ColorStyle)
  }
}
Поля
style

enum ( Style )

Стиль границы.

width
(deprecated)

integer

Ширина границы в пикселях. Устарело; ширина определяется полем «стиль».

color
(deprecated)

object ( Color )

Цвет границы. Устарело: используйте colorStyle .

colorStyle

object ( ColorStyle )

Цвет границы. Если также задан color , это поле имеет приоритет.

Стиль

Стиль границы.

Перечисления
STYLE_UNSPECIFIED Стиль не указан. Не используйте это.
DOTTED Граница пунктирная.
DASHED Граница пунктирная.
SOLID Граница представляет собой тонкую сплошную линию.
SOLID_MEDIUM Граница представляет собой среднюю сплошную линию.
SOLID_THICK Граница представляет собой толстую сплошную линию.
NONE Нет границы. Используется только при обновлении границы с целью ее стирания.
DOUBLE Граница представляет собой две сплошные линии.

Заполнение

Размер заполнения вокруг ячейки в пикселях. При обновлении заполнения необходимо указать каждое поле.

JSON-представление 
{
  "top": integer,
  "right": integer,
  "bottom": integer,
  "left": integer
}
Поля
top

integer

Верхнее дополнение ячейки.

right

integer

Правильное заполнение ячейки.

bottom

integer

Нижнее дополнение ячейки.

left

integer

Левое дополнение ячейки.

Горизонтальное выравнивание

Горизонтальное выравнивание текста в ячейке.

Перечисления
HORIZONTAL_ALIGN_UNSPECIFIED Горизонтальное выравнивание не указано. Не используйте это.
LEFT Текст явно выравнивается по левому краю ячейки.
CENTER Текст явно выравнивается по центру ячейки.
RIGHT Текст явно выравнивается по правому краю ячейки.

Вертикальное выравнивание

Вертикальное выравнивание текста в ячейке.

Перечисления
VERTICAL_ALIGN_UNSPECIFIED Вертикальное выравнивание не указано. Не используйте это.
TOP Текст явно выравнивается по верху ячейки.
MIDDLE Текст явно выравнивается по середине ячейки.
BOTTOM Текст явно выравнивается по нижней части ячейки.

WrapСтратегия

Как переносить текст в ячейке.

Перечисления
WRAP_STRATEGY_UNSPECIFIED Значение по умолчанию, не использовать.
OVERFLOW_CELL

Строки, длина которых превышает ширину ячейки, будут записаны в следующую ячейку, если эта ячейка пуста. Если следующая ячейка не пуста, это ведет себя так же, как CLIP . Текст никогда не перенесется на следующую строку, если пользователь вручную не вставит новую строку. Пример: 

| First sentence. |
| Manual newline that is very long. <- Text continues into next cell
| Next newline.   |
LEGACY_WRAP

Эта стратегия переноса представляет собой старую стратегию переноса Google Таблиц, при которой слова, длина которых превышает строку, обрезаются, а не разрываются. Эта стратегия поддерживается не на всех платформах и постепенно прекращается. Пример: 

| Cell has a |
| loooooooooo| <- Word is clipped.
| word.      |
CLIP

Линии, длина которых превышает ширину ячейки, будут обрезаны. Текст никогда не перенесется на следующую строку, если пользователь вручную не вставит новую строку. Пример: 

| First sentence. |
| Manual newline t| <- Text is clipped
| Next newline.   |
WRAP

Слова длиннее строки переносятся на уровне символов, а не обрезаются. Пример: 

| Cell has a |
| loooooooooo| <- Word is broken.
| ong word.  |

Текстдиректион

Направление текста в ячейке.

Перечисления
TEXT_DIRECTION_UNSPECIFIED Направление текста не указано. Не используйте это.
LEFT_TO_RIGHT Направление текста слева направо задается пользователем.
RIGHT_TO_LEFT Направление текста справа налево задается пользователем.

Текстовый формат

Формат текста в ячейке. Отсутствие значений означает, что поле не указано.

JSON-представление 
{
  "foregroundColor": {
    object (Color)
  },
  "foregroundColorStyle": {
    object (ColorStyle)
  },
  "fontFamily": string,
  "fontSize": integer,
  "bold": boolean,
  "italic": boolean,
  "strikethrough": boolean,
  "underline": boolean,
  "link": {
    object (Link)
  }
}
Поля
foregroundColor
(deprecated)

object ( Color )

Цвет переднего плана текста. Устарело: foregroundColorStyle .

foregroundColorStyle

object ( ColorStyle )

Цвет переднего плана текста. Если также установлен foregroundColor , это поле имеет приоритет.

fontFamily

string

Семейство шрифтов.

fontSize

integer

Размер шрифта.

bold

boolean

Верно, если текст выделен жирным шрифтом.

italic

boolean

True, если текст выделен курсивом.

strikethrough

boolean

True, если текст перечеркнут.

underline

boolean

True, если текст подчеркнут.

ГиперссылкаDisplayType

Следует ли явно отображать гиперссылку. Если не указано, гиперссылка является связанной.

Перечисления
LINKED Гиперссылка должна отображаться явно.
PLAIN_TEXT Гиперссылка не должна отображаться.

ТекстРотация

Поворот применяется к тексту в ячейке.

JSON-представление 
{

  // Union field type can be only one of the following:
  "angle": integer,
  "vertical": boolean
  // End of list of possible types for union field type.
}
Поля
type поля объединения. Тип вращения: вертикальный или угловой. type может быть только одним из следующих:
angle

integer

Угол между стандартной ориентацией и желаемой ориентацией. Измеряется в градусах. Допустимые значения: от -90 до 90. Положительные углы наклонены вверх, отрицательные — вниз.

Примечание. Для направления текста LTR положительные углы располагаются против часовой стрелки, а для RTL — по часовой стрелке.

vertical

boolean

Если это правда, текст читается сверху вниз, но ориентация отдельных символов не меняется. Например: 

| V |
| e |
| r |
| t |
| i |
| c |
| a |
| l |

Параметры итеративного расчета

Настройки для управления тем, как циклические зависимости разрешаются с помощью итеративных вычислений.

JSON-представление 
{
  "maxIterations": integer,
  "convergenceThreshold": number
}
Поля
maxIterations

integer

Если итеративный расчет включен, максимальное количество раундов расчета.

convergenceThreshold

number

Если включен итеративный расчет и последовательные результаты отличаются менее чем на это пороговое значение, раунды расчета останавливаются.

Электронная таблицаТема

Представляет тему электронной таблицы

JSON-представление 
{
  "primaryFontFamily": string,
  "themeColors": [
    {
      object (ThemeColorPair)
    }
  ]
}
Поля
primaryFontFamily

string

Название основного семейства шрифтов.

themeColors[]

object ( ThemeColorPair )

Цветовые пары темы электронной таблицы. Для обновления необходимо предоставить все пары цветов темы.

ТемаЦветПара

Пара, сопоставляющая цветовой тип темы электронной таблицы с конкретным цветом, который он представляет.

JSON-представление 
{
  "colorType": enum (ThemeColorType),
  "color": {
    object (ColorStyle)
  }
}
Поля
colorType

enum ( ThemeColorType )

Тип цвета темы электронной таблицы.

color

object ( ColorStyle )

Конкретный цвет, соответствующий цветовому типу темы.

Лист

Лист в электронной таблице.

JSON-представление 
{
  "properties": {
    object (SheetProperties)
  },
  "data": [
    {
      object (GridData)
    }
  ],
  "merges": [
    {
      object (GridRange)
    }
  ],
  "conditionalFormats": [
    {
      object (ConditionalFormatRule)
    }
  ],
  "filterViews": [
    {
      object (FilterView)
    }
  ],
  "protectedRanges": [
    {
      object (ProtectedRange)
    }
  ],
  "basicFilter": {
    object (BasicFilter)
  },
  "charts": [
    {
      object (EmbeddedChart)
    }
  ],
  "bandedRanges": [
    {
      object (BandedRange)
    }
  ],
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "rowGroups": [
    {
      object (DimensionGroup)
    }
  ],
  "columnGroups": [
    {
      object (DimensionGroup)
    }
  ],
  "slicers": [
    {
      object (Slicer)
    }
  ],
  "tables": [
    {
      object (Table)
    }
  ]
}
Поля
properties

object ( SheetProperties )

Свойства листа.

data[]

object ( GridData )

Данные в сетке, если это сеточный лист.

Количество возвращаемых объектов GridData зависит от количества диапазонов, запрошенных на этом листе. Например, если это представление Sheet1 , а электронная таблица была запрошена с диапазонами Sheet1!A1:C10 и Sheet1!D15:E20 , то первый GridData будет иметь startRow / startColumn со значением 0 , а второй будет иметь startRow 14 (строка с нулевым отсчетом 15) и startColumn 3 (столбец D с нулевым отсчетом).

Для листа DATA_SOURCE нельзя запросить конкретный диапазон, GridData содержит все значения.

merges[]

object ( GridRange )

Диапазоны, которые объединены вместе.

conditionalFormats[]

object ( ConditionalFormatRule )

На этом листе действуют правила условного формата.

filterViews[]

object ( FilterView )

Виды фильтров на этом листе.

protectedRanges[]

object ( ProtectedRange )

Защищенные диапазоны на этом листе.

basicFilter

object ( BasicFilter )

Фильтр на этом листе, если таковой имеется.

charts[]

object ( EmbeddedChart )

Характеристики каждой диаграммы на этом листе.

bandedRanges[]

object ( BandedRange )

На этом листе показаны полосчатые (чередующиеся цвета) диапазоны.

developerMetadata[]

object ( DeveloperMetadata )

Метаданные разработчика, связанные с листом.

rowGroups[]

object ( DimensionGroup )

Все группы строк на этом листе упорядочены по возрастанию начального индекса диапазона, а затем по глубине группы.

columnGroups[]

object ( DimensionGroup )

Все группы столбцов на этом листе упорядочены по возрастанию начального индекса диапазона, а затем по глубине группы.

slicers[]

object ( Slicer )

Срезы на этом листе.

tables[]

object ( Table )

Таблицы на этом листе.

Свойства листа

Свойства листа.

JSON-представление 
{
  "sheetId": integer,
  "title": string,
  "index": integer,
  "sheetType": enum (SheetType),
  "gridProperties": {
    object (GridProperties)
  },
  "hidden": boolean,
  "tabColor": {
    object (Color)
  },
  "tabColorStyle": {
    object (ColorStyle)
  },
  "rightToLeft": boolean,
  "dataSourceSheetProperties": {
    object (DataSourceSheetProperties)
  }
}
Поля
sheetId

integer

Идентификатор листа. Должно быть неотрицательным. Это поле нельзя изменить после установки.

title

string

Имя листа.

index

integer

Индекс листа в электронной таблице. Если при добавлении или обновлении свойств листа это поле исключено, лист добавляется или перемещается в конец списка листов. При обновлении индексов листов или вставке листов перемещение учитывается в индексах «до перемещения». Например, если было три листа (S1, S2, S3), чтобы переместить S1 впереди S2, индекс должен быть установлен на 2. Запрос на обновление индекса листа игнорируется, если запрошенный индекс идентичен текущему индексу листов или если запрошенный новый индекс равен текущему индексу листа + 1.

sheetType

enum ( SheetType )

Тип листа. По умолчанию GRID . Это поле нельзя изменить после установки.

gridProperties

object ( GridProperties )

Дополнительные свойства листа, если этот лист представляет собой сетку. (Если лист представляет собой объектный лист, содержащий диаграмму или изображение, то это поле будет отсутствовать.) При записи возникает ошибка установки каких-либо свойств сетки на листах без сетки.

Если этот лист является листом DATA_SOURCE , это поле предназначено только для вывода, но содержит свойства, которые отражают способ отображения листа источника данных в пользовательском интерфейсе, например rowCount .

hidden

boolean

True, если лист скрыт в пользовательском интерфейсе, и false, если он виден.

tabColor
(deprecated)

object ( Color )

Цвет вкладки в пользовательском интерфейсе. Устарело: используйте tabColorStyle .

tabColorStyle

object ( ColorStyle )

Цвет вкладки в пользовательском интерфейсе. Если также задан tabColor , это поле имеет приоритет.

rightToLeft

boolean

Истинно, если лист является листом RTL, а не листом LTR.

dataSourceSheetProperties

object ( DataSourceSheetProperties )

Только вывод. Если оно присутствует, поле содержит свойства, специфичные для листа DATA_SOURCE .

Тип Листа

Вид листа.

Перечисления
SHEET_TYPE_UNSPECIFIED Значение по умолчанию, не использовать.
GRID Лист представляет собой сетку.
OBJECT На листе нет сетки, вместо него имеется объект, например диаграмма или изображение.
DATA_SOURCE Лист подключается к внешнему DataSource и отображает предварительный просмотр данных.

Свойства сетки

Свойства сетки.

JSON-представление 
{
  "rowCount": integer,
  "columnCount": integer,
  "frozenRowCount": integer,
  "frozenColumnCount": integer,
  "hideGridlines": boolean,
  "rowGroupControlAfter": boolean,
  "columnGroupControlAfter": boolean
}
Поля
rowCount

integer

Количество строк в сетке.

columnCount

integer

Количество столбцов в сетке.

frozenRowCount

integer

Количество строк, закрепленных в сетке.

frozenColumnCount

integer

Количество столбцов, замороженных в сетке.

hideGridlines

boolean

True, если сетка не отображает линии сетки в пользовательском интерфейсе.

rowGroupControlAfter

boolean

Истинно, если после группы отображается переключатель управления группировкой строк.

columnGroupControlAfter

boolean

Истинно, если после группы отображается переключатель управления группировкой столбцов.

Свойства листа источника данных

Дополнительные свойства листа DATA_SOURCE .

JSON-представление 
{
  "dataSourceId": string,
  "columns": [
    {
      object (DataSourceColumn)
    }
  ],
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
Поля
dataSourceId

string

Идентификатор DataSource , к которому подключен лист.

columns[]

object ( DataSourceColumn )

Столбцы, отображаемые на листе, соответствуют значениям в RowData .

dataExecutionStatus

object ( DataExecutionStatus )

Статус выполнения данных.

Столбец источника данных

Столбец в источнике данных.

JSON-представление 
{
  "reference": {
    object (DataSourceColumnReference)
  },
  "formula": string
}
Поля
reference

object ( DataSourceColumnReference )

Ссылка на столбец.

formula

string

Формула вычисляемого столбца.

Ссылка на источник данных

Уникальный идентификатор, ссылающийся на столбец источника данных.

JSON-представление 
{
  "name": string
}
Поля
name

string

Отображаемое имя столбца. Он должен быть уникальным в пределах источника данных.

Статус DataExecutionStatus

Статус выполнения данных.

Выполнение данных создается для синхронизации объекта источника данных с последними данными из DataSource . Обычно его запуск планируется в фоновом режиме, вы можете проверить его state , чтобы узнать, завершено ли выполнение.

Существует несколько сценариев, в которых запускается выполнение данных:

  • Adding a data source создается связанный лист источника данных, а также выполняется выполнение данных для синхронизации данных из источника данных с листом.
  • Updating a data source создает выполнение данных для аналогичного обновления связанного листа источника данных.
  • Вы можете отправить refresh request , чтобы явно обновить один или несколько объектов источника данных.
JSON-представление 
{
  "state": enum (DataExecutionState),
  "errorCode": enum (DataExecutionErrorCode),
  "errorMessage": string,
  "lastRefreshTime": string
}
Поля
state

enum ( DataExecutionState )

Состояние выполнения данных.

errorCode

enum ( DataExecutionErrorCode )

Код ошибки.

errorMessage

string

Сообщение об ошибке, которое может быть пустым.

lastRefreshTime

string ( Timestamp format)

Получает время последнего успешного обновления данных.

DataExecutionState

Перечисление состояний выполнения данных.

Перечисления
DATA_EXECUTION_STATE_UNSPECIFIED Значение по умолчанию, не использовать.
NOT_STARTED Выполнение данных не началось.
RUNNING Выполнение данных началось и выполняется.
CANCELLING Выполнение данных в настоящее время отменяется.
SUCCEEDED Выполнение данных завершилось успешно.
FAILED Выполнение данных завершилось с ошибками.

DataExecutionErrorCode

Перечисление кодов ошибок выполнения данных.

Перечисления
DATA_EXECUTION_ERROR_CODE_UNSPECIFIED Значение по умолчанию, не использовать.
TIMED_OUT Время выполнения данных истекло.
TOO_MANY_ROWS Выполнение данных возвращает больше строк, чем разрешено.
TOO_MANY_COLUMNS Выполнение данных возвращает больше столбцов, чем разрешено.
TOO_MANY_CELLS Выполнение данных возвращает больше ячеек, чем разрешено.
ENGINE Получена ошибка от внутреннего механизма выполнения данных (например, BigQuery). Подробности проверьте errorMessage .
PARAMETER_INVALID Один или некоторые из предоставленных параметров источника данных недействительны.
UNSUPPORTED_DATA_TYPE Выполнение данных возвращает неподдерживаемый тип данных.
DUPLICATE_COLUMN_NAMES Выполнение данных возвращает повторяющиеся имена или псевдонимы столбцов.
INTERRUPTED Выполнение данных прерывается. Пожалуйста, обновите позже.
CONCURRENT_QUERY Выполнение данных в настоящее время продолжается и не может быть обновлено до его завершения.
OTHER Другие ошибки.
TOO_MANY_CHARS_PER_CELL Выполнение данных возвращает значения, превышающие максимальное количество символов, разрешенное в одной ячейке.
DATA_NOT_FOUND База данных, на которую ссылается источник данных, не найдена. */
PERMISSION_DENIED Пользователь не имеет доступа к базе данных, на которую ссылается источник данных.
MISSING_COLUMN_ALIAS Выполнение данных возвращает столбцы с отсутствующими псевдонимами.
OBJECT_NOT_FOUND Объект источника данных не существует.
OBJECT_IN_ERROR_STATE Объект источника данных в настоящее время находится в состоянии ошибки. Чтобы принудительно обновить, установите force в RefreshDataSourceRequest .
OBJECT_SPEC_INVALID Спецификация объекта источника данных недействительна.
DATA_EXECUTION_CANCELLED Выполнение данных было отменено.

Гридданные

Данные в сетке, а также метаданные об измерениях.

JSON-представление 
{
  "startRow": integer,
  "startColumn": integer,
  "rowData": [
    {
      object (RowData)
    }
  ],
  "rowMetadata": [
    {
      object (DimensionProperties)
    }
  ],
  "columnMetadata": [
    {
      object (DimensionProperties)
    }
  ]
}
Поля
startRow

integer

Первая строка, на которую ссылается этот GridData, начинается с нуля.

startColumn

integer

Первый столбец, на который ссылается GridData, начинается с нуля.

rowData[]

object ( RowData )

Данные в сетке, по одной записи в строке, начиная со строки в startRow. Значения в RowData будут соответствовать столбцам, начиная с startColumn .

rowMetadata[]

object ( DimensionProperties )

Метаданные о запрошенных строках в сетке, начиная со строки в startRow .

columnMetadata[]

object ( DimensionProperties )

Метаданные о запрошенных столбцах в сетке, начиная со столбца в startColumn .

СтрокаДанные

Данные о каждой ячейке подряд.

JSON-представление 
{
  "values": [
    {
      object (CellData)
    }
  ]
}
Поля
values[]

object ( CellData )

Значения в строке, по одному на столбец.

CellData

Данные о конкретной ячейке.

JSON-представление 
{
  "userEnteredValue": {
    object (ExtendedValue)
  },
  "effectiveValue": {
    object (ExtendedValue)
  },
  "formattedValue": string,
  "userEnteredFormat": {
    object (CellFormat)
  },
  "effectiveFormat": {
    object (CellFormat)
  },
  "hyperlink": string,
  "note": string,
  "textFormatRuns": [
    {
      object (TextFormatRun)
    }
  ],
  "dataValidation": {
    object (DataValidationRule)
  },
  "pivotTable": {
    object (PivotTable)
  },
  "dataSourceTable": {
    object (DataSourceTable)
  },
  "dataSourceFormula": {
    object (DataSourceFormula)
  }
}
Поля
userEnteredValue

object ( ExtendedValue )

Значение, введенное пользователем в ячейку. например, 1234 , 'Hello' или =NOW() Примечание. Даты, время и DateTimes представлены в виде двойных чисел в формате serial number .

effectiveValue

object ( ExtendedValue )

Эффективное значение ячейки. Для ячеек с формулами это расчетное значение. Для ячеек с литералами это то же самое, что и userEnteredValue. Это поле доступно только для чтения.

formattedValue

string

Отформатированное значение ячейки. Это значение, которое отображается пользователю. Это поле доступно только для чтения.

userEnteredFormat

object ( CellFormat )

Формат, введенный пользователем для ячейки.

При записи новый формат будет объединен с существующим форматом.

effectiveFormat

object ( CellFormat )

Эффективный формат, используемый ячейкой. Сюда входят результаты применения любого условного форматирования и, если ячейка содержит формулу, вычисленный числовой формат. Если действующий формат является форматом по умолчанию, действующий формат не будет записан. Это поле доступно только для чтения.

note

string

Любая заметка в ячейке.

textFormatRuns[]

object ( TextFormatRun )

Ряды форматированного текста, примененные к подразделам ячейки. Выполнение допустимо только для введенных пользователем строк, а не для формул, логических значений или чисел. Свойства запуска начинаются с определенного индекса в тексте и продолжаются до следующего запуска. Запуски будут наследовать свойства ячейки, если они не будут изменены явно.

При записи новые прогоны перезапишут все предыдущие прогоны. При записи нового userEnteredValue предыдущие прогоны стираются.

dataValidation

object ( DataValidationRule )

Правило проверки данных в ячейке, если таковое имеется.

При записи новое правило проверки данных перезапишет любое предыдущее правило.

pivotTable

object ( PivotTable )

Сводная таблица, привязанная к этой ячейке. Размер самой сводной таблицы вычисляется динамически на основе ее данных, группировки, фильтров, значений и т. д. Только верхняя левая ячейка сводной таблицы содержит определение сводной таблицы. Остальные ячейки будут содержать рассчитанные значения результатов сводной таблицы в полях effectiveValue .

dataSourceTable

object ( DataSourceTable )

Таблица источника данных, привязанная к этой ячейке. Размер самой таблицы источника данных вычисляется динамически на основе ее конфигурации. Только первая ячейка таблицы источника данных содержит определение таблицы источника данных. Остальные ячейки будут содержать отображаемые значения результата таблицы источника данных в полях effectiveValue .

dataSourceFormula

object ( DataSourceFormula )

Только вывод. Информация о формуле источника данных в ячейке. Поле устанавливается, если userEnteredValue представляет собой формулу, ссылающуюся на какой-либо лист DATA_SOURCE , например =SUM(DataSheet!Column) .

Расширенное значение

Виды значений, которые может иметь ячейка в электронной таблице.

JSON-представление 
{

  // Union field value can be only one of the following:
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "formulaValue": string,
  "errorValue": {
    object (ErrorValue)
  }
  // End of list of possible types for union field value.
}
Поля
value поля объединения. Тип значения в ячейке. Если поле не задано, в ячейке нет данных. value может быть только одним из следующих:
numberValue

number

Представляет двойное значение. Примечание. Даты, время и DateTimes представлены в виде двойных чисел в формате SERIAL_NUMBER .

stringValue

string

Представляет строковое значение. Ведущие одинарные кавычки не включаются. Например, если пользователь ввел '123 в пользовательский интерфейс, это будет представлено как stringValue "123" .

boolValue

boolean

Представляет логическое значение.

formulaValue

string

Представляет формулу.

errorValue

object ( ErrorValue )

Представляет ошибку. Это поле доступно только для чтения.

ErrorValue

Ошибка в ячейке.

JSON-представление 
{
  "type": enum (ErrorType),
  "message": string
}
Поля
type

enum ( ErrorType )

Тип ошибки.

message

string

Сообщение с дополнительной информацией об ошибке (в локали электронной таблицы).

Тип ошибки

Тип ошибки.

Перечисления
ERROR_TYPE_UNSPECIFIED Тип ошибки по умолчанию, не используйте его.
ERROR Соответствует #ERROR! ошибка.
NULL_VALUE Соответствует #NULL! ошибка.
DIVIDE_BY_ZERO Соответствует ошибке #DIV/0 .
VALUE Соответствует #VALUE! ошибка.
REF Соответствует #REF! ошибка.
NAME Соответствует #NAME? ошибка.
NUM Соответствует #NUM! ошибка.
N_A Соответствует ошибке #N/A .
LOADING Соответствует состоянию Loading...

ТекстФорматВыполнить

Прогон текстового формата. Формат этого прогона продолжается до тех пор, пока не будет достигнут индекс начала следующего прогона. При обновлении все поля должны быть заданы.

JSON-представление 
{
  "startIndex": integer,
  "format": {
    object (TextFormat)
  }
}
Поля
startIndex

integer

Индекс символов, отсчитываемый от нуля, в котором начинается этот запуск, в кодовых единицах UTF-16.

format

object ( TextFormat )

Формат этого забега. Отсутствующие значения наследуют формат ячейки.

Правило проверки данных

Правило проверки данных.

JSON-представление 
{
  "condition": {
    object (BooleanCondition)
  },
  "inputMessage": string,
  "strict": boolean,
  "showCustomUi": boolean
}
Поля
condition

object ( BooleanCondition )

Условие соответствия данных в ячейке.

inputMessage

string

Сообщение, отображаемое пользователю при добавлении данных в ячейку.

strict

boolean

True, если недействительные данные должны быть отклонены.

showCustomUi

boolean

Истинно, если пользовательский интерфейс должен быть настроен в зависимости от типа условия. Если это правда, условия «Списка» отобразят раскрывающийся список.

Логическое условие

Условие, которое может иметь значение true или false. BooleanConditions используются для условного форматирования, проверки данных и критериев в фильтрах.

JSON-представление 
{
  "type": enum (ConditionType),
  "values": [
    {
      object (ConditionValue)
    }
  ]
}
Поля
type

enum ( ConditionType )

Тип состояния.

values[]

object ( ConditionValue )

Значения условия. Количество поддерживаемых значений зависит от condition type . Некоторые поддерживают нулевые значения, другие — одно или два значения, а ConditionType.ONE_OF_LIST поддерживает произвольное количество значений.

Тип условия

Тип состояния.

Перечисления
CONDITION_TYPE_UNSPECIFIED Значение по умолчанию, не использовать.
NUMBER_GREATER Значение ячейки должно быть больше значения условия. Поддерживается проверка данных, условное форматирование и фильтры. Требуется одно ConditionValue .
NUMBER_GREATER_THAN_EQ Значение ячейки должно быть больше или равно значению условия. Поддерживается проверка данных, условное форматирование и фильтры. Требуется одно ConditionValue .
NUMBER_LESS Значение ячейки должно быть меньше значения условия. Поддерживается проверка данных, условное форматирование и фильтры. Требуется одно ConditionValue .
NUMBER_LESS_THAN_EQ Значение ячейки должно быть меньше или равно значению условия. Поддерживается проверка данных, условное форматирование и фильтры. Требуется одно ConditionValue .
NUMBER_EQ Значение ячейки должно быть равно значению условия. Поддерживается проверка данных, условное форматирование и фильтры. Требуется одно ConditionValue для проверки данных, условного форматирования и фильтров для объектов, не являющихся источниками данных, и по крайней мере одно ConditionValue для фильтров для объектов источника данных.
NUMBER_NOT_EQ Значение ячейки не должно быть равно значению условия. Поддерживается проверка данных, условное форматирование и фильтры. Требуется одно ConditionValue для проверки данных, условного форматирования и фильтров для объектов, не являющихся источниками данных, и по крайней мере одно ConditionValue для фильтров для объектов источника данных.
NUMBER_BETWEEN Значение ячейки должно находиться между двумя значениями условия. Поддерживается проверка данных, условное форматирование и фильтры. Требуется ровно два ConditionValues .
NUMBER_NOT_BETWEEN Значение ячейки не должно находиться между двумя значениями условия. Поддерживается проверка данных, условное форматирование и фильтры. Требуется ровно два ConditionValues .
TEXT_CONTAINS Значение ячейки должно содержать значение условия. Поддерживается проверка данных, условное форматирование и фильтры. Требуется одно ConditionValue .
TEXT_NOT_CONTAINS Значение ячейки не должно содержать значение условия. Поддерживается проверка данных, условное форматирование и фильтры. Требуется одно ConditionValue .
TEXT_STARTS_WITH Значение ячейки должно начинаться со значения условия. Поддерживается условное форматирование и фильтры. Требуется одно ConditionValue .
TEXT_ENDS_WITH Значение ячейки должно заканчиваться значением условия. Поддерживается условное форматирование и фильтры. Требуется одно ConditionValue .
TEXT_EQ Значение ячейки должно быть в точности значением условия. Поддерживается проверка данных, условное форматирование и фильтры. Требуется одно ConditionValue для проверки данных, условного форматирования и фильтров для объектов, не являющихся источниками данных, и по крайней мере одно ConditionValue для фильтров для объектов источника данных.
TEXT_IS_EMAIL Значение ячейки должно быть действительным адресом электронной почты. Поддерживается проверкой данных. Не требует ConditionValues ​​.
TEXT_IS_URL Значение ячейки должно быть действительным URL-адресом. Поддерживается проверкой данных. Не требует ConditionValues ​​.
DATE_EQ Значение ячейки должно совпадать с датой значения условия. Поддерживается проверка данных, условное форматирование и фильтры. Требуется единое ConditionValue для проверки данных, условного форматирования и фильтров на не дате-исходных объектах, а также, по крайней мере, одно ConditionValue для фильтров на объектах источника данных.
DATE_BEFORE Значение ячейки должно быть до даты значения условия. Поддерживается проверкой данных, условным форматированием и фильтрами. Требуется единственное ConditionValue , которое может быть relative date .
DATE_AFTER Значение ячейки должно быть после даты значения состояния. Поддерживается проверкой данных, условным форматированием и фильтрами. Требуется единственное ConditionValue , которое может быть relative date .
DATE_ON_OR_BEFORE Значение ячейки должно быть на или до даты значения условия. Поддерживается проверкой данных. Требуется единственное ConditionValue , которое может быть relative date .
DATE_ON_OR_AFTER Значение ячейки должно быть на или после даты значения условия. Поддерживается проверкой данных. Требуется единственное ConditionValue , которое может быть relative date .
DATE_BETWEEN Значение ячейки должно быть между датами двух значений состояния. Поддерживается проверкой данных. Требует ровно двух ConditionValues .
DATE_NOT_BETWEEN Значение ячейки должно быть за пределами дат двух значений состояния. Поддерживается проверкой данных. Требует ровно двух ConditionValues .
DATE_IS_VALID Значение ячейки должна быть датой. Поддерживается проверкой данных. Не требует ConditionValues .
ONE_OF_RANGE Значение ячейки должно быть указано в сетке в диапазоне значения условия. Поддерживается проверкой данных. Требуется единое ConditionValue , и значение должно быть допустимым диапазоном в обозначениях A1.
ONE_OF_LIST Значение ячейки должно быть в списке значений условий. Поддерживается проверкой данных. Поддерживает любое количество condition values , по одному на элемент в списке. Формулы не поддерживаются в значениях.
BLANK Значение ячейки должно быть пустым. Поддерживается условным форматированием и фильтрами. Не требует ConditionValues .
NOT_BLANK Значение ячейки не должно быть пустым. Поддерживается условным форматированием и фильтрами. Не требует ConditionValues .
CUSTOM_FORMULA Формула условия должна оцениваться до истины. Поддерживается проверкой данных, условным форматированием и фильтрами. Не поддерживается фильтрами листа источника данных. Требует единого ConditionValue .
BOOLEAN Значение ячейки должно быть истинным/ложным или в списке значений условий. Поддерживается проверкой данных. Образуется в качестве флажести ячейки. Поддерживает ноль, одно или два ConditionValues . Никакие значения не указывают, что ячейка должна быть истинной или ложной, где истина визуалирует, как проверяется, а ложные визуализируются как неконтролируемые. Одно значение указывает на то, что ячейка будет отображаться, когда она проверяется, когда она содержит это значение и не контролировано, когда она пустая. Два значения указывают на то, что ячейка будет отображаться как проверенная, когда она содержит первое значение, и не контролируется, когда она содержит второе значение. Например, [«Да», «Нет»] указывает, что ячейка будет отображать установленное флажок, когда у нее есть значение «Да» и неконтролируемое поле, когда у нее есть значение «Нет».
TEXT_NOT_EQ Значение ячейки должно быть точно не значением состояния. Поддерживается фильтрами на объектах источника данных. Требуется хотя бы одно ConditionValue .
DATE_NOT_EQ Значение ячейки должно быть точно не значением состояния. Поддерживается фильтрами на объектах источника данных. Требуется хотя бы одно ConditionValue .
FILTER_EXPRESSION Значение ячейки должно следовать указанному шаблону. Требует единого ConditionValue .

ConditionValue

Значение условия.

Представление JSON 
{

  // Union field value can be only one of the following:
  "relativeDate": enum (RelativeDate),
  "userEnteredValue": string
  // End of list of possible types for union field value.
}
Поля
value поля профсоюза. Значение условия, точно необходимо установить. value может быть только одним из следующих:
relativeDate

enum ( RelativeDate )

Относительная дата (на основе текущей даты). Действительно только в том случае, если type - DATE_BEFORE , DATE_AFTER , DATE_ON_OR_BEFORE или DATE_ON_OR_AFTER .

Относительные даты не поддерживаются в проверке данных. Они поддерживаются только в условном форматировании и условном фильтрах.

userEnteredValue

string

Значение, на котором основано условие. Значение анализируется так, как будто пользователь вводит в ячейку. Формулы поддерживаются (и должны начинаться с = или '+').

Относительно

Контролирует, как оценивается условие даты.

Перечисление
RELATIVE_DATE_UNSPECIFIED Значение по умолчанию не используйте.
PAST_YEAR Стоимость за год до сегодняшнего дня.
PAST_MONTH Стоимость - за месяц до сегодняшнего дня.
PAST_WEEK Ценность - одна неделя до сегодняшнего дня.
YESTERDAY Значение вчера.
TODAY Ценность сегодня.
TOMORROW Значение завтра.

Сбит с толку

Поворот.

Представление 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 )

Фильтры, применяемые к исходным столбцам перед агрегированием данных для таблицы Pivot.

И criteria , и filterSpecs заполнены ответами. Если оба поля указаны в запросе обновления, это поле имеет приоритет.

values[]

object ( PivotValue )

Список значений для включения в таблицу поворота.

valueLayout

enum ( PivotValueLayout )

Должны ли значения быть перечислены горизонтально (как столбцы) или вертикально (как строки).

dataExecutionStatus

object ( DataExecutionStatus )

Только вывод. Состояние выполнения данных для таблиц поворота источника данных.

Объединение поля source_data . Источник данных о поворотах. source_data может быть только одним из следующих:
source

object ( GridRange )

Диапазон The Pivot Table считывает данные.

dataSourceId

string

Идентификатор источника данных. Таблица Pivot считывает данные.

Стержень

Диапазон на листе. Все индексы основаны на нулевом уровне. Индексы наполовину открыты, то есть индекс начала является инклюзивным, а конечный индекс эксклюзив - [StartIndex, Endindex). Отсутствующие индексы показывают, что диапазон не ограничен на этой стороне.

Например, если "Sheet1" - это лист ID 123456, то:

Sheet1!A1:A1 == sheetId: 123456, startRowIndex: 0, endRowIndex: 1, startColumnIndex: 0, endColumnIndex: 1

Sheet1!A3:B4 == sheetId: 123456, startRowIndex: 2, endRowIndex: 4, startColumnIndex: 0, endColumnIndex: 2

Sheet1!A:B == sheetId: 123456, startColumnIndex: 0, endColumnIndex: 2

Sheet1!A5:B == sheetId: 123456, startRowIndex: 4, startColumnIndex: 0, endColumnIndex: 2

Sheet1 == sheetId: 123456

Индекс начала всегда должен быть меньше или равен конечному индексу. Если индекс начала равна индексу конечности, то диапазон пуст. Пустые диапазоны, как правило, не значимы и обычно отображаются в пользовательском интерфейсе как #REF! .

Представление JSON 
{
  "sheetId": integer,
  "startRowIndex": integer,
  "endRowIndex": integer,
  "startColumnIndex": integer,
  "endColumnIndex": integer
}
Поля
sheetId

integer

Лист, этот диапазон включен.

startRowIndex

integer

Начальная строка (включительно) диапазона или не установлена, если не ограничена.

endRowIndex

integer

Конечный ряд (эксклюзивный) диапазона или не установлен, если он не ограничен.

startColumnIndex

integer

Столбец старта (включительно) диапазона или не установлен, если он не ограничен.

endColumnIndex

integer

Конечный столбец (эксклюзивный) диапазона или не устанавливается, если он не ограничен.

Pivotgroup

Одна группировка (либо строка, либо столбец) в поворотной таблице.

Представление 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

Правда, если таблица поворота должна включать итоги для этой группировки.

valueMetadata[]

object ( PivotGroupValueMetadata )

Метаданные о ценностях в группировке.

sortOrder

enum ( SortOrder )

Порядок значения в этой группе должен быть отсортирован.

valueBucket

object ( PivotGroupSortValueBucket )

Ведро противоположной группы поворота для сортировки. Если не указано, сортировка является алфавитной комиссией по значениям этой группы.

repeatHeadings

boolean

Правда, если заголовки в этой группировке должны быть повторены. Это действительно только для групп строк и игнорируется столбцами.

По умолчанию мы минимизируем повторение заголовков, не показывая заголовки более высокого уровня, где они одинаковы. Например, хотя третья строка ниже соответствует «Q1 март», «Q1» не показан, потому что она избыточно с предыдущими рядами. Установка Repeatheadings True приведет к повторению «Q1» для «февраля» и «Mar». 

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

string

Метки, которые можно использовать для групп строк/столбцов, которые можно настроить. Например, в следующей поворотной таблице метка строки - это Region (которая может быть переименована в State ), а метка столбца - это Product (который можно переименовать Item ). Таблицы поворотов, созданные до декабря 2017 года, не имеют ярлыков заголовка. Если вы хотите добавить метки заголовка в существующую таблицу поворота, пожалуйста, удалите существующую таблицу Pivot, а затем создайте новую таблицу поворота с теми же параметрами. 

+--------------+---------+-------+
| 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 , sourceColumnOffset 0 означает, что эта группа относится к столбцу C , тогда как смещение 1 будет относиться к столбцу D

dataSourceColumnReference

object ( DataSourceColumnReference )

Ссылка на столбец источника данных. Эта группировка основана на.

Pivotgroupvaluemetadata

Метаданные о значении в поворотной группировке.

Представление JSON 
{
  "value": {
    object (ExtendedValue)
  },
  "collapsed": boolean
}
Поля
value

object ( ExtendedValue )

Рассчитанное значение Метаданные соответствуют. (Обратите внимание, что formulaValue недопустим, поскольку значения будут рассчитаны.)

collapsed

boolean

Верно, если данные, соответствующие значению, свернуты.

Сортировка

Сортированный порядок.

Перечисление
SORT_ORDER_UNSPECIFIED Значение по умолчанию, не используйте это.
ASCENDING Сортируйте восхождение.
DESCENDING Сортировать нисходящее.

PivotGroupSortValueBucket

Информация о том, какие значения в групповой группе следует использовать для сортировки.

Представление JSON 
{
  "valuesIndex": integer,
  "buckets": [
    {
      object (ExtendedValue)
    }
  ]
}
Поля
valuesIndex

integer

Смещение в списке PivotTable.values , по которому должны отсортировать значения в этой группировке.

buckets[]

object ( ExtendedValue )

Определяет ведро, из которого выбираются значения для сортировки.

Например, в таблице поворота с одной группой строк и двумя группами столбцов группа строк может перечислить до двух значений. Первое значение соответствует значению в группе первых столбцов, а второе значение соответствует значению во второй группе столбцов. Если никаких значений не указано, это указывает на то, что строка должна быть отсортирована в соответствии с «Великой общей» над группами столбцов. Если указано одно значение, это будет соответствовать использованию «общего» этого ведра.

Pivotgrouple

Дополнительная настройка на PivotGroup , которая определяет ведра для значений в столбце исходных данных, а не разбивает каждое отдельное значение. Для каждого столбца может быть добавлена ​​только одна PivotGroup с групповым правилом, хотя в любом данном столбце вы можете добавить как 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 .

Руководство

Позволяет вам вручную организовать значения в столбце исходных данных в ведра с именами по вашему выбору. Например, поворотная таблица, которая объединяет население по штату: 

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

можно превратить в поворотную таблицу, которая объединяет популяцию по часовым поясам, предоставляя список групп (например, GroupName = 'Central', элементы = ['al', 'ar', 'ia', ...]) в правило ручной группы. Обратите внимание, что аналогичный эффект может быть достигнут путем добавления столбца часового пояса к исходным данным и настройки таблицы Pivot. 

+-----------+-------------------+
| Time Zone | SUM of Population |
+-----------+-------------------+
| Central   |             106.3 |
| Eastern   |             151.9 |
| Mountain  |              17.4 |
...
+-----------+-------------------+
Представление JSON 
{
  "groups": [
    {
      object (ManualRuleGroup)
    }
  ]
}
Поля
groups[]

object ( ManualRuleGroup )

Список имен групп и соответствующие элементы из исходных данных, которые отображают имя каждой группы.

Руководитель

Имя группы и список элементов из исходных данных, которые должны быть размещены в группе с этим именем.

Представление JSON 
{
  "groupName": {
    object (ExtendedValue)
  },
  "items": [
    {
      object (ExtendedValue)
    }
  ]
}
Поля
groupName

object ( ExtendedValue )

Имя группы, которое должно быть строкой. Каждая группа в данном ManualRule должна иметь уникальное название группы.

items[]

object ( ExtendedValue )

Элементы в исходных данных, которые должны быть помещены в эту группу. Каждый элемент может быть строкой, номером или логином. Предметы могут появиться не более одной группы в данном ManualRule . Предметы, которые не появляются ни в одной группе, появятся сами по себе.

Гистограмма

Позволяет организовать числовые значения в столбце исходных данных в ведра постоянного размера. Все значения HistogramRule.end HistogramRule.start HistogramRule.interval Кроме того HistogramRule.end все значения ниже HistogramRule.start . HistogramRule.start только HistogramRule.interval HistogramRule.end хотя если предоставлены HistogramRule.start HistogramRule.end Например, таблица поворота, показывающая среднюю сумму покупки по возрасту, которая имеет более 50 строк: 

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

можно превратить в таблицу поворота, которая выглядит как приведенная ниже, применяя правило группы гистограммы с HistogramRule.start Start из 25, HistogramRule.interval 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

Минимальное значение, при котором элементы помещаются в ведра постоянного размера. Значения ниже начала смешиваются в одно ведро. Это поле необязательно.

end

number

Максимальное значение, при котором элементы помещаются в ведра постоянного размера. Значения выше конца смешиваются в одно ведро. Это поле необязательно.

DateTimeRule

Позволяет организовать значения даты времени в столбце исходных данных в ведра на основе выбранных частей их значений даты или времени. Например, рассмотрим сводную таблицу, показывающую транзакции продаж по дате: 

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

Применение правила группы даты с DateTimeRuleType годовой_монт приводит к следующей таблице Pivot. 

+--------------+--------------+
| 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», хотя фактический рендеринг дат и Times использует локаль электронной таблицы для некоторых типов правил.

Перечисление
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 вечера. Обозначение AM/PM переводится на основе локали электронной таблицы.
DAY_OF_WEEK Групповые даты в день недели, например, в воскресенье. Дни недели будут переведены на основе локали электронной таблицы.
DAY_OF_YEAR Группа датируется днем ​​года, с 1 до 366. Обратите внимание, что даты после 29 февраля падают в разных ведрах в лепечие годы, чем в не лежат в годы.
DAY_OF_MONTH Групповые даты дня месяца, с 1 до 31.
DAY_MONTH Групповые даты днем ​​и месяцем, например 22-нов. Месяц переводится на основе локали электронной таблицы.
MONTH Групповые даты по месяцу, например, ноябрь. Месяц переводится на основе локали электронных таблиц.
QUARTER Групповые даты по кварталу, например, Q1 (который представляет Jan-Mar).
YEAR Групповые даты по году, например, 2008 год.
YEAR_MONTH Групповые даты по год и месяца, например, 2008 г.-ноябрь. Месяц переводится на основе локали электронной таблицы.
YEAR_QUARTER Групповые даты по году и кварталу, например, 2008 Q4.
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-нотации, оцениваются относительно листа таблицы поворота. Ссылки обрабатываются абсолютно, поэтому не заполняются по поводу таблицы. Например, значение условия =A1 на «Pivot Table 1» рассматривается как 'Pivot Table 1'!$A$1 .

На исходных данных таблицы Pivot можно ссылаться имя заголовка столбца. Например, если исходные данные имеют столбцы с названием «Доход» и «Стоимость», и условие применяется к столбцу «Доход» с типом NUMBER_GREATER и value =Cost , тогда включаются только столбцы, где включены только «доход»> «стоимость».

visibleByDefault

boolean

Являются ли значения по умолчанию. Если истинно, visibleValues ​​игнорируются, показаны все значения, которые соответствуют condition (если указано). Если неверно, показаны значения, которые находятся в 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 )

Ссылка на столбец источника данных.

РАЗВЛЕНИЕ

Определение того, как должно быть рассчитано значение в таблице поворота.

Представление 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 )

Если указано, указывает, что значения поворота должны отображаться как результат вычисления с другим значением поворота. Например, если рассчитывается, что определяется как процент_оф_GRAND_TOTAL, все значения поворота отображаются как процент от общей суммы. В редакторе листов это называется «показывать как» в разделе «Значения» таблицы поворота.

value поля профсоюза. Данные для использования для значений в таблице Pivot. Ровно одно значение должно быть установлено. value может быть только одним из следующих:
sourceColumnOffset

integer

Смещение столбца в диапазоне источников, из которого это значение считывает.

Например, если источник был C10:E15 , sourceColumnOffset 0 означает, что это значение относится к столбцу 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 Data, где значение уже суммировано.

Pivotvaluecalcalculateddisplaytype

Возможные способы, которыми значения поворота могут быть рассчитаны для отображения.

Перечисление
PIVOT_VALUE_CALCULATED_DISPLAY_TYPE_UNSPECIFIED Значение по умолчанию не используйте.
PERCENT_OF_ROW_TOTAL Показывает значения поворота в процентах от общих значений строк.
PERCENT_OF_COLUMN_TOTAL Показывает значения поворота в процентах от общих значений столбца.
PERCENT_OF_GRAND_TOTAL Показывает значения поворота в процентах от общих общих значений.

Pivotvaluelayout

Макет значений поворота.

Перечисление
HORIZONTAL Значения выложены горизонтально (как столбцы).
VERTICAL Значения выложены вертикально (как ряды).

DataSourceTable

Таблица источника данных, которая позволяет пользователю импортировать статическую таблицу данных из DataSource в листы. Это также известно как «экстракт» в редакторе листов.

Представление JSON 
{
  "dataSourceId": string,
  "columnSelectionType": enum (DataSourceTableColumnSelectionType),
  "columns": [
    {
      object (DataSourceColumnReference)
    }
  ],
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ],
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "rowLimit": integer,
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
Поля
dataSourceId

string

Идентификатор источника данных. Таблица источника данных связана.

columnSelectionType

enum ( DataSourceTableColumnSelectionType )

Тип для выбора столбцов для таблицы источников данных. По умолчанию SELECTED .

columns[]

object ( DataSourceColumnReference )

Столбцы, выбранные для таблицы источников данных. columnSelectionType должен быть SELECTED .

filterSpecs[]

object ( FilterSpec )

Технические характеристики фильтра в таблице источников данных.

sortSpecs[]

object ( SortSpec )

Сортировка спецификаций в таблице источников данных. Результат таблицы источников данных сортируется на основе спецификаций сортировки по порядку.

rowLimit

integer

Предел рядов возвращается. Если не установлено, применяется предел по умолчанию. Пожалуйста, обратитесь к редактору листов по умолчанию и максимальному ограничению.

dataExecutionStatus

object ( DataExecutionStatus )

Только вывод. Статус выполнения данных.

DataSourcetableColumnSelectionType

Типы выбора столбцов с источником данных.

Перечисление
DATA_SOURCE_TABLE_COLUMN_SELECTION_TYPE_UNSPECIFIED Тип выбора столбца по умолчанию, не используйте.
SELECTED Выберите столбцы, указанные в поле columns .
SYNC_ALL

Синхронизируйте все текущие и будущие столбцы в источнике данных.

Если установлена, таблица источников данных извлекает все столбцы в источнике данных во время обновления.

Filterspec

Критерии фильтра, связанные с конкретным столбцом.

Представление JSON 
{
  "filterCriteria": {
    object (FilterCriteria)
  },

  // Union field reference can be only one of the following:
  "columnIndex": integer,
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
  // End of list of possible types for union field reference.
}
Поля
filterCriteria

object ( FilterCriteria )

Критерии для столбца.

reference полевой поля. Ссылка на фильтрованный столбец. reference может быть только одним из следующих:
columnIndex

integer

Индекс столбцов на основе нуля.

dataSourceColumnReference

object ( DataSourceColumnReference )

Ссылка на столбец источника данных.

FilterCriteria

Критерии для отображения/укрытия рядов в фильтре или фильтре.

Представление JSON 
{
  "hiddenValues": [
    string
  ],
  "condition": {
    object (BooleanCondition)
  },
  "visibleBackgroundColor": {
    object (Color)
  },
  "visibleBackgroundColorStyle": {
    object (ColorStyle)
  },
  "visibleForegroundColor": {
    object (Color)
  },
  "visibleForegroundColorStyle": {
    object (ColorStyle)
  }
}
Поля
hiddenValues[]

string

Ценности, которые должны быть скрыты.

condition

object ( BooleanCondition )

Условие, которое должно быть истинным для показателей, которые будут показаны. (Это не переопределяет hiddenValues - если там указано значение, оно все равно будет скрыто.)

visibleBackgroundColor
(deprecated)

object ( Color )

Фоновый заличный цвет для фильтрации по; Показаны только ячейки с этим цветом заливки. Взаимно эксклюзив с visibleForegroundColor . Умеренный: используйте visibleBackgroundColorStyle .

visibleBackgroundColorStyle

object ( ColorStyle )

Фоновый заличный цвет для фильтрации по; Показаны только ячейки с этим цветом заливки. Это поле взаимоисключает с visibleForegroundColor и должно быть установлено на цвет типа RGB. Если также установлен visibleBackgroundColor , это поле имеет приоритет.

visibleForegroundColor
(deprecated)

object ( Color )

Цвет переднего плана от фильтрации по; Показаны только ячейки с этим цветом переднего плана. Взаимно эксклюзив с visibleBackgroundColor . Установите: используйте visibleForegroundColorStyle .

visibleForegroundColorStyle

object ( ColorStyle )

Цвет переднего плана от фильтрации по; Показаны только ячейки с этим цветом переднего плана. Это поле взаимоисключает с visibleBackgroundColor и должно быть установлено на цвет RGB. Если visibleForegroundColor также установлено, также установлено, это поле имеет приоритет.

Sortspec

Порядок сортировки, связанный с конкретным столбцом или строкой.

Представление JSON 
{
  "sortOrder": enum (SortOrder),
  "foregroundColor": {
    object (Color)
  },
  "foregroundColorStyle": {
    object (ColorStyle)
  },
  "backgroundColor": {
    object (Color)
  },
  "backgroundColorStyle": {
    object (ColorStyle)
  },

  // Union field reference can be only one of the following:
  "dimensionIndex": integer,
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
  // End of list of possible types for union field reference.
}
Поля
sortOrder

enum ( SortOrder )

Данные заказа должны быть отсортированы.

foregroundColor
(deprecated)

object ( Color )

Цвет переднего плана, чтобы сортировать по; Клетки с этим цветом переднего плана отсортированы до вершины. Взаимно эксклюзивный с backgroundColor . Установите: используйте foregroundColorStyle .

foregroundColorStyle

object ( ColorStyle )

Цвет переднего плана, чтобы сортировать по; Клетки с этим цветом переднего плана отсортированы до вершины. Взаимно эксклюзивный с backgroundColor , и должен быть цветом типа RGB. Если foregroundColor также установлен, это поле имеет приоритет.

backgroundColor
(deprecated)

object ( Color )

Фоновый заличный цвет для сортировки по; Клетки с этим цветом наполнения отсортированы до вершины. Взаимно эксклюзив с foregroundColor . Установите: используйте backgroundColorStyle .

backgroundColorStyle

object ( ColorStyle )

Фоновый заличный цвет для сортировки по; Клетки с этим цветом наполнения отсортированы до вершины. Взаимно эксклюзивный с foregroundColor , и должен быть цветом типа RGB. Если backgroundColor также установлен, это поле имеет приоритет.

reference полевой поля. Ссылка на отсортированное измерение. reference может быть только одним из следующих:
dimensionIndex

integer

Измерение, к которому следует применять.

dataSourceColumnReference

object ( DataSourceColumnReference )

Ссылка на столбец источника данных.

DataSourceFormula

Формула источника данных.

Представление JSON 
{
  "dataSourceId": string,
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
Поля
dataSourceId

string

Идентификатор источника данных, с которой связана формула.

dataExecutionStatus

object ( DataExecutionStatus )

Только вывод. Статус выполнения данных.

Свойства размера

Свойства о измерении.

Представление JSON 
{
  "hiddenByFilter": boolean,
  "hiddenByUser": boolean,
  "pixelSize": integer,
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
}
Поля
hiddenByFilter

boolean

Правда, если это измерение отфильтровано. Это поле только для чтения.

hiddenByUser

boolean

Правда, если это измерение явно скрыто.

pixelSize

integer

Высота (если ряд) или ширина (если столбец) измерения в пикселях.

developerMetadata[]

object ( DeveloperMetadata )

Метаданные разработчика, связанные с одной строкой или столбцом.

dataSourceColumnReference

object ( DataSourceColumnReference )

Только вывод. Если установлено, это столбец в листе источника данных.

Условие

Правило, описывающее условное формат.

Представление JSON 
{
  "ranges": [
    {
      object (GridRange)
    }
  ],

  // Union field rule can be only one of the following:
  "booleanRule": {
    object (BooleanRule)
  },
  "gradientRule": {
    object (GradientRule)
  }
  // End of list of possible types for union field rule.
}
Поля
ranges[]

object ( GridRange )

Диапазоны, которые отформатированы, если условие верно. Все диапазоны должны быть на одной сетке.

Полевое rule Союза. Правило, управляющее этим условным форматом, точно необходимо установить. rule может быть только одним из следующих:
booleanRule

object ( BooleanRule )

Форматирование либо «включено», либо «выключено» в соответствии с правилом.

gradientRule

object ( GradientRule )

Форматирование будет варьироваться в зависимости от градиентов в правиле.

Логический

Правило, которое может соответствовать или не соответствовать, в зависимости от условия.

Представление JSON 
{
  "condition": {
    object (BooleanCondition)
  },
  "format": {
    object (CellFormat)
  }
}
Поля
condition

object ( BooleanCondition )

Состояние правила. Если условие оценивается в TRUE, применяется формат.

format

object ( CellFormat )

Формат для применения. Условное форматирование может применять только подмножество форматирования: bold , italic , strikethrough , foreground color и background color .

Градиентрул

Правило, которое применяет формат цветовой шкалы градиента, на основе перечисленных точек интерполяции. Формат ячейки будет варьироваться в зависимости от ее содержания по сравнению со значениями точек интерполяции.

Представление JSON 
{
  "minpoint": {
    object (InterpolationPoint)
  },
  "midpoint": {
    object (InterpolationPoint)
  },
  "maxpoint": {
    object (InterpolationPoint)
  }
}
Поля
minpoint

object ( InterpolationPoint )

Начальная точка интерполяции.

midpoint

object ( InterpolationPoint )

Дополнительная точка интерполяции на полпути.

maxpoint

object ( InterpolationPoint )

Последняя точка интерполяции.

InterpolationPoint

Единственная точка интерполяции в градиентном условном формате. Они прикрепляют цветовую шкалу градиента в соответствии с выбранным цветом, типом и значением.

Представление JSON 
{
  "color": {
    object (Color)
  },
  "colorStyle": {
    object (ColorStyle)
  },
  "type": enum (InterpolationPointType),
  "value": string
}
Поля
color
(deprecated)

object ( Color )

Цвет этой точки интерполяции должен использовать. Унижен: используйте colorStyle .

colorStyle

object ( ColorStyle )

Цвет этой точки интерполяции должен использовать. Если color также установлен, это поле имеет приоритет.

type

enum ( InterpolationPointType )

Как значение следует интерпретировать.

value

string

Значение, которую использует эта точка интерполяции. Может быть формулой. Неиспользованный, если type - MIN или MAX .

InterpolationPointType

Вид интерполяции.

Перечисление
INTERPOLATION_POINT_TYPE_UNSPECIFIED Значение по умолчанию не используйте.
MIN Точка интерполяции использует минимальное значение в ячейках в диапазоне условного формата.
MAX Точка интерполяции использует максимальное значение в ячейках в диапазоне условного формата.
NUMBER Точка интерполяции использует точно значение в InterpolationPoint.value .
PERCENT

Точка интерполяции является данным процентом по всем ячеек в диапазоне условного формата. Это эквивалентно NUMBER , если значение было: =(MAX(FLATTEN(range)) * (value / 100)) + (MIN(FLATTEN(range)) * (1 - (value / 100))) (где ошибки в диапазоне игнорируются при сглаживании).

PERCENTILE Точка интерполяции является данным процентилем по всем клеткам в диапазоне условного формата. Это эквивалентно NUMBER , если значение было: =PERCENTILE(FLATTEN(range), value / 100) (где ошибки в диапазоне игнорируются при сглаживании).

FilterView

Вид фильтра.

Представление JSON 
{
  "filterViewId": integer,
  "title": string,
  "range": {
    object (GridRange)
  },
  "namedRangeId": string,
  "tableId": string,
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "criteria": {
    integer: {
      object (FilterCriteria)
    },
    ...
  },
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ]
}
Поля
filterViewId

integer

Идентификатор вида фильтра.

title

string

Название вида фильтра.

range

object ( GridRange )

Диапазон этот вид фильтра покрывает.

При написании может быть установлен только один из range или namedRangeId или tableId .

namedRangeId

string

Названный диапазон. Этот вид фильтра поддерживается, если таковой имеется.

При написании может быть установлен только один из range или namedRangeId или tableId .

tableId

string

Таблица этого представления фильтра поддерживается, если таковая имеется.

При написании может быть установлен только один из range или namedRangeId или tableId .

sortSpecs[]

object ( SortSpec )

Порядок сортировки на столбец. Более поздние спецификации используются, когда значения равны в более ранних спецификациях.

criteria
(deprecated)

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

Критерии отображения/скрытия значений на столбец. Ключ карты - это индекс столбца, а значение - это критерии для этого столбца.

Это поле устанавливается в пользу filterSpecs .

filterSpecs[]

object ( FilterSpec )

Критерии фильтра для отображения/скрытия значений на столбец.

И criteria , и filterSpecs заполнены ответами. Если оба поля указаны в запросе обновления, это поле имеет приоритет.

Защищенный

Защищенный диапазон.

Представление JSON 
{
  "protectedRangeId": integer,
  "range": {
    object (GridRange)
  },
  "namedRangeId": string,
  "tableId": string,
  "description": string,
  "warningOnly": boolean,
  "requestingUserCanEdit": boolean,
  "unprotectedRanges": [
    {
      object (GridRange)
    }
  ],
  "editors": {
    object (Editors)
  }
}
Поля
protectedRangeId

integer

Идентификатор защищенного диапазона. Это поле только для чтения.

range

object ( GridRange )

Диапазон, который защищен. Диапазон может быть полностью неограничен, и в этом случае это считается защищенным листом.

При написании может быть установлен только один из range или namedRangeId или tableId .

namedRangeId

string

Названный диапазон. Этот защищенный диапазон поддерживается, если таковой имеется.

При написании может быть установлен только один из range или namedRangeId или tableId .

tableId

string

Таблица этот защищенный диапазон поддерживается, если таковой имеется.

При написании может быть установлен только один из range или namedRangeId или tableId .

description

string

Описание этого защищенного диапазона.

warningOnly

boolean

Правда, если этот защищенный диапазон покажет предупреждение при редактировании. Защита, основанная на предупреждении, означает, что каждый пользователь может редактировать данные в защищенном диапазоне, за исключением редактирования, предупреждает предупреждение с просьбой подтвердить редактирование.

При написании: если это поле верно, то editors игнорируются. Кроме того, если это поле изменено с истины на false, а поле editors не установлено (не включено в маску поля), то редакторы будут установлены всем редакторам в документе.

requestingUserCanEdit

boolean

Верно, если пользователь, который запросил этот защищенный диапазон, может отредактировать защищенную область. Это поле только для чтения.

unprotectedRanges[]

object ( GridRange )

Список незащищенных диапазонов в защищенном листе. Незащищенные диапазоны поддерживаются только на защищенных листах.

editors

object ( Editors )

Пользователи и группы с редактированием доступа к защищенному диапазону. Это поле видно только для пользователей с редактированием доступа к защищенному диапазону и документу. Редакторы не поддерживаются защитой warningOnly .

Редакторы

Редакторы защищенного диапазона.

Представление JSON 
{
  "users": [
    string
  ],
  "groups": [
    string
  ],
  "domainUsersCanEdit": boolean
}
Поля
users[]

string

Адреса электронной почты пользователей с редактированием доступа к защищенному диапазону.

groups[]

string

Адреса электронной почты групп с редактированием доступа к защищенному диапазону.

domainUsersCanEdit

boolean

Верно, если кто -то в домене документа имеет редактирование доступа к защищенному диапазону. Защита домена поддерживается только в документах в домене.

БазовыйФильтр

Фильтр по умолчанию, связанный с листом.

Представление JSON 
{
  "range": {
    object (GridRange)
  },
  "tableId": string,
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "criteria": {
    integer: {
      object (FilterCriteria)
    },
    ...
  },
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ]
}
Поля
range

object ( GridRange )

Диапазон фильтра покрывает.

tableId

string

Таблица этот фильтр поддерживается, если таковой имеется. При написании может быть установлен только один из range или tableId .

sortSpecs[]

object ( SortSpec )

Порядок сортировки на столбец. Более поздние спецификации используются, когда значения равны в более ранних спецификациях.

criteria
(deprecated)

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

Критерии отображения/скрытия значений на столбец. Ключ карты - это индекс столбца, а значение - это критерии для этого столбца.

Это поле устанавливается в пользу filterSpecs .

filterSpecs[]

object ( FilterSpec )

Критерии фильтра по столбцу.

И criteria , и filterSpecs заполнены ответами. Если оба поля указаны в запросе обновления, это поле имеет приоритет.

EnceddedChart

Диаграмма, встроенная в лист.

Представление JSON 
{
  "chartId": integer,
  "spec": {
    object (ChartSpec)
  },
  "position": {
    object (EmbeddedObjectPosition)
  },
  "border": {
    object (EmbeddedObjectBorder)
  }
}
Поля
chartId

integer

Идентификатор диаграммы.

spec

object ( ChartSpec )

Спецификация диаграммы.

position

object ( EmbeddedObjectPosition )

Положение графика.

border

object ( EmbeddedObjectBorder )

Граница графика.

Chartspec

Спецификации диаграммы.

Представление JSON 
{
  "title": string,
  "altText": string,
  "titleTextFormat": {
    object (TextFormat)
  },
  "titleTextPosition": {
    object (TextPosition)
  },
  "subtitle": string,
  "subtitleTextFormat": {
    object (TextFormat)
  },
  "subtitleTextPosition": {
    object (TextPosition)
  },
  "fontName": string,
  "maximized": boolean,
  "backgroundColor": {
    object (Color)
  },
  "backgroundColorStyle": {
    object (ColorStyle)
  },
  "dataSourceChartProperties": {
    object (DataSourceChartProperties)
  },
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ],
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "hiddenDimensionStrategy": enum (ChartHiddenDimensionStrategy),

  // Union field chart can be only one of the following:
  "basicChart": {
    object (BasicChartSpec)
  },
  "pieChart": {
    object (PieChartSpec)
  },
  "bubbleChart": {
    object (BubbleChartSpec)
  },
  "candlestickChart": {
    object (CandlestickChartSpec)
  },
  "orgChart": {
    object (OrgChartSpec)
  },
  "histogramChart": {
    object (HistogramChartSpec)
  },
  "waterfallChart": {
    object (WaterfallChartSpec)
  },
  "treemapChart": {
    object (TreemapChartSpec)
  },
  "scorecardChart": {
    object (ScorecardChartSpec)
  }
  // End of list of possible types for union field chart.
}
Поля
title

string

Название диаграммы.

altText

string

Альтернативный текст, который описывает диаграмму. Это часто используется для доступности.

titleTextFormat

object ( TextFormat )

Формат текста заголовка. Strikethtrough, Underline и Link не поддерживаются.

titleTextPosition

object ( TextPosition )

Позиция текста заголовка. Это поле необязательно.

subtitle

string

Субтитры диаграммы.

subtitleTextFormat

object ( TextFormat )

Формат текста подзаголовок. Strikethtrough, Underline и Link не поддерживаются.

subtitleTextPosition

object ( TextPosition )

Положение текста подзаголовок. Это поле необязательно.

fontName

string

Название шрифта для использования по умолчанию для всех текстов диаграммы (например, название, этикетки оси, легенда). Если шрифт указан для определенной части диаграммы, он будет переопределять это имя шрифта.

maximized

boolean

Верно, чтобы сделать график заполнить все пространство, в котором он отображается с минимальной прокладкой. Неверно использовать заполнение по умолчанию. (Не применимо к диаграммам GEO и орг.)

backgroundColor
(deprecated)

object ( Color )

Фоновый цвет всей диаграммы. Не применимо к оргну. Установите: используйте backgroundColorStyle .

backgroundColorStyle

object ( ColorStyle )

Фоновый цвет всей диаграммы. Не применимо к оргну. Если backgroundColor также установлен, это поле имеет приоритет.

dataSourceChartProperties

object ( DataSourceChartProperties )

Если присутствует, поле содержит специфические свойства графика данных.

filterSpecs[]

object ( FilterSpec )

Фильтры, применяемые к исходным данным диаграммы. Поддерживается только для диаграмм источников данных.

sortSpecs[]

object ( SortSpec )

Приказ сортировать данные диаграммы по. Поддерживается только одна спецификация сортировки. Поддерживается только для диаграмм источников данных.

hiddenDimensionStrategy

enum ( ChartHiddenDimensionStrategy )

Определяет, как диаграммы будут использовать скрытые ряды или столбцы.

Полевая chart Союза. Специальная спецификация диаграммы, необходимо установить точно одно значение. chart может быть только одним из следующих:
basicChart

object ( BasicChartSpec )

Основная спецификация диаграммы может быть одним из многих видов диаграмм. См. BasicChartType для списка всех диаграмм, которые поддерживают.

pieChart

object ( PieChartSpec )

Спецификация круговой диаграммы.

bubbleChart

object ( BubbleChartSpec )

Спецификация пузырьковой диаграммы.

candlestickChart

object ( CandlestickChartSpec )

Спецификация диаграммы подсвечника.

orgChart

object ( OrgChartSpec )

Спецификация карты орг.

histogramChart

object ( HistogramChartSpec )

Спецификация диаграммы гистограммы.

waterfallChart

object ( WaterfallChartSpec )

Спецификация графика водопада.

treemapChart

object ( TreemapChartSpec )

Спецификация диаграммы TreeMap.

scorecardChart

object ( ScorecardChartSpec )

Спецификация карты показателей.

Текстпозиция

Настройки позиции для текста.

Представление JSON 
{
  "horizontalAlignment": enum (HorizontalAlign)
}
Поля
horizontalAlignment

enum ( HorizontalAlign )

Горизонтальный настройка выравнивания для части текста.

DataSourceChartProperties

Свойства диаграммы источника данных.

Представление JSON 
{
  "dataSourceId": string,
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
Поля
dataSourceId

string

Идентификатор источника данных, с которым связана диаграмма.

dataExecutionStatus

object ( DataExecutionStatus )

Только вывод. Статус выполнения данных.

BasicChartSpec

Спецификация для базовой диаграммы. См. BasicChartType для списка диаграмм, которые поддерживает.

Представление JSON 
{
  "chartType": enum (BasicChartType),
  "legendPosition": enum (BasicChartLegendPosition),
  "axis": [
    {
      object (BasicChartAxis)
    }
  ],
  "domains": [
    {
      object (BasicChartDomain)
    }
  ],
  "series": [
    {
      object (BasicChartSeries)
    }
  ],
  "headerCount": integer,
  "threeDimensional": boolean,
  "interpolateNulls": boolean,
  "stackedType": enum (BasicChartStackedType),
  "lineSmoothing": boolean,
  "compareMode": enum (BasicChartCompareMode),
  "totalDataLabel": {
    object (DataLabel)
  }
}
Поля
chartType

enum ( BasicChartType )

Тип диаграммы.

legendPosition

enum ( BasicChartLegendPosition )

Позиция легенды диаграммы.

axis[]

object ( BasicChartAxis )

Ось на графике.

domains[]

object ( BasicChartDomain )

Домен данных Это состоит из графика. Поддерживается только один домен.

series[]

object ( BasicChartSeries )

Данные эта диаграмма визуализирует.

headerCount

integer

Количество строк или столбцов в данных, которые являются «заголовками». Если не установлено, Google Sheets догадается, сколько строк является заголовком на основе данных.

(Обратите внимание, что BasicChartAxis.title может переопределить заголовок оси, выведенный из значений заголовка.)

threeDimensional

boolean

Верно сделать график 3d. Применяется к диаграммах стержней и столбцов.

interpolateNulls

boolean

If some values in a series are missing, gaps may appear in the chart (eg, segments of lines in a line chart will be missing). To eliminate these gaps set this to true. Applies to Line, Area, and Combo charts.

stackedType

enum ( BasicChartStackedType )

The stacked type for charts that support vertical stacking. Applies to Area, Bar, Column, Combo, and Stepped Area charts.

lineSmoothing

boolean

Gets whether all lines should be rendered smooth or straight by default. Applies to Line charts.

compareMode

enum ( BasicChartCompareMode )

The behavior of tooltips and data highlighting when hovering on data and chart area.

totalDataLabel

object ( DataLabel )

Controls whether to display additional data labels on stacked charts which sum the total value of all stacked values at each value along the domain axis. These data labels can only be set when chartType is one of AREA , BAR , COLUMN , COMBO or STEPPED_AREA and stackedType is either STACKED or PERCENT_STACKED . In addition, for COMBO , this will only be supported if there is only one type of stackable series type or one type has more series than the others and each of the other types have no more than one series. For example, if a chart has two stacked bar series and one area series, the total data labels will be supported. If it has three bar series and two area series, total data labels are not allowed. Neither CUSTOM nor placement can be set on the totalDataLabel .

BasicChartType

How the chart should be visualized.

Перечисление
BASIC_CHART_TYPE_UNSPECIFIED Default value, do not use.
BAR A bar chart .
LINE A line chart .
AREA An area chart .
COLUMN A column chart .
SCATTER A scatter chart .
COMBO A combo chart .
STEPPED_AREA A stepped area chart .

BasicChartLegendPosition

Where the legend of the chart should be positioned.

Перечисление
BASIC_CHART_LEGEND_POSITION_UNSPECIFIED Default value, do not use.
BOTTOM_LEGEND The legend is rendered on the bottom of the chart.
LEFT_LEGEND The legend is rendered on the left of the chart.
RIGHT_LEGEND The legend is rendered on the right of the chart.
TOP_LEGEND The legend is rendered on the top of the chart.
NO_LEGEND No legend is rendered.

BasicChartAxis

An axis of the chart. A chart may not have more than one axis per axis position .

JSON representation 
{
  "position": enum (BasicChartAxisPosition),
  "title": string,
  "format": {
    object (TextFormat)
  },
  "titleTextPosition": {
    object (TextPosition)
  },
  "viewWindowOptions": {
    object (ChartAxisViewWindowOptions)
  }
}
Fields
position

enum ( BasicChartAxisPosition )

The position of this axis.

title

string

The title of this axis. If set, this overrides any title inferred from headers of the data.

format

object ( TextFormat )

The format of the title. Only valid if the axis is not associated with the domain. The link field is not supported.

titleTextPosition

object ( TextPosition )

The axis title text position.

viewWindowOptions

object ( ChartAxisViewWindowOptions )

The view window options for this axis.

BasicChartAxisPosition

The position of a chart axis.

Перечисление
BASIC_CHART_AXIS_POSITION_UNSPECIFIED Default value, do not use.
BOTTOM_AXIS The axis rendered at the bottom of a chart. For most charts, this is the standard major axis. For bar charts, this is a minor axis.
LEFT_AXIS The axis rendered at the left of a chart. For most charts, this is a minor axis. For bar charts, this is the standard major axis.
RIGHT_AXIS The axis rendered at the right of a chart. For most charts, this is a minor axis. For bar charts, this is an unusual major axis.

ChartAxisViewWindowOptions

The options that define a "view window" for a chart (such as the visible values in an axis).

JSON representation 
{
  "viewWindowMin": number,
  "viewWindowMax": number,
  "viewWindowMode": enum (ViewWindowMode)
}
Fields
viewWindowMin

number

The minimum numeric value to be shown in this view window. If unset, will automatically determine a minimum value that looks good for the data.

viewWindowMax

number

The maximum numeric value to be shown in this view window. If unset, will automatically determine a maximum value that looks good for the data.

viewWindowMode

enum ( ViewWindowMode )

The view window's mode.

ViewWindowMode

The view window's mode. It defines how to treat the min and max of the view window.

Перечисление
DEFAULT_VIEW_WINDOW_MODE The default view window mode used in the Sheets editor for this chart type. In most cases, if set, the default mode is equivalent to PRETTY .
VIEW_WINDOW_MODE_UNSUPPORTED Не используйте. Represents that the currently set mode is not supported by the API.
EXPLICIT Follows the min and max exactly if specified. If a value is unspecified, it will fall back to the PRETTY value.
PRETTY Chooses a min and max that make the chart look good. Both min and max are ignored in this mode.

BasicChartDomain

The domain of a chart. For example, if charting stock prices over time, this would be the date.

JSON representation 
{
  "domain": {
    object (ChartData)
  },
  "reversed": boolean
}
Fields
domain

object ( ChartData )

The data of the domain. For example, if charting stock prices over time, this is the data representing the dates.

reversed

boolean

True to reverse the order of the domain values (horizontal axis).

ChartData

The data included in a domain or series.

JSON representation 
{
  "groupRule": {
    object (ChartGroupRule)
  },
  "aggregateType": enum (ChartAggregateType),

  // Union field type can be only one of the following:
  "sourceRange": {
    object (ChartSourceRange)
  },
  "columnReference": {
    object (DataSourceColumnReference)
  }
  // End of list of possible types for union field type.
}
Fields
groupRule

object ( ChartGroupRule )

The rule to group the data by if the ChartData backs the domain of a data source chart. Only supported for data source charts.

aggregateType

enum ( ChartAggregateType )

The aggregation type for the series of a data source chart. Only supported for data source charts.

type поля Союза. The type of data included, exactly one value must be set. type может быть только одним из следующих:
sourceRange

object ( ChartSourceRange )

The source ranges of the data.

columnReference

object ( DataSourceColumnReference )

The reference to the data source column that the data reads from.

ChartSourceRange

Source ranges for a chart.

JSON representation 
{
  "sources": [
    {
      object (GridRange)
    }
  ]
}
Fields
sources[]

object ( GridRange )

The ranges of data for a series or domain. Exactly one dimension must have a length of 1, and all sources in the list must have the same dimension with length 1. The domain (if it exists) & all series must have the same number of source ranges. If using more than one source range, then the source range at a given offset must be in order and contiguous across the domain and series.

For example, these are valid configurations: 

domain sources: A1:A5
series1 sources: B1:B5
series2 sources: D6:D10

domain sources: A1:A5, C10:C12
series1 sources: B1:B5, D10:D12
series2 sources: C1:C5, E10:E12

ChartGroupRule

An optional setting on the ChartData of the domain of a data source chart that defines buckets for the values in the domain rather than breaking out each individual value.

For example, when plotting a data source chart, you can specify a histogram rule on the domain (it should only contain numeric values), grouping its values into buckets. Any values of a chart series that fall into the same bucket are aggregated based on the aggregateType .

JSON representation 
{

  // Union field rule can be only one of the following:
  "dateTimeRule": {
    object (ChartDateTimeRule)
  },
  "histogramRule": {
    object (ChartHistogramRule)
  }
  // End of list of possible types for union field rule.
}
Fields
Union field rule . The rule to apply to the ChartData . rule can be only one of the following:
dateTimeRule

object ( ChartDateTimeRule )

A ChartDateTimeRule .

histogramRule

object ( ChartHistogramRule )

A ChartHistogramRule

ChartDateTimeRule

Allows you to organize the date-time values in a source data column into buckets based on selected parts of their date or time values.

JSON representation 
{
  "type": enum (ChartDateTimeRuleType)
}
Fields
type

enum ( ChartDateTimeRuleType )

The type of date-time grouping to apply.

ChartDateTimeRuleType

The available types of date-time grouping rules.

Перечисление
CHART_DATE_TIME_RULE_TYPE_UNSPECIFIED The default type, do not use.
SECOND Group dates by second, from 0 to 59.
MINUTE Group dates by minute, from 0 to 59.
HOUR Group dates by hour using a 24-hour system, from 0 to 23.
HOUR_MINUTE Group dates by hour and minute using a 24-hour system, for example 19:45.
HOUR_MINUTE_AMPM Group dates by hour and minute using a 12-hour system, for example 7:45 PM. The AM/PM designation is translated based on the spreadsheet locale.
DAY_OF_WEEK Group dates by day of week, for example Sunday. The days of the week will be translated based on the spreadsheet locale.
DAY_OF_YEAR Group dates by day of year, from 1 to 366. Note that dates after Feb. 29 fall in different buckets in leap years than in non-leap years.
DAY_OF_MONTH Group dates by day of month, from 1 to 31.
DAY_MONTH Group dates by day and month, for example 22-Nov. The month is translated based on the spreadsheet locale.
MONTH Group dates by month, for example Nov. The month is translated based on the spreadsheet locale.
QUARTER Group dates by quarter, for example Q1 (which represents Jan-Mar).
YEAR Group dates by year, for example 2008.
YEAR_MONTH Group dates by year and month, for example 2008-Nov. The month is translated based on the spreadsheet locale.
YEAR_QUARTER Group dates by year and quarter, for example 2008 Q4.
YEAR_MONTH_DAY Group dates by year, month, and day, for example 2008-11-22.

ChartHistogramRule

Allows you to organize numeric values in a source data column into buckets of constant size.

JSON representation 
{
  "minValue": number,
  "maxValue": number,
  "intervalSize": number
}
Fields
minValue

number

The minimum value at which items are placed into buckets. Values that are less than the minimum are grouped into a single bucket. If omitted, it is determined by the minimum item value.

maxValue

number

The maximum value at which items are placed into buckets. Values greater than the maximum are grouped into a single bucket. If omitted, it is determined by the maximum item value.

intervalSize

number

The size of the buckets that are created. Must be positive.

ChartAggregateType

The type of aggregation for chart series.

Перечисление
CHART_AGGREGATE_TYPE_UNSPECIFIED Default value, do not use.
AVERAGE Average aggregate function.
COUNT Count aggregate function.
MAX Maximum aggregate function.
MEDIAN Median aggregate function.
MIN Minimum aggregate function.
SUM Sum aggregate function.

BasicChartSeries

A single series of data in a chart. For example, if charting stock prices over time, multiple series may exist, one for the "Open Price", "High Price", "Low Price" and "Close Price".

JSON representation 
{
  "series": {
    object (ChartData)
  },
  "targetAxis": enum (BasicChartAxisPosition),
  "type": enum (BasicChartType),
  "lineStyle": {
    object (LineStyle)
  },
  "dataLabel": {
    object (DataLabel)
  },
  "color": {
    object (Color)
  },
  "colorStyle": {
    object (ColorStyle)
  },
  "pointStyle": {
    object (PointStyle)
  },
  "styleOverrides": [
    {
      object (BasicSeriesDataPointStyleOverride)
    }
  ]
}
Fields
series

object ( ChartData )

The data being visualized in this chart series.

targetAxis

enum ( BasicChartAxisPosition )

The minor axis that will specify the range of values for this series. For example, if charting stocks over time, the "Volume" series may want to be pinned to the right with the prices pinned to the left, because the scale of trading volume is different than the scale of prices. It is an error to specify an axis that isn't a valid minor axis for the chart's type .

type

enum ( BasicChartType )

The type of this series. Valid only if the chartType is COMBO . Different types will change the way the series is visualized. Only LINE , AREA , and COLUMN are supported.

lineStyle

object ( LineStyle )

The line style of this series. Valid only if the chartType is AREA , LINE , or SCATTER . COMBO charts are also supported if the series chart type is AREA or LINE .

dataLabel

object ( DataLabel )

Information about the data labels for this series.

color
(deprecated)

object ( Color )

The color for elements (such as bars, lines, and points) associated with this series. If empty, a default color is used. Deprecated: Use colorStyle .

colorStyle

object ( ColorStyle )

The color for elements (such as bars, lines, and points) associated with this series. If empty, a default color is used. If color is also set, this field takes precedence.

pointStyle

object ( PointStyle )

The style for points associated with this series. Valid only if the chartType is AREA , LINE , or SCATTER . COMBO charts are also supported if the series chart type is AREA , LINE , or SCATTER . If empty, a default point style is used.

styleOverrides[]

object ( BasicSeriesDataPointStyleOverride )

Style override settings for series data points.

LineStyle

Properties that describe the style of a line.

JSON representation 
{
  "width": integer,
  "type": enum (LineDashType)
}
Fields
width

integer

The thickness of the line, in px.

type

enum ( LineDashType )

The dash type of the line.

LineDashType

The dash type of a line.

Перечисление
LINE_DASH_TYPE_UNSPECIFIED Default value, do not use.
INVISIBLE No dash type, which is equivalent to a non-visible line.
CUSTOM A custom dash for a line. Modifying the exact custom dash style is currently unsupported.
SOLID A solid line.
DOTTED A dotted line.
MEDIUM_DASHED A dashed line where the dashes have "medium" length.
MEDIUM_DASHED_DOTTED A line that alternates between a "medium" dash and a dot.
LONG_DASHED A dashed line where the dashes have "long" length.
LONG_DASHED_DOTTED A line that alternates between a "long" dash and a dot.

DataLabel

Settings for one set of data labels. Data labels are annotations that appear next to a set of data, such as the points on a line chart, and provide additional information about what the data represents, such as a text representation of the value behind that point on the graph.

JSON representation 
{
  "type": enum (DataLabelType),
  "textFormat": {
    object (TextFormat)
  },
  "placement": enum (DataLabelPlacement),
  "customLabelData": {
    object (ChartData)
  }
}
Fields
type

enum ( DataLabelType )

The type of the data label.

textFormat

object ( TextFormat )

The text format used for the data label. The link field is not supported.

placement

enum ( DataLabelPlacement )

The placement of the data label relative to the labeled data.

customLabelData

object ( ChartData )

Data to use for custom labels. Only used if type is set to CUSTOM . This data must be the same length as the series or other element this data label is applied to. In addition, if the series is split into multiple source ranges, this source data must come from the next column in the source data. For example, if the series is B2:B4,E6:E8 then this data must come from C2:C4,F6:F8.

DataLabelType

The type of a data label.

Перечисление
DATA_LABEL_TYPE_UNSPECIFIED The data label type is not specified and will be interpreted depending on the context of the data label within the chart.
NONE The data label is not displayed.
DATA The data label is displayed using values from the series data.
CUSTOM The data label is displayed using values from a custom data source indicated by customLabelData .

DataLabelPlacement

The placement of a data label relative to the labeled data.

Перечисление
DATA_LABEL_PLACEMENT_UNSPECIFIED The positioning is determined automatically by the renderer.
CENTER Center within a bar or column, both horizontally and vertically.
LEFT To the left of a data point.
RIGHT To the right of a data point.
ABOVE Above a data point.
BELOW Below a data point.
INSIDE_END Inside a bar or column at the end (top if positive, bottom if negative).
INSIDE_BASE Inside a bar or column at the base.
OUTSIDE_END Outside a bar or column at the end.

PointStyle

The style of a point on the chart.

JSON representation 
{
  "size": number,
  "shape": enum (PointShape)
}
Fields
size

number

The point size. If empty, a default size is used.

shape

enum ( PointShape )

The point shape. If empty or unspecified, a default shape is used.

ПойнтШейп

The shape of a point.

Перечисление
POINT_SHAPE_UNSPECIFIED Значение по умолчанию.
CIRCLE A circle shape.
DIAMOND A diamond shape.
HEXAGON A hexagon shape.
PENTAGON A pentagon shape.
SQUARE A square shape.
STAR A star shape.
TRIANGLE A triangle shape.
X_MARK An x-mark shape.

BasicSeriesDataPointStyleOverride

Style override settings for a single series data point.

JSON representation 
{
  "index": integer,
  "color": {
    object (Color)
  },
  "colorStyle": {
    object (ColorStyle)
  },
  "pointStyle": {
    object (PointStyle)
  }
}
Fields
index

integer

The zero-based index of the series data point.

color
(deprecated)

object ( Color )

Color of the series data point. If empty, the series default is used. Deprecated: Use colorStyle .

colorStyle

object ( ColorStyle )

Color of the series data point. If empty, the series default is used. If color is also set, this field takes precedence.

pointStyle

object ( PointStyle )

Point style of the series data point. Valid only if the chartType is AREA , LINE , or SCATTER . COMBO charts are also supported if the series chart type is AREA , LINE , or SCATTER . If empty, the series default is used.

BasicChartStackedType

When charts are stacked, range (vertical axis) values are rendered on top of one another rather than from the horizontal axis. For example, the two values 20 and 80 would be drawn from 0, with 80 being 80 units away from the horizontal axis. If they were stacked, 80 would be rendered from 20, putting it 100 units away from the horizontal axis.

Перечисление
BASIC_CHART_STACKED_TYPE_UNSPECIFIED Default value, do not use.
NOT_STACKED Series are not stacked.
STACKED Series values are stacked, each value is rendered vertically beginning from the top of the value below it.
PERCENT_STACKED Vertical stacks are stretched to reach the top of the chart, with values laid out as percentages of each other.

BasicChartCompareMode

The compare mode type, which describes the behavior of tooltips and data highlighting when hovering on data and chart area.

Перечисление
BASIC_CHART_COMPARE_MODE_UNSPECIFIED Default value, do not use.
DATUM Only the focused data element is highlighted and shown in the tooltip.
CATEGORY All data elements with the same category (eg, domain value) are highlighted and shown in the tooltip.

PieChartSpec

A pie chart .

JSON representation 
{
  "legendPosition": enum (PieChartLegendPosition),
  "domain": {
    object (ChartData)
  },
  "series": {
    object (ChartData)
  },
  "threeDimensional": boolean,
  "pieHole": number
}
Fields
legendPosition

enum ( PieChartLegendPosition )

Where the legend of the pie chart should be drawn.

domain

object ( ChartData )

The data that covers the domain of the pie chart.

series

object ( ChartData )

The data that covers the one and only series of the pie chart.

threeDimensional

boolean

True if the pie is three dimensional.

pieHole

number

The size of the hole in the pie chart.

PieChartLegendPosition

Where the legend of the chart should be positioned.

Перечисление
PIE_CHART_LEGEND_POSITION_UNSPECIFIED Default value, do not use.
BOTTOM_LEGEND The legend is rendered on the bottom of the chart.
LEFT_LEGEND The legend is rendered on the left of the chart.
RIGHT_LEGEND The legend is rendered on the right of the chart.
TOP_LEGEND The legend is rendered on the top of the chart.
NO_LEGEND No legend is rendered.
LABELED_LEGEND Each pie slice has a label attached to it.

BubbleChartSpec

A bubble chart .

JSON representation 
{
  "legendPosition": enum (BubbleChartLegendPosition),
  "bubbleLabels": {
    object (ChartData)
  },
  "domain": {
    object (ChartData)
  },
  "series": {
    object (ChartData)
  },
  "groupIds": {
    object (ChartData)
  },
  "bubbleSizes": {
    object (ChartData)
  },
  "bubbleOpacity": number,
  "bubbleBorderColor": {
    object (Color)
  },
  "bubbleBorderColorStyle": {
    object (ColorStyle)
  },
  "bubbleMaxRadiusSize": integer,
  "bubbleMinRadiusSize": integer,
  "bubbleTextStyle": {
    object (TextFormat)
  }
}
Fields
legendPosition

enum ( BubbleChartLegendPosition )

Where the legend of the chart should be drawn.

bubbleLabels

object ( ChartData )

The data containing the bubble labels. These do not need to be unique.

domain

object ( ChartData )

The data containing the bubble x-values. These values locate the bubbles in the chart horizontally.

series

object ( ChartData )

The data containing the bubble y-values. These values locate the bubbles in the chart vertically.

groupIds

object ( ChartData )

The data containing the bubble group IDs. All bubbles with the same group ID are drawn in the same color. If bubbleSizes is specified then this field must also be specified but may contain blank values. This field is optional.

bubbleSizes

object ( ChartData )

The data containing the bubble sizes. Bubble sizes are used to draw the bubbles at different sizes relative to each other. If specified, groupIds must also be specified. This field is optional.

bubbleOpacity

number

The opacity of the bubbles between 0 and 1.0. 0 is fully transparent and 1 is fully opaque.

bubbleBorderColor
(deprecated)

object ( Color )

The bubble border color. Deprecated: Use bubbleBorderColorStyle .

bubbleBorderColorStyle

object ( ColorStyle )

The bubble border color. If bubbleBorderColor is also set, this field takes precedence.

bubbleMaxRadiusSize

integer

The max radius size of the bubbles, in pixels. If specified, the field must be a positive value.

bubbleMinRadiusSize

integer

The minimum radius size of the bubbles, in pixels. If specific, the field must be a positive value.

bubbleTextStyle

object ( TextFormat )

The format of the text inside the bubbles. Strikethrough, underline, and link are not supported.

BubbleChartLegendPosition

Where the legend of the chart should be positioned.

Перечисление
BUBBLE_CHART_LEGEND_POSITION_UNSPECIFIED Default value, do not use.
BOTTOM_LEGEND The legend is rendered on the bottom of the chart.
LEFT_LEGEND The legend is rendered on the left of the chart.
RIGHT_LEGEND The legend is rendered on the right of the chart.
TOP_LEGEND The legend is rendered on the top of the chart.
NO_LEGEND No legend is rendered.
INSIDE_LEGEND The legend is rendered inside the chart area.

CandlestickChartSpec

A candlestick chart .

JSON representation 
{
  "domain": {
    object (CandlestickDomain)
  },
  "data": [
    {
      object (CandlestickData)
    }
  ]
}
Fields
domain

object ( CandlestickDomain )

The domain data (horizontal axis) for the candlestick chart. String data will be treated as discrete labels, other data will be treated as continuous values.

data[]

object ( CandlestickData )

The Candlestick chart data. Only one CandlestickData is supported.

CandlestickDomain

The domain of a CandlestickChart.

JSON representation 
{
  "data": {
    object (ChartData)
  },
  "reversed": boolean
}
Fields
data

object ( ChartData )

The data of the CandlestickDomain.

reversed

boolean

True to reverse the order of the domain values (horizontal axis).

CandlestickData

The Candlestick chart data, each containing the low, open, close, and high values for a series.

JSON representation 
{
  "lowSeries": {
    object (CandlestickSeries)
  },
  "openSeries": {
    object (CandlestickSeries)
  },
  "closeSeries": {
    object (CandlestickSeries)
  },
  "highSeries": {
    object (CandlestickSeries)
  }
}
Fields
lowSeries

object ( CandlestickSeries )

The range data (vertical axis) for the low/minimum value for each candle. This is the bottom of the candle's center line.

openSeries

object ( CandlestickSeries )

The range data (vertical axis) for the open/initial value for each candle. This is the bottom of the candle body. If less than the close value the candle will be filled. Otherwise the candle will be hollow.

closeSeries

object ( CandlestickSeries )

The range data (vertical axis) for the close/final value for each candle. This is the top of the candle body. If greater than the open value the candle will be filled. Otherwise the candle will be hollow.

highSeries

object ( CandlestickSeries )

The range data (vertical axis) for the high/maximum value for each candle. This is the top of the candle's center line.

CandlestickSeries

The series of a CandlestickData.

JSON representation 
{
  "data": {
    object (ChartData)
  }
}
Fields
data

object ( ChartData )

The data of the CandlestickSeries.

OrgChartSpec

An org chart . Org charts require a unique set of labels in labels and may optionally include parentLabels and tooltips . parentLabels contain, for each node, the label identifying the parent node. tooltips contain, for each node, an optional tooltip.

For example, to describe an OrgChart with Alice as the CEO, Bob as the President (reporting to Alice) and Cathy as VP of Sales (also reporting to Alice), have labels contain "Alice", "Bob", "Cathy", parentLabels contain "", "Alice", "Alice" and tooltips contain "CEO", "President", "VP Sales".

JSON representation 
{
  "nodeSize": enum (OrgChartNodeSize),
  "nodeColor": {
    object (Color)
  },
  "nodeColorStyle": {
    object (ColorStyle)
  },
  "selectedNodeColor": {
    object (Color)
  },
  "selectedNodeColorStyle": {
    object (ColorStyle)
  },
  "labels": {
    object (ChartData)
  },
  "parentLabels": {
    object (ChartData)
  },
  "tooltips": {
    object (ChartData)
  }
}
Fields
nodeSize

enum ( OrgChartNodeSize )

The size of the org chart nodes.

nodeColor
(deprecated)

object ( Color )

The color of the org chart nodes. Deprecated: Use nodeColorStyle .

nodeColorStyle

object ( ColorStyle )

The color of the org chart nodes. If nodeColor is also set, this field takes precedence.

selectedNodeColor
(deprecated)

object ( Color )

The color of the selected org chart nodes. Deprecated: Use selectedNodeColorStyle .

selectedNodeColorStyle

object ( ColorStyle )

The color of the selected org chart nodes. If selectedNodeColor is also set, this field takes precedence.

labels

object ( ChartData )

The data containing the labels for all the nodes in the chart. Labels must be unique.

parentLabels

object ( ChartData )

The data containing the label of the parent for the corresponding node. A blank value indicates that the node has no parent and is a top-level node. This field is optional.

tooltips

object ( ChartData )

The data containing the tooltip for the corresponding node. A blank value results in no tooltip being displayed for the node. This field is optional.

OrgChartNodeSize

The size of the org chart nodes.

Перечисление
ORG_CHART_LABEL_SIZE_UNSPECIFIED Default value, do not use.
SMALL The small org chart node size.
MEDIUM The medium org chart node size.
LARGE The large org chart node size.

HistogramChartSpec

A histogram chart . A histogram chart groups data items into bins, displaying each bin as a column of stacked items. Histograms are used to display the distribution of a dataset. Each column of items represents a range into which those items fall. The number of bins can be chosen automatically or specified explicitly.

JSON representation 
{
  "series": [
    {
      object (HistogramSeries)
    }
  ],
  "legendPosition": enum (HistogramChartLegendPosition),
  "showItemDividers": boolean,
  "bucketSize": number,
  "outlierPercentile": number
}
Fields
series[]

object ( HistogramSeries )

The series for a histogram may be either a single series of values to be bucketed or multiple series, each of the same length, containing the name of the series followed by the values to be bucketed for that series.

legendPosition

enum ( HistogramChartLegendPosition )

The position of the chart legend.

showItemDividers

boolean

Whether horizontal divider lines should be displayed between items in each column.

bucketSize

number

By default the bucket size (the range of values stacked in a single column) is chosen automatically, but it may be overridden here. Eg, A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc. Cannot be negative. This field is optional.

outlierPercentile

number

The outlier percentile is used to ensure that outliers do not adversely affect the calculation of bucket sizes. For example, setting an outlier percentile of 0.05 indicates that the top and bottom 5% of values when calculating buckets. The values are still included in the chart, they will be added to the first or last buckets instead of their own buckets. Must be between 0.0 and 0.5.

HistogramSeries

A histogram series containing the series color and data.

JSON representation 
{
  "barColor": {
    object (Color)
  },
  "barColorStyle": {
    object (ColorStyle)
  },
  "data": {
    object (ChartData)
  }
}
Fields
barColor
(deprecated)

object ( Color )

The color of the column representing this series in each bucket. This field is optional. Deprecated: Use barColorStyle .

barColorStyle

object ( ColorStyle )

The color of the column representing this series in each bucket. This field is optional. If barColor is also set, this field takes precedence.

data

object ( ChartData )

The data for this histogram series.

HistogramChartLegendPosition

Where the legend of the chart should be positioned.

Перечисление
HISTOGRAM_CHART_LEGEND_POSITION_UNSPECIFIED Default value, do not use.
BOTTOM_LEGEND The legend is rendered on the bottom of the chart.
LEFT_LEGEND The legend is rendered on the left of the chart.
RIGHT_LEGEND The legend is rendered on the right of the chart.
TOP_LEGEND The legend is rendered on the top of the chart.
NO_LEGEND No legend is rendered.
INSIDE_LEGEND The legend is rendered inside the chart area.

WaterfallChartSpec

A waterfall chart.

JSON representation 
{
  "domain": {
    object (WaterfallChartDomain)
  },
  "series": [
    {
      object (WaterfallChartSeries)
    }
  ],
  "stackedType": enum (WaterfallChartStackedType),
  "firstValueIsTotal": boolean,
  "hideConnectorLines": boolean,
  "connectorLineStyle": {
    object (LineStyle)
  },
  "totalDataLabel": {
    object (DataLabel)
  }
}
Fields
domain

object ( WaterfallChartDomain )

The domain data (horizontal axis) for the waterfall chart.

series[]

object ( WaterfallChartSeries )

The data this waterfall chart is visualizing.

stackedType

enum ( WaterfallChartStackedType )

The stacked type.

firstValueIsTotal

boolean

True to interpret the first value as a total.

hideConnectorLines

boolean

True to hide connector lines between columns.

connectorLineStyle

object ( LineStyle )

The line style for the connector lines.

totalDataLabel

object ( DataLabel )

Controls whether to display additional data labels on stacked charts which sum the total value of all stacked values at each value along the domain axis. stackedType must be STACKED and neither CUSTOM nor placement can be set on the totalDataLabel .

WaterfallChartDomain

The domain of a waterfall chart.

JSON representation 
{
  "data": {
    object (ChartData)
  },
  "reversed": boolean
}
Fields
data

object ( ChartData )

The data of the WaterfallChartDomain.

reversed

boolean

True to reverse the order of the domain values (horizontal axis).

WaterfallChartSeries

A single series of data for a waterfall chart.

JSON representation 
{
  "data": {
    object (ChartData)
  },
  "positiveColumnsStyle": {
    object (WaterfallChartColumnStyle)
  },
  "negativeColumnsStyle": {
    object (WaterfallChartColumnStyle)
  },
  "subtotalColumnsStyle": {
    object (WaterfallChartColumnStyle)
  },
  "hideTrailingSubtotal": boolean,
  "customSubtotals": [
    {
      object (WaterfallChartCustomSubtotal)
    }
  ],
  "dataLabel": {
    object (DataLabel)
  }
}
Fields
data

object ( ChartData )

The data being visualized in this series.

positiveColumnsStyle

object ( WaterfallChartColumnStyle )

Styles for all columns in this series with positive values.

negativeColumnsStyle

object ( WaterfallChartColumnStyle )

Styles for all columns in this series with negative values.

subtotalColumnsStyle

object ( WaterfallChartColumnStyle )

Styles for all subtotal columns in this series.

hideTrailingSubtotal

boolean

True to hide the subtotal column from the end of the series. By default, a subtotal column will appear at the end of each series. Setting this field to true will hide that subtotal column for this series.

customSubtotals[]

object ( WaterfallChartCustomSubtotal )

Custom subtotal columns appearing in this series. The order in which subtotals are defined is not significant. Only one subtotal may be defined for each data point.

dataLabel

object ( DataLabel )

Information about the data labels for this series.

WaterfallChartColumnStyle

Styles for a waterfall chart column.

JSON representation 
{
  "label": string,
  "color": {
    object (Color)
  },
  "colorStyle": {
    object (ColorStyle)
  }
}
Fields
label

string

The label of the column's legend.

color
(deprecated)

object ( Color )

The color of the column. Deprecated: Use colorStyle .

colorStyle

object ( ColorStyle )

The color of the column. If color is also set, this field takes precedence.

WaterfallChartCustomSubtotal

A custom subtotal column for a waterfall chart series.

JSON representation 
{
  "subtotalIndex": integer,
  "label": string,
  "dataIsSubtotal": boolean
}
Fields
subtotalIndex

integer

The zero-based index of a data point within the series. If dataIsSubtotal is true, the data point at this index is the subtotal. Otherwise, the subtotal appears after the data point with this index. A series can have multiple subtotals at arbitrary indices, but subtotals do not affect the indices of the data points. For example, if a series has three data points, their indices will always be 0, 1, and 2, regardless of how many subtotals exist on the series or what data points they are associated with.

label

string

A label for the subtotal column.

dataIsSubtotal

boolean

True if the data point at subtotalIndex is the subtotal. If false, the subtotal will be computed and appear after the data point.

WaterfallChartStackedType

Stacked type options for waterfall charts.

Перечисление
WATERFALL_STACKED_TYPE_UNSPECIFIED Default value, do not use.
STACKED Values corresponding to the same domain (horizontal axis) value will be stacked vertically.
SEQUENTIAL Series will spread out along the horizontal axis.

TreemapChartSpec

A Treemap chart .

JSON representation 
{
  "labels": {
    object (ChartData)
  },
  "parentLabels": {
    object (ChartData)
  },
  "sizeData": {
    object (ChartData)
  },
  "colorData": {
    object (ChartData)
  },
  "textFormat": {
    object (TextFormat)
  },
  "levels": integer,
  "hintedLevels": integer,
  "minValue": number,
  "maxValue": number,
  "headerColor": {
    object (Color)
  },
  "headerColorStyle": {
    object (ColorStyle)
  },
  "colorScale": {
    object (TreemapChartColorScale)
  },
  "hideTooltips": boolean
}
Fields
labels

object ( ChartData )

The data that contains the treemap cell labels.

parentLabels

object ( ChartData )

The data the contains the treemap cells' parent labels.

sizeData

object ( ChartData )

The data that determines the size of each treemap data cell. This data is expected to be numeric. The cells corresponding to non-numeric or missing data will not be rendered. If colorData is not specified, this data is used to determine data cell background colors as well.

colorData

object ( ChartData )

The data that determines the background color of each treemap data cell. This field is optional. If not specified, sizeData is used to determine background colors. If specified, the data is expected to be numeric. colorScale will determine how the values in this data map to data cell background colors.

textFormat

object ( TextFormat )

The text format for all labels on the chart. The link field is not supported.

levels

integer

The number of data levels to show on the treemap chart. These levels are interactive and are shown with their labels. Defaults to 2 if not specified.

hintedLevels

integer

The number of additional data levels beyond the labeled levels to be shown on the treemap chart. These levels are not interactive and are shown without their labels. Defaults to 0 if not specified.

minValue

number

The minimum possible data value. Cells with values less than this will have the same color as cells with this value. If not specified, defaults to the actual minimum value from colorData , or the minimum value from sizeData if colorData is not specified.

maxValue

number

The maximum possible data value. Cells with values greater than this will have the same color as cells with this value. If not specified, defaults to the actual maximum value from colorData , or the maximum value from sizeData if colorData is not specified.

headerColor
(deprecated)

object ( Color )

The background color for header cells. Deprecated: Use headerColorStyle .

headerColorStyle

object ( ColorStyle )

The background color for header cells. If headerColor is also set, this field takes precedence.

colorScale

object ( TreemapChartColorScale )

The color scale for data cells in the treemap chart. Data cells are assigned colors based on their color values. These color values come from colorData , or from sizeData if colorData is not specified. Cells with color values less than or equal to minValue will have minValueColor as their background color. Cells with color values greater than or equal to maxValue will have maxValueColor as their background color. Cells with color values between minValue and maxValue will have background colors on a gradient between minValueColor and maxValueColor , the midpoint of the gradient being midValueColor . Cells with missing or non-numeric color values will have noDataColor as their background color.

hideTooltips

boolean

True to hide tooltips.

TreemapChartColorScale

A color scale for a treemap chart.

JSON representation 
{
  "minValueColor": {
    object (Color)
  },
  "minValueColorStyle": {
    object (ColorStyle)
  },
  "midValueColor": {
    object (Color)
  },
  "midValueColorStyle": {
    object (ColorStyle)
  },
  "maxValueColor": {
    object (Color)
  },
  "maxValueColorStyle": {
    object (ColorStyle)
  },
  "noDataColor": {
    object (Color)
  },
  "noDataColorStyle": {
    object (ColorStyle)
  }
}
Fields
minValueColor
(deprecated)

object ( Color )

The background color for cells with a color value less than or equal to minValue . Defaults to #dc3912 if not specified. Deprecated: Use minValueColorStyle .

minValueColorStyle

object ( ColorStyle )

The background color for cells with a color value less than or equal to minValue . Defaults to #dc3912 if not specified. If minValueColor is also set, this field takes precedence.

midValueColor
(deprecated)

object ( Color )

The background color for cells with a color value at the midpoint between minValue and maxValue . Defaults to #efe6dc if not specified. Deprecated: Use midValueColorStyle .

midValueColorStyle

object ( ColorStyle )

The background color for cells with a color value at the midpoint between minValue and maxValue . Defaults to #efe6dc if not specified. If midValueColor is also set, this field takes precedence.

maxValueColor
(deprecated)

object ( Color )

The background color for cells with a color value greater than or equal to maxValue . Defaults to #109618 if not specified. Deprecated: Use maxValueColorStyle .

maxValueColorStyle

object ( ColorStyle )

The background color for cells with a color value greater than or equal to maxValue . Defaults to #109618 if not specified. If maxValueColor is also set, this field takes precedence.

noDataColor
(deprecated)

object ( Color )

The background color for cells that have no color data associated with them. Defaults to #000000 if not specified. Deprecated: Use noDataColorStyle .

noDataColorStyle

object ( ColorStyle )

The background color for cells that have no color data associated with them. Defaults to #000000 if not specified. If noDataColor is also set, this field takes precedence.

ScorecardChartSpec

A scorecard chart. Scorecard charts are used to highlight key performance indicators, known as KPIs, on the spreadsheet. A scorecard chart can represent things like total sales, average cost, or a top selling item. You can specify a single data value, or aggregate over a range of data. Percentage or absolute difference from a baseline value can be highlighted, like changes over time.

JSON representation 
{
  "keyValueData": {
    object (ChartData)
  },
  "baselineValueData": {
    object (ChartData)
  },
  "aggregateType": enum (ChartAggregateType),
  "keyValueFormat": {
    object (KeyValueFormat)
  },
  "baselineValueFormat": {
    object (BaselineValueFormat)
  },
  "scaleFactor": number,
  "numberFormatSource": enum (ChartNumberFormatSource),
  "customFormatOptions": {
    object (ChartCustomNumberFormatOptions)
  }
}
Fields
keyValueData

object ( ChartData )

The data for scorecard key value.

baselineValueData

object ( ChartData )

The data for scorecard baseline value. This field is optional.

aggregateType

enum ( ChartAggregateType )

The aggregation type for key and baseline chart data in scorecard chart. This field is not supported for data source charts. Use the ChartData.aggregateType field of the keyValueData or baselineValueData instead for data source charts. This field is optional.

keyValueFormat

object ( KeyValueFormat )

Formatting options for key value.

baselineValueFormat

object ( BaselineValueFormat )

Formatting options for baseline value. This field is needed only if baselineValueData is specified.

scaleFactor

number

Value to scale scorecard key and baseline value. For example, a factor of 10 can be used to divide all values in the chart by 10. This field is optional.

numberFormatSource

enum ( ChartNumberFormatSource )

The number format source used in the scorecard chart. This field is optional.

customFormatOptions

object ( ChartCustomNumberFormatOptions )

Custom formatting options for numeric key/baseline values in scorecard chart. This field is used only when numberFormatSource is set to CUSTOM . This field is optional.

КлючЗначениеФормат

Formatting options for key value.

JSON representation 
{
  "textFormat": {
    object (TextFormat)
  },
  "position": {
    object (TextPosition)
  }
}
Fields
textFormat

object ( TextFormat )

Text formatting options for key value. The link field is not supported.

position

object ( TextPosition )

Specifies the horizontal text positioning of key value. This field is optional. If not specified, default positioning is used.

BaselineValueFormat

Formatting options for baseline value.

JSON representation 
{
  "comparisonType": enum (ComparisonType),
  "textFormat": {
    object (TextFormat)
  },
  "position": {
    object (TextPosition)
  },
  "description": string,
  "positiveColor": {
    object (Color)
  },
  "positiveColorStyle": {
    object (ColorStyle)
  },
  "negativeColor": {
    object (Color)
  },
  "negativeColorStyle": {
    object (ColorStyle)
  }
}
Fields
comparisonType

enum ( ComparisonType )

The comparison type of key value with baseline value.

textFormat

object ( TextFormat )

Text formatting options for baseline value. The link field is not supported.

position

object ( TextPosition )

Specifies the horizontal text positioning of baseline value. This field is optional. If not specified, default positioning is used.

description

string

Description which is appended after the baseline value. This field is optional.

positiveColor
(deprecated)

object ( Color )

Color to be used, in case baseline value represents a positive change for key value. This field is optional. Deprecated: Use positiveColorStyle .

positiveColorStyle

object ( ColorStyle )

Color to be used, in case baseline value represents a positive change for key value. This field is optional. If positiveColor is also set, this field takes precedence.

negativeColor
(deprecated)

object ( Color )

Color to be used, in case baseline value represents a negative change for key value. This field is optional. Deprecated: Use negativeColorStyle .

negativeColorStyle

object ( ColorStyle )

Color to be used, in case baseline value represents a negative change for key value. This field is optional. If negativeColor is also set, this field takes precedence.

ComparisonType

The comparison type of key value with baseline value.

Перечисление
COMPARISON_TYPE_UNDEFINED Default value, do not use.
ABSOLUTE_DIFFERENCE Use absolute difference between key and baseline value.
PERCENTAGE_DIFFERENCE Use percentage difference between key and baseline value.

ChartNumberFormatSource

The number formatting source options for chart attributes.

Перечисление
CHART_NUMBER_FORMAT_SOURCE_UNDEFINED Default value, do not use.
FROM_DATA Inherit number formatting from data.
CUSTOM Apply custom formatting as specified by ChartCustomNumberFormatOptions .

ChartCustomNumberFormatOptions

Custom number formatting options for chart attributes.

JSON representation 
{
  "prefix": string,
  "suffix": string
}
Fields
prefix

string

Custom prefix to be prepended to the chart attribute. This field is optional.

suffix

string

Custom suffix to be appended to the chart attribute. This field is optional.

ChartHiddenDimensionStrategy

Determines how charts should handle source rows that are hidden. Hidden rows include both manually hidden and hidden by a filter.

Перечисление
CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED Default value, do not use.
SKIP_HIDDEN_ROWS_AND_COLUMNS Charts will skip hidden rows and columns.
SKIP_HIDDEN_ROWS Charts will skip hidden rows only.
SKIP_HIDDEN_COLUMNS Charts will skip hidden columns only.
SHOW_ALL Charts will not skip any hidden rows or columns.

EmbeddedObjectPosition

The position of an embedded object such as a chart.

JSON representation 
{

  // Union field location can be only one of the following:
  "sheetId": integer,
  "overlayPosition": {
    object (OverlayPosition)
  },
  "newSheet": boolean
  // End of list of possible types for union field location.
}
Fields
Union field location . The location of the object. Exactly one value must be set. location can be only one of the following:
sheetId

integer

The sheet this is on. Set only if the embedded object is on its own sheet. Must be non-negative.

overlayPosition

object ( OverlayPosition )

The position at which the object is overlaid on top of a grid.

newSheet

boolean

If true, the embedded object is put on a new sheet whose ID is chosen for you. Used only when writing.

OverlayPosition

The location an object is overlaid on top of a grid.

JSON representation 
{
  "anchorCell": {
    object (GridCoordinate)
  },
  "offsetXPixels": integer,
  "offsetYPixels": integer,
  "widthPixels": integer,
  "heightPixels": integer
}
Fields
anchorCell

object ( GridCoordinate )

The cell the object is anchored to.

offsetXPixels

integer

The horizontal offset, in pixels, that the object is offset from the anchor cell.

offsetYPixels

integer

The vertical offset, in pixels, that the object is offset from the anchor cell.

widthPixels

integer

The width of the object, in pixels. Defaults to 600.

heightPixels

integer

The height of the object, in pixels. Defaults to 371.

GridCoordinate

A coordinate in a sheet. All indexes are zero-based.

JSON representation 
{
  "sheetId": integer,
  "rowIndex": integer,
  "columnIndex": integer
}
Fields
sheetId

integer

The sheet this coordinate is on.

rowIndex

integer

The row index of the coordinate.

columnIndex

integer

The column index of the coordinate.

EmbeddedObjectBorder

A border along an embedded object.

JSON representation 
{
  "color": {
    object (Color)
  },
  "colorStyle": {
    object (ColorStyle)
  }
}
Fields
color
(deprecated)

object ( Color )

The color of the border. Deprecated: Use colorStyle .

colorStyle

object ( ColorStyle )

The color of the border. If color is also set, this field takes precedence.

BandedRange

A banded (alternating colors) range in a sheet.

JSON representation 
{
  "bandedRangeId": integer,
  "range": {
    object (GridRange)
  },
  "rowProperties": {
    object (BandingProperties)
  },
  "columnProperties": {
    object (BandingProperties)
  }
}
Fields
bandedRangeId

integer

The ID of the banded range.

range

object ( GridRange )

The range over which these properties are applied.

rowProperties

object ( BandingProperties )

Properties for row bands. These properties are applied on a row-by-row basis throughout all the rows in the range. At least one of rowProperties or columnProperties must be specified.

columnProperties

object ( BandingProperties )

Properties for column bands. These properties are applied on a column- by-column basis throughout all the columns in the range. At least one of rowProperties or columnProperties must be specified.

BandingProperties

Properties referring a single dimension (either row or column). If both BandedRange.row_properties and BandedRange.column_properties are set, the fill colors are applied to cells according to the following rules:

For example, the first row color takes priority over the first column color, but the first column color takes priority over the second row color. Similarly, the row header takes priority over the column header in the top left cell, but the column header takes priority over the first row color if the row header is not set.

JSON representation 
{
  "headerColor": {
    object (Color)
  },
  "headerColorStyle": {
    object (ColorStyle)
  },
  "firstBandColor": {
    object (Color)
  },
  "firstBandColorStyle": {
    object (ColorStyle)
  },
  "secondBandColor": {
    object (Color)
  },
  "secondBandColorStyle": {
    object (ColorStyle)
  },
  "footerColor": {
    object (Color)
  },
  "footerColorStyle": {
    object (ColorStyle)
  }
}
Fields
headerColor
(deprecated)

object ( Color )

The color of the first row or column. If this field is set, the first row or column is filled with this color and the colors alternate between firstBandColor and secondBandColor starting from the second row or column. Otherwise, the first row or column is filled with firstBandColor and the colors proceed to alternate as they normally would. Deprecated: Use headerColorStyle .

headerColorStyle

object ( ColorStyle )

The color of the first row or column. If this field is set, the first row or column is filled with this color and the colors alternate between firstBandColor and secondBandColor starting from the second row or column. Otherwise, the first row or column is filled with firstBandColor and the colors proceed to alternate as they normally would. If headerColor is also set, this field takes precedence.

firstBandColor
(deprecated)

object ( Color )

The first color that is alternating. (Required) Deprecated: Use firstBandColorStyle .

firstBandColorStyle

object ( ColorStyle )

The first color that is alternating. (Required) If firstBandColor is also set, this field takes precedence.

secondBandColor
(deprecated)

object ( Color )

The second color that is alternating. (Required) Deprecated: Use secondBandColorStyle .

secondBandColorStyle

object ( ColorStyle )

The second color that is alternating. (Required) If secondBandColor is also set, this field takes precedence.

footerColor
(deprecated)

object ( Color )

The color of the last row or column. If this field is not set, the last row or column is filled with either firstBandColor or secondBandColor , depending on the color of the previous row or column. Deprecated: Use footerColorStyle .

footerColorStyle

object ( ColorStyle )

The color of the last row or column. If this field is not set, the last row or column is filled with either firstBandColor or secondBandColor , depending on the color of the previous row or column. If footerColor is also set, this field takes precedence.

DimensionGroup

A group over an interval of rows or columns on a sheet, which can contain or be contained within other groups. A group can be collapsed or expanded as a unit on the sheet.

JSON representation 
{
  "range": {
    object (DimensionRange)
  },
  "depth": integer,
  "collapsed": boolean
}
Fields
range

object ( DimensionRange )

The range over which this group exists.

depth

integer

The depth of the group, representing how many groups have a range that wholly contains the range of this group.

collapsed

boolean

This field is true if this group is collapsed. A collapsed group remains collapsed if an overlapping group at a shallower depth is expanded.

A true value does not imply that all dimensions within the group are hidden, since a dimension's visibility can change independently from this group property. However, when this property is updated, all dimensions within it are set to hidden if this field is true, or set to visible if this field is false.

Slicer

A slicer in a sheet.

JSON representation 
{
  "slicerId": integer,
  "spec": {
    object (SlicerSpec)
  },
  "position": {
    object (EmbeddedObjectPosition)
  }
}
Fields
slicerId

integer

The ID of the slicer.

spec

object ( SlicerSpec )

The specification of the slicer.

position

object ( EmbeddedObjectPosition )

The position of the slicer. Note that slicer can be positioned only on existing sheet. Also, width and height of slicer can be automatically adjusted to keep it within permitted limits.

SlicerSpec

The specifications of a slicer.

JSON representation 
{
  "dataRange": {
    object (GridRange)
  },
  "filterCriteria": {
    object (FilterCriteria)
  },
  "columnIndex": integer,
  "applyToPivotTables": boolean,
  "title": string,
  "textFormat": {
    object (TextFormat)
  },
  "backgroundColor": {
    object (Color)
  },
  "backgroundColorStyle": {
    object (ColorStyle)
  },
  "horizontalAlignment": enum (HorizontalAlign)
}
Fields
dataRange

object ( GridRange )

The data range of the slicer.

filterCriteria

object ( FilterCriteria )

The filtering criteria of the slicer.

columnIndex

integer

The zero-based column index in the data table on which the filter is applied to.

applyToPivotTables

boolean

True if the filter should apply to pivot tables. If not set, default to True .

title

string

The title of the slicer.

textFormat

object ( TextFormat )

The text format of title in the slicer. The link field is not supported.

backgroundColor
(deprecated)

object ( Color )

The background color of the slicer. Deprecated: Use backgroundColorStyle .

backgroundColorStyle

object ( ColorStyle )

The background color of the slicer. If backgroundColor is also set, this field takes precedence.

horizontalAlignment

enum ( HorizontalAlign )

The horizontal alignment of title in the slicer. If unspecified, defaults to LEFT

Стол

A table.

JSON representation 
{
  "tableId": string,
  "name": string,
  "range": {
    object (GridRange)
  },
  "rowsProperties": {
    object (TableRowsProperties)
  },
  "columnProperties": [
    {
      object (TableColumnProperties)
    }
  ]
}
Fields
tableId

string

The id of the table.

name

string

The table name. This is unique to all tables in the same spreadsheet.

range

object ( GridRange )

The table range.

rowsProperties

object ( TableRowsProperties )

The table rows properties.

columnProperties[]

object ( TableColumnProperties )

The table column properties.

TableRowsProperties

The table row properties.

JSON representation 
{
  "headerColorStyle": {
    object (ColorStyle)
  },
  "firstBandColorStyle": {
    object (ColorStyle)
  },
  "secondBandColorStyle": {
    object (ColorStyle)
  },
  "footerColorStyle": {
    object (ColorStyle)
  }
}
Fields
headerColorStyle

object ( ColorStyle )

The color of the header row. If this field is set, the header row is filled with the specified color. Otherwise, the header row is filled with a default color.

firstBandColorStyle

object ( ColorStyle )

The first color that is alternating. If this field is set, the first banded row is filled with the specified color. Otherwise, the first banded row is filled with a default color.

secondBandColorStyle

object ( ColorStyle )

The second color that is alternating. If this field is set, the second banded row is filled with the specified color. Otherwise, the second banded row is filled with a default color.

footerColorStyle

object ( ColorStyle )

The color of the last row. If this field is not set a footer is not added, the last row is filled with either firstBandColorStyle or secondBandColorStyle , depending on the color of the previous row. If updating an existing table without a footer to have a footer, the range will be expanded by 1 row. If updating an existing table with a footer and removing a footer, the range will be shrunk by 1 row.

TableColumnProperties

The table column.

JSON representation 
{
  "columnIndex": integer,
  "columnName": string,
  "columnType": enum (ColumnType),
  "dataValidationRule": {
    object (TableColumnDataValidationRule)
  }
}
Fields
columnIndex

integer

The 0-based column index. This index is relative to its position in the table and is not necessarily the same as the column index in the sheet.

columnName

string

The column name.

columnType

enum ( ColumnType )

The column type.

dataValidationRule

object ( TableColumnDataValidationRule )

The column data validation rule. Only set for dropdown column type.

ColumnType

The column type for a given column in a table.

Перечисление
COLUMN_TYPE_UNSPECIFIED An unspecified column type.
DOUBLE The number column type.
CURRENCY The currency column type.
PERCENT The percent column type.
DATE The date column type.
TIME The time column type.
DATE_TIME The date and time column type.
TEXT The text column type.
BOOLEAN The boolean column type.
DROPDOWN The dropdown column type.
FILES_CHIP The files chip column type
PEOPLE_CHIP The people chip column type
FINANCE_CHIP The finance chip column type
PLACE_CHIP The place chip column type
RATINGS_CHIP The ratings chip column type

TableColumnDataValidationRule

A data validation rule for a column in a table.

JSON representation 
{
  "condition": {
    object (BooleanCondition)
  }
}
Fields
condition

object ( BooleanCondition )

The condition that data in the cell must match. Valid only if the [BooleanCondition.type] is ONE_OF_LIST.

NamedRange

A named range.

JSON representation 
{
  "namedRangeId": string,
  "name": string,
  "range": {
    object (GridRange)
  }
}
Fields
namedRangeId

string

The ID of the named range.

name

string

The name of the named range.

range

object ( GridRange )

The range this represents.

DataSource

Information about an external data source in the spreadsheet.

JSON representation 
{
  "dataSourceId": string,
  "spec": {
    object (DataSourceSpec)
  },
  "calculatedColumns": [
    {
      object (DataSourceColumn)
    }
  ],
  "sheetId": integer
}
Fields
dataSourceId

string

The spreadsheet-scoped unique ID that identifies the data source. Example: 1080547365.

spec

object ( DataSourceSpec )

The DataSourceSpec for the data source connected with this spreadsheet.

calculatedColumns[]

object ( DataSourceColumn )

All calculated columns in the data source.

sheetId

integer

The ID of the Sheet connected with the data source. The field cannot be changed once set.

When creating a data source, an associated DATA_SOURCE sheet is also created, if the field is not specified, the ID of the created sheet will be randomly generated.

DataSourceSpec

This specifies the details of the data source. For example, for BigQuery, this specifies information about the BigQuery source.

JSON representation 
{
  "parameters": [
    {
      object (DataSourceParameter)
    }
  ],

  // Union field spec can be only one of the following:
  "bigQuery": {
    object (BigQueryDataSourceSpec)
  },
  "looker": {
    object (LookerDataSourceSpec)
  }
  // End of list of possible types for union field spec.
}
Fields
parameters[]

object ( DataSourceParameter )

The parameters of the data source, used when querying the data source.

Union field spec . The actual specification per data source type. spec can be only one of the following:
bigQuery

object ( BigQueryDataSourceSpec )

A BigQueryDataSourceSpec .

looker

object ( LookerDataSourceSpec )

A [LookerDatasourceSpec][].

BigQueryDataSourceSpec

The specification of a BigQuery data source that's connected to a sheet.

JSON representation 
{
  "projectId": string,

  // Union field spec can be only one of the following:
  "querySpec": {
    object (BigQueryQuerySpec)
  },
  "tableSpec": {
    object (BigQueryTableSpec)
  }
  // End of list of possible types for union field spec.
}
Fields
projectId

string

The ID of a BigQuery enabled Google Cloud project with a billing account attached. For any queries executed against the data source, the project is charged.

Union field spec . The actual specification. spec can be only one of the following:
querySpec

object ( BigQueryQuerySpec )

A BigQueryQuerySpec .

tableSpec

object ( BigQueryTableSpec )

A BigQueryTableSpec .

BigQueryQuerySpec

Specifies a custom BigQuery query.

JSON representation 
{
  "rawQuery": string
}
Fields
rawQuery

string

The raw query string.

BigQueryTableSpec

Specifies a BigQuery table definition. Only native tables are allowed.

JSON representation 
{
  "tableProjectId": string,
  "tableId": string,
  "datasetId": string
}
Fields
tableProjectId

string

The ID of a BigQuery project the table belongs to. If not specified, the projectId is assumed.

tableId

string

The BigQuery table id.

datasetId

string

The BigQuery dataset id.

LookerDataSourceSpec

The specification of a Looker data source.

JSON representation 
{
  "instanceUri": string,
  "model": string,
  "explore": string
}
Fields
instanceUri

string

A Looker instance URL.

model

string

Name of a Looker model.

explore

string

Name of a Looker model explore.

DataSourceParameter

A parameter in a data source's query. The parameter allows the user to pass in values from the spreadsheet into a query.

JSON representation 
{

  // Union field identifier can be only one of the following:
  "name": string
  // End of list of possible types for union field identifier.

  // Union field value can be only one of the following:
  "namedRangeId": string,
  "range": {
    object (GridRange)
  }
  // End of list of possible types for union field value.
}
Fields
Union field identifier . The parameter identifier. identifier can be only one of the following:
name

string

Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, BigQuery identifier .

Union field value . The parameter value. value can be only one of the following:
namedRangeId

string

ID of a NamedRange . Its size must be 1x1.

range

object ( GridRange )

A range that contains the value of the parameter. Its size must be 1x1.

DataSourceRefreshSchedule

Schedule for refreshing the data source.

Data sources in the spreadsheet are refreshed within a time interval. You can specify the start time by clicking the Scheduled Refresh button in the Sheets editor, but the interval is fixed at 4 hours. For example, if you specify a start time of 8 AM , the refresh will take place between 8 AM and 12 PM every day.

JSON representation 
{
  "enabled": boolean,
  "refreshScope": enum (DataSourceRefreshScope),
  "nextRun": {
    object (Interval)
  },

  // Union field schedule_config can be only one of the following:
  "dailySchedule": {
    object (DataSourceRefreshDailySchedule)
  },
  "weeklySchedule": {
    object (DataSourceRefreshWeeklySchedule)
  },
  "monthlySchedule": {
    object (DataSourceRefreshMonthlySchedule)
  }
  // End of list of possible types for union field schedule_config.
}
Fields
enabled

boolean

True if the refresh schedule is enabled, or false otherwise.

refreshScope

enum ( DataSourceRefreshScope )

The scope of the refresh. Must be ALL_DATA_SOURCES .

nextRun

object ( Interval )

Output only. The time interval of the next run.

Union field schedule_config . Schedule configurations schedule_config can be only one of the following:
dailySchedule

object ( DataSourceRefreshDailySchedule )

Daily refresh schedule.

weeklySchedule

object ( DataSourceRefreshWeeklySchedule )

Weekly refresh schedule.

monthlySchedule

object ( DataSourceRefreshMonthlySchedule )

Monthly refresh schedule.

DataSourceRefreshScope

The data source refresh scopes.

Перечисление
DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED Default value, do not use.
ALL_DATA_SOURCES Refreshes all data sources and their associated data source objects in the spreadsheet.

DataSourceRefreshDailySchedule

A schedule for data to refresh every day in a given time interval.

JSON representation 
{
  "startTime": {
    object (TimeOfDay)
  }
}
Fields
startTime

object ( TimeOfDay )

The start time of a time interval in which a data source refresh is scheduled. Only hours part is used. The time interval size defaults to that in the Sheets editor.

TimeOfDay

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp .

JSON representation 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Fields
hours

integer

Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

minutes

integer

Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.

seconds

integer

Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.

nanos

integer

Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.

DataSourceRefreshWeeklySchedule

A weekly schedule for data to refresh on specific days in a given time interval.

JSON representation 
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfWeek": [
    enum (DayOfWeek)
  ]
}
Fields
startTime

object ( TimeOfDay )

The start time of a time interval in which a data source refresh is scheduled. Only hours part is used. The time interval size defaults to that in the Sheets editor.

daysOfWeek[]

enum ( DayOfWeek )

Days of the week to refresh. At least one day must be specified.

DayOfWeek

Represents a day of the week.

Перечисление
DAY_OF_WEEK_UNSPECIFIED The day of the week is unspecified.
MONDAY Понедельник
TUESDAY Вторник
WEDNESDAY Среда
THURSDAY Четверг
FRIDAY Пятница
SATURDAY Суббота
SUNDAY Воскресенье

DataSourceRefreshMonthlySchedule

A monthly schedule for data to refresh on specific days in the month in a given time interval.

JSON representation 
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfMonth": [
    integer
  ]
}
Fields
startTime

object ( TimeOfDay )

The start time of a time interval in which a data source refresh is scheduled. Only hours part is used. The time interval size defaults to that in the Sheets editor.

daysOfMonth[]

integer

Days of the month to refresh. Only 1-28 are supported, mapping to the 1st to the 28th day. At least one day must be specified.

Интервал

Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).

The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.

JSON representation 
{
  "startTime": string,
  "endTime": string
}
Fields
startTime

string ( Timestamp format)

Необязательный. Inclusive start of the interval.

If specified, a Timestamp matching this interval will have to be the same or after the start.

endTime

string ( Timestamp format)

Необязательный. Exclusive end of the interval.

If specified, a Timestamp matching this interval will have to be before the end.

Методы

batchUpdate

 Applies one or more updates to the spreadsheet.

create

 Creates a spreadsheet, returning the newly created spreadsheet.

get

 Returns the spreadsheet at the given ID.

getByDataFilter

 Returns the spreadsheet at the given ID.