Configurer l'accès à l'API

Voici comment configurer l'accès à l'API Data Manager avec un SDK ou REST.

Prérequis

Avant de pouvoir utiliser l'API Data, assurez-vous de disposer des éléments suivants :

  1. Un projet Google Cloud.
  2. Un compte Google qui répond aux deux critères suivants :
    1. Vous avez obtenu l'accès à l'API Data Manager après avoir rempli le formulaire d'intérêt pour l'API Data Manager. Si vous pouvez accéder à la page Détails du produit d'API, vous y avez accès.
    2. Dispose de l'autorisation serviceusage.services.enable sur votre projet Google Cloud ou d'un rôle qui inclut cette autorisation. Par exemple, roles/owner et roles/serviceusage.serviceUsageAdmin incluent tous les deux l'autorisation serviceusage.services.enable. Pour vérifier vos autorisations, consultez Afficher l'accès actuel.

Activer l'API

Si vous ne l'avez pas déjà fait, activez l'API Data Manager.

Si vous ne trouvez pas l'API Data Manager, vérifiez que votre compte Google répond aux conditions préalables.

Configurer l'authentification

Sélectionnez et configurez une méthode d'authentification. Nous vous recommandons de configurer les identifiants par défaut de l'application pour trouver automatiquement les identifiants à partir de l'environnement. Cette API n'utilise pas de clés API.

Le champ d'application https://www.googleapis.com/auth/datamanager est requis pour tous les identifiants utilisés avec l'API Data Manager. Pour obtenir un exemple d'utilisation des champs d'application, consultez la documentation de la commande gcloud auth application-default login.

Pour en savoir plus sur l'authentification et les identifiants de votre application, consultez Méthodes d'authentification chez Google et Fonctionnement des identifiants par défaut de l'application.

Configurer l'accès au compte d'exploitation

Accordez à l'adresse e-mail associée à votre compte utilisateur ou de service l'accès à Destination.

Configurer le SDK correspondant à votre langage de programmation

Sur votre ordinateur local, installez le SDK de votre choix :

REST

  1. Mettez à jour les espaces réservés dans l'exemple suivant, tels que OPERATING_ACCOUNT_PRODUCT, OPERATING_ACCOUNT_ID et AUDIENCE_ID, avec les valeurs de votre compte et de votre destination.
  2. Remplacez PROJECT_ID par l'ID de votre projet Google Cloud.
  3. Copiez l'exemple dans la ligne de commande pour envoyer la requête.

    Supprimez l'attribut linkedAccount de l'entrée dans destinations si vous n'accédez pas à operationAccount à l'aide d'un lien produit établi.

    #!/bin/bash
    
    # Uses gcloud to get an access token.
    DATA_MANAGER_ACCESS_TOKEN="$(gcloud auth application-default print-access-token --scopes=https://www.googleapis.com/auth/datamanager)"
    
    # Sends the request.
    curl -X POST "https://datamanager.googleapis.com/v1/audienceMembers:ingest" \
      --header "Authorization: Bearer ${DATA_MANAGER_ACCESS_TOKEN}" \
      --header "x-goog-user-project: PROJECT_ID" \
      --header "Content-Type: application/json" \
      --data @- <<EOF
    {
      "destinations": [
        {
          "operatingAccount": {
            "product": "OPERATING_ACCOUNT_PRODUCT",
            "accountId": "OPERATING_ACCOUNT_ID"
          },
          "loginAccount": {
            "product": "LOGIN_ACCOUNT_PRODUCT",
            "accountId": "LOGIN_ACCOUNT_ID"
          },
          "linkedAccount": {
            "product": "LINKED_ACCOUNT_PRODUCT",
            "accountId": "LINKED_ACCOUNT_ID"
          },
          "productDestinationId": "AUDIENCE_ID"
        }
      ],
      "audienceMembers": [
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "07e2f1394b0ea80e2adca010ea8318df697001a005ba7452720edda4b0ce57b3"
              },
              {
                "emailAddress": "1df6b43bc68dd38eca94e6a65b4f466ae537b796c81a526918b40ac4a7b906c7"
              }
            ]
          }
        },
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "2ef46c4214c3fc1b277a2d976d55194e12b899aa50d721f28da858c7689756e3"
              },
              {
                "emailAddress": "54e410b14fa652a4b49b43aff6eaf92ad680d4d1e5e62ed71b86cd3188385a51"
              },
              {
                "emailAddress": "e8bd3f8da6f5af73bec1ab3fbf7beb47482c4766dfdfc94e6bd89e359c139478"
              }
            ]
          }
        },
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "05bb62526f091b45d20e243d194766cca8869137421047dc53fa4876d111a6f0"
              },
              {
                "emailAddress": "f1fcde379f31f4d446b76ee8f34860eca2288adc6b6d6c0fdc56d9eee75a2fa5"
              }
            ]
          }
        },
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "83a834cc5327bc4dee7c5408988040dc5813c7662611cd93b707aff72bf7d33f"
              },
              {
                "emailAddress": "223ebda6f6889b1494551ba902d9d381daf2f642bae055888e96343d53e9f9c4"
              }
            ]
          }
        }
      ],
      "consent": {
        "adUserData": "CONSENT_GRANTED",
        "adPersonalization": "CONSENT_GRANTED"
      },
      "encoding": "HEX",
      "termsOfService": {
        "customerMatchTermsOfServiceStatus": "ACCEPTED"
      },
      "validateOnly": true
    }
    EOF
    

