В этом руководстве описывается, как и зачем использовать API Google Таблиц для добавления и управления смарт-чипами в ваши электронные таблицы.
Что такое смарт-чип?
С помощью смарт-чипов вы можете переносить интерактивные данные из других приложений Google Workspace непосредственно в Таблицы. Смарт-чипы предоставляют пользователям быстрый доступ к информации и действиям, преобразуя ссылку на ячейку в динамический объект. Подробнее см. в статье «Вставка смарт-чипов в Google Таблицы» .
Добавить смарт-чип
Чипы представлены в виде запусков чипов, которые являются частью CellData , поэтому вы можете вставить чип, используя существующий метод spreadsheets.batchUpdate
, предоставив UpdateCellsRequest
или AppendCellsRequest
.
Запрос должен включать поле chipRuns
. Поле chip Run описывает свойства чипа и его расположение в тексте ячейки.
При записи chipRuns
необходимо также указать значение userEnteredValue
, содержащее символы-заполнители ( @
) для каждого добавляемого чипа. Каждый запуск в массиве chipRuns
будет соответствовать одному из этих символов-заполнителей. Запуски без чипов можно опустить при записи.
В следующем примере показано, как записать чип файла, чип пользователя и простой текст в одну ячейку A1. * {JSON}
{
"updateCells": {
"rows": [
{
"values": [
{
"userEnteredValue": {
"stringValue": "@ is the owner of @."
},
"chipRuns": [
{
"chip": {
"personProperties": {
"email": "johndoe@gmail.com",
"displayFormat": "DEFAULT"
}
}
},
{
"startIndex": 18,
"chip": {
"richLinkProperties": {
"uri": "https://docs.google.com/document/d/YOUR_DOCUMENT_ID/edit"
}
}
}
]
}
]
}
],
"fields": "userEnteredValue,chipRuns",
"range": {
"startRowIndex": 0,
"startColumnIndex": 0
}
}
}
Настроить свойства чипа
Объект чипа может иметь один из следующих типов свойств:
personProperties
Используйте это для создания персонального чипа.
-
email
: (Обязательно) Адрес электронной почты человека, с которым необходимо установить связь. -
displayFormat
: (Необязательно) Предпочтительный формат отображения имени человека. Может быть одним из следующих:-
DEFAULT
: Стандартный формат «Имя Фамилия». -
LAST_NAME_COMMA_FIRST_NAME
: Формат «Фамилия, Имя». -
EMAIL
: Адрес электронной почты человека.
-
richLinkProperties
Используйте это для создания чипа с расширенными ссылками. Хотя API может считывать ссылки на различные сервисы Google (например, YouTube или Календарь), в качестве чипов можно записывать только ссылки на файлы Google Диска.
-
uri
: (Обязательно) URI ресурса. Для записи это должна быть ссылка на файл на Google Диске. URI не могут превышать 2000 байт.
Прочитать смарт-чип
Чтобы прочитать данные смарт-чипа, используйте метод spreadsheets.get
и включите sheets.data.rowData.values(chipRuns)
в параметр fields.
Массив chipRuns
в ответе будет содержать объекты для всех подразделов текста ячейки.
- Чипированные прогоны: эти разделы будут иметь заполненный объект
chip
, содержащий либоpersonProperties
, либоrichLinkProperties
. - Нечипированные прогоны: разделы с обычным текстом также будут иметь объект прогона, но его поле
chip
будет пустым.
Чтобы получить отображаемый текст чипа, добавьте formattedValue
как поле.
Обновите смарт-чип
Чтобы обновить или заменить смарт-чип, необходимо перезаписать содержимое ячейки. Используйте тот же метод UpdateCellsRequest
или AppendCellsRequest
, что и для добавления чипа, указав новые userEnteredValue
и chipRun
. Это заменит существующий чип в ячейке.
Используйте смарт-чипы с другими функциями Таблиц
Таблицы : смарт-чипы можно использовать в качестве столбца таблицы для отслеживания владельцев проекта (чип людей) или связанных документов (чип файлов).
Фильтры : вы можете фильтровать диапазоны на основе текстового значения смарт-чипов в них.