Effectuer un appel d'API

Le dépôt googleads/googleads-shopping-samples sur GitHub contient un exemple de code pour les opérations courantes de chaque bibliothèque cliente. Les exemples dans googleads-shopping-samples/python/shopping/content/products/, entre autres, fournissent du code pour les opérations courantes à l'aide de la ressource products avec Python. Dans ce guide, vous commencez avec un fichier vide, puis créez un exemple qui insère un nouveau produit. Vous découvrirez ainsi la structure de base et les composants requis des applications qui s'intègrent à Content API. Le résultat final sera semblable à celui du fichier d'exemple products/insert.py. Vous pourrez ensuite utiliser APIs Explorer pour la méthode products.list afin de vous assurer que le produit a bien été ajouté.

Remarque : Cet exemple utilise le module python/shopping/content/Common.py pour créer un objet de service qui gère l'authentification et fournit une interface permettant d'effectuer des appels à Content API. Le module Common.py inclut également d'autres méthodes utiles pour les opérations courantes, par exemple pour générer des identifiants uniques, réessayer d'envoyer des requêtes et vérifier si un compte est un multicompte (MC).

Pour effectuer votre premier appel, procédez comme suit :

1. Dans le répertoire googleads-shopping-samples/python/shopping/content/products/, créez un fichier my-insert.py vide. Ajoutez tout le code mentionné dans les étapes suivantes à ce fichier.

2. Ajoutez les instructions d'import pour les modules requis.

   Au début du fichier my-insert.py, ajoutez le code suivant :

   from __future__ import print_function
   import sys
   
   # The common module provides setup functionality used by the samples,
   # such as authentication and unique id generation.
   from shopping.content import common
   

3. Définissez un identifiant produit unique et créez un dictionnaire avec la définition du produit.

   À la fin du fichier my-insert.py, ajoutez le code suivant :

   offer_id = 'book#%s' % common.get_unique_id()
   product = {
        'offerId':
            offer_id,
        'title':
            'A Tale of Two Cities',
        'description':
            'A classic novel about the French Revolution',
        'link':
            'http://my-book-shop.com/tale-of-two-cities.html',
        'imageLink':
            'http://my-book-shop.com/tale-of-two-cities.jpg',
        'contentLanguage':
            'en',
        'targetCountry':
            'US',
        'channel':
            'online',
        'availability':
            'in stock',
        'condition':
            'new',
        'googleProductCategory':
            'Media > Books',
        'gtin':
            '9780007350896',
        'price': {
            'value': '2.50',
            'currency': 'USD'
        },
        'shipping': [{
            'country': 'US',
            'service': 'Standard shipping',
            'price': {
                'value': '0.99',
                'currency': 'USD'
            }
        }],
        'shippingWeight': {
            'value': '200',
            'unit': 'grams'
        }
   }
   

4. Créez une fonction qui s'exécute lorsque le script est lancé à partir de la ligne de commande. La fonction génère un objet de service pour interagir avec Content API, obtient la référence marchand à partir du fichier de configuration, crée la requête et l'exécute pour effectuer l'appel d'API.

   À la fin du fichier my-insert.py, ajoutez le code suivant :

   def main(argv):
     # Construct the service object to interact with the Content API.
     service, config, _ = common.init(argv, __doc__)
   
     # Get the merchant ID from merchant-info.json.
     merchant_id = config['merchantId']
   
     # Create the request with the merchant ID and product object.
     request = service.products().insert(merchantId=merchant_id, body=product)
   
     # Execute the request and print the result.
     result = request.execute()
     print('Product with offerId "%s" was created.' % (result['offerId']))
   
   # Allow the function to be called with arguments passed from the command line.
   if __name__ == '__main__':
     main(sys.argv)
   
   

5. Pour exécuter le script et l'appel d'API, accédez à googleads-shopping-samples/python/ à partir d'une fenêtre de terminal, puis lancez la commande suivante :

   python -m shopping.content.products.my-insert
   

   Si l'appel a abouti, le service imprime le message suivant sur le terminal : Le produit ayant l'offerId "offerId" a été créé.

6. Pour vérifier que le produit a bien été ajouté, utilisez APIs Explorer afin que la méthode products.list renvoie tous les produits de votre compte Merchant Center.

   Remarque : Une fois l'appel products.insert terminé, il peut s'écouler quelques minutes avant que le produit ne soit disponible via products.list ou dans Merchant Center.

   Dans APIs Explorer pour la méthode products.list, saisissez les valeurs suivantes :

   1. Indiquez votre merchantId.
   Remarque : Tous les autres paramètres de requête sont facultatifs.
   1. Dans la section Identifiants, sélectionnez Google OAuth 2.0 et Clé API.
   2. Cliquez sur le bouton Exécuter.
   3. Si vous y êtes invité, connectez-vous avec le compte Google associé à votre compte Merchant Center.

   Si le produit a bien été ajouté, les données produit apparaissent dans la réponse d'APIs Explorer.

Les marchands sont tenus de respecter les règles concernant les annonces Shopping et les fiches gratuites. Google Shopping se réserve le droit de faire appliquer ces règles et de prendre les mesures appropriées si nous détectons un contenu ou un comportement qui n'y est pas conforme.

Remarque : Par défaut, les nouveaux produits insérés avec Content API sont ajoutés à un nouveau flux principal dans Merchant Center. Pour en savoir plus sur l'utilisation de différents types de flux avec Content API, consultez la page Bonnes pratiques.