コネクタービルダーのアクションカードドキュメント

コネクターのすべてのカードには、カードの目的とフィールドについて説明するヘルプトピックが必要です。

Name and description（名前と説明）

カード名を明記し、カードが実行するアクションの簡単な説明を記載します。この情報は、カードに関連付けられているアクションフローの名前と説明のセクションと一致する場合があります。

Field definitions（フィールド定義）

カードのすべてのオプション、入力、出力フィールドの情報を盛り込みます。フィールドごとに、次の情報を提供します。

  • Label（ラベル）：フィールドの名前。

  • Definition（定義）：フィールドの目的を説明します（フィールドに渡されるデータ、フィールドが返すデータなど）。

  • Type（型）：このフィールドで許可されるデータ型を指定します。たとえば、Number（数値）、List of Text（テキストのリスト）などです。

  • Required（必須）：フローを実行するために、このフィールドに値が必要であるかどうかを示します。

すべてのオプション、入力、出力を個別のセクションとして編成します。

オプションについては、グループ名にOptionsというラベルが付けられ、変更できません。ヘルプトピックで説明されるオプションのフィールドには、利用できるすべての選択肢を列挙します。

入力と出力については、すべてのフィールドは1つ以上のグループに集約され、グループ名のラベルは変更できます。ヘルプトピックには、すべてのグループラベルを盛り込みます。

Limitations and known issues（制限事項と既知の問題）

カードの制限事項や既知の問題についての情報を盛り込みます。例：

  • 大規模なレコードセットの処理が必要な場合、カードの実行は低速になります。

  • オプションのフィールドのドロップダウンに表示されるのは、考えられるすべての選択肢のサブセットにすぎません。

例

参考情報については、コネクターカードの次のトピックを参照してください。

次の手順

コネクタービルダーのカスタムAPIカードドキュメント