Bibliothèques clientes CX Agent Studio

Cette page explique comment débuter avec les bibliothèques clientes Cloud pour l'API Customer Engagement Suite. Les bibliothèques clientes facilitent l'accès aux APIGoogle Cloud à l'aide d'un langage compatible. Bien que vous puissiez utiliser directement les APIGoogle Cloud en envoyant des requêtes brutes au serveur, les bibliothèques clientes vous simplifient la tâche en réduisent considérablement la quantité de code à écrire.

Pour en savoir plus sur les bibliothèques clientes Cloud et les anciennes bibliothèques clientes pour les API Google, consultez Présentation des bibliothèques clientes.

Installer la bibliothèque cliente

C#

Téléchargez google-cloud-ces-v1-csharp.tar.gz.

Téléchargez google-cloud-ces-v1beta-csharp.tar.gz.

Contactez votre responsable de compte Google pour obtenir des instructions.

Pour en savoir plus, consultez la page Configurer un environnement de développement C#.

Go

Téléchargez gapi-cloud-ces-v1-go.tar.gz.

Téléchargez gapi-cloud-ces-v1beta-go.tar.gz.

Clonez cloud.google.com/go et capturez le chemin d'accès comme suit :

git clone https://github.com/googleapis/google-cloud-go
export CLOUD_GO=`pwd`/google-cloud-go

Décompressez le fichier tar : tar -xzpf gapi-cloud-ces-v1-go.tar.gz. Copiez ensuite les sources dans le répertoire CLOUD_GO.

Remarque : Le module racine est cloud.google.com/go. Vous devez donc cibler un répertoire plus profond lorsque vous copiez des éléments à partir du fichier tar. Certains packages seront imbriqués dans plusieurs répertoires, comme cloud.google.com/go/maps/maplearning.

cp -r ./cloud.google.com/go/gapi-cloud-ces-v1-go $CLOUD_GO

À partir du répertoire racine d'un module Go utilisant le client, remplacez la dépendance du client par le clone local.

Remarque : Si ce n'est pas un tout nouveau module et qu'un sous-module a été publié sur CLOUD_GO, ciblez plutôt cette dépendance de module avec la commande suivante.

go mod edit -replace=cloud.google.com/go=$CLOUD_GO

La bibliothèque cliente générée localement est maintenant prête à être utilisée.

Pour en savoir plus, consultez Configurer un environnement de développement Go.

Java

Téléchargez google-cloud-ces-v1-java.tar.gz.

Téléchargez google-cloud-ces-v1beta-java.tar.gz.

Vous pouvez choisir l'une des deux options suivantes :

Option 1 (recommandée) : Installez le client dans un cache Maven local :

cd /path/to/library ./gradlew clean publishToMavenLocal

Le client peut ensuite être utilisé de manière conventionnelle à partir de n'importe quel projet Gradle ou Maven. Pour obtenir un exemple d'ajout de la bibliothèque cliente Java créée localement à un projet Maven, consultez les informations suivantes :

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.google.cloud</groupId>
            <artifactId>gapic-google-cloud-ces-v1-java</artifactId>
            <version>0.0.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>com.google.api</groupId>
            <artifactId>gax-bom</artifactId>
            <version>${gax-bom.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<dependencies>
    <dependency>
        <groupId>com.google.cloud</groupId>
        <artifactId>gapic-google-cloud-ces-v1-java</artifactId>
    </dependency>
    <dependency>
        <groupId>com.google.api</groupId>
        <artifactId>gax</artifactId>
    </dependency>
    <dependency>
        <groupId>com.google.api</groupId>
        <artifactId>gax-grpc</artifactId>
    </dependency>
    <dependency>
        <groupId>com.google.api</groupId>
        <artifactId>gax-httpjson</artifactId>
    </dependency>
</dependencies>

Option 2 : Créez simplement le fichier JAR du client et extrayez toutes ses dépendances dans un seul dossier :

./gradlew clean allJars

Ensuite, vérifiez le dossier all-jars. Il devrait contenir tous les fichiers JAR nécessaires à l'exécution du client (c'est-à-dire le client lui-même et toutes ses dépendances directes et transitives).

Pour en savoir plus, consultez Configurer un environnement de développement Java.

Node.js

Téléchargez ces-v1-nodejs.tar.gz.

Téléchargez ces-v1beta-nodejs.tar.gz.

NPM est compatible avec les installations locales à l'aide du fichier tar produit par npm pack.

Tout d'abord, décompressez le fichier produit par Bazel :

tar xzf path/to/ces-v1-nodejs.tar.gz
cd ces-v1-nodejs

Dans le dossier décompressé, exécutez npm install pour compiler la bibliothèque et npm pack pour empaqueter le résultat dans le fichier .tgz à utiliser par npm :

npm install
npm pack

Le fichier obtenu peut être transmis à npm install :

npm install RESULTING_FILE

Il peut également être distribué au sein du projet.

Pour en savoir plus, consultez Configurer un environnement de développement Node.js.

PHP

Téléchargez google-cloud-ces-v1-php.tar.gz.

