Installer une bibliothèque cliente

Voici comment installer et configurer une bibliothèque cliente ou REST.

Prérequis

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

Procédure d'installation

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

REST

  1. Mettez à jour les espaces réservés de 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. N'utilisez l'exemple Partenaire pour les données que si vous accédez au compte d'exploitation via un lien partenaire. Sinon, utilisez l'exemple Annonceur.

    Annonceur

    #!/bin/bash
    
    # Uses gcloud to get an access token. If the Application Default
    # Credentials aren't for a service account then the command that
    # specifies --scopes fails, so 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": [
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "07e2f1394b0ea80e2adca010ea8318df697001a005ba7452720edda4b0ce57b3"
                },
                {
                  "emailAddress": "1df6b43bc68dd38eca94e6a65b4f466ae537b796c81a526918b40ac4a7b906c7"
                }
              ]
            }
          }
        },
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "2ef46c4214c3fc1b277a2d976d55194e12b899aa50d721f28da858c7689756e3"
                },
                {
                  "emailAddress": "54e410b14fa652a4b49b43aff6eaf92ad680d4d1e5e62ed71b86cd3188385a51"
                },
                {
                  "emailAddress": "e8bd3f8da6f5af73bec1ab3fbf7beb47482c4766dfdfc94e6bd89e359c139478"
                }
              ]
            }
          }
        },
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "05bb62526f091b45d20e243d194766cca8869137421047dc53fa4876d111a6f0"
                },
                {
                  "emailAddress": "f1fcde379f31f4d446b76ee8f34860eca2288adc6b6d6c0fdc56d9eee75a2fa5"
                }
              ]
            }
          }
        },
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "83a834cc5327bc4dee7c5408988040dc5813c7662611cd93b707aff72bf7d33f"
                },
                {
                  "emailAddress": "223ebda6f6889b1494551ba902d9d381daf2f642bae055888e96343d53e9f9c4"
                }
              ]
            }
          }
        }
      ],
      "consent": {
        "adUserData": "CONSENT_GRANTED",
        "adPersonalization": "CONSENT_GRANTED"
      },
      "encoding": "HEX",
      "termsOfService": {
        "customerMatchTermsOfServiceStatus": "ACCEPTED"
      },
      "validateOnly": true
    }
    EOF
    

    Partenaire pour les données

    #!/bin/bash
    
    # Uses gcloud to get an access token. If the Application Default
    # Credentials aren't for a service account then the command that
    # specifies --scopes fails, so 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"
          },
          "linkedAccount": {
            "accountType": "LINKED_ACCOUNT_TYPE",
            "accountId": "LINKED_ACCOUNT_ID"
          },
          "productDestinationId": "AUDIENCE_ID"
        }
      ],
      "audienceMembers": [
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "07e2f1394b0ea80e2adca010ea8318df697001a005ba7452720edda4b0ce57b3"
                },
                {
                  "emailAddress": "1df6b43bc68dd38eca94e6a65b4f466ae537b796c81a526918b40ac4a7b906c7"
                }
              ]
            }
          }
        },
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "2ef46c4214c3fc1b277a2d976d55194e12b899aa50d721f28da858c7689756e3"
                },
                {
                  "emailAddress": "54e410b14fa652a4b49b43aff6eaf92ad680d4d1e5e62ed71b86cd3188385a51"
                },
                {
                  "emailAddress": "e8bd3f8da6f5af73bec1ab3fbf7beb47482c4766dfdfc94e6bd89e359c139478"
                }
              ]
            }
          }
        },
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "05bb62526f091b45d20e243d194766cca8869137421047dc53fa4876d111a6f0"
                },
                {
                  "emailAddress": "f1fcde379f31f4d446b76ee8f34860eca2288adc6b6d6c0fdc56d9eee75a2fa5"
                }
              ]
            }
          }
        },
        {
          "compositeData": {
            "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 : Installer la bibliothèque d'utilitaires

En plus de la bibliothèque cliente, vous pouvez installer la bibliothèque d'utilitaires pour vous aider à effectuer des tâches courantes, comme la mise en forme des données pour l'ingestion.

  1. Dans votre projet .NET, déclarez une dépendance à la bibliothèque d'utilitaires Google.Ads.DataManager.Util.

    dotnet add package Google.Ads.DataManager.Util --version 0.4.0
    
  2. Pour mettre en forme les données, utilisez l'utilitaire UserDataFormatter dans votre projet .NET.

Parcourir des exemples de code

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

Pour exécuter des exemples :

  1. Clonez le dépôt GitHub au niveau du tag v0.4.0 :

    git clone --branch v0.4.0 https://github.com/googleads/data-manager-dotnet.git
    
  2. Accédez au répertoire data-manager-dotnet.

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

    dotnet run
    

    Transmettez l'argument --help lors de l'exécution d'un exemple pour afficher 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 les fichiers de samples/sampledata.

Go

Installer la bibliothèque cliente

go get cloud.google.com/go/datamanager/apiv1@latest

Pour en savoir plus, suivez les instructions du guide de la bibliothèque cliente Go.

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 : Installer la bibliothèque d'utilitaires

En plus de la bibliothèque cliente, vous pouvez installer la bibliothèque d'utilitaires pour vous aider à effectuer des tâches courantes telles que le formatage et le chiffrement des données pour l'ingestion.

  1. Dans votre projet Java, déclarez une dépendance à la bibliothèque d'utilitaires data-manager-util.

    Gradle :

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

    Maven :

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

Parcourir des exemples de code

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

Pour exécuter des exemples :

  1. Clonez le dépôt GitHub au niveau du tag v0.4.0 :

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

  3. Exécutez les exemples à partir de la ligne de commande à l'aide de la tâche Gradle run, en transmettant les arguments requis. Transmettez l'argument --help lors de l'exécution d'un exemple pour afficher une instruction d'utilisation avec les paramètres attendus.

    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 à démarrer avec des exemples de données, utilisez les fichiers de data-manager-samples/src/main/resources/sampledata.

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 : Installer la bibliothèque d'utilitaires

En plus de la bibliothèque cliente, vous pouvez installer la bibliothèque d'utilitaires pour vous aider à effectuer des tâches courantes, comme la mise en forme des données pour l'ingestion.

  1. Dans votre projet Node.js, déclarez une dépendance à la bibliothèque d'utilitaires @google-ads/datamanager-util :

    npm install @google-ads/datamanager-util
    
  2. Pour formater les données, utilisez l'utilitaire UserDataFormatter dans votre projet Node.js.

Parcourir des exemples de code

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

Pour exécuter des exemples :

  1. Clonez le dépôt GitHub au niveau du tag v0.4.1 :

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

  3. Installez les dépendances pour exécuter les exemples :

    npm install
    
  4. Exécutez les exemples en transmettant les arguments requis. Transmettez l'argument --help lors de l'exécution d'un exemple pour afficher une instruction d'utilisation avec les paramètres attendus.

    Par exemple, la commande suivante exécute l'exemple ingest-audience-members et affiche une instruction d'utilisation :

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

Pour vous aider à démarrer avec des exemples de données, utilisez les fichiers de samples/sampledata.

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 bibliothèque cliente googleads/data-manager dans votre projet.

Facultatif : Installer la bibliothèque d'utilitaires

En plus de la bibliothèque cliente, vous pouvez installer la bibliothèque d'utilitaires pour vous aider à effectuer des tâches courantes, comme la mise en forme des données pour l'ingestion.

  1. Dans le fichier composer.json de votre projet PHP sur le même hôte, déclarez une dépendance à la bibliothèque d'utilitaires :

    composer require googleads/data-manager-util
    
  2. Pour formater les données, utilisez l'utilitaire Formatter dans votre projet PHP.

Parcourir les exemples de code

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

Pour exécuter des exemples :

  1. Clonez le dépôt GitHub au niveau du tag v0.4.0 :

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

  3. Installez les dépendances pour exécuter les exemples :

    composer install
    
  4. Exécutez les exemples en transmettant les arguments requis. Transmettez l'argument --help lors de l'exécution d'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 affiche une instruction d'utilisation :

    php audiences/ingest_audience_members.php --help
    

Pour vous aider à démarrer avec des exemples de données, utilisez les fichiers de samples/sampledata.

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 : Installer la bibliothèque d'utilitaires

En plus de la bibliothèque cliente, vous pouvez installer la bibliothèque d'utilitaires pour vous aider à effectuer des tâches courantes, comme le formatage et le chiffrement des données pour l'ingestion.

  1. Dans votre projet Python, déclarez une dépendance à la bibliothèque d'utilitaires google-ads-datamanager-util.

    Par exemple, si vous utilisez un fichier requirements.txt dans votre projet, ajoutez-y la ligne suivante :

    google-ads-datamanager-util==0.4.0
    

    Vous pouvez également installer directement la bibliothèque d'utilitaires :

    pip install google-ads-datamanager-util==0.4.0
    
  2. Pour formater et chiffrer les données, utilisez les utilitaires Formatter et Encrypter dans votre projet Python.

Parcourir les exemples de code

  1. Clonez le dépôt GitHub au niveau du tag v0.4.0 :

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

  3. Installez les dépendances pour exécuter les exemples :

    pip install -r samples/requirements.txt
    
  4. Exécutez les exemples en transmettant les arguments requis. Transmettez l'argument --help lors de l'exécution d'un exemple pour afficher une instruction d'utilisation avec les paramètres attendus.

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

    python3 samples/audiences/ingest_audience_members.py --help
    

Pour vous aider à démarrer avec des exemples de données, utilisez les fichiers de samples/sampledata.

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