Управление проектами

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

Обзор метода API
Создавайте проекты

проекты.создать

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

Опции : Вы можете указать название проекта. Вы также можете создать привязанный скрипт, указав идентификатор Google Диска файла Google Docs, Google Sheets, Google Forms или Slides, который будет выступать в качестве родительского скрипта.

Чтение метаданных проекта

проекты.get

Результаты : извлекает объект Project , который представляет метаданные проекта. Эти данные включают название проекта, идентификатор сценария, создающего пользователя, время создания и другие сведения.

Читать содержание проекта

проекты.getContent

Результаты : Возвращает массив объектов File , по одному для каждого кода и файла HTML в проекте. Список также включает манифест проекта в виде файла JSON. Файловые объекты содержат исходное содержимое файла ( File.source ) и другие метаданные, например список функций в файле ( File.functionSet ).

Опции : вы можете указать, какую версию контента нужно получить, с помощью параметра запроса.

Обновить содержимое проекта

project.updateContent

Результаты : Изменяет содержимое файла в проекте сценария. Вы предоставляете новый контент в виде массива объектов File . Один из этих объектов File должен иметь тип JSON и представлять новый манифест проекта проекта скрипта. Новое содержимое сохраняется как HEAD-версия проекта. Он используется, когда сценарий выполняется как триггер, в редакторе сценариев, в режиме предварительного просмотра надстройки или как веб-приложение или API сценариев приложений в режиме разработки.

Примечание . При обновлении содержимого проекта сценария обычной практикой является сначала выдача запроса projects.getContent для получения массива существующих File , выполнение запроса к этим объектам, а затем использование File s в качестве входных данных для запроса project.updateContent .

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

Чтение показателей проекта

project.getMetrics

Результаты . Прочтите определенные показатели проекта. Эти показатели включают количество пользователей, общее количество выполнений, общее количество ошибок выполнения и другие детали. Используйте MetricType , чтобы указать запрашиваемую информацию.

Опции : Ограничить результаты конкретными развертываниями или функциями сценария с помощью MetricsFilter . Вы также можете определить конкретный интервал показателей с помощью MetricsIntervalConfig .

,

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

Обзор метода API
Создавайте проекты

проекты.создать

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

Опции : Вы можете указать название проекта. Вы также можете создать привязанный скрипт, указав идентификатор Google Диска файла Google Docs, Google Sheets, Google Forms или Slides, который будет выступать в качестве родительского скрипта.

Чтение метаданных проекта

проекты.get

Результаты : извлекает объект Project , который представляет метаданные проекта. Эти данные включают название проекта, идентификатор сценария, создающего пользователя, время создания и другие сведения.

Читать содержание проекта

проекты.getContent

Результаты : Возвращает массив объектов File , по одному для каждого кода и файла HTML в проекте. Список также включает манифест проекта в виде файла JSON. Файловые объекты содержат исходное содержимое файла ( File.source ) и другие метаданные, например список функций в файле ( File.functionSet ).

Опции : вы можете указать, какую версию контента нужно получить, с помощью параметра запроса.

Обновить содержимое проекта

project.updateContent

Результаты : Изменяет содержимое файла в проекте сценария. Вы предоставляете новый контент в виде массива объектов File . Один из этих объектов File должен иметь тип JSON и представлять новый манифест проекта проекта скрипта. Новое содержимое сохраняется как HEAD-версия проекта. Он используется, когда сценарий выполняется как триггер, в редакторе сценариев, в режиме предварительного просмотра надстройки или как веб-приложение или API сценариев приложений в режиме разработки.

Примечание . При обновлении содержимого проекта сценария обычной практикой является сначала выдача запроса projects.getContent для получения массива существующих File , выполнение запроса к этим объектам, а затем использование File s в качестве входных данных для запроса project.updateContent .

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

Чтение показателей проекта

project.getMetrics

Результаты . Прочтите определенные показатели проекта. Эти показатели включают количество пользователей, общее количество выполнений, общее количество ошибок выполнения и другие детали. Используйте MetricType , чтобы указать запрашиваемую информацию.

Опции : Ограничить результаты конкретными развертываниями или функциями сценария с помощью MetricsFilter . Вы также можете определить конкретный интервал показателей с помощью MetricsIntervalConfig .