# REST API を使用したジャーニー内のアクティベーションの管理

UI と同様に、REST API でアクティベーションを設定できます。ジャーニー内でのアクティベーションの作成、表示、更新に加えて、API を使用してオブジェクトを検証し、カスタマージャーニーとプロファイルを表示できます。

この記事には以下が含まれます:

* [ジャーニー内でのアクティベーションの作成](#create-an-activation-inside-a-journey)
* [リクエストサンプル](#request-sample)
* [ジャーニー内の指定されたアクティベーションの更新](#update-a-specified-activation-inside-a-journey)
* [リクエストサンプル](#request-sample-1)
* [ジャーニー内のアクティベーションの表示](#view-an-activation-inside-a-journey)
* [リクエストサンプル](#request-sample-2)
* [フォルダ内のオブジェクトの検証](#verifying-objects-in-a-folder)
* [リクエストサンプル](#request-sample-3)
* [ジャーニー統計の表示](#viewing-journey-statistics)
* [カスタマープロファイルの表示](#viewing-customer-profiles)


# ジャーニー内でのアクティベーションの作成

指定されたジャーニー内でアクティベーションを作成できます。以下の例では、ジャーニー ID は 12345 です。

#### リクエストサンプル


```bash
curl -i -X POST \
 https://api-cdp.treasuredata.com/entities/journeys/12345/syndications \
 -H 'AUTHORIZATION: TD1 1/1234567891234567891234560001234567891234'
```


```json
{
 "type": "journeyActivationStep",
 "attributes": {
 "syndication_params": {
 "scheduleType": "hourly",
 "scheduleOption": "00:00,
 "timezone": "UTC",
 "connectorConfig": {
 "useKey": false,
 "spreadsheetTitle": "xxxx",
 "sheetTitle": "From Activation",
 "mode": "replace",
 "range": "A1",
 "rowsThreshold": 5000,
 "valueInputOption": "RAW",
 "setNilForDoubleNan": true
 },
 "connectionId": "135593",
 "name": "My Activation",
 "description": "",
 "columns": [],
 "allColumns": true,
 "emailRecipients": [],
 "notifyOn": []
 }
 },
 "relationships": {
 "journey": {
 "data": {
 "id": ...,
 "type": "journey"
 }
 },
 "createdBy": {
 "data": {
 "id": ...,
 "type": "user"
 }
 }
 "updatedBy": {
 "data": {
 "id": ...,
 "type": "user"
 }
 }
 }
}
```

# ジャーニー内の指定されたアクティベーションの更新

指定されたジャーニー内の特定のアクティベーションを更新できます。ジャーニー内の他のオブジェクトとは異なり、アクティベーションは指定されたジャーニーが起動された後でも更新できます。以下の例では、ジャーニー ID は 12345 で、アクティベーション ID は 678 です。

#### リクエストサンプル


```bash
curl -i -X PATCH \
 https://api-cdp.treasuredata.com/entities/journeys/12345/syndications/678 \
 -H 'AUTHORIZATION: TD1 1/1234567891234567891234560001234567891234'
```


```json
{
 "type": "journeyActivationStep",
 "attributes": {
 "syndication_params": {
 "scheduleType": "hourly",
 "scheduleOption": "00:00,
 "timezone": "UTC",
 "connectorConfig": {
 "useKey": false,
 "spreadsheetTitle": "xxxx",
 "sheetTitle": "From Activation",
 "mode": "replace",
 "range": "A1",
 "rowsThreshold": 5000,
 "valueInputOption": "RAW",
 "setNilForDoubleNan": true
 },
 "connectionId": "135593",
 "name": "My Activation",
 "description": "",
 "columns": [],
 "allColumns": true,
 "emailRecipients": [],
 "notifyOn": []
 }
 }
}
```

# ジャーニー内のアクティベーションの表示

指定されたジャーニー内の特定のアクティベーションを表示できます。以下の例では、ジャーニー ID は 12345 で、アクティベーション ID は 678 です。

#### リクエストサンプル


```bash
curl -i -X GET \
https://api-cdp.treasuredata.com/entities/journeys/12345/syndications/678 \
-H 'AUTHORIZATION: TD1 1/1234567891234567891234560001234567891234'
```

# フォルダ内のオブジェクトの検証

UI の  *objects* と同様に、API で  *entities* を表示できます。次の呼び出しは、セグメント、予測スコアリングモデル、フォルダ内の他のフォルダを含む、フォルダ内のすべてのエンティティを返します。

ジャーニーが目的のフォルダ内に作成されていることを確認できます。次の例では、フォルダ ID は 295432 です。表示したい深さを指定することで、ネストされたフォルダを表示することもできます。以下の 30 として示される深さは、フォルダ内をどれだけ深く検索するかを示しています。最大 32 レベルの子フォルダが表示可能です。

#### リクエストサンプル


```bash
curl -i -X GET \
 https://api-cdp.treasuredata.com/entities/by-folder/295432?depth=30
 -H 'AUTHORIZATION: TD1 1/1234567891234567891234560001234567891234'
```

# ジャーニー統計の表示

*statistics* エンドポイントを呼び出すことで、ジャーニーの統計を表示できます。レスポンスには、ジャーニー全体の目標を達成したプロファイルの数(ジャーニーに設定されている場合)、各ステージにいるプロファイルの数、および終了基準を満たしてステージを終了したプロファイルの数(ステージに設定されている場合、およびプロファイルが終了した場合)が含まれます。以下の例では、ジャーニー ID は 12345 です。デフォルトでは、過去 30 日間(現在の日付を含む)の統計が表示されます。


```bash
curl -i -X GET \
 https://api-cdp.treasuredata.com/entities/journeys/12345/statistics \
 -H 'AUTHORIZATION: TD1 1/1234567891234567891234560001234567891234'
```

# カスタマープロファイルの表示

*customers* エンドポイントを呼び出すことで、指定されたジャーニー内のカスタマープロファイルのリストを表示できます。以下の例では、ジャーニー ID は 12345 です。


```bash
curl -i -X GET \
 https://api-cdp.treasuredata.com/entities/journeys/12345/customers \
 -H 'AUTHORIZATION: TD1 1/1234567891234567891234560001234567891234'
```