Краткое руководство по Python для клиентов

Следуйте инструкциям в этом руководстве, и примерно через 10 минут у вас будет простое приложение командной строки Python, которое отправляет запросы к API для клиентов, использующих автоматическую настройку.

Требования

Чтобы запустить этот быстрый старт, вам необходимо:

  • Аккаунт Google, который является участником вашего аккаунта клиента автоматической настройки. Подробнее о том, как начать работу…
  • Python 3.0 или более поздней версии.
  • Инструмент управления пакетами pip.
  • Доступ к интернету и веб-браузер.

Шаг 1. Включите API автоматической настройки

  1. Используйте этот мастер, чтобы создать или выбрать проект в Google Developers Console и автоматически включить API. Нажмите Продолжить, а затем – Перейти к учетным данным.
  2. Нажмите Отмена в окне "Создать учетные данные".
  3. В верхней части страницы выберите вкладку Окно запроса доступа OAuth. Выберите Адрес электронной почты, введите Название товара, если оно ещё не указано, и нажмите кнопку Сохранить.
  4. Перейдите на вкладку Учетные данные, нажмите кнопку Создать учетные данные и выберите Идентификатор клиента OAuth.
  5. Выберите тип приложения Other (Другое), введите название Quickstart и нажмите кнопку Create (Создать).
  6. Нажмите ОК, чтобы закрыть панель Клиент OAuth.
  7. Нажмите Скачать JSON.
  8. Переместите файл в рабочий каталог и переименуйте его в client_secret.json.

Шаг 2. Установите клиентскую библиотеку Google

Чтобы установить библиотеку с помощью pip, выполните следующую команду:

pip install --upgrade google-api-python-client oauth2client

Различные варианты установки описаны на странице установки библиотеки.

Шаг 3. Настройте образец

Создайте файл с названием quickstart.py в рабочем каталоге. Скопируйте в него следующий код и сохраните файл.

#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""Zero-touch enrollment quickstart sample.

This script forms the quickstart introduction to the zero-touch enrollment
customer API. To learn more, visit https://developer.google.com/zero-touch
"""

import sys
from apiclient import discovery
import httplib2
from oauth2client import tools
from oauth2client.client import flow_from_clientsecrets
from oauth2client.file import Storage

# A single auth scope is used for the zero-touch enrollment customer API.
SCOPES = ['https://www.googleapis.com/auth/androidworkzerotouchemm']
CLIENT_SECRET_FILE = 'client_secret.json'
USER_CREDENTIAL_FILE = 'user_credential.json'


def get_credential():
  """Creates a Credential object with the correct OAuth2 authorization.

  Ask the user to authorize the request using their Google Account in their
  browser. Because this method stores the cedential in the
  USER_CREDENTIAL_FILE, the user is typically only asked to the first time they
  run the script.

  Returns:
    Credentials, the user's credential.
  """
  flow = flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES)
  storage = Storage(USER_CREDENTIAL_FILE)
  credential = storage.get()

  if not credential or credential.invalid:
    credential = tools.run_flow(flow, storage)  # skipping flags for brevity
  return credential


def get_service():
  """Creates a service endpoint for the zero-touch enrollment API.

  Builds and returns an authorized API client service for v1 of the API. Use
  the service endpoint to call the API methods.

  Returns:
    A service Resource object with methods for interacting with the service.
  """
  http_auth = get_credential().authorize(httplib2.Http())
  return discovery.build('androiddeviceprovisioning', 'v1', http=http_auth)


def main():
  """Runs the zero-touch enrollment quickstart app.
  """
  # Create a zero-touch enrollment API service endpoint.
  service = get_service()

  # Get the customer's account. Because a customer might have more
  # than one, limit the results to the first account found.
  response = service.customers().list(pageSize=1).execute()

  if 'customers' not in response:
    # No accounts found for the user. Confirm the Google Account
    # that authorizes the request can access the zero-touch portal.
    print('No zero-touch enrollment account found.')
    sys.exit()
  customer_account = response['customers'][0]['name']

  # Send an API request to list all the DPCs available using the customer
  # account.
  results = service.customers().dpcs().list(parent=customer_account).execute()

  # Print out the details of each DPC.
  for dpc in results['dpcs']:
    # Some DPCs may not have a name, so replace with a marker.
    if 'dpcName' in dpc:
      dpcName = dpc['dpcName']
    else:
      dpcName = "-"
    print('Name:{0}  APK:{1}'.format(dpcName, dpc['packageName']))


if __name__ == '__main__':
  main()

Шаг 4. Запустите пример

Чтобы запустить скрипт в файле, воспользуйтесь справкой по операционной системе. На компьютерах UNIX и Mac выполните в терминале следующую команду:

python quickstart.py

При первом запуске приложения необходимо разрешить доступ:

  1. Приложение пытается открыть новую вкладку в браузере по умолчанию. Если это не сработает, скопируйте URL из консоли и откройте его в браузере. Если вы не вошли в аккаунт Google, вам будет предложено это сделать. Если вы вошли в несколько аккаунтов Google, вам будет предложено выбрать один из них для авторизации.
  2. Нажмите Принимаю.
  3. Закройте вкладку браузера. Приложение продолжит работать.

Примечания

  • Поскольку клиентская библиотека API Google хранит данные авторизации в файловой системе, при последующих запусках авторизация не требуется.
  • Чтобы сбросить данные авторизации приложения, удалите файл user_credential.json и запустите приложение снова.
  • Процесс авторизации, описанный в этом кратком руководстве, идеально подходит для приложения командной строки. Чтобы узнать, как добавить авторизацию в веб-приложение, ознакомьтесь со статьей Использование OAuth 2.0 для веб-серверных приложений.

Устранение неполадок

Вот несколько распространенных причин. Расскажите, что пошло не так, и мы постараемся это исправить.

  • Убедитесь, что вы авторизуете вызовы API с помощью того же аккаунта Google, который является участником вашего аккаунта клиента автоматической настройки. Попробуйте войти на портал автоматической настройки, используя тот же аккаунт Google, чтобы проверить доступ.
  • Убедитесь, что в аккаунте приняты последние Условия использования на портале. Подробнее об аккаунтах клиентов…

Подробнее…