CX Agent Studio クライアント ライブラリ

このページでは、Customer Engagement Suite API の Cloud クライアント ライブラリの使用を開始する方法を説明します。クライアント ライブラリを使用すると、サポートされている言語からGoogle Cloud API に簡単にアクセスできます。サーバーにリクエストを送信してGoogle Cloud API を直接利用することもできますが、クライアント ライブラリを使用すると、記述するコードの量を大幅に削減できます。

Cloud クライアント ライブラリと以前の Google API クライアント ライブラリの詳細については、クライアント ライブラリの説明をご覧ください。

クライアント ライブラリをインストールする

C#

google-cloud-ces-v1-csharp.tar.gz をダウンロードする。

google-cloud-ces-v1beta-csharp.tar.gz をダウンロードする。

手順については、Google アカウントの担当者にお問い合わせください。

詳細については、C# 開発環境の設定をご覧ください。

Go

gapi-cloud-ces-v1-go.tar.gz をダウンロードする。

gapi-cloud-ces-v1beta-go.tar.gz をダウンロードする。

cloud.google.com/go のクローンを作成し、次のようにパスを取得します。

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

tar ファイルを解凍します。tar -xzpf gapi-cloud-ces-v1-go.tar.gz次に、ソースを CLOUD_GO ディレクトリにコピーします。

注: ルート モジュールは cloud.google.com/go であるため、tar ファイルからコピーするときは、1 つ深いディレクトリをターゲットにします。一部のパッケージは cloud.google.com/go/maps/maplearning などの複数のディレクトリの下にネストされます。

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

クライアントを利用する Go モジュールのルート ディレクトリから、クライアントの依存関係をローカルクローンに置き換えます。

注: これがまったく新しいモジュールではなく、サブモジュールが CLOUD_GO に公開されている場合は、代わりに次のコマンドでそのモジュール依存関係をターゲットにします。

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

これで、ローカルで生成されたクライアント ライブラリを使用できるようになりました。

詳細については、Go 開発環境の設定をご覧ください。

Java

google-cloud-ces-v1-java.tar.gz をダウンロードします。

google-cloud-ces-v1beta-java.tar.gz をダウンロードします。

次の 2 つのオプションのいずれかを選択できます。

オプション 1（推奨）: ローカルの Maven キャッシュにクライアントをインストールします。

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

その後、クライアントは Gradle または Maven プロジェクトから従来の方法で利用できます。ローカルでビルドされた Java クライアント ライブラリを Maven プロジェクトに追加する例については、以下をご覧ください。

<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>

オプション 2: クライアント jar をビルドし、そのすべての依存関係を 1 つのフォルダにプルします。

./gradlew clean allJars

その後、all-jars フォルダを確認します。このフォルダには、クライアントの実行に必要なすべての JAR（クライアント自体と、その直接的および推移的な依存関係すべて）が含まれているはずです。

詳細については、Java 開発環境の設定をご覧ください。

Node.js

ces-v1-nodejs.tar.gz をダウンロードする。

ces-v1beta-nodejs.tar.gz をダウンロードする。

NPM は、npm pack によって生成された tar ファイルを使用したローカル インストールをサポートしています。

まず、Bazel によって生成されたファイルを解凍します。

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

解凍したフォルダで、npm install を実行してライブラリをコンパイルし、npm pack を実行して結果を .tgz ファイルにパックし、npm で使用できるようにします。

npm install
npm pack

結果のファイルは npm install に渡すことができます。

npm install RESULTING_FILE

プロジェクト内で配布することもできます。

詳細については、Node.js 開発環境の設定をご覧ください。

PHP

google-cloud-ces-v1-php.tar.gz をダウンロードする。

google-cloud-ces-v1beta-php.tar.gz をダウンロードする。

これをプロジェクトのフォルダに解凍します。例:

tar xvf path/to/LIBRARY.tar.gz

