メインコンテンツへスキップ
PDF4me API統合AIとSDK知識ベース拡張機能APIテスターブログ

テンプレート内のハイパーリンク - 動的リンクガイド

ハイパーリンクは現代の文書に不可欠な要素となっており、請求書、契約書、見積書、法的文書、報告書、その他様々なビジネス文書に見られる。 PDF4me 生成されたドキュメント内に動的なハイパーリンクを挿入できるため、インタラクティブなWeb接続ドキュメントを作成できます。

ハイパーリンク構文​

以下のテンプレート構文を使用して、ドキュメントにクリック可能なハイパーリンクを挿入してください。

<<link[linkUrl][linkDisplay]>>

構成要素：

  • linkUrl - ターゲット URL またはウェブアドレス
  • linkDisplay クリック可能なリンクに表示されるテキスト

基本的なハイパーリンクの例​

シンプルなリンク挿入​

テンプレート構文:

Visit our website: <<link[websiteUrl][companyName]>>

データソース（JSON）：

{
  "websiteUrl": "https://pdf4me.com/",
  "companyName": "PDF4me API Website"
}

生成された出力:

Visit our website: PDF4me API Website

（どこ "PDF4me API ウェブサイト」はクリック可能なリンクです https://pdf4me.com/）

複数のハイパーリンク​

異なるデータフィールドを使用して、文書内に複数のハイパーリンクを生成します。

例：連絡先情報​

テンプレート：

Website: <<link[website][websiteName]>>
Support Portal: <<link[supportUrl][supportText]>>
Documentation: <<link[docsUrl][docsText]>>

データ：

{
  "website": "https://pdf4me.com/",
  "websiteName": "PDF4me Homepage",
  "supportUrl": "https://pdf4me.com/contact/",
  "supportText": "Contact Support",
  "docsUrl": "https://dev.pdf4me.com/documentation/",
  "docsText": "View Documentation"
}

表内のハイパーリンク​

ハイパーリンクと表構造を組み合わせることで、整理されたリンク表示が可能になります。

リソーステーブルの例​

テンプレート：

Resource | Link
<<foreach [resource in resources]>>
<<[resource.name]>> | <<link[resource.url][resource.linkText]>>
<</foreach>>

データ：

{
  "resources": [
    {
      "name": "API Documentation",
      "url": "https://dev.pdf4me.com/documentation/",
      "linkText": "View Docs"
    },
    {
      "name": "Support Center",
      "url": "https://pdf4me.com/contact/",
      "linkText": "Get Help"
    },
    {
      "name": "Code Samples",
      "url": "https://github.com/pdf4me/samples",
      "linkText": "Browse Code"
    }
  ]
}

ダイナミック URL 工事​

建てる URLs 式と連結を動的に利用する。

例：商品リンク​

テンプレート：

<<foreach [product in products]>>
Product: <<[product.name]>>
View Details: <<link["https://example.com/product/" + product.id][product.name]>>
<</foreach>>

例：メールリンク​

テンプレート：

Contact: <<link["mailto:" + employee.email][employee.name]>>

データ：

{
  "employee": {
    "name": "John Smith",
    "email": "[email protected]"
  }
}

出力：

Contact: John Smith

（クリックすると、テンプレートのアドレスが表示されたメールクライアントが開きます。）

条件付きハイパーリンク​

特定の条件が満たされた場合にのみハイパーリンクを表示する。

例：オプションのウェブサイトリンク​

テンプレート：

<<if [websiteUrl != null]>>
Visit us: <<link[websiteUrl][websiteName]>>
<</if>>

Foreachを使ったテンプレート：

<<foreach [contact in contacts]>>
<<[contact.name]>>
<<if [contact.website != null]>> - <<link[contact.website]["Visit Website"]>><</if>>
<</foreach>>

書式設定された表示テキスト​

スタイル付きリンクの場合、ハイパーリンクの表示テキストにテキスト書式を適用します。

例：大文字のリンク​

テンプレート：

Visit: <<link[url][companyName:caps]>>

データ：

{
  "url": "https://pdf4me.com",
  "companyName": "pdf4me solutions"
}

出力：

