Knowledge Graphはさまざまなフィールドタイプをサポートし、それぞれが異なる種類のデータ向けに設計されています。
標準フィールドタイプ
各フィールドはタイプによって定義されます。これらはYextプラットフォームで利用可能な標準フィールドタイプです。
| タイプ | 説明 | 利用可能な検証 |
|---|---|---|
| 行動喚起（CTA） | ラベルとリンクを使用した行動喚起（CTA） | ラベル文字数（最大255文字）、リンク文字数（最大2,000文字） |
| 複雑な写真 | 組み込みのキャプション、詳細、クリックスルーURLおよび代替テキストのある写真 | アスペクト比、最小幅/高さ |
| 複雑な写真ギャラリー | 組み込みのキャプション、詳細、クリックスルーURLおよび代替テキストのある写真ギャラリー | アスペクト比：最小幅/高さ：アイテム数（最大500件） |
| 複雑な動画 | YouTube（およびYouTube Shorts）のURLと組み込みの説明 | 説明の文字数（最大140文字） |
| 複雑な動画ギャラリー | 説明が組み込まれたYouTube URLのギャラリー | 説明の文字数（最大140文字）、アイテム数（最大100件） |
| 各曜日の営業時間 | 曜日ごとに特定の時間を設定します。 | 該当なし |
| 日付 | 日付フィールド | 日付範囲 |
| 日付と時間 | 指定された時刻を含む日付フィールド | 日付範囲と時間範囲 |
| エンティティ関係 | 関連エンティティの一覧。一方向、双方向（共有フィールド）、または双方向（個別フィールド）の関係タイプを選択するオプションあり | 選択可能なエンティティタイプ、アイテム数（最大5,000件） |
| ファイル | ファイルフィールドタイプを構成して1件のファイルをサポートするか、ファイルのリストをサポートできます。 | ファイル形式と最大ファイルサイズ（最大1GB） |
| 営業時間 | 各曜日の時間リストを設定します。エンティティが稼働中かどうかは、「オープン」、「クローズ」、「分割」、「24時間」のいずれかで指定します。特定の日に複数の時間範囲を指定できます。 | 該当なし |
| 複数行テキスト | 長文テキスト | 文字数（最大100,000文字） |
| 複数オプション選択 | 複数のオプションを選択できるオプションフィールド | 利用可能なオプション、アイテム数（最大2,000件） |
| 数 | 数値フィールド | 数値の範囲 |
| 電話番号 | 国コードの接頭辞付き数値フィールドと電話番号の自動フォーマット | 該当なし（Googleのデータに基づいて有効な電話番号の定義を検証） |
| 写真 | 代替テキスト付きの写真 | アスペクト比、最小幅/高さ |
| 写真ギャラリー | 代替テキスト付きの写真ギャラリー | アスペクト比：最小幅/高さ：アイテム数（最大500件） |
| 料金 | 料金フィールド | 該当なし |
| リッチテキスト | 書式付きリッチテキストフィールド | 書式設定の種類（太字、斜体、下線、箇条書き、番号付きリスト、ハイパーリンク、コードブロック）、文字数（最大100,000文字） |
| 1行テキスト | 短文形式のテキスト | 文字数（最大100,000文字） |
| 単一オプション選択 | ユーザーがオプションを1つのみ選択できるオプションフィールド | 利用可能なオプション |
| スラッグ | URLの末尾にあるユーザーに読みやすい短いラベルで、通常識別子として機能する。例：hitchhikers.yext.com/docs | 小文字の英数字および以下の特殊文字：- ._ ~ : / [ ] @ !$ ' ( ) * + ; = " |
| テキスト-リスト | テキスト文字列のリスト | 文字数(最大100,000)、アイテム数(最大1,000) |
| 時間 | 時間と分の値（hh:mm） |
該当なし |
| URL | ウェブサイトURL | 文字数（最大2,000文字） |
| ビデオ | YouTube（およびYouTube Shorts）のURL | 該当なし |
| 動画ギャラリー | YouTube（およびYouTube Shorts）URLのギャラリー | アスペクト比、最小幅/高さ、アイテム数（最大100件） |
| はい / いいえ | 「はい」「いいえ」「未指定」のいずれかを選択できるフィールド | 該当なし |
ファイルフィールドタイプ
ファイルフィールドタイプを使用すると、エンティティにファイルを直接保存できます。このタイプは、カスタムフィールドとカスタムフィールドタイプで使用できます。
プロパティ
ファイルフィールドタイプは、次の5つのプロパティで構成されています。
| プロパティ | 説明 |
|---|---|
sourceURL |
ファイルのソースURL。ホストされたURLを提供してアップロードされた場合にのみ、入力されます。 |
URL |
YextがホストするファイルのURL。 |
mimeType |
ファイルのMIMEタイプ。現在、すべてのMIMEタイプがサポートされています。 |
名前 |
ファイルの表示名。ユーザーが設定できます。注：nameプロパティはコネクタ経由でマッピングできませんが、他のすべてのインターフェースで設定または編集できます。 |
サイズ |
ファイルのサイズ（バイト単位）。 |
ファイルフィールドタイプを構成して1件のファイルをサポートするか、ファイルのリストをサポートできます。これにより、ファイルアップロードの最大検証数はそれぞれ1または5,000に自動的に設定されます。
検証
ファイルフィールドのデフォルトの検証は以下の通りです。ファイルカスタムフィールドとファイルカスタムフィールドタイプの検証も設定できます。
| オプション | デフォルト検証 | カスタム検証 |
|---|---|---|
| ファイル形式 | すべてのMIMEタイプ形式が許可されています。 | アップロードされたファイルは、一般的なMIMEタイプに基づいて、許可されたファイルタイプのサブセットに制限できます。 |
| 最大ファイルサイズ | ファイルは1 GBを超えることはできません。 | 異なる最大サイズ制限をバイト、キロバイト、またはメガバイトで設定します。値は整数である必要があります。 |
注：JsonFormat.Printerにはコードとして構成に影響を与え、maxSizeプロパティは取得時に文字列として返される既知の問題があります。ただし、これを適用する場合は、このプロパティは数値である必要があります。
ファイルをアップロード中
ファイルは、Knowledge Graphの編集エンティティのすべてのインターフェースを使用してアップロードできます（例：エンティティの編集、エンティティのアップロード、コネクタ、API、CaC）。
すべてのインターフェースは、ソースURLを参照してファイルのアップロードをサポートします。ローカルファイルシステムからのアップロードは、エンティティの編集でのみサポートされています。
オンラインでホストされているファイルをアップロードするには、urlプロパティを使用してホストされているURLを指定します。次に、この提供されたURLはsourceUrlプロパティに伝搬され、URLフィールドはこのファイルのYextがホストするURLに変更されます。
ファイルを更新中
エンティティでフィールドに保存されているファイルを変更するには、urlプロパティの値が新しくホストされるファイルのURLになるよう更新します。sourceUrlプロパティへの更新の送信はサポートされていません。
ファイルのダウンロードに使用されるユーザーエージェント文字列は、YextBot YextFileDownloader/1.0です。
保存されたファイルのアクセス
エンティティに保存されているファイルは、［エンティティの編集] およびAPI経由でアクセスできます。
エンティティの編集
ファイルはURLプロパティからダウンロードできます。このフィールドの編集状態では、ファイルフィールドのすべてのプロパティが表示されます。ファイルのプロパティは、ファイル名を除いて、[エンティティの編集] では編集できません。
API
urlプロパティに保存されているURLを開くと、ファイルがローカルデバイスにダウンロードされます。以下は、エンティティ: GETの例です。
他のフィールドを省略すると、応答は次のようになります。
{
"response": {
"entities": [{
"c_pdfFile": [{
"sourceUrl": "https://www.pdfs.com/123",
"url":"https://a.mktgcdn.com/f/3912636/123",
"mimeType": "application/pdf",
"name": "Instruction Manual",
"size": 2001
}]
}]
}
}写真フィールドタイプ
写真フィールドタイプを使用すると、写真をエンティティに直接保存できます。このタイプは、カスタムフィールドとカスタムフィールドタイプで使用できます。
プロパティ
写真フィールドタイプは、次の5つのプロパティで構成されています。
| プロパティ | 説明 |
|---|---|
幅 |
写真の幅（ピクセル）。 |
高さ |
写真の高さ（ピクセル）。 |
URL |
YextがホストするファイルのURL。 |
sourceUrl |
ファイルのソースURL。ホストされたURLを提供してアップロードされた場合にのみ、入力されます。 |
thumbnails（既存機能） |
アップロード時にさまざまなサイズのサムネイルを生成する既存機能です。この機能は動的な画像変換に置き換えられました。 |
検証
写真カスタムフィールドと写真カスタムフィールドタイプの検証を構成できます。
| オプション | 利用可能な検証 | デフォルト | 指定できる値 |
|---|---|---|---|
| 幅 | 最小幅を設定（ピクセル） | 0 | 整数 0-1,000 |
| 高さ | 最小の高さを設定（ピクセル） | 0 | 整数 0-1,000 |
| アスペクト比 | 幅と高さの許容される比率を設定 | 無制限 | 制約なし、1:1、4:3、3:2、5:3、16:9、3:1、2:3、5:7、4:5、16:10 |
制限事項
| オプション | 指定できる値 |
|---|---|
| 画像サイズ | 最大100メガピクセル |
| 画像フォーマット | JPEG、PNG、BMP、GIF、TIFF、WEBP |
写真のアップロード
写真は、Knowledge Graphのエンティティを編集するためのすべてのインターフェイスを使用してアップロードできます。
すべてのインターフェースは、ソースURLを参照して写真のアップロードをサポートします。ローカルファイルシステムから写真をアップロードする機能は、エンティティの編集のみでサポートされています。
オンラインでホストされている写真をアップロードするには、urlプロパティに写真のURLを入力します。次に、このURLはsourceUrlプロパティに伝播され、URLフィールドはYextがホストする写真のURLになります。
写真の更新
特定の写真フィールドに保存されている写真を変更するには、urlプロパティの値を新しいホストされる写真のURLに更新します。更新を直接sourceUrlプロパティに送信することはサポートされていません。
写真へのアクセス
画像がエンティティにアップロードされると、そのホストURLはエンティティのフィールドに参照として保存されます。API経由でエンティティにアクセスし、写真のURLディレクトリを直接取得できます。例：
他のフィールドを省略すると、応答は次のようになります。
{
"response": {
"entities": [{
"photoGallery": [{
"image": {
"width": 314,
"height": 366,
"url": "http://a.mktgcdn.com/p/Oua5ocwC7euaUFkJ-V8n3OpF76Xtfh_rdsDT9ki_laY/314x366.jpg"
}]
}]
}
}画像はすべて長いUUID（上記の長いランダムな文字列）に割り当てられるため、URLは次のような形式になります。a.mktgcdn.com/p/UUID/WIDTHxHEIGHT.EXT。
HTTPとHTTPSの両方がサポートされています。
カスタムフィールドタイプ
カスタムフィールドタイプを作成して、複数のフィールドを1つの複雑なフィールドにまとめることができます。たとえば、営業日、営業時間、閉店時間のサブフィールドを含む「営業時間オーバーライド」フィールドタイプを作成できます。
通常は、Yextの組み込みフィールドタイプを使用します。ユースケースに必要な場合は、カスタムフィールドタイプを作成することもできます。
カスタムフィールドタイプを作成するには、次の手順に従ってください。
-
Knowledge Graph > 設定に移動し、[フィールドタイプ] タイルをクリックします。
-
[カスタムフィールドタイプを追加] をクリックします。
-
カスタムフィールドタイプの基本情報を入力します。
- フィールドタイプ名
- API名：これは名前に基づいて自動的に設定されますが、必要に応じて変更できます。
-
タイプの説明（オプション）
- 代替言語プロフィールを使用している場合は、カスタムエンティティタイプに翻訳を追加します。名前または説明の設定で[翻訳を追加]をクリックします。
- 希望の言語を選択し、翻訳された値を入力します。[保存]または[保存してさらに追加]をクリックし、同じ設定に別の翻訳を追加します。
- 新規フィールドタイプを構成する個々のフィールドを追加します。開始するには、[サブフィールドを追加] をクリックします。
- サブフィールドの設定を入力してください。
- サブフィールドタイプ：追加するサブフィールドのタイプを選択します。選択したフィールドタイプに応じて、若干異なる設定が表示される場合があります。
- サブフィールドラベル：サブフィールドのラベルを入力します。必要に応じて翻訳を追加します。
- 検証：最小文字数や最大文字数などの検証ルールや、サブフィールドに入力できるその他の内容を設定します。
- 設定：カスタムフィールドの入力時にこのサブフィールドを必須にするかどうか、およびこのサブフィールドにリストオプションを付与するかどうかを選択します。
- 他のサブフィールドを追加するには、[サブフィールドを追加]をクリックします。
- サブフィールドにあるゴミ箱アイコンをクリックして削除します。
- 画面下部にある [保存]ボタンをクリックして、カスタムフィールドタイプを保存します。