【ノーコード】Nuclia のデータを Google スプレッドシートにインポートする方法
CData API Server は、Nuclia をREST API(OData) として公開することによりWeb サービスから接続することを可能にします。Google スプレッドシートでは、ImportData 関数を使ってWeb サービスデータをSCV フォーマットで取得することができます。次の手順で Google スプレッドシートでImportData 関数を使ってNuclia のデータ にアクセスする方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなNuclia OData サービスを作成していきましょう。
Nuclia への接続
Google スプレッドシートからNuclia のデータを操作するには、まずNuclia への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Nuclia」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、Nuclia への接続設定を行っていきましょう!
-
API キー認証の設定
Nuclia は、Knowledge Box のデータにアクセスするために API キー認証を使用します。API キーを取得するには、以下のステップで進めます:
- https://nuclia.cloud で Nuclia Cloud Dashboard にログインします
- Knowledge Box の設定に移動します
- Service Accounts セクションに移動します
- 新しいサービスアカウントを作成するか、既存の API キーをコピーします
API キーを取得したら、以下の接続プロパティを設定します:
- AuthScheme:APIKey に設定します。
- APIKey:Nuclia サービスアカウントの API キーに設定します。
- KbId:Knowledge Box の UUID に設定します。
- Zone:Nuclia のデプロイゾーンに設定します(例:aws-us-east-2-1)。
接続文字列の例
Profile=C:\profiles\Nuclia.apip;AuthScheme=APIKey;APIKey=your_service_account_key;KbId=your_kb_uuid;Zone=aws-us-east-2-1;
Nuclia への接続
認証を設定すると、Nuclia に接続して、Resources、KnowledgeBox、LabelSets、ProcessingStatus などの利用可能なテーブルからデータをクエリできます。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
API キー認証の設定
Nuclia は、Knowledge Box のデータにアクセスするために API キー認証を使用します。API キーを取得するには、以下のステップで進めます:
- https://nuclia.cloud で Nuclia Cloud Dashboard にログインします
- Knowledge Box の設定に移動します
- Service Accounts セクションに移動します
- 新しいサービスアカウントを作成するか、既存の API キーをコピーします
API キーを取得したら、以下の接続プロパティを設定します:
- AuthScheme:APIKey に設定します。
- APIKey:Nuclia サービスアカウントの API キーに設定します。
- KbId:Knowledge Box の UUID に設定します。
- Zone:Nuclia のデプロイゾーンに設定します(例:aws-us-east-2-1)。
接続文字列の例
Profile=C:\profiles\Nuclia.apip;AuthScheme=APIKey;APIKey=your_service_account_key;KbId=your_kb_uuid;Zone=aws-us-east-2-1;
Nuclia への接続
認証を設定すると、Nuclia に接続して、Resources、KnowledgeBox、LabelSets、ProcessingStatus などの利用可能なテーブルからデータをクエリできます。
API Server のユーザー設定
次に、API Server 経由でNuclia にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
Nuclia 用のAPI エンドポイントの作成
ユーザーを作成したら、Nuclia のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でNuclia への接続を設定してユーザーを作成し、API Server でNuclia データのAPI を追加しました。これで、OData 形式のNuclia データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
作成したAPI にGoogle シートから接続
- 次にGoogle Sheet からの接続のために、認証トークンをクエリ文字列で渡せるようにします。
クエリ文字列パラメータとして認証トークンを使用する HTTP フォームポストデータ、もしくはクエリパラメータの一部として提供される_@authtoken_ パラメータの値として認証トークンを指定することができます。ただし、デフォルトではAPI Server はクエリ文字列パラメータにおいて認証トークンを渡すことをサポートしていません。 settings.cfg のアプリケーションセクションにて、次のオプションを設定することで有効化できます。クエリ文字列パラメータとして認証トークンを使用する を参照してください。 - エンドポイントURL をAPI Server が自動生成するAPI ドキュメントからコピーします。authtoken はAPI Server の[ユーザー]を作成し、生成されたトークンを使います。
-
新しいGoogle スプレッドシートで、=ImportData() 関数をつかって、公開されたデータソースからCSV ファイルでデータをリクエストします。このサンプルでは、KnowledgeBox テーブル全体をリクエストします。 Google は定期的に関数の結果を更新し、シートが最新のデータを保有している状態に保ちます。次のように関すを設定してみます。:
=ImportData("https://your-server/api.rsc/KnowledgeBox?@csv&@authtoken=your-authtoken")