Guide de démarrage rapide Python pour les clients

Suivez les étapes de ce guide de démarrage rapide. En 10 minutes environ, vous disposerez d'une application de ligne de commande Python simple qui envoie des requêtes à l'API client d'enregistrement sans contact.

Prérequis

Pour exécuter ce guide de démarrage rapide, vous avez besoin des éléments suivants :

  • Un compte Google qui est membre de votre compte client d'enregistrement sans contact Consultez la section Premiers pas.
  • Python 3.0 ou version ultérieure.
  • L'outil de gestion de packages pip
  • Accès à Internet et à un navigateur Web.

Étape 1 : Activez l'API d'inscription sans contact

  1. Utilisez cet assistant pour créer ou sélectionner un projet dans la Google Developers Console et activer automatiquement l'API. Cliquez sur Continue (Continuer), puis sur Go to credentials (Accéder à Identifiants).
  2. Cliquez sur Annuler sur la page "Créer des identifiants".
  3. En haut de la page, sélectionnez l'onglet OAuth consent screen (Écran d'autorisation OAuth). Sélectionnez une adresse e-mail, saisissez un nom de produit si ce n'est pas déjà fait, puis cliquez sur le bouton Enregistrer.
  4. Sélectionnez l'onglet Credentials (Identifiants), cliquez sur le bouton Create credentials (Créer des identifiants) et sélectionnez OAuth client ID (ID client OAuth).
  5. Sélectionnez le type d'application Autre, saisissez le nom "Démarrage rapide", puis cliquez sur le bouton Créer.
  6. Cliquez sur OK pour fermer le panneau Client OAuth.
  7. Cliquez sur  Télécharger au format JSON.
  8. Déplacez le fichier vers votre répertoire de travail et renommez-le client_secret.json.

Étape 2 : Installez la bibliothèque cliente Google

Exécutez la commande suivante pour installer la bibliothèque à l'aide de pip :

pip install --upgrade google-api-python-client oauth2client

Consultez la page d'installation de la bibliothèque pour découvrir les différentes options d'installation.

Étape 3 : Configurer l'exemple

Créez un fichier nommé quickstart.py dans votre répertoire de travail. Copiez le code suivant et enregistrez le fichier.

#!/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()

Étape 4: Exécuter l'exemple

Utilisez l'aide de votre système d'exploitation pour exécuter le script dans le fichier. Sur les ordinateurs UNIX et Mac, exécutez la commande ci-dessous dans votre terminal :

python quickstart.py

La première fois que vous exécutez l'application, vous devez autoriser l'accès :

  1. L'application tente d'ouvrir un nouvel onglet dans votre navigateur par défaut. Si cela échoue, copiez l'URL dans la console, puis ouvrez-la dans votre navigateur. Si vous n'êtes pas encore connecté à votre compte Google, vous êtes invité à le faire. Si vous êtes connecté à plusieurs comptes Google, la page vous invite à en sélectionner un pour l'autorisation.
  2. Cliquez sur Accepter.
  3. Fermez l'onglet du navigateur. L'application continue de s'exécuter.

Remarques

  • Étant donné que la bibliothèque cliente des API Google stocke des données d'autorisation sur le système de fichiers, les lancements suivants ne vous invitent pas à vous authentifier.
  • Pour réinitialiser les données d'autorisation de l'application, supprimez le fichier user_credential.json, puis exécutez à nouveau l'application.
  • Le flux d'autorisation de ce guide de démarrage rapide est idéal pour une application de ligne de commande. Pour savoir comment ajouter une autorisation à une application Web, consultez Utiliser OAuth 2.0 pour les applications de serveur Web.

Dépannage

Voici quelques points courants à vérifier. Dites-nous ce qui ne va pas avec le tutoriel de démarrage, et nous ferons tout notre possible pour le résoudre.

  • Vérifiez que vous autorisez les appels d'API avec le compte Google membre de votre compte client pour l'enregistrement sans contact. Essayez de vous connecter au portail d'enregistrement sans contact avec le même compte Google pour tester votre accès.
  • Vérifiez que le compte a accepté les dernières conditions d'utilisation dans le portail. Consultez Comptes client.

En savoir plus