> For the complete documentation index, see [llms.txt](https://help.impact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.impact.com/brand/ja/what-would-you-like-to-learn-about/platform-features/reach-out-to-partners/generate-leads/create-a-custom-widget.md).

# カスタムウィジェットを作成する

パートナーがブランドを宣伝するための動的なツールを開発できます。カスタムウィジェットを使用すると、外部でホストされているツールやページをiframeを介してimpact.comのインターフェースに直接埋め込むことができます。このガイドでは、パートナーにパーソナライズされたリソースと一貫したブランド体験を提供するカスタムコンテンツウィジェットの作成方法と設定方法を説明します。

{% stepper %}
{% step %}

## カスタムウィジェット作成画面にアクセスする

1. 左側のナビゲーションメニューから、 ![](https://1458456015-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-230534471fef5f40808e921e41ee44e4a06ded03%2Fe6cb9548999afdc1ed3ce4942e4cb5b45b5cecbd323267aac2a7cd1915fccc09.svg?alt=media) **［エンゲージ］** → **コンテンツ** → [**ウィジェット**](https://app.impact.com/secure/advertiser/engage/ads/list-widget-tool-flow.ihtml)**.**
2. 右上で、 **ウィジェットを作成** → **カスタム**.
   {% endstep %}

{% step %}

## ウィジェットの詳細を入力する

1. カスタムウィジェットの **名前** を入力します。
2. 必要に応じて、カスタムウィジェットの **説明** を入力します。
3. 必要に応じて、カスタムウィジェットの **ラベル** を入力します。
4. 必要に応じて、 ![](https://1458456015-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2FiZjM1xY8o3v1iR3Zaysd%2FToggle.svg?alt=media\&token=b1550d48-bba9-4e81-8604-bc12370c5caa) **［オンにする］パートナーアクセスを制限** を有効にし、ウィジェットへのアクセスを許可する個々のパートナーとグループを指定します。
   * **パートナー：** カスタムウィジェットにアクセスできるパートナーの名前を入力します。
   * **グループ：** カスタムウィジェットにアクセスできるグループの名前を入力します。
     {% endstep %}

{% step %}

## ウィジェットを設定する

1. 表示オプションからウィジェットの動作を選択します。
   * **新しいタブで開く：** ホスト先のURLを別のタブで開きます。
   * **impact.comに埋め込む：** プラットフォームのインターフェース内にウィジェットを直接表示します。
2. 必要に応じて、 **プレビュー画像** セクションで **ファイルを選択** を選び、サムネイルをアップロードします。ファイルはGIF、JPG、PNGのいずれかで、サイズは512 KB以下にしてください。
3. 「 **ウィジェットURL** 」フィールドに、ウィジェットのホスト先のWebアドレスを入力します。
4. 「 ![](https://1458456015-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-c2cb550b55c51ea1eeff0acbd6f437a03b621a2c%2F60d033ae8a04c14498d5229c3c0160ac05feea7f605dbd770741793c900469f0.svg?alt=media)**ドロップダウンメニュー**」から、サイトのセキュリティに対応するプロトコル（<https://など）を選択します。>
5. 必要に応じて、 ![](https://1458456015-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-6282f271b7521383385339243690b303086736d9%2F3b5a585dd2895bdf1c30d1236c72ba590dddd18717863b27074c8d313d05ae20.svg?alt=media) **［追加］動的フィールドを挿入** を選択し、トークンの一覧を展開します。
6. 使用するトークンを探し、 **挿入**。プラットフォームはトークン（例：{irpid}）を自動的に次の項目に追加します： **ウィジェット URL**。各トークンの説明については、以下の [動的フィールドトークン](#dynamic-field-tokens) セクションを参照してください。
   {% endstep %}

{% step %}

## 詳細設定を更新する

［ **言語** ![](https://1458456015-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-c2cb550b55c51ea1eeff0acbd6f437a03b621a2c%2F60d033ae8a04c14498d5229c3c0160ac05feea7f605dbd770741793c900469f0.svg?alt=media)**］ドロップダウンメニューから**このウィジェットの表示言語を選択します。
{% endstep %}

{% step %}

## カスタムウィジェットを完成させる

［ **作成** ］を選択してウィジェットを保存します。パートナーはこのウィジェットを *コンテンツウィジェット*.
{% endstep %}
{% endstepper %}

<details>

<summary>動的フィールドトークン</summary>

| トークン                           | 説明                                    |
| ------------------------------ | ------------------------------------- |
| `{click_url_encoded}`          | エンコードされたクリック URL                      |
| `{click_url}`                  | エンコードされていないクリック URL                   |
| `{irimpurl}`                   | インプレッション URL                          |
| `{irpid}`                      | パートナーID                               |
| `{subid1}`                     | パートナーサブ ID 1                          |
| `{subid2}`                     | パートナーサブ ID 2                          |
| `{subid3}`                     | パートナーサブ ID 3                          |
| `{sharedId}`                   | 共有 ID                                 |
| `{iradid}`                     | 広告ID                                  |
| `{ircid}`                      | プログラムID                               |
| `{click_url_encoded_deeplink}` | ディープリンクパラメーターが追加された、エンコード済みのクリック URL。 |

</details>

## 実例

{% hint style="info" %}
**これらの例について：** カスタムウィジェットは、お客様が作成してホスティングします。impact.com はホストされたページを埋め込み、そこにパートナーの最新データを挿入するだけです。以下の参考実装をコピーして独自のドメインでホスティングし、必要に応じて調整してください。パートナーがコードを編集することはありません。完成したウィジェットを *コンテンツウィジェット*.
{% endhint %}

### 動的フィールドトークンがウィジェットに渡される仕組み

動的フィールドトークンを **ウィジェット URL**に追加すると、impact.com はページを読み込む前に、そのトークンを各パートナーの実際の値に置き換えます。ページはクエリ文字列から値を読み取り、それを使ってトラッキング可能なリンクを作成します。

たとえば、 **ウィジェット URL** を次のように設定すると： `https://widgets.yourbrand.com/search?partner={irpid}&clickurl={click_url_encoded}`impact.com は、ID が `123456`:

{% code overflow="wrap" %}

```
https://widgets.yourbrand.com/search?partner=123456&clickurl=https%3A%2F%2Facme.sjv.io%2Fc%2F123456%2F789012%2F3456
```

{% endcode %}

{% hint style="warning" %}
クリック URL には `{click_url_encoded}`を渡し、 `{click_url}` は渡さないでください。未加工のクリック URL には、それ自体の `?` と `&` クエリ文字列が壊れる原因となる文字です。使用する前にページ内でデコードしてください。
{% endhint %}

### 例 1：検索ウィジェット

パートナーが impact.com を離れることなく、カタログを検索し、任意の商品についてトラッキング可能なリンクをコピーできるようにします。検索ページはお客様がホストし、impact.com がパートナーの ID とクリック URL を渡すため、すべての検索結果リンクがそのパートナーに紐付けられます。

1. ご自身が管理するドメインで、HTTPS を使用して検索ページをホストします（例： `https://widgets.yourbrand.com/search`）。デモ用の `CATALOG` 配列を、ご自身の商品カタログまたは検索 API を呼び出す処理に置き換えてください。
2. 上記の 5 つの手順に従ってカスタムウィジェットを作成します。「 **ウィジェットを設定**」で、 **ウィジェット URL** に、 `{irpid}` と `{click_url_encoded}` のトークン（下記参照）を含むページ URL を設定します。
3. 「 **新しいタブで開く**」を使ってテストします。テスト用パートナーとして検索を実行し、検索結果リンクが自社サイトに移動してクリックが記録されることを確認します。その後、ウィジェットを「 **impact.com に埋め込む**.

**ウィジェット URL**

{% code overflow="wrap" %}

```
https://widgets.yourbrand.com/search?partner={irpid}&clickurl={click_url_encoded}
```

{% endcode %}

<details>

<summary>search-widget.html</summary>

```html
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1" />
  <title>商品検索</title>
  <style>
    body { font-family: Arial, sans-serif; margin: 0; padding: 16px; }
    .search-bar { display: flex; gap: 8px; margin-bottom: 16px; }
    .search-bar input { flex: 1; padding: 10px; font-size: 16px; }
    .search-bar button { padding: 10px 16px; font-size: 16px; cursor: pointer; }
    .result { padding: 12px; border: 1px solid #ddd; border-radius: 6px; margin-bottom: 8px; }
    .result a { text-decoration: none; font-weight: bold; }
    .copy { margin-left: 8px; font-size: 13px; color: #2b6cb0; cursor: pointer; }
  </style>
</head>
<body>
  <div class="search-bar">
    <input id="q" type="text" placeholder="商品を検索..." />
    <button id="go">検索</button>
  </div>
  <div id="results"></div>

  <script>
    // 1. impact.com がウィジェット URL に挿入した値を読み取ります。
    var params    = new URLSearchParams(window.location.search);
    var partnerId = params.get('partner') || '';
    var clickUrl  = decodeURIComponent(params.get('clickurl') || '');

    // 2. このデモ用配列を、ご自身の商品カタログまたは検索 API を呼び出す処理に置き換えてください。
    var CATALOG = [
      { name: 'Trail Runner Shoe',   url: 'https://www.yourbrand.com/products/trail-runner' },
      { name: 'Waterproof Jacket',   url: 'https://www.yourbrand.com/products/waterproof-jacket' },
      { name: 'Merino Hiking Socks', url: 'https://www.yourbrand.com/products/merino-socks' }
    ];

    // 3. トラッキング可能なディープリンクを作成する: パートナーのクリックURL + 遷移先ページ。
    //    公開前に、プログラムで使用する正確なディープリンク形式を確認してください（「公開前に」を参照）。
    function buildTrackingLink(destinationUrl) {
      if (!clickUrl) return destinationUrl;            // フォールバック: トークンがない場合はトラッキングしない
      return clickUrl + encodeURIComponent(destinationUrl);
    }

    function search() {
      var term = document.getElementById('q').value.toLowerCase();
      var matches = CATALOG.filter(function (p) {
        return p.name.toLowerCase().indexOf(term) !== -1;
      });
      var container = document.getElementById('results');
      container.innerHTML = matches.length ? '' : '<p>商品が見つかりません。</p>';
      matches.forEach(function (p) {
        var link = buildTrackingLink(p.url);
        var row = document.createElement('div');
        row.className = 'result';
        row.innerHTML =
          ' <a href="' + link + '" target="_blank" rel="noopener">' + p.name + '</a>' +
          '<span class="copy" data-link="' + link + '">リンクをコピー</span>';
        container.appendChild(row);
      });
    }

    document.getElementById('go').addEventListener('click', search);
    document.getElementById('q').addEventListener('keyup', function (e) {
      if (e.key === 'Enter') search();
    });
    document.addEventListener('click', function (e) {
      if (e.target.classList.contains('copy')) {
        navigator.clipboard.writeText(e.target.getAttribute('data-link'));
      }
    });
  </script>
</body>
</html>
```

</details>

### 例2: 動的リッチメディア広告（フローティングチャットウィジェット）

動的リッチメディア広告とは、ホストしてウィジェットとして埋め込む、インタラクティブなHTMLアセットのことです。この例では、フローティングチャットバブルを作成し、展開するとプロモーションメッセージと行動喚起が表示されるようにします。訪問者がボタンを選択すると、パートナーのクリックURLを経由してリダイレクトされるため、クリックがトラッキングされ、成果として計上されます。

1. 管理しているドメイン上で、HTTPS経由でページをホストします（例:  `https://widgets.yourbrand.com/chat`）。キャンペーンに合わせて、文言、色、行動喚起をカスタマイズしてください。
2. 上記の5つの手順でカスタムウィジェットを作成し、 **ウィジェットURL** に `{click_url_encoded}` トークン（下記参照）を設定します。
3. テストパートナーとして **新しいタブで開く** を使ってテストし、行動喚起からサイトが開き、クリックが記録されることを確認してから、ウィジェットを **impact.comに埋め込む**.

**ウィジェット URL**

{% code overflow="wrap" %}

```
https://widgets.yourbrand.com/chat?clickurl={click_url_encoded}
```

{% endcode %}

デフォルトのランディングページではなく特定のページに訪問者を誘導するには、 `{click_url_encoded_deeplink}` トークンを、 `{click_url_encoded}`または、例 1 に示すように、独自のコードで遷移先を追加します。

<details>

<summary>chat-widget.html</summary>

```html
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1" />
  <title>Assistant</title>
  <style>
    html, body { margin: 0; height: 100%; background: transparent; font-family: Arial, sans-serif; }
    #bubble {
      position: fixed; bottom: 20px; right: 20px;
      width: 60px; height: 60px; border-radius: 50%;
      background: #2b6cb0; color: #fff; font-size: 26px;
      display: flex; align-items: center; justify-content: center;
      cursor: pointer; box-shadow: 0 4px 12px rgba(0,0,0,.25);
    }
    #panel {
      position: fixed; bottom: 90px; right: 20px; width: 260px;
      background: #fff; border-radius: 10px; box-shadow: 0 6px 24px rgba(0,0,0,.2);
      padding: 16px; display: none;
    }
    #panel.open { display: block; }
    #panel p { margin: 0 0 12px; font-size: 14px; color: #333; }
    #cta {
      display: block; width: 100%; padding: 10px; border: none; border-radius: 6px;
      background: #2b6cb0; color: #fff; font-size: 15px; cursor: pointer;
    }
  </style>
</head>
<body>
  <div id="bubble">&#128172;</div>
  <div id="panel">
    <p>こんにちは！最新のお得な情報をお探しですか？下をタップして、お買い物をお楽しみください。</p>
    <button id="cta">今すぐ購入</button>
  </div>

  <script>
    // impact.com はパートナーのクリック URL をこのページに挿入します。
    var params   = new URLSearchParams(window.location.search);
    var clickUrl = decodeURIComponent(params.get('clickurl') || '');

    var bubble = document.getElementById('bubble');
    var panel  = document.getElementById('panel');
    bubble.addEventListener('click', function () {
      panel.classList.toggle('open');
    });

    document.getElementById('cta').addEventListener('click', function () {
      if (!clickUrl) return;
      // クリックを追跡し、パートナーに成果を紐付けられるよう、新しいタブで開きます。
      window.open(clickUrl, '_blank', 'noopener');
    });
  </script>
</body>
</html>
```

</details>

## 公開する前に

* HTTPS で自身のサーバーにホストしてください。impact.com は iframe でページを埋め込むか、新しいタブで開きます。コードをホストすることはありません。埋め込みモードではページが iframe 内で実行されるため、遷移先リンクを開くには、親ウィンドウを遷移させるのではなく、 `target="_blank"` または `window.open(...)` を使用してください。
* クリック URL をエンコードします。 `{click_url_encoded}` として渡し、ページ内でデコードしてください。これにより、URL 自体に含まれる `?` ? `&` や
* などの文字によってクエリ文字列が壊れるのを防げます。

## その他のリソース

* [パートナー向けトラッキングリンクの作成と共有](https://help.impact.com/brand/ja/what-would-you-like-to-learn-about/platform-features/reach-out-to-partners/generate-leads/create-and-share-tracking-links-with-partners.md) — トラッキングリンクを作成し、パートナーと共有する方法。
* [トラッキングリンクのパラメーターについて](https://help.impact.com/brand/ja/what-would-you-like-to-learn-about/platform-features/tracking/tracking-explained/tracking-link-parameters-explained.md) — トラッキングリンクの構造と、サブ ID、共有 ID、ディープリンクなど、追加できるパラメーターについて。
* [ディープリンクを許可するドメインを設定する](https://help.impact.com/brand/ja/what-would-you-like-to-learn-about/account-administration/program-settings/tracking-settings/set-up-permitted-domains-for-deep-linking.md) — パートナーがサイト上でディープリンクできる遷移先ドメインを許可します。
* [アセットの種類について](https://help.impact.com/brand/ja/what-would-you-like-to-learn-about/platform-features/ads/introduction-to-asset-types.md) — パートナーに提供できるアセットの種類と、カスタムウィジェットの位置づけについて説明します。
* [Rakuten Advertisingからimpact.comへの移行：主な手順](https://help.impact.com/brand/ja/what-would-you-like-to-learn-about/getting-started/rakuten-advertising-to-impact.com-key-transition-steps.md) — Rakuten Advertisingからimpact.comにプログラムを移行すると、何が変わるかを説明します。


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.impact.com/brand/ja/what-would-you-like-to-learn-about/platform-features/reach-out-to-partners/generate-leads/create-a-custom-widget.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
