經銷商適用的 Python 快速入門導覽課程
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
只要按照本快速入門指南中的步驟操作,約 10 分鐘內,您就能擁有一個簡單的 Python 指令列應用程式,用於向零接觸註冊經銷商 API 提出要求。
必要條件
如要執行這個快速入門,您需要:
- Google 帳戶 (屬於零接觸註冊機制經銷商帳戶的成員)。如果尚未完成新手上路流程,請按照經銷商入口網站指南中的入門步驟操作。
- Python 2.6 以上版本。
- pip 套件管理工具。
- 連上網際網路和網路瀏覽器。
步驟 1:啟用零接觸註冊 API
- 使用這個精靈,在 Google Developers Console 中建立或選取專案,並自動開啟 API。按一下「繼續」,然後點選「前往憑證」。
- 將「您需要存取什麼資料?」設為「應用程式資料」。
- 按一下「繼續」,系統應會提示您建立服務帳戶。
- 在「Service account name」(服務帳戶名稱) 中輸入描述性名稱。
- 請記下服務帳戶 ID (看起來像電子郵件地址),因為您稍後會用到這個 ID。
- 將「角色」設為 [服務帳戶] > [服務帳戶使用者]。
- 按一下「Done」(完成),即完成建立服務帳戶。
- 按一下您建立的服務帳戶電子郵件地址。
- 按一下「鍵」。
- 依序按一下「新增金鑰」和「建立新的金鑰」。
- 在「金鑰類型」中選取「JSON」。
- 按一下「Create」,私密金鑰就會下載到電腦中。
- 按一下「關閉」。
- 將檔案移至工作目錄,並重新命名為
service_account_key.json
。
步驟 2:連結服務帳戶
- 開啟零接觸註冊機制入口網站。您可能需要登入。
- 按一下「服務帳戶」圖示 settings_ethernet。
- 按一下 add「連結服務帳戶」。
- 將「電子郵件地址」設為您建立的服務帳戶地址。
- 按一下「連結服務帳戶」,即可使用服務帳戶和零接觸註冊帳戶。
步驟 3:安裝 Google 用戶端程式庫
執行下列指令,使用 pip 安裝程式庫:
pip install --upgrade google-api-python-client
如要瞭解其他安裝選項,請參閱程式庫的安裝頁面。
步驟 4:設定範例
在工作目錄中建立名為 quickstart.py
的檔案。複製下列程式碼並儲存檔案。插入您自己的經銷商合作夥伴 ID,做為 PARTNER_ID
的值 (應用程式匯入後的第一行)。
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""Zero-touch enrollment reseller quickstart.
This script forms the quickstart introduction to the zero-touch enrollemnt
reseller API. To learn more, visit https://developer.google.com/zero-touch
"""
from apiclient.discovery import build
from httplib2 import Http
from oauth2client.service_account import ServiceAccountCredentials
# TODO: replace this with your partner reseller ID.
PARTNER_ID = '11036885';
# A single auth scope is used for the zero-touch enrollment customer API.
SCOPES = ['https://www.googleapis.com/auth/androidworkprovisioning']
SERVICE_ACCOUNT_KEY_FILE = 'service_account_key.json'
def get_credential():
"""Creates a Credential object with the correct OAuth2 authorization.
Creates a Credential object with the correct OAuth2 authorization
for the service account that calls the reseller API. The service
endpoint calls this method when setting up a new service instance.
Returns:
Credential, the user's credential.
"""
credential = ServiceAccountCredentials.from_json_keyfile_name(
SERVICE_ACCOUNT_KEY_FILE, scopes=SCOPES)
return credential
def get_service():
"""Creates a service endpoint for the zero-touch enrollment reseller 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(Http())
service = build('androiddeviceprovisioning', 'v1', http=http_auth)
return service
def main():
"""Runs the zero-touch enrollment quickstart app.
"""
# Create a zero-touch enrollment API service endpoint.
service = get_service()
# Send an API request to list all our customers.
response = service.partners().customers().list(partnerId=PARTNER_ID).execute()
# Print out the details of each customer.
if 'customers' in response:
for customer in response['customers']:
print 'Name:{0} ID:{1}'.format(
customer['companyName'], customer['companyId'])
else:
print 'No customers found'
if __name__ == '__main__':
main()
合作夥伴 ID
API 呼叫通常需要您的經銷商合作夥伴 ID 做為引數。如要在零接觸註冊機制入口網站中查看合作夥伴 ID,請按照下列步驟操作:
- 開啟入口網站,您可能需要登入。
- 按一下 settings_ethernet「Service Accounts」。
- 複製「你的經銷商 ID」行中的合作夥伴 ID 編號。
步驟 5:執行範例
利用作業系統的相關說明,執行檔案中的指令碼。在 UNIX 和 Mac 電腦上,請在終端機中執行下列指令:
python quickstart.py
列印 API 回應
如要更輕鬆地在試用 API 時檢查回應,請設定 JSON 回應資料的格式。下列程式碼片段說明如何在 Python 中使用 JSON 模組執行此操作:
from json import dumps
# ...
results = provisioning.partners().devices().claimAsync(partnerId=MY_PARTNER_ID,
body={'claims':new_claims}).execute()
# Print formatted JSON response
print dumps(results, indent=4, sort_keys=True)
疑難排解
透過快速入門導覽課程告訴我們問題所在,我們會加以修正。如想瞭解零接觸機制如何使用服務帳戶授權 API 呼叫,請參閱「授權」。
瞭解詳情
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-08-29 (世界標準時間)。
[null,null,["上次更新時間:2025-08-29 (世界標準時間)。"],[[["\u003cp\u003eThis quickstart guide helps you set up a Python command-line app to interact with the zero-touch enrollment reseller API in about 10 minutes.\u003c/p\u003e\n"],["\u003cp\u003ePrerequisites include having a Google account, Python 2.6 or greater, the pip package management tool, and internet access.\u003c/p\u003e\n"],["\u003cp\u003eThe setup involves creating and enabling a service account in the Google Developers Console, linking it in the zero-touch enrollment portal, and downloading its JSON key file.\u003c/p\u003e\n"],["\u003cp\u003eYou will need to install the Google client library using pip, and then create and modify the \u003ccode\u003equickstart.py\u003c/code\u003e file with your reseller partner ID to run a sample API request.\u003c/p\u003e\n"],["\u003cp\u003eThe guide provides instructions for finding your partner ID, running the Python script, and formatting JSON responses for easier inspection.\u003c/p\u003e\n"]]],["First, enable the zero-touch enrollment API by creating a service account, setting its role, and downloading its JSON key. Next, link this service account in the zero-touch enrollment portal using the service account's email address. Install the Google client library with `pip`. Then, create a `quickstart.py` file, inserting your reseller partner ID, and run it via the terminal to make an API request, listing customer details. Retrieve partner ID from the Service Accounts page in the portal.\n"],null,["# Python quickstart for resellers\n\nFollow the steps in this quickstart guide, and in about 10 minutes you'll have\na simple Python command-line app that makes requests to the zero-touch\nenrollment reseller API.\n\nPrerequisites\n-------------\n\nTo run this quickstart, you'll need:\n\n- A Google account, that's a member of your zero-touch enrollment reseller account. If you haven't onboarded yet, follow the steps in *Get started* in the [Reseller portal guide](/zero-touch/guides/portal).\n- Python 2.6 or greater.\n- The [pip](https://pypi.python.org/pypi/pip) package management tool.\n- Access to the internet and a web browser.\n\nStep 1: Turn on the zero-touch enrollment API\n---------------------------------------------\n\n1. Use [this\n wizard](https://console.developers.google.com/start/api?id=androiddeviceprovisioning.googleapis.com) to create or select a project in the Google Developers Console and automatically turn on the API. Click **Continue** , then **Go to credentials**.\n2. Set **What data will you be accessing?** to *Application data*.\n3. Click **Next**. You should be prompted to create a service account.\n4. Give a descriptive name for **Service account name**.\n5. Note the **Service account ID** (it looks like an email address) because you'll use it later.\n6. Set **Role** to *Service Accounts \\\u003e Service Account User*.\n7. Click **Done** to finish creating the service account.\n8. Click the email address for the service account that you created.\n9. Click \\*\\*Keys\\*\\*.\n10. Click \\*\\*Add key\\*\\*, then click \\*\\*Create new key\\*\\*.\n11. For \\*\\*Key type\\*\\*, select \\*\\*JSON\\*\\*.\n12. Click **Create** and the private key downloads to your computer.\n13. Click \\*\\*Close\\*\\*.\n14. Move the file to your working directory and rename it `service_account_key.json`.\n\n| **Warning:** Service account keys can become a security risk if not managed carefully. For advice see [best practices for managing API keys](https://cloud.google.com/iam/docs/best-practices-for-managing-service-account-keys).\n\nStep 2: Link the service account\n--------------------------------\n\n1. Open the zero-touch enrollment [portal](https://enterprise.google.com/android/zero-touch/resellers). You might need to sign in.\n2. Click settings_ethernet **Service\n accounts**.\n3. Click add **Link service account**.\n4. Set **Email address** to the address of the service account you created.\n5. Click **Link service account** to use the service account with your zero-touch enrollment account.\n\nStep 3: Install the Google client library\n-----------------------------------------\n\nRun the following command to install the library using pip: \n\n pip install --upgrade google-api-python-client\n\nSee the library's [installation\npage](/api-client-library/python/start/installation) for different installation\noptions.\n\nStep 4: Set up the sample\n-------------------------\n\nCreate a file named `quickstart.py` in your working directory. Copy in the\nfollowing code and save the file. Insert your own [reseller partner\nID](#partner-id) as the value for `PARTNER_ID` (the app's first line after the\nimports). \n\n```python\n#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n\"\"\"Zero-touch enrollment reseller quickstart.\n\nThis script forms the quickstart introduction to the zero-touch enrollemnt\nreseller API. To learn more, visit https://developer.google.com/zero-touch\n\"\"\"\n\nfrom apiclient.discovery import build\nfrom httplib2 import Http\nfrom oauth2client.service_account import ServiceAccountCredentials\n\n# TODO: replace this with your partner reseller ID.\nPARTNER_ID = '11036885';\n\n# A single auth scope is used for the zero-touch enrollment customer API.\nSCOPES = ['https://www.googleapis.com/auth/androidworkprovisioning']\nSERVICE_ACCOUNT_KEY_FILE = 'service_account_key.json'\n\ndef get_credential():\n \"\"\"Creates a Credential object with the correct OAuth2 authorization.\n\n Creates a Credential object with the correct OAuth2 authorization\n for the service account that calls the reseller API. The service\n endpoint calls this method when setting up a new service instance.\n\n Returns:\n Credential, the user's credential.\n \"\"\"\n credential = ServiceAccountCredentials.from_json_keyfile_name(\n SERVICE_ACCOUNT_KEY_FILE, scopes=SCOPES)\n return credential\n\n\ndef get_service():\n \"\"\"Creates a service endpoint for the zero-touch enrollment reseller API.\n\n Builds and returns an authorized API client service for v1 of the API. Use\n the service endpoint to call the API methods.\n\n Returns:\n A service Resource object with methods for interacting with the service.\n \"\"\"\n http_auth = get_credential().authorize(Http())\n service = build('androiddeviceprovisioning', 'v1', http=http_auth)\n return service\n\n\ndef main():\n \"\"\"Runs the zero-touch enrollment quickstart app.\n \"\"\"\n # Create a zero-touch enrollment API service endpoint.\n service = get_service()\n\n # Send an API request to list all our customers.\n response = service.partners().customers().list(partnerId=PARTNER_ID).execute()\n\n # Print out the details of each customer.\n if 'customers' in response:\n for customer in response['customers']:\n print 'Name:{0} ID:{1}'.format(\n customer['companyName'], customer['companyId'])\n else:\n print 'No customers found'\n\n\nif __name__ == '__main__':\n main()\n```\n\n### Partner ID\n\nAPI calls typically need your reseller partner ID as an argument. To find your\npartner ID from the zero-touch enrollment portal, follow the steps below:\n\n1. Open the [portal](https://enterprise.google.com/android/zero-touch/resellers). You might need to sign in.\n2. Click settings_ethernet **Service\n accounts**.\n3. Copy your partner ID number from the **Your reseller ID** line.\n\nStep 5: Run the sample\n----------------------\n\nUse your operating system's help to run the script in the file. On UNIX and Mac\ncomputers, run the command below in your terminal: \n\n python quickstart.py\n\n### Printing API responses\n\nTo make it easier to inspect responses when trying out the API, format the JSON\nresponse data. The snippet below shows how you might do this in Python using the\nJSON module: \n\n from json import dumps\n\n # ...\n\n results = provisioning.partners().devices().claimAsync(partnerId=MY_PARTNER_ID,\n body={'claims':new_claims}).execute()\n # Print formatted JSON response\n print dumps(results, indent=4, sort_keys=True)\n\nTroubleshooting\n---------------\n\n\n[Tell us what went wrong]() with the quickstart and we'll work to\nfix it. To learn how zero-touch uses service accounts to authorize API calls, read\n[Authorization](/zero-touch/guides/auth).\n\nLearn more\n----------\n\n- [Google Developers Console help documentation](/console/help/new)\n- [Google APIs Client for Python documentation](/api-client-library/python)\n- [pip User Guide](https://pip.pypa.io/en/stable/user_guide/)"]]