API名はYextシステムのバックエンドにおけるフィールドの一意のIDです。API名は、Yextと他のシステムとの統合などのアプリケーションでフィールドを識別するために使用されます。
この記事では、特定のエンティティタイプで利用可能なフィールドとそれに対応するAPI名のリストを表示する方法を説明します。
フィールドとそのAPI名を表示する方法
- ナビゲーションバーにある[Knowledge Graph]をクリックし、[設定]をクリックします。
- [エンティティタイプ]をクリックします。
- 目的のエンティティタイプの横にある[詳細を表示する]をクリックします。
- [フィールド] タブをクリックします。
- このエンティティタイプに設定されたすべてのフィールドが、フィールドセクションごとに整理されて表示されます。フィールドのAPI名は、フィールド名のすぐ下に記載されています。
エンティティタイプに新しいフィールドを追加するには、「カスタムフィールドを作成する」をご覧ください。セクションの作成または編集の詳細については、「フィールドセクションを作成および整理する」または「エンティティタイプのフィールド設定を編集する」をご覧ください。