お客様向け Python クイックスタート

このクイックスタート ガイドの手順に沿って操作してください。約 10 分で、ゼロタッチ登録カスタマー API にリクエストを送信するシンプルな Python コマンドライン アプリが完成します。

前提条件

このクイックスタートを実行するには、以下のものが必要です。

  • ゼロタッチ登録のお客様のアカウントのメンバーである Google アカウント。スタートガイドをご覧ください。
  • Python 3.0 以降。
  • pip パッケージ管理ツール。
  • インターネット アクセスとウェブブラウザ。

ステップ 1: ゼロタッチ登録 API を有効にする

  1. Google Developers Console でこちらのウィザードを使ってプロジェクトを作成するか既存のプロジェクトを選択すると、自動的に API が有効になります。[続行] をクリックし、[認証情報に進む] をクリックします。
  2. [認証情報の作成] で [キャンセル] をクリックします。
  3. ページ上部の [OAuth 同意画面] タブを選択します。メールアドレスを選択し、[ユーザーに表示するサービス名] が設定されていない場合はサービス名を入力して、[保存] ボタンをクリックします。
  4. [認証情報] タブを選択し、[認証情報を作成] ボタンをクリックして、[OAuth クライアント ID] を選択します。
  5. アプリケーションの種類として [その他] を選択し、名前「Quickstart」を入力して、[作成] ボタンをクリックします。
  6. [OK] をクリックして [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 enrollemnt
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. [Accept] をクリックします。
  3. ブラウザタブを閉じても、アプリは引き続き実行されます。

メモ

  • Google API クライアント ライブラリは承認データをファイル システムに保存するため、その後の起動時に承認を求めるメッセージは表示されません。
  • アプリの認可データをリセットするには、user_credential.json ファイルを削除してアプリを再度実行します。
  • このクイックスタートの承認フローは、コマンドライン アプリに最適です。ウェブアプリに承認を追加する方法については、 ウェブサーバー アプリケーションに OAuth 2.0 を使用するをご覧ください。

トラブルシューティング

一般的な確認事項を以下に示します。 クイックスタートで問題が発生した場合は、お知らせください。問題の解決に向けて取り組みます。

  • ゼロタッチ登録のお客様アカウントのメンバーと同じ Google アカウントで API 呼び出しを承認していることを確認してください。同じ Google アカウントを使用してゼロタッチ登録のポータルにログインし、アクセスをテストします。
  • アカウントがポータルで最新の利用規約に同意していることを確認します。 顧客アカウントをご覧ください。

その他の情報