面向客户的 Python 快速入门
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
按照本快速入门指南中的步骤操作,在大约 10 分钟内,您就创建好了一个简单的 Python 命令行应用,该应用可以向零触摸注册客户 API 发出请求。
前提条件
如需运行本快速入门,您需要满足以下条件:
- 一个 Google 账号,该账号是您的零触摸注册客户账号的成员。请参阅开始使用。
- Python 3.0 或更高版本。
- pip 软件包管理工具。
- 能够连接到互联网并使用网络浏览器。
第 1 步:启用零触摸注册 API
- 您可以使用此向导在 Google Developers Console 中创建或选择项目,并自动开启 API。点击继续,然后点击转到凭据。
- 在“创建凭据”页面上,点击取消。
- 在页面顶部,选择 OAuth 权限请求页面标签页。选择电子邮件地址,输入商品名称(如果尚未设置),然后点击保存按钮。
- 选择凭据标签页,点击创建凭据按钮,然后选择 OAuth 客户端 ID。
- 选择应用类型 Other(其他),输入名称“Quickstart”(快速启动),然后点击 Create(创建)按钮。
- 点击确定以关闭 OAuth 客户端面板。
- 点击 file_download 下载 JSON。
- 将该文件移至您的工作目录中,并将其重命名为
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
首次运行应用时,您需要授予访问权限:
- 应用会尝试在您的默认浏览器中打开一个新标签页。如果失败,请从控制台中复制网址,然后在浏览器中打开该网址。如果您尚未登录 Google 账号,系统会提示您登录。如果您登录了多个 Google 账号,页面会提示您选择一个账号进行授权。
- 点击接受。
- 关闭浏览器标签页,应用会继续运行。
备注
- 由于 Google API 客户端库会将授权数据存储在文件系统中,因此在后续启动时系统不会提示您进行授权。
- 如需重置应用的授权数据,请删除
user_credential.json
文件,然后重新运行应用。
- 本快速入门中的授权流程非常适合命令行应用。如需了解如何向 Web 应用添加授权,请参阅为 Web 服务器应用使用 OAuth 2.0。
问题排查
以下是您需要检查的一些常见事项。
请
告诉我们快速入门中的问题,我们将努力解决此问题。
- 请检查您是否使用的是零触摸注册客户账号的成员所用 Google 账号来授权 API 调用。尝试使用同一个 Google 账号登录零触摸注册门户,以测试您的访问权限。
- 确认该账号已在门户中接受最新的《服务条款》。请参阅客户账号。
了解详情
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-08-29。
[null,null,["最后更新时间 (UTC):2025-08-29。"],[[["\u003cp\u003eThis quickstart guide helps you create a simple Python command-line application that interacts with the zero-touch enrollment customer API in approximately 10 minutes.\u003c/p\u003e\n"],["\u003cp\u003eTo use this guide, you will need a Google account linked to your zero-touch enrollment customer account, Python 3.0 or greater, the pip package manager, internet access, and a web browser.\u003c/p\u003e\n"],["\u003cp\u003eThe guide involves enabling the zero-touch enrollment API, installing the Google client library using pip, setting up the sample code in a \u003ccode\u003equickstart.py\u003c/code\u003e file, and finally, running the sample.\u003c/p\u003e\n"],["\u003cp\u003eThe sample code provided retrieves the customer's account information and lists the available DPCs (Device Policy Controllers), printing their details.\u003c/p\u003e\n"],["\u003cp\u003eThe first time the app is run, it will require you to authorize it through your default browser, but subsequent runs will not if the authorization data is stored in the \u003ccode\u003euser_credential.json\u003c/code\u003e file.\u003c/p\u003e\n"]]],["This guide outlines creating a Python command-line app to interact with the zero-touch enrollment customer API. Steps involve enabling the API in the Google Developers Console, creating OAuth credentials, and downloading the `client_secret.json` file. The guide then directs users to install the `google-api-python-client` and `oauth2client` libraries using pip. Finally, a `quickstart.py` sample script is provided to list DPCs for a customer account. The script requires one-time authorization through a web browser.\n"],null,["# Python quickstart for customers\n\nFollow the steps in this quickstart guide, and in about 10 minutes you have\na simple Python command-line app that makes requests to the zero-touch\nenrollment customer API.\n\nPrerequisites\n-------------\n\nTo run this quickstart, you need:\n\n- A Google account, that's a member of your zero-touch enrollment customer account. See [Get\n started](/zero-touch/guides/customer/how-it-works#get_started).\n- Python 3.0 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. Click **Cancel** on the Create credentials.\n3. At the top of the page, select the **OAuth consent screen** tab. Select an **Email address** , enter a **Product name** if not already set, and click the **Save** button.\n4. Select the **Credentials** tab, click the **Create credentials** button and select **OAuth client ID**.\n5. Select the application type **Other** , enter the name \"Quickstart\", and click the **Create** button.\n6. Click **OK** to dismiss the *OAuth client* panel.\n7. Click file_download **Download JSON**.\n8. Move the file to your working directory and rename it `client_secret.json`.\n\nStep 2: 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 oauth2client\n\nSee the library's [installation\npage](/api-client-library/python/start/installation) for different installation\noptions.\n\nStep 3: 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. \n\n```python\n#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n\"\"\"Zero-touch enrollment quickstart sample.\n\nThis script forms the quickstart introduction to the zero-touch enrollemnt\ncustomer API. To learn more, visit https://developer.google.com/zero-touch\n\"\"\"\n\nimport sys\nfrom apiclient import discovery\nimport httplib2\nfrom oauth2client import tools\nfrom oauth2client.client import flow_from_clientsecrets\nfrom oauth2client.file import Storage\n\n# A single auth scope is used for the zero-touch enrollment customer API.\nSCOPES = ['https://www.googleapis.com/auth/androidworkzerotouchemm']\nCLIENT_SECRET_FILE = 'client_secret.json'\nUSER_CREDENTIAL_FILE = 'user_credential.json'\n\n\ndef get_credential():\n \"\"\"Creates a Credential object with the correct OAuth2 authorization.\n\n Ask the user to authorize the request using their Google Account in their\n browser. Because this method stores the cedential in the\n USER_CREDENTIAL_FILE, the user is typically only asked to the first time they\n run the script.\n\n Returns:\n Credentials, the user's credential.\n \"\"\"\n flow = flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES)\n storage = Storage(USER_CREDENTIAL_FILE)\n credential = storage.get()\n\n if not credential or credential.invalid:\n credential = tools.run_flow(flow, storage) # skipping flags for brevity\n return credential\n\n\ndef get_service():\n \"\"\"Creates a service endpoint for the zero-touch enrollment 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(httplib2.Http())\n return discovery.build('androiddeviceprovisioning', 'v1', http=http_auth)\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 # Get the customer's account. Because a customer might have more\n # than one, limit the results to the first account found.\n response = service.customers().list(pageSize=1).execute()\n\n if 'customers' not in response:\n # No accounts found for the user. Confirm the Google Account\n # that authorizes the request can access the zero-touch portal.\n print('No zero-touch enrollment account found.')\n sys.exit()\n customer_account = response['customers'][0]['name']\n\n # Send an API request to list all the DPCs available using the customer\n # account.\n results = service.customers().dpcs().list(parent=customer_account).execute()\n\n # Print out the details of each DPC.\n for dpc in results['dpcs']:\n # Some DPCs may not have a name, so replace with a marker.\n if 'dpcName' in dpc:\n dpcName = dpc['dpcName']\n else:\n dpcName = \"-\"\n print('Name:{0} APK:{1}'.format(dpcName, dpc['packageName']))\n\n\nif __name__ == '__main__':\n main()\n```\n\nStep 4: 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\nThe first time you run the app, you need to authorize access:\n\n1. The app tries to open a new tab in your default browser. If this fails, copy the URL from the console and open it in your browser. If you're not already logged into your Google Account, you're prompted to log in. If you're logged into multiple Google accounts, the page prompts you to select an account for the authorization.\n2. Click **Accept**.\n3. Close the browser tab---the app continues running.\n\nNotes\n-----\n\n- Because Google API client library stores authorization data on the file system, subsequent launches don't prompt you for authorization.\n- To reset the app's authorization data, delete the `user_credential.json` file and run the app again.\n- The authorization flow in this quickstart is ideal for a command-line app. To learn how to add authorization to a web app, see [Using OAuth 2.0 for Web Server Applications](/api-client-library/python/auth/web-app).\n\nTroubleshooting\n---------------\n\nHere are some common things you'll want to check.\n[Tell us what went wrong]() with the quickstart and we'll work to fix it.\n\n- Check that you're authorizing API calls with the same Google Account that's a member of your zero-touch enrollment customer account. Try signing in to the zero-touch enrollment [portal](https://enterprise.google.com/android/zero-touch/resellers) using the same Google Account to test your access.\n- Confirm that the account has accepted the latest Terms of Service in the [portal](https://enterprise.google.com/android/zero-touch/resellers). See [Customer accounts](/zero-touch/guides/customer/auth#customer_accounts).\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/)"]]