> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kameleoon.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Kameleoon.API.Segments

> セグメントを読み取り、再評価し、トリガーする Kameleoon.API.Segments メソッドのリファレンスです。

このモジュールは、セグメントとターゲティングを管理するメソッドを提供します。

## getAll

`getAll()` メソッドは、実験、パーソナライゼーション、または Audience トラッキングに関連付けられたものを含む、すべてのライブセグメントを返します。

```javascript theme={null}
let segments = Kameleoon.API.Segments.getAll();
```

**戻り値**

| 名前 | 型 | 説明 |
| - | - | - |
| segments | Array | [Segment オブジェクト](https://docs.kameleoon.com/ja/developer-docs/apis/activation-api-js/api-reference/objects/goal-segment-trigger-and-product.md#segment)のリスト。 |

## getById

`getById()` メソッドは、指定された ID のセグメントを返します。

```javascript theme={null}
let segment = Kameleoon.API.Segments.getById(123456);
```

**引数**

| 名前 | 型 | 説明 |
| - | - | - |
| id | Number | セグメントの ID。このフィールドは必須です。 |

**戻り値**

| 名前 | 型 | 説明 |
| - | - | - |
| segment | Object | [Segment オブジェクト](https://docs.kameleoon.com/ja/developer-docs/apis/activation-api-js/api-reference/objects/goal-segment-trigger-and-product.md#segment)。 |

## getByName

`getByName()` メソッドは、指定された名前のセグメントを返します。

```javascript theme={null}
let segment = Kameleoon.API.Segments.getByName("My segment");
```

**引数**

| 名前 | 型 | 説明 |
| - | - | - |
| name | String | セグメントの名前。このフィールドは必須です。 |

**戻り値**

| 名前 | 型 | 説明 |
| - | - | - |
| segment | Object | [Segment オブジェクト](https://docs.kameleoon.com/ja/developer-docs/apis/activation-api-js/api-reference/objects/goal-segment-trigger-and-product.md#segment)。 |

## reevaluate

`reevaluate()` メソッドは、指定されたセグメントのターゲティング条件の即時再評価を強制します。評価は通常、ページ読み込み時に行われ、**true**、**false**、または **undefined** のステータスになります。このメソッドは、エンジンが初期化されたばかりであるかのように評価プロセスを再開します。

```javascript theme={null}
Kameleoon.API.Utils.addEventListener(document.body, "mouseleave", function (event) {
  if (event.clientY < 0) {
    Kameleoon.API.Segments.reevaluate(123456);
  }
});
```

**引数**

| 名前 | 型 | 説明 |
| - | - | - |
| id | Number | セグメントの ID。このフィールドは必須です。 |

## trigger

`trigger()` メソッドは、現在の訪問者に対してセグメントトリガーを強制し、ターゲティング条件を回避します。

```javascript theme={null}
Kameleoon.API.Segments.trigger(12345);
```

**引数**

| 名前 | 型 | 説明 |
| - | - | - |
| id | Number | セグメントの ID。このフィールドは必須です。 |