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. Откройте API Looker Studio в Google API Console.
2. При появлении запроса выберите проект или создайте новый.
3. Щелкните Включить .
4. При появлении запроса прочитайте и примите Условия использования API.

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

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

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

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

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

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

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

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

1. Войдите в консоль администратора Google и перейдите к делегированию на уровне домена .
2. В API clients щелкните Добавить новый .
3. Введите Client ID приложения для авторизации (например, приложения, которое использует API Looker Studio).
4. Введите все области действия OAuth, необходимые приложению. При использовании Looker Studio API для управления активами обычно запрашиваются следующие области:
   • 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 при авторизации приложения. Единственным исключением будет случай, когда приложение запрашивает авторизацию для дополнительных областей API Google, которые не настроены администратором рабочей области, и в этом случае диалоговое окно OAuth будет показано пользователям.

Ошибка 400: недействительная_область

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