API Студии Looker

API Looker Studio позволяет искать и управлять ресурсами Looker Studio.

Основное назначение API — позволить организациям, использующим Google Workspace или Cloud Identity, автоматизировать управление и миграцию ресурсов Looker Studio.

Важный момент: API доступен только пользователям, входящим в организацию, использующую Google Workspace или Cloud Identity.

Обзор требований

Для использования API Looker Studio необходимо выполнить следующие шаги:

1. Настройте приложение для использования API .
2. Для авторизации приложения используйте консоль администратора Google .
3. Получите токены доступа OAuth 2.0 и вызовите API .

Вышеописанные шаги могут выполняться одной и той же или разными организациями в зависимости от следующих распространенных сценариев:

• Внутренние приложения, разработанные для организации. Организация настраивает и авторизует приложение для всех пользователей своей организации.
• Сторонние приложения, разработанные для внешних пользователей/клиентов (т.е. разработчик и пользователи принадлежат к разным организациям). Разработчик настраивает приложение, но организация пользователя авторизует стороннее приложение.

1. Настройте приложение для использования API.

Выполните следующие действия для настройки вашего приложения:

• Включить API
• Создайте OAuth-клиент

Включить API

Чтобы включить API для вашего проекта:

1. Откройте [Looker Studio API] в консоли Google API.
2. При появлении запроса выберите проект или создайте новый.
3. Нажмите «Включить» .
4. При появлении запроса ознакомьтесь с условиями использования API и примите их.

Создайте OAuth-клиент

Следующие шаги по созданию клиента OAuth представляют собой общие рекомендации и должны быть скорректированы в соответствии с требованиями вашего приложения.

Важно: не добавляйте области действия Looker Studio в свой OAuth-клиент. Области действия будут добавлены администратором рабочей области при авторизации приложения.

1. Перейдите на экран настройки согласия OAuth .
   1. Выберите «Внутренний» , нажмите «Создать» .
   2. Заполните необходимые поля и нажмите «Сохранить» .
2. Перейдите в раздел «Учетные данные» .
   1. Нажмите «СОЗДАТЬ УЧЕТНЫЕ ДАННЫЕ» .
   2. Выберите идентификатор клиента OAuth .
   3. Выберите соответствующий Application Type . (Веб-приложение — наиболее распространенный вариант).
   4. Заполните необходимые поля и нажмите «Создать» .
3. Обратите внимание на идентификатор клиента (Client ID) , поскольку он используется для авторизации приложения.

2. Авторизуйте приложение для организации.

Приложения, использующие API Looker Studio, могут аутентифицировать и авторизовывать пользователей Google Workspace только в том случае, если организация пользователя авторизовала приложение, используя делегирование на уровне домена для управления доступом к API .

Настройте делегирование в масштабе всего домена, указав идентификатор клиента OAuth приложения и области действия, необходимые для приложения.

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

1. Войдите в консоль администратора Google и перейдите в раздел «Делегирование на уровне домена» .
2. В разделе API clients нажмите «Добавить новый» .
3. Введите Client ID приложения для авторизации (т.е. приложения, использующего API Looker Studio).
4. Укажите все необходимые для приложения области действия OAuth. При использовании API Looker Studio для управления ресурсами обычно запрашиваются следующие области действия:
   • https://www.googleapis.com/auth/datastudio
   • https://www.googleapis.com/auth/userinfo.profile
5. Нажмите «Авторизовать» .

Примечание: Если вашему приложению не требуется управлять ресурсами Looker Studio, рассмотрите возможность использования более ограничительной области действия https://www.googleapis.com/auth/datastudio.readonly вместо https://www.googleapis.com/auth/datastudio .

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

3. Получение токенов доступа OAuth 2.0 и вызов API.

После разработки и авторизации приложения у вас появится необходимый доступ для вызова API для пользователей Workspace. Подробную информацию о работе с API Google с использованием OAuth см. в разделе «Использование OAuth 2.0 для доступа к API Google». Для получения информации о доступных операциях обратитесь к справочнику API .

Поиск неисправностей

Отсутствует диалоговое окно OAuth.

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

Ошибка 400: invalid_scope

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