Google Apps Script: Как выполнить HTTP GET запрос?

Что такое HTTP GET запрос и зачем он нужен?

HTTP GET запрос – это один из основных методов HTTP протокола, используемый для запроса данных с сервера. Он предназначен только для получения данных, а не для их изменения. В Google Apps Script, GET запросы позволяют скриптам взаимодействовать с внешними веб-сервисами и API, получая необходимую информацию для дальнейшей обработки или анализа. Например, можно получить данные о погоде, курсы валют, статистику рекламной кампании и многое другое.

Преимущества использования GET запросов в Google Apps Script

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

Интеграция с REST API: Многие REST API предоставляют данные через GET запросы, что делает их удобными для интеграции с Google Apps Script.

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

Необходимые условия для выполнения GET запросов

Для выполнения GET запросов в Google Apps Script необходимо:

Иметь доступ к интернету.

Понимать структуру URL целевого API или веб-сервиса.

Разрешить скрипту доступ к внешним сервисам в настройках проекта Apps Script (если требуется).

Использование UrlFetchApp для отправки GET запросов

Основы UrlFetchApp.fetch()

UrlFetchApp – это встроенный в Google Apps Script сервис, предоставляющий функциональность для выполнения HTTP запросов. Основной метод для отправки GET запроса – UrlFetchApp.fetch(url, params), где url – это URL запрашиваемого ресурса, а params (необязательный) – объект с дополнительными параметрами запроса.

Создание простого GET запроса

/**
 * Выполняет простой GET запрос к указанному URL.
 * @param {string} url URL для запроса.
 * @return {string} Ответ от сервера.
 */
function simpleGetRequest(url) {
  try {
    const response = UrlFetchApp.fetch(url);
    const content = response.getContentText();
    return content;
  } catch (error) {
    Logger.log('Ошибка при выполнении GET запроса: ' + error);
    return null;
  }
}

// Пример использования
const apiUrl = 'https://example.com/data';
const data = simpleGetRequest(apiUrl);
if (data) {
  Logger.log(data);
}

Обработка ответа от сервера

Метод UrlFetchApp.fetch() возвращает объект HTTPResponse, содержащий информацию об ответе сервера. Основные методы для работы с ответом:

getContentText(): Возвращает тело ответа в виде текста.

getContent(): Возвращает тело ответа в виде массива байтов.

getResponseCode(): Возвращает HTTP код ответа (200, 404, 500 и т.д.).

getHeaders(): Возвращает заголовки ответа в виде объекта.

Параметры GET запроса

Передача параметров в URL

Параметры GET запроса передаются в URL после знака вопроса ?, разделяясь амперсандом &. Например: https://example.com/data?param1=value1&param2=value2.

Кодирование URL для безопасной передачи данных

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

/**
 * Кодирует строку для безопасной передачи в URL.
 * @param {string} str Строка для кодирования.
 * @return {string} Кодированная строка.
 */
function encodeUrl(str) {
  return encodeURIComponent(str);
}

// Пример использования
const query = 'поиск данных';
const encodedQuery = encodeUrl(query);
const url = 'https://example.com/search?q=' + encodedQuery;
Logger.log(url);

Примеры использования параметров в GET запросах

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

/**
 * Получает статистику по ключевому слову из API контекстной рекламы.
 * @param {string} keyword Ключевое слово.
 * @param {string} startDate Дата начала периода (YYYY-MM-DD).
 * @param {string} endDate Дата окончания периода (YYYY-MM-DD).
 * @return {string} JSON строка с данными статистики.
 */
function getKeywordStats(keyword, startDate, endDate) {
  const baseUrl = 'https://api.example.com/stats';
  const encodedKeyword = encodeURIComponent(keyword);
  const url = `${baseUrl}?keyword=${encodedKeyword}&start_date=${startDate}&end_date=${endDate}`;

  try {
    const response = UrlFetchApp.fetch(url);
    const content = response.getContentText();
    return content;
  } catch (error) {
    Logger.log('Ошибка при получении статистики: ' + error);
    return null;
  }
}

// Пример использования
const keyword = 'купить слона';
const startDate = '2023-01-01';
const endDate = '2023-01-31';
const stats = getKeywordStats(keyword, startDate, endDate);
if (stats) {
  Logger.log(stats);
}

Расширенные настройки и обработка ошибок

Настройка параметров запроса (headers, muteHttpExceptions)

Объект params в методе UrlFetchApp.fetch() позволяет настроить параметры запроса, такие как заголовки (headers) и режим обработки исключений (muteHttpExceptions).

headers: Объект, содержащий заголовки запроса (например, Content-Type, Authorization).

muteHttpExceptions: Если установлено в true, скрипт не будет выбрасывать исключение при получении HTTP кодов ошибок (4xx, 5xx). Это позволяет обрабатывать ошибки в коде скрипта.

const options = {
  'method': 'get',
  'headers': {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  'muteHttpExceptions': true
};

const response = UrlFetchApp.fetch(url, options);
const responseCode = response.getResponseCode();

if (responseCode >= 400) {
  Logger.log('Ошибка: ' + response.getContentText());
} else {
  Logger.log(response.getContentText());
}

Обработка ошибок и исключений при выполнении запросов

Рекомендуется всегда обрабатывать исключения при выполнении HTTP запросов, чтобы предотвратить неожиданное завершение скрипта. Используйте блоки try...catch для перехвата исключений и логирования ошибок.

Работа с различными типами ответов (JSON, XML, Text)

Сервер может возвращать ответы в различных форматах: JSON, XML, Text. Для работы с JSON ответами используйте метод JSON.parse() для преобразования JSON строки в JavaScript объект. Для работы с XML ответами можно использовать сторонние библиотеки для парсинга XML.

// Пример обработки JSON ответа
const jsonString = '{"name": "John", "age": 30}';
const jsonObject = JSON.parse(jsonString);
Logger.log(jsonObject.name); // Выведет: John

Примеры практического применения GET запросов

Получение данных из REST API

GET запросы широко используются для получения данных из REST API. Например, можно получить информацию о товарах из API интернет-магазина, данные о погоде из API погодного сервиса и т.д.

Интеграция с внешними сервисами (примеры)

Google Sheets API: Получение данных из Google Sheets с помощью GET запросов (через API).

Twitter API: Получение твитов по определенному запросу.

Geocoding API: Преобразование адресов в географические координаты.

Автоматизация задач с помощью GET запросов

GET запросы могут быть использованы для автоматизации рутинных задач, таких как:

Мониторинг цен конкурентов: Регулярное получение цен с сайтов конкурентов и запись в Google Sheets.

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

Обновление данных в CRM: Получение данных из внешних систем и обновление информации в CRM.