面向转销商的 Python 快速入门
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
按照本快速入门指南中的步骤操作,大约 10 分钟后,您将拥有一个简单的 Python 命令行应用,该应用可向零触摸注册转销商 API 发出请求。
前提条件
如需运行本快速入门,您需要:
- 一个 Google 账号,该账号是您的“零触摸注册”转销商账号的成员。如果您尚未完成初始配置,请按照转销商门户指南中的使用入门中的步骤操作。
- Python 2.6 或更高版本。
- pip 软件包管理工具。
- 能够连接到互联网并使用网络浏览器。
第 1 步:启用零触摸注册 API
- 您可以使用此向导在 Google Developers Console 中创建或选择项目,并自动开启 API。点击继续,然后点击转到凭据。
- 将您要访问哪些数据?设置为应用数据。
- 点击下一步。系统会提示您创建服务账号。
- 为服务账号名称指定一个描述性名称。
- 记下服务账号 ID(看起来像电子邮件地址),因为您稍后将用到它。
- 将角色设置为 Service Accounts > Service Account User。
- 点击完成以完成服务账号的创建过程。
- 点击您创建的服务账号的电子邮件地址。
- 点击**密钥**。
- 点击 **Add key**,然后点击 **Create new key**。
- 在“密钥类型”中,选择“JSON”。
- 点击创建,系统会将私钥下载到您的计算机。
- 点击“关闭”。
- 将该文件移至您的工作目录中,并将其重命名为
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 服务账号。
- 从您的转销商 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 调用,请参阅授权。
了解详情
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-08-29。
[null,null,["最后更新时间 (UTC):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/)"]]