セグメント条件更新APIを開発したい

セグメント条件更新APIとは

本APIの概要

セグメント条件更新APIとは、貴社の基幹システム/アプリケーションとb→dashを繋ぐことで、b→dash管理画面を介さずに、「セグメント」アプリ上のセグメント用データに対して、「絞り込み条件」や「更新条件」を変更/更新することができるAPIです。

貴社の基幹システム/アプリケーションに連携したセグメント更新を行いたい場合は、本API仕様書をご参照のもと貴社開発環境に実装してください。

本APIで更新できるb→dash管理画面上のデータ

b→dash管理画面と同等の操作

セグメント条件更新APIでは、b→dash管理画面にある「セグメント編集画面（以下キャプチャ）」における操作と同様に、カラムに対して条件指定を行うことでレコードを絞り込むことができます。

※複合セグメントの場合は、「編集」をクリックしても下記の編集画面に遷移しません
複合セグメント作成時に「ベースセグメント」「追加セグメント」として選択した単一セグメントの編集画面をご参照ください

セグメント編集画面

b→dash管理画面上の更新結果確認方法

セグメント条件更新APIを利用した結果は以下のb→dash管理画面（「セグメント一覧画面」「セグメント詳細画面（データファイル利用状況モーダル）」）で確認することができます。

セグメント一覧画面

データパレット詳細画面（データファイル利用状況モーダル）

本API利用にあたっての前提事項

事前準備

セグメント条件更新APIを利用する事前準備として「セグメント用データの作成」「参照データファイルの取込設定」「セグメント利用施策の運用停止」の3つの手順を踏む必要があります。

セグメント用データの作成

b→dash管理画面上で更新対象となるセグメント用データを作成する必要があります。

セグメントアプリ上でセグメント用データの作成がまだ完了していない場合は「セグメントを作成したい」をご参照の上、設定を完了させてください。

参照データファイルの取込設定

本APIの利用でセグメントの「更新条件」を変更する場合、セグメント用データを作成する際に参照したデータファイルのデータファイル取込設定が「定期更新設定する」を選択している必要があります。

データファイル取込設定をもう一度見直したい場合は、
「データファイルの取込履歴の確認方法」「データファイルの取込履歴の編集方法」をご参照の上、設定を完了させてください。

セグメント利用施策の運用停止

本APIの利用でセグメントの「絞り込み条件」を変更する場合、更新するセグメントを利用している施策（メールアプリ、データ分析など）の運用を停止する必要があります。

更新したいセグメントがどの施策で利用されているか、利用している施策が「運用中」であるかは、下記の「利用状況モーダル」で確認できます。必要に応じて施策を運用停止し、利用状況モーダルのステータスを「運用停止」または「運用終了」にしてください。

利用状況モーダル（運用停止操作の必要がある場合）の例

各施策の運用停止画面の例

共通仕様

セグメント条件更新APIでは、b→dash APIの共通仕様も参照する必要があります。共通仕様の詳細については「b→dash APIの共通仕様を知りたい」をご参照ください。

セグメント条件更新APIの仕様

処理フロー図

セグメント条件更新APIの処理フロー図は以下になります。

セグメント条件更新リクエスト

セグメント条件更新APIのURIにURIパラメータを指定してデータ連携をリクエストするリクエストURIを準備します

〇セグメント条件更新APIのURI

〇URIパラメータ

【リクエストURIサンプル】

https://api.smart-bdash.com/api/v1/segments/10

json形式のファイル(拡張子：.json)にリクエストボディパラメータを指定して、セグメントの更新内容を送信するためのリクエストボディを準備します

〇リクエストボディパラメータ

【リクエストボディサンプル】

{
  "segment_conditions": {
    "condition_or": [ 
      {
        "condition": [
          {
            "column_id": "COLUMN_1",
            "condition_name": "EQ",
            "condition_value": {
              "value": "vwxyz"
            }
          },
          {
            "column_id": "COLUMN_2",
            "condition_name": "BW",
            "condition_value": {
              "from": "20220101",
              "to": "20221231235959"
            }
          },
          {
            "column_id": "COLUMN_3",
            "condition_name": "NW",
            "condition_value": {
              "from": "20220101000000",
              "to": "20221231235959"
            }
          },
          {
            "column_id": "COLUMN_4",
            "condition_name": "T"
            }
          ]
        }
      ]
    },
  "aggregation_timing_settings": {
    "regular_update_settings": [
      {
        "interval": "MONTHLY",
        "day": 31,
        "hour": 23,
        "minute": 0
      },
      {
        "interval": "WEEKLY",
        "day_of_the_week": "FRI",
        "hour": 23,
        "minute": 0
      }
    ],
    "is_linked_to_datafile_update": true,
    "name": "更新後セグメント名称"
  }
}

準備したリクエストURI/リクエストボディと、下記のリクエストヘッダパラメータを用いて、貴社Webアプリから「PUT」リクエスト形式でセグメント条件更新のリクエストをします

〇リクエスト形式

〇リクエストヘッダパラメータ

【リクエストコードサンプル】

PUT https://api.smart-bdash.com/api/v1/segments/10 

セグメント条件更新レスポンス

リクエストの送信に成功すると、下記のレスポンス形式でセグメント条件更新APIからレスポンスが返されます

〇レスポンスボディパラメータ

〇リクエストエラー発生時のエラーメッセージ詳細

【レスポンスボディサンプル（成功レスポンス（202））】

{
  "result": {
  "code": 202,
 }
}