サポートされているタグの種類
Box Doc Genでは、PPTXテンプレート内で以下のタグをサポートしています。- テキストタグ
- 画像タグ
生成方法ごとのサポート状況
各種タグのサポート状況は、ドキュメントの生成方法によって異なります。テキストタグ
テキストタグは、文字列型、数値型、または日付型のデータフィールドです。 次の例では、companyName、subscriptionPlan、renewalDate、expiryDateなどのフィールドがテキストタグとして使用されています。
{{companyName}}などの二重波括弧内のフィールドがデータに置き換えられます。 この機能は、API、Automate、Boxウェブアプリで利用できます。
画像タグ
Box Doc Genでは、Boxに保存されている任意の画像ファイルを、生成されたプレゼンテーションに埋め込むことができます。 画像タグを使用するには、以下の手順に従います。手順1: 画像ファイルをBoxにアップロードする
使用する画像ファイルをBoxにアップロードします。APIでドキュメントを生成する際にサービスアカウントを使用している場合は、そのサービスアカウントで画像ファイルにアクセスできることを確認してください。
手順2: Doc Genテンプレートを作成する
Box Doc Genは、テンプレート内でプレースホルダ画像を使用します。 プレースホルダ画像を設定するには、以下の手順に従います。- PPTXテンプレートに参照画像またはサンプル画像を挿入します。 プレースホルダ画像のサイズと配置は、Microsoft PowerPointのネイティブツールを使用して調整できます。
- 画像を選択して右クリックし、[代替テキストを表示] を選択します。 次のコードを追加した後、プレゼンテーションを保存します。
image-pathは、JSONスキーマで使用するキーです。alt-textは、生成後に画像に設定される代替テキストです。
手順3: JSONペイロードを作成する
Box内の画像ファイルを含むドキュメントを生成するには、以下のスキーマを使用します。brandLogoなどのキーは、プレースホルダ画像で使用されているキーと一致します。idは、Box内の画像ファイルのファイルIDです。typeは、これがドキュメントに埋め込む画像ファイルであることを示します。 値は常にimageである必要があります。
画像ファイルIDでは、Box内の画像ファイルIDを参照する必要があります。
手順4: ドキュメント生成リクエストを作成する
生成されたドキュメントに画像を含めるには、以下のいずれかの方法を使用できます。- Box Doc Gen API – 画像を含むドキュメントをプログラムで生成します。 詳細については、Box Doc Gen APIのドキュメントを参照してください。
- Box Doc Genウェブアプリ – ウェブインターフェースを使用して、画像が埋め込まれたドキュメントを作成します。