Java

  1. Téléchargez et extrayez google-cloud-ads-datamanager-v1-java.tar.gz.
  2. Accédez au répertoire google-cloud-ads-datamanager-v1-java.
  3. Exécutez la commande suivante pour compiler et publier la bibliothèque dans votre dépôt Maven local afin de l'utiliser avec Maven ou Gradle.

    ./gradlew -Pversion=0.1.0 install
    
  4. Dans votre projet Java, déclarez une dépendance sur la bibliothèque de l'API Data Manager.

    Gradle :

    implementation 'com.google.cloud:gapic-google-cloud-ads-datamanager-v1-java:0.1.0'
    

    Maven :

    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>gapic-google-cloud-ads-datamanager-v1-java</artifactId>
      <version>0.1.0</version>
    </dependency>
    
  5. Facultatif. Obtenez la bibliothèque d'utilitaires et les exemples de code.

    1. Clonez le dépôt GitHub.

      git clone https://github.com/googleads/data-manager-java.git
      
    2. Accédez au répertoire data-manager-java.

    3. Créez et publiez la bibliothèque d'utilitaires dans votre dépôt Maven local.

      ./gradlew data-manager-util:install
      
    4. Dans votre projet Java, déclarez une dépendance sur la bibliothèque utilitaire.

      Gradle :

      implementation 'com.google.api-ads:data-manager-util:0.1.0'
      

      Maven :

      <dependency>
         <groupId>com.google.api-ads</groupId>
         <artifactId>data-manager-util</artifactId>
         <version>0.1.0</version>
      </dependency>
      
    5. Pour mettre en forme et chiffrer les données, utilisez les utilitaires UserDataFormatter et Encrypter dans votre projet Java.

    6. Parcourez les exemples de code dans le sous-répertoire data-manager-samples ou sur GitHub. Pour exécuter un exemple à partir de la ligne de commande, utilisez la tâche Gradle run.

      Par exemple, la commande suivante exécute l'exemple IngestAudienceMembers et affiche une instruction d'utilisation :

      ./gradlew data-manager-samples:run \
        --args='IngestAudienceMembers --help'
      

      Pour vous aider à vous lancer avec des exemples de données, utilisez le fichier data-manager-samples/src/main/resources/sampledata/audience_members_1.csv.

Python

  1. Téléchargez ads-datamanager-v1-py.tar.gz.
  2. Accédez au répertoire du téléchargement.
  3. Exécutez la commande suivante pour compiler la bibliothèque et la rendre disponible pour d'autres projets dans le même environnement Python :

    pip install ./ads-datamanager-v1-py.tar.gz
    
  4. Dans votre projet Python, déclarez une dépendance sur la bibliothèque de l'API Data Manager. Par exemple, si vous utilisez un fichier requirements.txt dans votre projet, ajoutez la ligne suivante au fichier :

    google-ads-data-manager=0.1.0
    
  5. Facultatif. Obtenez la bibliothèque d'utilitaires et les exemples de code.

    1. Téléchargez et extrayez data-manager-python.tar.gz.
    2. Accédez au répertoire data-manager-python.
    3. Pour installer la bibliothèque utilitaire dans votre environnement Python, exécutez la commande suivante :

      pip install .
      
    4. Dans votre projet Python, déclarez une dépendance sur la bibliothèque utilitaire. Par exemple, si vous utilisez un fichier requirements.txt dans votre projet, ajoutez la ligne suivante au fichier :

      google-ads-data-manager-util=0.1.0
      
    5. Pour mettre en forme et chiffrer les données, utilisez les utilitaires Formatter et Encrypter dans votre projet Python.

    6. Parcourez les exemples de code dans le sous-répertoire samples. Transmettez l'argument --help lorsque vous exécutez un exemple pour imprimer une instruction d'utilisation avec les paramètres attendus.

      Pour vous aider à vous lancer avec des exemples de données, utilisez le fichier samples/sampledata/audience_members_1.csv.

