セグメントAPI

Last Updated 1月 2, 2024

概要

コンテンツセグメンテーション、インサイトのフィルタリング、レポート作成のために、外部サービスがWalkMeセグメントデータを作成、編集、削除、または使用できるようにします。

例えば、Heapのアナリティクスを使って新しいセグメントを作成したり、セグメンテーションロジックに従ってシャウトアウトを表示したりできます。

アクセストークンの認証と作成

アクセストークンとは何ですか?

アクセストークンは、アプリケーションがAPIにアクセスするために使用できる資格情報です。 トークンの所有者が特定のアクションにアクセスする権限を有していることをAPIに通知します。

アクセストークンは、APIコールを認証し、システムからWorkstationにデータを渡す権限をアプリケーションに付与します。

アクセストークンの作成

  1. 管理センターに移動します
  2. API Keys(APIキー)]タブ(https://admin.walkme.com/account-api-keys)に移動します
  3. Create new Key(新規キーを作成)]をクリックします。

[Create new key(新規キーを作成)]パネルで以下を行います。

  1. キーに名前を付けます
    • ヒント:後で思い出せるよう、名前にはキーの目的を記入します
  2. Segment API(セグメントAPI)]をオンにします
  3. ドロップダウンから[Write and Read(書き込みと読み取り)]を選択します
  4. Create(作成)]をクリックします

[Key Details(キーの詳細)]パネルで以下を行います。

  1. Client ID(クライアントID)とClient Secret(クライアントシークレット)をコピーします
クライアントシークレットを保存します

シークレットは再度表示されませんので、アクセス可能な場所に保存してください。すぐにまた必要となります。

認証トークン

追加のサポートおよび認証トークンを取得するには開発者ページを参照してください。

API接続アプリケーションに情報を追加

追加のサポートについては、開発者ページを参照してください。

API接続アプリケーションにいくつかの情報を入力していきます。

下記で使用される情報は、全アプリケーションで普遍的に必要です。

  1. URL = https://api.walkme.com/accounts/connect/token
  2. ペイロードタイプ = application/x-www-form-urlencoded
  3. データ = grant_type → client_credentials

基本認証を追加します

  1. クライアントID | クライアントシークレット(管理センターからコピー)

    • 0o234234234UqD5d7 | JVnD346346346436345asfgasgbPt_4T7h2_

この情報を追加すると、アクセストークンが表示されます。

  1. アクセストークンをコピーします

これで、下記のAPIドキュメントを参照しながら、トークンを使ってWalkMeセグメントの作成取得更新、または削除を行うことができます。

また、次のcURLコードブロックを使用することもできます。

リクエストの例 – cURL

curl --location --request POST 'https://api.walkme.com/accounts/connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic <credentials>' \
--data-urlencode 'grant_type=client_credentials'
# <credentials> is the base64 encoding of the consumer key and consumer secrect of the WalkMe account joined by a colon.
レスポンスの例 – JSON
{ "access_token": "asdjkldfsjsdfhjksfdhjkxvc32cvhjhjksefbnxjnweuirou8sdfg8xdfjwkjr.sv8o8vuisuhvseuksfe",
"expires_in": 86400,
"token_type": "Bearer",
"scope": "segments:write segments:read"
}

呼び出しの実行

セグメントの作成

説明 ユーザーの静的リストに基づいて新しいセグメントを作成
URL https://api.walkme.com/public/v1/user/system/{systemGuid}/segment
メソッド POST
ヘッダー Authorization – Bearer – jwt
URLパラメーター

systemGuidWalkMeシステムのGUID。

エディタの>エディタメニュー>スニペットからシステムGUIDを取得できます

「https:cdn.walkme.com/users/<GUIDはここです>/test/walkme_<….>」の間にあるキーをコピーします

ペイロード/本文 {“id”: “<extneral id>“,
“name”: “<WalkMeセグメント名 – エディタに表示されます>“,
“userIds”: [[email protected]”, “[email protected]] }

id:heapのセグメントのID> – オプションのパラメーター

userIds:ユーザーIDのリスト –

  • 制限:
    • リクエストあたりのユーザーは最大25000人
    • ID値あたり最大100文字。

セグメントの更新

説明 既存のセグメントを更新
URL https://api.walkme.com/public/v1/user/system/{systemGuid}/segment/{segmentGuid}
メソッド PUT
ヘッダー uthorization – Bearer – jwt
systemGUID systemGuid- WalkMeシステムのGUID
segmentGuid –
WalkMe セグメントのGUID**SegmentGuidは、12345aeb-123c-4d83-8b38-a5a456789d0aのような、ハイフン付きの出力形式でURLに配置する必要があります。
ペイロード application/json
{  "action": <enum("add"|"remove"|"override")>,
  "userIds": [<string>]
}

ペイロードのパラメーター:

userIds: List of users ids - limit - 25k users

action: selected update mode, accept only "add","remove" or "override"

ペイロードの例:

{"action": "add",
  "userIds": ["[email protected]"]
}

セグメントの取得

説明 セグメントを取得します
URL https://api.walkme.com/public/v1/user/system/{systemGuid}/segment
ヘッダー Authorization – Bearer – jwt
URLパラメーター systemGuid – WalkMeのシステムGUID

セグメントが作成された後、エディタで、条件ビルダーが新しい外部セグメントで更新されるまでに10分ほどかかります。

APIで作成された特定のセグメントにユーザーIdが含まれるかどうかでコンテンツをセグメント化するには、条件ビルダーに移動して、ユーザー属性 → 外部セグメント → セグメント名 → IsまたはIs not → 「true」を選択します。

演算子には「Is」または「Is not」のみ使用し、入力フィールドには「true」を使用する必要があります(他のオプションではうまく動作しません)。

この記事は役に立ちましたか?

ご意見ありがとうございます!

Be part of something bigger.

Engage with peers, ask questions, share ideas

Ask the Community
×

アカウントタイプの選択

選ぶ
< 戻る

Mobile account login

< 戻る