これにより、クライアント ライブラリがローカル フォルダに解凍されます。このフォルダをプロジェクトのルートに移動し、プロジェクトの composer.json に次のコードを追加します（存在しない場合は作成します）。

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

これにより、google/gax 依存関係が追加され、クラスファイルが見つかり、composer によって自動読み込みされるディレクトリが識別されます。

composer install を実行し、コードに vendor/autoload.php を含めれば、準備完了です。

詳細については、Google Cloud での PHP の使用をご覧ください。

Python

ces-v1-py.tar.gz をダウンロードする。

ces-v1beta-py.tar.gz をダウンロードする。

まず、仮想環境を設定します。

python3 -m venv env
source env/bin/activate

次に、tar ファイルからライブラリをインストールします。

pip install ces-v1-py.tar.gz

詳細については、Python 開発環境の設定をご覧ください。

Ruby

google-cloud-ces-v1-ruby.tar.gz をダウンロードする。

google-cloud-ces-v1beta-ruby.tar.gz をダウンロードする。

手順については、Google アカウントの担当者にお問い合わせください。

詳細については、Ruby 開発環境の設定をご覧ください。

認証を設定する

Google Cloud API の呼び出しを認証するために、クライアント ライブラリではアプリケーションのデフォルト認証情報（ADC）がサポートされています。このライブラリは、一連の定義済みロケーションの中から認証情報を探し、それらの認証情報を使用して API へのリクエストを認証します。ADC を使用すると、アプリケーション コードを変更することなく、ローカルでの開発や本番環境など、さまざまな環境のアプリケーションで認証情報を使用できるようになります。

本番環境では、ADC の設定方法はサービスとコンテキストによって異なります。詳細については、アプリケーションのデフォルト認証情報を設定するをご覧ください。

ローカル開発環境では、Google アカウントに関連付けられている認証情報を使用して ADC を設定できます。

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.

   ログイン画面が表示されます。ログインすると、ADC で使用されるローカル認証情報ファイルに認証情報が保存されます。

参考情報

C#

次のリストは、C# のクライアント ライブラリに関連するその他のリソースへのリンクを示します。

• API リファレンス
• クライアント ライブラリのベスト プラクティス
• 公開バグトラッカー
• Stack Overflow の gemini-enterprise-cx
• ソースコード

Go

次のリストは、Go のクライアント ライブラリに関連するその他のリソースへのリンクを示します。

• API リファレンス
• クライアント ライブラリのベスト プラクティス
• 公開バグトラッカー
• Stack Overflow の gemini-enterprise-cx
• ソースコード

Java

次のリストは、Java のクライアント ライブラリに関連するその他のリソースへのリンクを示します。

• API リファレンス
• クライアント ライブラリのベスト プラクティス
• 公開バグトラッカー
• Stack Overflow の gemini-enterprise-cx
• ソースコード

Node.js

次のリストは、Node.js のクライアント ライブラリに関連するその他のリソースへのリンクを示します。

• API リファレンス
• クライアント ライブラリのベスト プラクティス
• 公開バグトラッカー
• Stack Overflow の gemini-enterprise-cx
• ソースコード

PHP

次のリストは、PHP のクライアント ライブラリに関連するその他のリソースへのリンクを示します。

• API リファレンス
• クライアント ライブラリのベスト プラクティス
• 公開バグトラッカー
• Stack Overflow の gemini-enterprise-cx
• ソースコード

Python

次のリストは、Python のクライアント ライブラリに関連するその他のリソースへのリンクを示します。

• API リファレンス
• クライアント ライブラリのベスト プラクティス
• 公開バグトラッカー
• Stack Overflow の gemini-enterprise-cx
• ソースコード

Ruby

次のリストは、Ruby のクライアント ライブラリに関連するその他のリソースへのリンクを示します。

• API リファレンス
• クライアント ライブラリのベスト プラクティス
• 公開バグトラッカー
• Stack Overflow の gemini-enterprise-cx
• ソースコード