Node.js

  1. Téléchargez et extrayez ads-datamanager-v1-nodejs.tar.gz.
  2. Accédez au répertoire ads-datamanager-v1-nodejs.
  3. Exécutez les commandes suivantes pour compiler et empaqueter la bibliothèque dans un fichier .tgz à utiliser avec npm.

    npm install
    npm pack
    

    Les commandes génèrent une archive nommée google-cloud-datamanager-0.1.0.tgz.

  4. Dans votre projet Node.js, déclarez une dépendance sur la bibliothèque de l'API Data Manager en ajoutant une entrée dependencies pour le chemin d'accès complet et le nom de fichier du fichier google-cloud-datamanager-0.1.0.tgz.

PHP

  1. Téléchargez et extrayez google-cloud-ads-datamanager-v1-php.tar.gz.
  2. Accédez au répertoire google-cloud-ads-datamanager-v1-php.
  3. Exécutez la commande suivante pour résoudre les dépendances de la bibliothèque :

    composer update --prefer-dist
    
  4. Dans le fichier composer.json de votre projet PHP sur le même hôte, déclarez une dépendance à la bibliothèque de l'API Data Manager en procédant comme suit :

    1. Ajoutez une section repositories qui pointe vers l'emplacement du répertoire google-cloud-ads-datamanager-v1-php.

      "repositories" : [
         {
            "type" : "path",
            "url" : "PATH_TO_CLIENT_LIBRARY"
         }
      ]
      
    2. Déclarez une dépendance sur la bibliothèque de l'API Data Manager.

      "require": {
         "googleads/data-manager": "^0.1.0"
      }
      
  5. (Facultatif) Obtenez la bibliothèque d'utilitaires et les exemples de code.

    1. Téléchargez et extrayez data-manager-php.tar.gz.
    2. Accédez au répertoire data-manager-php.
    3. Exécutez la commande suivante pour résoudre les dépendances de la bibliothèque :

      composer update --prefer-dist
      
    4. Dans le fichier composer.json de votre projet PHP sur le même hôte, déclarez une dépendance sur la bibliothèque d'utilitaires en procédant comme suit :

      1. Ajoutez une entrée dans la section repositories qui pointe vers l'emplacement du répertoire data-manager-php.

        "repositories" : [
           {
              "type" : "path",
              "url" : "PATH_TO_UTILITY_LIBRARY"
           }
        ]
        
      2. Déclarez une dépendance à la bibliothèque d'utilitaires.

        "require": {
           "googleads/data-manager-util": "@dev"
        }
        

      Pour mettre en forme les données, utilisez l'utilitaire Formatter dans votre projet PHP.

    5. Parcourez les exemples de code dans le sous-répertoire samples. Exécutez les exemples en procédant comme suit :

      1. Accédez au répertoire samples.

      2. Définissez la variable d'environnement DATA_MANAGER_PHP_LIB sur le chemin d'accès à l'emplacement où vous avez extrait la bibliothèque cliente.

        export DATA_MANAGER_PHP_LIB="PATH_TO_CLIENT_LIBRARY"
        
      3. Exécutez la commande suivante pour résoudre les dépendances de la bibliothèque :

        composer update --prefer-dist
        
      4. Exécutez les exemples en transmettant les arguments requis. Transmettez l'argument --help lorsque vous exécutez un exemple pour imprimer une instruction d'utilisation avec les paramètres attendus.

      Pour vous aider à vous lancer avec des exemples de données, utilisez le fichier samples/sampledata/audience_members_1.csv.