客戶的 Python 快速入門導覽課程

只要按照本快速入門指南的步驟操作，大約 10 分鐘內，您就能完成一個簡單的 Python 指令列應用程式，向零接觸註冊客戶 API 提出要求。

必要條件

如要執行這個快速入門，您需要：

  • Google 帳戶，也就是零接觸註冊機制客戶帳戶的成員。請參閱開始使用。
  • Python 3.0 以上版本。
  • pip 套件管理工具。
  • 可連上網際網路並具備網路瀏覽器。

步驟 1：啟用零接觸註冊 API

  1. 使用這個精靈，在 Google Developers Console 中建立或選取專案，並自動開啟 API。按一下「繼續」，然後點選「前往憑證」。
  2. 按一下「建立憑證」中的「取消」。
  3. 選取頁面頂端的「OAuth 同意畫面」分頁標籤。選取電子郵件地址，如果尚未設定產品名稱，請輸入產品名稱，然後按一下「儲存」按鈕。
  4. 選取「Credentials」(憑證) 分頁標籤，按一下「Create credentials」(建立憑證) 按鈕，然後選取「OAuth client ID」(OAuth 用戶端 ID)。
  5. 選取「Other」應用程式類型，並輸入「quickstart」這個名稱，然後按一下 [Create] 按鈕。
  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. 應用程式會嘗試在預設瀏覽器中開啟新分頁。如果失敗，請從控制台中複製網址，然後在瀏覽器中開啟網址。如果您尚未登入 Google 帳戶，系統會提示您登入。如果您登入了多個 Google 帳戶，系統會在該頁面提示您選取要授權的帳戶。
  2. 然後點選 [Accept]。
  3. 關閉瀏覽器分頁，應用程式會繼續執行。

附註

  • Google API 用戶端程式庫會在檔案系統中儲存授權資料，因此後續啟動不會提示您進行授權。
  • 如要重設應用程式的授權資料，請刪除 user_credential.json 檔案，然後再次執行應用程式。
  • 本快速入門課程中的授權流程非常適合指令列應用程式。如要瞭解如何為網路應用程式新增授權，請參閱「針對網路伺服器應用程式使用 OAuth 2.0」。

疑難排解

以下是一些常見的檢查項目。請告訴我們快速入門導覽課程有哪些錯誤，我們會盡力修正。

  • 請確認您是使用零接觸註冊機制客戶帳戶的會員帳戶，授權 API 呼叫。請嘗試使用相同的 Google 帳戶登入零接觸註冊機制入口網站，測試您的存取權。
  • 確認帳戶已在入口網站接受最新的《服務條款》。請參閱「客戶帳戶」。

瞭解詳情