> For the complete documentation index, see [llms.txt](https://docs.maiagent.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.maiagent.ai/maiagent-user-guide/ja/serve/platform-settings/basic-settings.md).

# 基本設定

Webチャットプラットフォームの基本設定：プラットフォーム名、紐付けるAIアシスタント、戻り先URL、カスタムドメイン、埋め込みを許可するドメイン、公開アクセスURL、および3種類の埋め込み方法について説明します。

<mark style="color:blue;">基本設定</mark>は、チャットプラットフォーム設定ページの「一般」グループにある最初のカテゴリです。このプラットフォームの名前、接続するAIアシスタント、サービスを提供するURLを設定します。このページでは、Webプラットフォームのすべての項目について説明します。LINEやMicrosoft Teamsなどのコミュニケーションプラットフォームでは、基本設定に各プラットフォームの認証情報を入力します。該当する「チャットプラットフォームを接続する」ページをご覧ください。設定ページ全体の構成とアクセス方法については、[チャットプラットフォーム設定の概要](/maiagent-user-guide/ja/serve/platform-settings.md)をご覧ください。

## 1. 使用する場面 <a href="#when-to-use" id="when-to-use"></a>

マーケティング担当者が、会社のAIカスタマーサービスを公式Webサイトに設置するとします。Webプラットフォームの<mark style="color:blue;">基本設定</mark>を開き、名前を「カスタマーサービスアシスタント」に変更し、「製品相談アシスタント」が紐付けられていることを確認します。<mark style="color:blue;">戻り先URL</mark>に公式Webサイトのトップページを入力し、<mark style="color:blue;">埋め込みを許可するドメイン</mark>に`*.my-company.com`を追加します。保存後、<mark style="color:blue;">埋め込み</mark>をクリックし、JavaScriptコードをWebサイトのエンジニアに渡します。公開後は会社のWebサイトだけがこのカスタマーサービスを読み込めるようになり、第三者がコードをコピーしても使用できません。

## 2. 項目の説明 <a href="#fields" id="fields"></a>

<figure><img src="https://2584873290-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTvHx8hgwYGDTLD3A7xoW%2Fuploads%2Fgit-blob-8b1e203abe16f045412157499f71caf17674cb29%2Fplatform-basic-settings.png?alt=media" alt="Webプラットフォームの基本設定：名前、AIアシスタント、戻り先URL、カスタムドメイン、埋め込みを許可するドメイン、公開アクセスURL"><figcaption><p>Webプラットフォームの基本設定</p></figcaption></figure>

| 項目                  | 説明                                                                             |
| ------------------- | ------------------------------------------------------------------------------ |
| **名前**              | チャットウィンドウのタイトルバーに表示する名前（例：「カスタマーサービスアシスタント」）。必須項目です                            |
| **AIアシスタント**        | このプラットフォームで回答するAIアシスタント。同じアシスタントを複数のプラットフォームに接続できます                            |
| **戻り先URL**          | ユーザーがチャットウィンドウで戻るをクリックしたときに移動するURL。通常は公式Webサイトのトップページを入力します                    |
| **カスタムドメイン（CNAME）** | 独自ドメインでチャットページを提供します。[セクション3](#custom-domain)をご覧ください                           |
| **埋め込みを許可するドメイン**   | 埋め込みの許可リストです。[セクション4](#allowed-embed-origins)をご覧ください                           |
| **公開アクセスURL**       | システムが自動生成するチャットページのURL。直接共有または埋め込みができます。[セクション5](#public-url-and-embed)をご覧ください |

### 名前とAIアシスタント <a href="#name-and-agent" id="name-and-agent"></a>

<mark style="color:blue;">名前</mark>にWebサイトで表示する名前を入力し、<mark style="color:blue;">AIアシスタント</mark>のドロップダウンメニューから質問に回答するアシスタントを選択します。アシスタントの切り替えはすぐに反映され、チャットウィンドウを埋め込み直す必要はありません。

<figure><img src="https://2584873290-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTvHx8hgwYGDTLD3A7xoW%2Fuploads%2Fgit-blob-b51d95e2e16cbd042aa3b0b1c86f72f8923b0439%2F%E5%90%8D%E7%A8%B1display.png?alt=media" alt="チャットウィンドウのタイトルバーに表示されるプラットフォーム名"><figcaption><p>プラットフォーム名はチャットウィンドウのタイトルバーに表示されます</p></figcaption></figure>

### 戻り先URL <a href="#return-url" id="return-url"></a>

会社のWebサイトのURLを入力すると、ユーザーが全画面のチャットページで戻るをクリックした際に、このURLへ移動します。埋め込みプレビューでも、このURLのWebサイトが背景として使用されます。

<figure><img src="https://2584873290-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTvHx8hgwYGDTLD3A7xoW%2Fuploads%2Fgit-blob-63ec964871ee05c4285511fbc4b922d35405803b%2F%E5%9F%BA%E6%9C%AC%E8%A8%AD%E5%AE%9A%20-%20%E5%B5%8C%E5%85%A5%E9%A0%90%E8%A6%BD%20%E8%BF%94%E5%9B%9E%E7%B6%B2%E5%9D%80%20(1)%20(1).png?alt=media" alt="埋め込みプレビューでは戻り先URLのWebサイトが背景として表示されます"><figcaption><p>戻り先URLを追加すると、埋め込みプレビューではそのWebサイトが背景として表示されます</p></figcaption></figure>

## 3. カスタムドメイン（CNAME） <a href="#custom-domain" id="custom-domain"></a>

デフォルトの公開アクセスURLは`chat.maiagent.ai`配下にあります。チャットページに独自ドメイン（例：`chat.my-company.com`）を使用する場合は、<mark style="color:blue;">カスタムドメイン（CNAME）</mark>にそのドメインを入力して保存します。システムが証明書を申請し、ルーティングを設定します。保存後、項目の横に<mark style="color:blue;">ドメインステータス</mark>が表示されます。

| ステータス       | 意味                              | 対応方法                           |
| ----------- | ------------------------------- | ------------------------------ |
| **確認中**     | システムがルーティングと証明書を設定しています         | 数分待ってからページを更新します               |
| **DNS未準備**  | DNSで対象ドメインがまだMaiAgentを参照していません  | DNSプロバイダーでCNAMEレコードを追加します      |
| **証明書未準備**  | DNSは設定済みですが、証明書がまだ発行中です         | 待機します。通常は数分以内に完了します            |
| **DNS設定異常** | 以前は有効でしたが、DNSレコードが変更または削除されています | DNSプロバイダーのCNAMEレコードを確認します      |
| **有効**      | 独自ドメインでチャットページを開けます             | 公開アクセスURLと埋め込みコードが独自ドメインを使用します |

{% hint style="info" %}
CNAMEレコードの参照先アドレスは環境によって異なります。[サポートセンター](https://helpdesk.maiagent.ai/)にお問い合わせください。項目を空にして保存するとカスタムドメインを削除でき、チャットページはデフォルトURLに戻ります。
{% endhint %}

## 4. 埋め込みを許可するドメイン <a href="#allowed-embed-origins" id="allowed-embed-origins"></a>

### この設定について <a href="#embed-origins-overview" id="embed-origins-overview"></a>

<mark style="color:blue;">埋め込みを許可するドメイン</mark>は、埋め込みの許可リストです。設定すると、リストにあるWebサイトだけがこのWebチャットを埋め込めます。それ以外のWebサイトに設置した埋め込みコードは機能しません。

次のような場合に有効化することをおすすめします。

* **無断埋め込みの防止**：第三者のWebサイトに埋め込みコードをコピーされ、カスタマーサービスボットを設置されることで、会話枠が消費されることを防ぎます
* **セキュリティコンプライアンス**：このカスタマーサービスコンポーネントを読み込めるWebサイトの管理を求める、会社や顧客のセキュリティポリシーに対応します

{% hint style="info" %}
これは高度なセキュリティ設定です。**上記の要件がない場合は、リストを空のままにしてください。** リストが空の場合、どのWebサイトでもこのWebチャットを埋め込めます。
{% endhint %}

### 動作 <a href="#embed-origins-behavior" id="embed-origins-behavior"></a>

| リストの状態   | 動作                                                      |
| -------- | ------------------------------------------------------- |
| 空（デフォルト） | 制限なし。どのWebサイトでもこのWebチャットを埋め込めます                         |
| 空ではない    | 許可リストモード。ブラウザは他のドメインからの埋め込みをブロックし、SDKもそのsetup呼び出しを拒否します |

* **ブロック対象のドメインに埋め込んだ場合**：そのページのチャットコンポーネントは初期化を完了できず、訪問者は会話を開始できません
* **公開アクセスURLを直接開く訪問者**：この設定は「埋め込み」だけを制限します。公開URLからチャットページを直接開く訪問者には影響しません
* **セキュリティ機構は「検証できない場合は拒否」します**：リストが空でない場合、オリジン検証を通過できない埋め込みはすべて拒否されます。ドメイン名の入力ミスや、オリジン検証に対応していない古い埋め込みスクリプトを使用するページも対象です

### 設定手順 <a href="#embed-origins-setup" id="embed-origins-setup"></a>

{% stepper %}
{% step %}

### 項目を見つける <a href="#embed-origins-step-navigate" id="embed-origins-step-navigate"></a>

<mark style="color:blue;">基本設定</mark>で<mark style="color:blue;">埋め込みを許可するドメイン</mark>を見つけ、<mark style="color:blue;">＋ 追加</mark>をクリックします。

<figure><img src="https://2584873290-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTvHx8hgwYGDTLD3A7xoW%2Fuploads%2Fgit-blob-2c6dc13d0e37a07d6f539d493f1e1493d018dcfb%2Fwebchat-basic-allowed-origins.png?alt=media" alt="基本設定の「埋め込みを許可するドメイン」項目"><figcaption><p>基本設定の「埋め込みを許可するドメイン」項目</p></figcaption></figure>
{% endstep %}

{% step %}

### ドメインを追加する <a href="#embed-origins-step-add" id="embed-origins-step-add"></a>

各項目には、完全一致するオリジン（`https://example.com`）、またはワイルドカードドメイン（`*.example.com`。example.comとそのすべてのサブドメインに一致します）を入力できます。

| 形式                          | 説明                                                                |
| --------------------------- | ----------------------------------------------------------------- |
| ✅ `https://www.example.com` | 完全一致するオリジン：このURL（プロトコルを含む）のページだけに埋め込みを許可します                       |
| ✅ `*.example.com`           | ワイルドカードドメイン：example.comとそのすべてのサブドメイン（www、shop、blogなど）への埋め込みを許可します |
| ❌ `example.com`             | 完全一致するオリジンにはプロトコルが必要です。`https://`がない場合は有効になりません                   |
| ❌ `*.com`                   | 範囲が広すぎるため、すべての.com Webサイトを許可することになり、許可リストの意味がなくなります               |
| {% endstep %}               |                                                                   |

{% step %}

### 保存して確認する <a href="#embed-origins-step-save" id="embed-origins-step-save"></a>

設定を保存して約1分待ってから、リストにあるWebサイトで埋め込みページを更新し、チャットウィンドウで引き続き正常に会話を開始できることを確認します。

<figure><img src="https://2584873290-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTvHx8hgwYGDTLD3A7xoW%2Fuploads%2Fgit-blob-856c495d2fb9896943ac455178eed55a38f15a0e%2Fembed-origins-01-filled-list.png?alt=media" alt="ドメインリストを入力した「埋め込みを許可するドメイン」項目"><figcaption><p>完全一致するオリジンとワイルドカードドメインを入力したリストの例</p></figcaption></figure>
{% endstep %}
{% endstepper %}

### 有効化前のチェックリスト <a href="#embed-origins-checklist" id="embed-origins-checklist"></a>

{% hint style="warning" %}
リストが空でなくなると、リストにない埋め込みはすべてブロックされます。「入力した途端にすべてブロックされる」事態を避けるため、有効化の前に次の項目を順番に確認してください。

1. **このWebチャットを埋め込むすべてのドメインをリストアップする**：本番サイト、テスト環境、プレビュー環境を漏れなく含めます
2. **最新の埋め込みコードを再取得する**：以前に取得した埋め込みスクリプトはオリジン検証に対応しておらず、リストを有効にするとすべて拒否される場合があります。先に<mark style="color:blue;">埋め込み</mark>を開いて新しいコードをコピーし、Webサイトを更新することをおすすめします
3. **最初は追加だけを行い、削除しない**：初めて有効化するときは、項目を整理する前にすべてのドメインを追加します
4. **1つずつ検証する**：保存後、各埋め込みページで実際に会話を開始し、すべて正常に動作することを確認します
5. **復旧手段を確保する**：有効化後に埋め込み側で会話を開始できない場合は、リストを空にして保存します。約1分待つと、制限なしの状態に戻ります
   {% endhint %}

### よくある質問 <a href="#embed-origins-faq" id="embed-origins-faq"></a>

**Q：設定はどのくらいで反映されますか？**

保存後、通常は約1分以内に反映されます。その後、開いている埋め込みページを更新すると、新しい設定が適用されます。

**Q：サブドメインが多い場合、1つずつ記載する必要がありますか？**

いいえ。`*.example.com`を1件追加すると、example.comとそのすべてのサブドメインに一致します。

**Q：この設定で防げることと、防げないことは何ですか？**

これは「埋め込みレイヤー」の保護です。他のWebサイトがこのWebチャットを自分のページに埋め込むことを防げます。ただし、本人確認ではありません。公開アクセスURLを知っている人は、引き続きチャットページを直接開いて会話できます。「誰が会話できるか」を管理する必要がある場合は、[ログイン設定](/maiagent-user-guide/ja/serve/choose-channel/web-chat/website.md#login-settings)も併用してください。

**Q：設定を誤り、すべての埋め込み先で会話できなくなった場合はどうすればよいですか？**

<mark style="color:blue;">埋め込みを許可するドメイン</mark>のリストを空にして保存します。約1分待つと制限なしの状態に戻ります。その後、ドメインの入力形式を再確認してください。

## 5. 公開アクセスURLと埋め込み <a href="#public-url-and-embed" id="public-url-and-embed"></a>

ページ下部の<mark style="color:blue;">公開アクセスURL</mark>は、システムが自動生成するチャットページのURLです。その横には4つの操作があります。

| 操作            | 用途                                     |
| ------------- | -------------------------------------- |
| **コピー**       | URLをコピーし、ユーザーに直接共有したりQR Codeに使用したりできます |
| **アクセス**      | 新しいタブでチャットページを開き、設定の効果をテストします          |
| **埋め込み**      | 埋め込みコードを取得します。以下の3種類の埋め込み方法をご覧ください     |
| **埋め込みプレビュー** | 戻り先URLのWebサイトを背景にして、埋め込み後の表示をプレビューします  |

### 3種類の埋め込み方法 <a href="#embed-methods" id="embed-methods"></a>

<mark style="color:blue;">埋め込み</mark>をクリックすると、ウィンドウ上部で次の方法を切り替えられます。

* **JavaScript**：`<script>`で読み込みます。最もよく使用され、自動的に読み込みと互換性を処理します
* **Iframe**：`<iframe>`で直接埋め込みます。スクリプトを挿入できない環境に適しています
* **MaiGPT**：ChatGPT形式の完全なチャットインターフェース（左側に会話履歴、右側にメインの会話エリア）です。ページ内に常時埋め込むことも、右下のフローティングボタンをクリックして全画面表示することもできます

<mark style="color:blue;">MaiGPT</mark>を選択すると、左側で<mark style="color:blue;">埋め込みコンテナ（targetElement）</mark>、<mark style="color:blue;">言語（locale）</mark>、<mark style="color:blue;">タイトル（maigptTitle）</mark>を調整できます。右側の<mark style="color:blue;">コードプレビュー</mark>はすぐに更新されます。<mark style="color:blue;">コピー</mark>をクリックしてWebサイトに貼り付けてください。パラメータの詳細については、[MaiGPTウィンドウモードの埋め込み](/maiagent-user-guide/ja/serve/choose-channel/web-chat/maigpt-embed.md)をご覧ください。

### 埋め込みスクリプトの特長 <a href="#embed-script" id="embed-script"></a>

JavaScript埋め込みで提供されるembed.jsスクリプトには、次の特長があります。

* **重複実行の防止**：スクリプトが複数回読み込まれても、初期化は1回だけ行われます
* **明確なエラーメッセージ**：読み込みに失敗した場合に、トラブルシューティングに役立つエラーメッセージを表示します
* **Webサイトの読み込み速度に影響しない**：スクリプトは最適化されています
* **さまざまなWebサイト環境やフレームワークに対応**

埋め込み時の推奨事項：

1. ページの主要コンテンツが先に読み込まれるよう、埋め込みスクリプトを`</body>`タグの直前に配置します
2. 重複を避けるため、ページ内に埋め込みスクリプトを1回だけ追加します
3. SPA（Single Page Application）で使用する場合は、技術ドキュメントの高度な設定をご覧ください

<figure><img src="https://2584873290-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTvHx8hgwYGDTLD3A7xoW%2Fuploads%2Fgit-blob-5c896d7bb75574c434d11ef560612d20a61eba48%2F%E5%9F%BA%E6%9C%AC%E8%A8%AD%E5%AE%9A%20-%20%E9%81%B7%E5%85%A5%E8%A8%AD%E5%AE%9A%E9%A0%90%E8%A6%BD.png?alt=media" alt="埋め込みプレビュー画面"><figcaption><p>埋め込みプレビュー</p></figcaption></figure>

## 6. よくある質問 <a href="#faq" id="faq"></a>

### Q：名前やAIアシスタントを変更した場合、埋め込み直す必要がありますか？ <a href="#faq-resave" id="faq-resave"></a>

いいえ。<mark style="color:blue;">保存</mark>をクリックするとすぐに反映され、埋め込みコードは変わりません。

### Q：同じAIアシスタントを複数のWebプラットフォームに接続できますか？ <a href="#faq-multi-platform" id="faq-multi-platform"></a>

はい。各プラットフォームには個別の名前、外観、機能スイッチがあるため、同じアシスタントをWebサイトごとに異なる形で表示できます。<mark style="color:blue;">カスタマーサービス会話</mark> → <mark style="color:blue;">チャットプラットフォーム</mark>の順に進み、<mark style="color:blue;">チャットプラットフォームを接続する</mark>をクリックして追加します。


---

# 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://docs.maiagent.ai/maiagent-user-guide/ja/serve/platform-settings/basic-settings.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.