Partner tags機能について

[yosmoris]

• はじめに
• Tag付与手順
• Tagによる検索例
• 参考

 

 

はじめに

本記事では2023年5月に実装されたPartner tags機能について紹介します。
Partner hubを用いて顧客を管理するパートナー管理者にて顧客組織にTag情報を付与することで、Tagに応じた検索など細かな顧客管理を行うことが可能です。

 

 

Tag付与手順

1. Partner hubから、Tag付与対象となる顧客組織の組織IDを取得します。
Partner hub > Customers > 対象顧客を選択 > Org ID
 

2. developer.webex.comにアクセスします。

3. Log inをクリックし、パートナー管理者の権限を持つユーザでログインします。

必要なパートナー管理者権限は各API毎に記載があります。
例えばGet customer organization's tagsでは以下権限にて実行可能です。

• Partner full administrator
• Partner administrator
• Partner read-only administrator

Get customer organization's tags
Retrieve tags associated with a customer organization based on the orgId provided. This API can be used by a partner full admin, a read-only partner, or an partner admin.

パートナー管理者権限についての詳細はAssign administrator roles in Partner Hubをご参照下さい。

4. ログイン後、"Create or Replace existing customer tags with the provided ones"ページであることを確認し、orgIdにて"1"で取得したTag付与対象となる顧客組織の組織IDを入力します。

5. 以下のようなオブジェクトを作成し、Bodyに貼り付け、Runをクリックします。

[
  {
    "name": "by-yosmoris",
    "description": "org created by yosmoris"
  }
]

項目	説明	入力要否
name	任意のtag名を指定	必須
decription	tagの説明	任意

6. 200/OKのレスポンスが返ることを確認します。

 

 

Tagによる検索例

1. Fetch all customers for a given set of tagsにアクセスします。

2. tagsに先程作成したTag名を入力し、Runをクリックします。

 

3. 200/OKにて該当Tagを持つ顧客組織が返答されることを確認します。以下サンプルとなります。

{
  "customerTagsResponseBean": [
    {
      "orgName": ##組織名##,
      "orgId": ##組織ID##,
      "tags": [
        "by-yosmoris"
      ]
    }
  ]
}

 

本記事ではdeveloper.webex.com内で可能な方法にてご紹介しておりますが、REST APIをコール可能なPostmanなどでも同様の操作が可能です。Postmanの利用方法についてはWebex API の動作を Postman で確認する方法などをご参照下さい。

 

参考

Create or Replace existing customer tags with the provided ones
Get customer organization's tags
Assign administrator roles in Partner Hub
Fetch all customers for a given set of tags
Webex API の動作を Postman で確認する方法