Installer une bibliothèque cliente

Découvrez comment installer et configurer une bibliothèque cliente ou REST.

Prérequis

Avant d'installer une bibliothèque cliente, suivez les étapes décrites dans Configurer l'accès à l'API, y compris la configuration des identifiants par défaut de l'application (ADC).

Installer la bibliothèque

Sur votre ordinateur local, installez la bibliothèque cliente de votre choix :

REST

Choisissez le type de processus de configuration que vous souhaitez suivre :

  1. Remplacez les espaces réservés de l'exemple suivant, tels que OPERATING_ACCOUNT_PRODUCT, OPERATING_ACCOUNT_ID, et AUDIENCE_ID, par 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.

    #!/bin/bash
    
    # Uses gcloud to get an access token. If the Application Default
    # Credentials aren't for a service account, the command that specifies
    # --scopes fails. This sample falls back to the command without the
    # --scopes argument.
    DATA_MANAGER_ACCESS_TOKEN="$(gcloud auth application-default print-access-token --scopes=https://www.googleapis.com/auth/datamanager || \
      gcloud auth application-default print-access-token)"
    
    # Fetches and prints the scope information for the access token. If you
    # get scope-related errors when you send the request in the next step,
    # verify that this output includes the Data Manager API scope:
    #   https://www.googleapis.com/auth/datamanager
    curl https://www.googleapis.com/oauth2/v1/tokeninfo?access_token="${DATA_MANAGER_ACCESS_TOKEN}"
    
    # 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": {
            "accountType": "OPERATING_ACCOUNT_TYPE",
            "accountId": "OPERATING_ACCOUNT_ID"
          },
          "loginAccount": {
            "accountType": "LOGIN_ACCOUNT_TYPE",
            "accountId": "LOGIN_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
    

.NET

Installer la bibliothèque cliente

Suivez les instructions du guide d'installation de la bibliothèque cliente.NET pour ajouter une dépendance à la bibliothèque cliente dans votre projet.

Facultatif : Obtenir la bibliothèque d'utilitaires et des exemples de code

  1. Clonez le dépôt GitHub.

    git clone https://github.com/googleads/data-manager-dotnet.git
    
  2. Dans votre projet .NET, déclarez une dépendance ProjectReference sur la bibliothèque d'utilitaires. Remplacez PATH_TO_UTILITY_LIBRARY par l' emplacement où vous avez cloné le dépôt data-manager-dotnet.

    <ProjectReference Include="PATH_TO_UTILITY_LIBRARY\Google.Ads.DataManager.Util\src\Google.Ads.DataManager.Util.csproj" />
    
  3. Pour mettre en forme les données, utilisez l'utilitaire Formatter dans votre projet .NET.

  4. Parcourez les exemples de code dans le samples sous-répertoire ou sur GitHub.

    Accédez au répertoire samples et utilisez dotnet run pour obtenir la liste des exemples disponibles.

    dotnet run
    

    Transmettez l'argument --help lorsque vous exécutez un exemple pour imprimer une instruction d'utilisation avec les paramètres attendus.

    dotnet run -- ingest-audience-members --help
    

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

Java

Installer la bibliothèque cliente

Suivez les instructions du guide d'installation de la bibliothèque cliente Java pour ajouter une dépendance à la bibliothèque cliente dans votre projet.

Facultatif : Obtenir la bibliothèque d'utilitaires et des exemples de code

  1. Clonez le dépôt GitHub.

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

  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 d'utilitaires.

    Gradle:

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

    Maven:

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

  6. Parcourez les exemples de code dans le data-manager-samples sous-répertoire 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'IngestAudienceMembers exemple et imprime une instruction d'utilisation :

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

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

Node.js

Installer la bibliothèque cliente

Suivez les instructions du guide d'installation de la bibliothèque cliente Node.js pour ajouter une dépendance à la bibliothèque cliente @google-ads/datamanager dans votre projet.

Facultatif : Obtenir la bibliothèque d'utilitaires et des exemples de code

  1. Clonez le dépôt GitHub.

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

  3. Exécutez la commande suivante pour installer les dépendances.

    npm install
    
  4. Accédez au répertoire util.

    cd util
    
  5. Exécutez la commande suivante pour compiler et empaqueter la bibliothèque d'utilitaires dans un .tgz fichier à utiliser avec npm.

    npm pack
    

    La commande génère une archive nommée google-ads-datamanager-util-0.2.0.tgz. Notez l'emplacement du fichier afin de pouvoir l'utiliser lors des étapes suivantes.

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

    {
       "dependencies": {
          ...
          "@google-ads/data-manager-util": "file:PATH_TO_UTILITY_LIBRARY/google-ads-datamanager-util-0.2.0.tgz",
          ...
       }
    }
    

    Pour mettre en forme les données, utilisez l'utilitaire UserDataFormatter dans votre projet Node.js.

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

    1. Accédez au data-manager-node répertoire.

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

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

      npm run ingest-audience-members -w samples -- --help
      

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

PHP

Installer la bibliothèque cliente

Suivez les instructions du guide d'installation de la bibliothèque cliente PHP pour ajouter une dépendance à la googleads/data-manager bibliothèque cliente dans votre projet.

Facultatif : Obtenir la bibliothèque d'utilitaires et des exemples de code

  1. Clonez le dépôt GitHub.

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

  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 sur 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 samples sous-répertoire ou sur GitHub. Exécutez les exemples en procédant comme suit :

    1. Accédez au samples répertoire.

    2. Exécutez la commande suivante pour résoudre les dépendances de la bibliothèque :

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

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

Python

Installer la bibliothèque cliente

Suivez les instructions du guide d'installation de la bibliothèque cliente Python pour ajouter une dépendance à la bibliothèque cliente google-ads-datamanager dans votre projet.

Facultatif : Obtenir la bibliothèque d'utilitaires et des exemples de code

  1. Clonez le dépôt GitHub.

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

  3. Pour installer la bibliothèque d'utilitaires 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 d'utilitaires. Par exemple, si vous utilisez un fichier requirements.txt dans votre projet, ajoutez la ligne suivante au fichier :

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

  6. Parcourez les exemples de code dans le samples sous-répertoire ou sur GitHub. Pour exécuter des exemples, installez les dépendances nécessaires :

    pip install .[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 à démarrer avec des exemples de données, utilisez le fichier à samples/sampledata/audience_members_1.csv.

Ruby

Installer la bibliothèque cliente

Suivez les instructions du guide d'installation de la bibliothèque cliente Ruby pour ajouter une dépendance à la bibliothèque cliente dans votre projet.

Étapes suivantes