Visit: Pdf4me Solutions

（適切な大文字表記とクリック可能なリンク付き）

一般的な使用例​

リンク付き請求書フッター​

テンプレート：

Questions? Visit our FAQ: <<link[faqUrl]["FAQ Page"]>>
Payment Portal: <<link[paymentUrl]["Pay Invoice"]>>
Contact Support: <<link["mailto:" + supportEmail]["Email Support"]>>

レポートの参考文献​

テンプレート：

Data Sources:
<<foreach [source in dataSources]>>
- <<[source.name]>>: <<link[source.url][source.description]>>
<</foreach>>

製品カタログ​

テンプレート：

<<foreach [product in products]>>
Product Name: <<[product.name]>>
Price: $<<[product.price]>>
More Info: <<link[product.detailsUrl]["View Details"]>>

<</foreach>>

ハイパーリンクのベストプラクティス​

URL 管理​

  1. 検証する URLs - 確保する URLs テンプレートに渡す前に適切にフォーマットされている
  2. 使用 HTTPS - セキュリティを優先 HTTPS URLs 可能な限り
  3. 短い表示テキスト リンクテキストは簡潔かつ分かりやすく記述してください。
  4. テストリンク - 生成されたすべてのリンクが正しく機能することを確認します。

リンクのスタイル設定​

  1. 一貫した書式設定 - 文書全体で同様のリンクテキストパターンを使用する
  2. 明確な文脈 リンクの目的をテキストで明確にする。
  3. 視覚的な区別 リンクが視覚的に区別できることを確認してください（通常は自動的に行われます）。

データ準備​

  1. 特殊文字をエンコードする - 特殊文字を処理する URLs きちんと
  2. デフォルト値を提供する - 欠損値に対する代替値を用意する URL データ
  3. 検証 - 検証する URL テンプレート処理前のアプリケーション内のフォーマット

サポートされているハイパーリンクの種類​

ウェブリンク​

<<link["https://example.com"]["Visit Website"]>>

メールリンク​

<<link["mailto:[email protected]"]["Email Us"]>>

ご自身のメールアドレス、またはプレースホルダーを使用してください。一部のホスティングサービスではリンク切れが発生する可能性があるため、テンプレートにサポート／連絡先メールアドレスをそのまま使用することは避けてください。

ドキュメントリンク​

<<link["file:///path/to/document.pdf"]["View PDF"]>>

電話リンク（対応ビューアのみ）​

<<link["tel:+1234567890"]["Call Us"]>>

トラブルシューティング​

よくある問題​

問題： 生成されたドキュメント内のリンクがクリックできません
解決： 構文が完全に一致することを確認してください。 <<link[url][text]>>

問題： 壊れた URLs 出力において
解決： 特殊文字をチェックし、エンコードする URLs きちんと

問題： 表示テキストにはマージフィールドの構文が表示されます
解決： 確実に閉店する >> 括弧が存在します

問題： リンクはプレーンテキストとして表示されます
解決： ドキュメントビューアがハイパーリンクをサポートしていることを確認してください。

完全な例：顧客コミュニケーション​

テンプレート：

Dear <<[customerName]>>,

Thank you for your recent purchase. Your order details are available at:
<<link[orderTrackingUrl]["Track Your Order"]>>

For assistance, please visit:
- Help Center: <<link[helpUrl]["Get Help"]>>
- Email Support: <<link["mailto:" + supportEmail]["Contact Support"]>>
- Live Chat: <<link[chatUrl]["Start Chat"]>>

Best regards,
<<[companyName]>>

データ：

{
  "customerName": "John Smith",
  "orderTrackingUrl": "https://example.com/track/12345",
  "helpUrl": "https://example.com/help",
  "supportEmail": "[email protected]",
  "chatUrl": "https://example.com/chat",
  "companyName": "Acme Corporation"
}

:::ヒント リンクのテスト 生成されたドキュメントには必ず実際のハイパーリンクを使用してテストを行い、異なる環境でも正しく機能することを確認してください。 PDF視聴者とプラットフォーム。一部の視聴者は、特定のリンクタイプを異なる方法で処理する場合があります。 :::