Feishu 多次元テーブルデータソースの設定
AEデータ開発プラットフォームでは、Feishu 多次元テーブルをデータソースとして使用し、テーブル内のデータをプリセット倉庫に書き込んでデータを同期できます。
このドキュメントでは、Feishu 多次元テーブルLarkSheet データソースの設定機能について説明します。
対応バージョン
- 任意のSaaS版またはプライベートデプロイ版のFeishu 多次元テーブル。
使用制限
- Feishu 多次元テーブルデータソースはオフライン読み取り（データソースとして使用）にのみ対応しており、データの流向として書き込むことには対応していません。
- 多次元テーブルのデータを読み取る場合、String/ Datetime/ Date タイプのフィールドの読み取りにのみ対応しており、その他のデータタイプとしての読み取りには対応していません。
- Feishuのスプレッドシートにはヘッダーという概念はありませんが、Feishuスプレッドシートのインポートタスクの規範性を高めるため、次のように取り決めています：
スプレッドシートの1行目をヘッダーとして扱います。ヘッダーは、A1セルから始まる、連続した、空でない、名前が重複しない一連のセルである必要があります。ヘッダーはフィールド照合にのみ使用され、データ転送には含まれません。
たとえば、ヘッダー行のデータが次のような場合：- 不正なヘッダー（D列が空）
| A | B | C | D | E |
|---|---|---|---|---|
| 氏名 | 年齢 | 趣味 | 学校 |
前提条件
1. Feishuのカスタムアプリを用意して権限を設定する
Refer: https://open.feishu.cn/document/best-practices/intro-to-custom-app-review
Feishu APIを呼び出してデータを取得するには、スプレッドシートのオーナーが「Feishuクラウドドキュメントアプリ（Feishu企業カスタムアプリとも呼ばれます）」に権限を付与する必要があります
企業内部のアプリケーションであるため、まず権限が十分に設定されたアプリを用意する必要があります。
事前にFeishuオープンプラットフォームで「企業カスタムアプリ」を作成し、企業カスタムアプリにスプレッドシートの読み取り権限と編集権限を付与します。
付与する具体的な権限は次のとおりです：
-
ナレッジベースの閲覧、編集、管理：wiki:wiki
-
ドキュメントの閲覧、コメント、編集、管理：docs:doc
-
多次元テーブルの閲覧、コメント、編集、管理：bitable:app
-
スプレッドシートの閲覧、コメント、編集、管理：sheets:spreadsheet
-
クラウドスペース内のすべてのファイルの閲覧、コメント、編集、管理：drive:drive
-
現在のユーザーにクラウドドキュメントの権限があるかどうかの判定：docs:permission.member:auth
詳しくは企業カスタムアプリの開発フローを参照してください。
2. App IDとApp Secretの取得
Feishuの開発者コンソールでアプリの認証情報を取得し、AEデータ開発プラットフォームのコネクタに入力して、接続テストに合格する必要があります。
取得したApp idとSecretを、統合プランのデータソース設定に入力します
3. 接続する多次元テーブルを見つける
接続する多次元テーブルに権限を割り当てます。少なくとも「組織内でリンクを知っている人が閲覧可能」の権限を割り当てる必要があります。
- 「組織内でリンクを知っている人が閲覧可能/編集可能」を選択した場合、データ開発プラットフォームでリンク先のFeishuスプレッドシートのデータを取得する際に、組織の権限チェックが行われます。
- 「インターネット上でリンクを知っている人が閲覧可能/編集可能」を選択した場合、そのリンクに対応するFeishuスプレッドシートのデータを直接取得できます。
企業データのセキュリティに注意し、適切な権限を割り当てて、リンク情報を適切に管理してください
Feishu 多次元テーブルでドキュメントアプリを追加し、作成済みの「企業カスタムアプリ」を追加して、閲覧または編集の権限を付与します。
4. 多次元テーブルのリンクの取得
接続する多次元テーブルのリンクを取得します。
5. 対応している多次元テーブルの取得方法
| 多次元テーブルの保存場所 | 説明 | 対応状況 |
|---|---|---|
| Wikiナレッジベース内の多次元テーブル | ナレッジベース内のリソースとは、ナレッジベース（wiki）にマウントされたリソースを指します。
| 対応 |
| 個人Base内の多次元テーブル | 個人のFeishuクラウドストレージにある多次元テーブルリソース。
| 対応 |
| FeishuクラウドドキュメントDoc内の多次元テーブル | Feishuクラウドドキュメントに埋め込まれた多次元テーブル | 未対応 |
Feishu 多次元テーブルデータソースの作成
データ開発プラットフォーム - バッチ統合 モジュールで、Feishu 多次元テーブルデータソースを追加を選択できます
データソース設定パラメータ情報
データソースに必要な設定情報を入力し、接続性テストが完了すると、Feishu 多次元テーブルデータソースを作成できます。
| フィールド名 | 説明 |
|---|---|
| 基本情報 | |
| *データソース名 | データ開発プラットフォームのスペース内で一意である必要があります。英字、数字、アンダースコアの組み合わせで、数字やアンダースコアで始めることはできません |
| 備考 | 任意 |
| データソース設定 | |
| APP ID | アプリ認証情報のアカウント |
| APP Secret | アプリ認証情報のパスワード |
| Base URL | ドメイン名です。デフォルトは https://open.feishu.cn です 企業でプライベートデプロイしているFeishuの場合は、プライベートデプロイのドメイン名を入力してください |
パラメータ名の前に * が付いているものは必須パラメータ、* が付いていないものは任意パラメータです。
オフライン同期タスクの作成
上記の手順でFeishu 多次元テーブルデータソースを作成し、接続性テストに成功したら、実際のシナリオに応じてFeishu 多次元テーブルのオフライン読み取りタスクを設定できます。
データソースとしてのFeishu 多次元テーブル
データソースとしてFeishu 多次元テーブルを選択し、以下の関連パラメータを設定します：
| フィールド名 | 説明 |
|---|---|
| *ソースタイプ | データソースのタイプとしてFeishu 多次元テーブルを選択 |
| *データソース名 | データソース管理画面で登録済みのFeishuデータソースを、ドロップダウンから選択できます。 対応するデータソースをまだ作成していない場合は、データソース管理 ボタンをクリックして、Feishu 多次元テーブルデータソースを作成できます。 |
| *多次元テーブル URL | 同期したいFeishu 多次元テーブルのURLをコピーしてテキストボックスに貼り付け、「URLの検証」をクリックしてください |
| *ソースデータテーブル | 読み取るFeishu 多次元テーブル内のデータテーブル名です。ドロップダウンから選択できます
|
| *ソースビュー | 読み取るデータテーブル内のビュー名です。ドロップダウンから選択できます
|
データの取得に失敗した場合に表示される可能性のあるエラーメッセージと対処方法：
- Feishu統合の接続性を確認してください：統合が有効になっていない、設定情報が不完全、またはtokenが失効しています。
- テーブル情報を取得する権限がありません。対応するAPIのインターフェース権限を有効にしてください：FeishuアプリのAPI権限が有効になっていません。
- 有効なFeishu 多次元テーブルのリンクを入力してください：入力したリンクに誤りがないか確認してください。
- Feishuインターフェースへのリクエストに失敗しました：データが大きすぎてサーバーの計算がタイムアウトしたか、前回送信した変更がまだ処理されていません。適宜再試行してください。
- テーブルのリンクの権限設定を確認してください：スプレッドシートや多次元テーブルのリンクの共有範囲を調整する必要があります。
- Feishu APIのリクエストに失敗しました：Feishu公式のエラードキュメントで、該当するエラーの原因を確認できます。
対応するフィールドタイプ
Feishuスプレッドシートには強制的なSchema制約がないため、Date、Datetimeのフィールドタイプが識別されて特別に処理されるほかは、データ開発プラットフォームはテーブル内の各セルを一律にstringとして処理します。ターゲットのWriterデータソースの対応するフィールドもstringタイプにすることをお勧めします。そうしないと、データ形式の変換エラーによってジョブが失敗する可能性があります。
- デフォルトでは、テーブル内でデータがある最後の列まで、またはカスタムの列数に従って読み取ります。途中の空の列はnullで埋められます
- 空の行はFeishuスプレッドシートでsheetの行数に含まれるため、空のデータが発生する可能性があります。
- 列名は重複できません
- 数式の処理には対応していません
フィールド照合の説明
データソースとターゲット側の設定が完了したら、フィールド照合関係を作成する必要があります。システムは照合関係に従って、ソース側フィールドのデータを目標フィールドに自動的に同期します。フィールド照合関係の設定方法は3つあります：
- 方法1：カスタム選択。ソーステーブルのフィールドを選択し、目標テーブルの目標フィールドを選択します
- 方法2：同名照合。システムが、ソーステーブルと目標テーブルの同名フィールド間に照合関係を自動作成します
- 方法3：同行照合。システムが、同じ行のフィールド間に照合関係を自動作成します
1つの目標フィールドに対応できるソースフィールドは1つだけであることに注意してください
基本情報の設定
最後に、統合プランの基本情報を設定する必要があります。プラン名、責任者、統合の同期速度、備考などが含まれます。
設定が完了したら、「保存」 ボタンをクリックして統合プランの作成を完了できます。
注：プラン名は保存後に変更できません
詳細ページの表示：
オフライン同期プランのタスクフローへのマウント
マウントされたタスクフロー
1.マウント手順を開始する
- 統合プランの詳細ページで、右上の「ジョブフローにマウントする」ボタンをクリックします
2.タスクフローを選択する
-
ドロップダウンメニューから対象のタスクフローを選択します
-
タスクフローを新規作成する場合：
- ドロップダウンメニューの下にある「タスクフローを新規作成」ショートカットボタンをクリックします
- または「開発」モジュールで作成します
-
ヒント：対象のタスクフローが表示されない場合は、右側の↻更新ボタンをクリックしてください
3.同期ノードを作成する
- タスクフロー内で「オフライン同期プラン」タイプのノードを新規作成します
- このノードは現在の統合プランに関連付けられ、ノードの実行時に対応する統合プランの実行がトリガーされます
4.マウントを完了する
- 「ノードを作成し、マウントします」をクリックして設定を完了します
- マウントに成功したら、「タスクフローに進む」をクリックしてマウント結果をすぐに確認できます
注：タスクフローへのマウントで作成されたタスクノードは 未リリース状態 です。タスクフローを確認し、そのノードをリリースして配信を開始することをお勧めします。
タスクフローのマウント解除
オフライン同期プランのタスクフローへのマウントを解除する場合：
- タスクフローがまだリリースされていない場合は、そのプランがマウントされているタスクフローに移動し、開発モード でその「オフライン同期プラン」タスクノードを削除するだけです。
- タスクフローがすでにリリースされている場合は、開発モード でその「オフライン同期プラン」タスクノードを削除した後、タスクフローを再リリースする必要があります。これにより、本番環境 でのそのノードのマウントも同時に解除されます。