Téléchargez google-cloud-ces-v1beta-php.tar.gz.

Décompressez-le dans un dossier de votre projet, par exemple :

tar xvf path/to/LIBRARY.tar.gz

La bibliothèque cliente sera alors décompressée dans un dossier local. Déplacez ce dossier à la racine de votre projet et ajoutez les éléments suivants au fichier composer.json de votre projet (ou créez-en un s'il n'existe pas) :

{
    "require": {
        "google/gax": "^1.34"
    },
    "autoload": {
        "classmap": [
            "LIBRARY/src",
            "LIBRARY/proto/src"
        ]
    }
}

Cela ajoute la dépendance google/gax et identifie les répertoires où les fichiers de classe peuvent être trouvés et chargés automatiquement par Composer.

Exécutez composer install, incluez vendor/autoload.php dans votre code, et le tour est joué.

Pour en savoir plus, consultez la page Utiliser PHP sur Google Cloud.

Python

Téléchargez ces-v1-py.tar.gz.

Téléchargez ces-v1beta-py.tar.gz.

Commencez par configurer un environnement virtuel :

python3 -m venv env
source env/bin/activate

Installez ensuite la bibliothèque à partir du fichier tar :

pip install ces-v1-py.tar.gz

Pour en savoir plus, consultez la page Configurer un environnement de développement Python.

Ruby

Téléchargez google-cloud-ces-v1-ruby.tar.gz.

Téléchargez google-cloud-ces-v1beta-ruby.tar.gz.

Contactez votre responsable de compte Google pour obtenir des instructions.

Pour en savoir plus, consultez Configurer un environnement de développement Ruby.

Configurer l'authentification

Pour authentifier les appels aux API Google Cloud , les bibliothèques clientes utilisent le service Identifiants par défaut de l'application (ADC). Les bibliothèques recherchent des identifiants dans un ensemble d'emplacements définis et les utilisent pour authentifier les requêtes adressées à l'API. Grâce à ADC, vous pouvez mettre des identifiants à disposition de votre application dans divers environnements, tels que l'environnement de développement ou de production local, sans avoir à modifier le code de votre application.

Pour les environnements de production, la façon de configurer ADC dépend du service et du contexte. Pour en savoir plus, consultez Configurer le service Identifiants par défaut de l'application.

Pour un environnement de développement local, vous pouvez configurer ADC avec les identifiants associés à votre compte Google :

1. Install the Google Cloud CLI. After installation, initialize the Google Cloud CLI by running the following command:

   gcloud init

   If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

2. If you're using a local shell, then create local authentication credentials for your user account:

   gcloud auth application-default login

   You don't need to do this if you're using Cloud Shell.

   If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

   Un écran de connexion s'affiche. Une fois que vous êtes connecté, vos identifiants sont stockés dans le fichier d'identifiants local utilisé par le service Identifiants par défaut de l'application.

Autres ressources

C#

La liste suivante contient des liens vers d'autres ressources liées à la bibliothèque cliente pour C# :

• Documentation de référence sur l'API
• Bonnes pratiques concernant les bibliothèques clientes
• Outil de suivi des problèmes
• gemini-enterprise-cx sur Stack Overflow
• Code source

Go

La liste suivante contient des liens vers d'autres ressources liées à la bibliothèque cliente pour Go :

• Documentation de référence de l'API
• Bonnes pratiques concernant les bibliothèques clientes
• Outil de suivi des problèmes
• gemini-enterprise-cx sur Stack Overflow
• Code source

Java

La liste suivante contient des liens vers d'autres ressources liées à la bibliothèque cliente pour Java :

• Documentation de référence de l'API
• Bonnes pratiques concernant les bibliothèques clientes
• Outil de suivi des problèmes
• gemini-enterprise-cx sur Stack Overflow
• Code source

Node.js

La liste suivante contient des liens vers d'autres ressources liées à la bibliothèque cliente pour Node.js :

• Documentation de référence de l'API
• Bonnes pratiques concernant les bibliothèques clientes
• Outil de suivi des problèmes
• gemini-enterprise-cx sur Stack Overflow
• Code source

PHP

La liste suivante contient des liens vers d'autres ressources liées à la bibliothèque cliente pour PHP :

• Documentation de référence de l'API
• Bonnes pratiques concernant les bibliothèques clientes
• Outil de suivi des problèmes
• gemini-enterprise-cx sur Stack Overflow
• Code source

Python

La liste suivante contient des liens vers d'autres ressources liées à la bibliothèque cliente pour Python :

• Documentation de référence de l'API
• Bonnes pratiques concernant les bibliothèques clientes
• Outil de suivi des problèmes
• gemini-enterprise-cx sur Stack Overflow
• Code source

Ruby

La liste suivante contient des liens vers d'autres ressources liées à la bibliothèque cliente pour Ruby :

• Documentation de référence de l'API
• Bonnes pratiques concernant les bibliothèques clientes
• Outil de suivi des problèmes
• gemini-enterprise-cx sur Stack Overflow
• Code source