Workplace from Metaは廃止されます。Workplaceは2025年8月31日まで今までどおりご利用いただけます。詳しくはヘルプセンターをご覧ください。

メンバー

パス`/{member-id}`

Workplaceコミュニティまたはグループのメンバーとしてのユーザーオブジェクトを表します。

パス: `/community/members`

現在のすべてのユーザーアカウントのリストを返します。仕事用プロフィールの管理のアクセス許可が必要です。

`external_id`に基づくフィルタリング

外部IDに基づいてユーザーのフィルタリングを実行するには、external_idsパラメーターを使用し、対象となるユーザーの外部IDのコンマ区切りリストを渡します。

パス: `/community/organization_members`

ユーザーのリストを返します。グループメンバーシップの読み取りのアクセス許可が必要です。デフォルトでは、アクティブユーザーアカウントのリストになります。inactive=1 URLパラメーターを使用すると、代わりに、利用解除されているユーザーアカウントを表示できます。

読み取り

Workplaceユーザーを表す単一のUserオブジェクトを返します。メンバーのWorkplace IDまたはメンバーがWorkplaceにログインするために使用するメールアドレスでアクセスできます。

/{member_id}
/{email_address}

アクセス許可

メンバーについての情報を読み取るには、仕事用プロフィールの読み取りまたはアカウントの管理のアクセス許可のいずれかが必要です。統合でアカウントの管理のアクセス許可が使用されていて、かつそのスコープが特定のグループの場合、一部のメンバーフィールドにはアクセスできなくなります。

フィールド

フィールド名	説明	型
`id`	この人のユーザーアカウントのID。	`string`
`first_name`	この人の名。	`string`
`last_name`	この人の姓。	`string`
`email`	この人の主要メールアドレス(Workplaceでユーザー名としても使用される)。	`string`
`title`	Workplaceにおけるこの人の肩書(アカウント管理APIで設定されている場合)。	`string`
`organization`	Workplaceにおけるこの人の組織(アカウント管理APIで設定されている場合)。	`string`
`division`	Workplaceにおけるこの人の部(アカウント管理APIで設定されている場合)。	`string`
`department`	Workplaceにおけるこの人の課(アカウント管理APIで設定されている場合)。	`string`
`primary_phone`	この人のリストに示される主要な電話番号。アカウント管理APIで`primary`のマークが付けられた`phoneNumbers`項目に対応します。	`string`
`primary_address`	この人のリストに示される主要な住所。アカウント管理APIで`primary`のマークが付けられた`addresses`項目に対応します	`string`
`picture`	この人のプロフィール写真。	`url`
`link`	この人のプロフィールへのリンク。	`url`
`locale`	この人のロケール。	`string`
`name`	この人のフルネーム。	`string`
`name_format`	この人の名前を、中国語、日本語、韓国語における順序で正しく処理できるような形式にしたもの。	`string`
`updated_time`	更新日時。	`datetime`
`account_invite_time`	アカウント招待時刻(UTC形式)。	`datetime`
`account_claim_time`	アカウント取得時刻(UTC形式)。	`datetime`
`account_deactivate_time`	アカウント閉鎖時刻(UTC形式)。	`datetime`
`external_id`	カスタマー定義のメンバーのID。各メンバーには、アカウント管理APIを使って設定された空でないexternal_id値が含まれることがあります。external_id属性の値がWorkplaceによって指定されることは決してありません。	`string`
`start_date`	この人の入社日時(アカウント管理APIによって設定されている場合)。	`datetime`
`about`	この人のバイオ。	`string`
`cost_center`	コストセンターの名前を識別します。	`string`
`impersonate_token`	統合で特定の人に代わって呼び出しを行えるようにするためのメンバーアクセストークン。なりすましは廃止されたアクセス許可です。このアクセス許可を使用して新しい機能を作成しないでください。このアクセス許可は、現在それを有効にしているカスタム統合からのみ使用可能です。	`string`
`claim_link`	Workplaceアカウントを取得するためにユーザーが使用できるリンクを提供します(未取得ユーザーのみ使用可能)。	`string`
`access_code`	Workplaceアカウントを取得するためにユーザーが使用できるアクセスコードを提供します(未取得ユーザーのみ使用可能)。	`string`
`work_locale`	ユーザーのロケール。これは、このユーザーのロケールを判別する別の手段(ブラウザーやデバイスの言語設定など)が使用可能になるまで、このユーザーのためにWorkplaceが使用するロケールです	`string` 有効な値は、ISO 639-1の2文字言語コード、下線文字、そしてISO 3166-1の2文字国コードを連結したものです。例えば、en_USは言語として英語、国としてUSを指定します。
`frontline`	ユーザーのフロントラインステータスについての情報	`object` (下記の例を参照)
`active`	ユーザーアカウントがアクティブかどうか	`boolean`

公開

アカウント管理API (グラフ)を参照

削除

アカウント管理API (グラフ)を参照

更新

アカウント管理API (グラフ)を参照

エッジ

エッジ名	説明
`/events`	この人のイベント。デフォルトの場合、この人が承認しなかったイベントも返信しなかったイベントも含まれません。
`/feed`	この人によって公開された投稿(ステータス更新を含む)やリンクのフィード。
`/conversations`	人またはボットページのWorkplaceメッセージ。特定の人のスレッドを表示するには、すべてのメッセージの読み取りのアクセス許可が必要です。
`/managers`	特定の人についてリスト表示されるマネージャ。
`/reports`	特定の人についてリスト表示される部下。
`/photos`	メンバーのプロフィール写真。
`/groups`	メンバーに関連するグループ。
`/phones`	メンバーに関連する電話番号。
`/skills`	メンバーのスキル。
`/badges`	ユーザーに贈られたバッジ
`/logout`	Workplaceからユーザーをログアウトします。`POST`のみ
`/remove_profile_information`	利用解除されたユーザーのプロフィール情報を削除します。`POST`のみ

例

コミュニティメンバーについての情報の取得

特定のメンバーの名前とメールアドレスを取得する。

GET /{member_id}?fields=email,name HTTP/1.1
Host: graph.facebook.com

メンバーのメールアドレスからそのメンバーのIDを取得する

GET /{email_address} HTTP/1.1
Host: graph.facebook.com

ユーザーの外部IDに基づいて会社メンバーのリストを出力する

GET /community/members?external_ids=12356,abc123 HTTP/1.1
Host: graph.facebook.com

利用解除されたアカウントを含めて会社メンバーのリストを出力する

GET /community/organization_members?inactive=1 HTTP/1.1
Host: graph.facebook.com

メンバーのイベントを取得する

GET graph.facebook.com
      /{member-id}/events

ユーザーのマネージャと部下についての情報の取得

特定のメンバーの部下を取得する

GET /{member_id}/reports HTTP/1.1
Host: graph.facebook.com

特定のメンバーのマネージャを取得する

GET /{member_id}/managers HTTP/1.1
Host: graph.facebook.com

メンバーのメッセージを取得する

メンバーのスレッドを取得する(メッセージ、送信元、添付ファイルを含む)

すべてのメッセージの読み取りのアクセス許可を付与されたカスタム統合トークンが必要です。

GET graph.facebook.com
      /{member-id}/conversations?fields=messages{message,attachments,from}

メンバーのスレッドIDをスレッドごとに取得する

すべてのメッセージの読み取りのアクセス許可を付与されたカスタム統合トークンが必要です。

GET graph.facebook.com
      /{member-id}/conversations

特定のユーザー、特定のスレッドIDのメッセージを取得する

すべてのメッセージの読み取りのアクセス許可を付与されたカスタム統合トークンが必要です。

GET graph.facebook.com
      /{thread-id}/messages?user={user-id}

ボットページのスレッドを取得する(メッセージおよび添付ファイルを含む)

GET graph.facebook.com
      /me/conversations?fields=messages{message,attachments}

カスタム統合トークンを使用する場合のボットのページに対する/meエイリアスポイント

カスタム統合トークンを使用して、メンバーの受信箱の中の特定のメッセージを削除する

チャットメッセージの削除のアクセス許可を付与されたカスタム統合トークンが必要です

DELETE graph.facebook.com
      /{message-id}?user={user-id}

メッセージを削除しても、リクエストで指定されたメンバーの表示からメッセージが削除されるだけです。メッセージを完全に削除するには、そのメッセージの各メンバーのビューを削除する必要があります。

メンバーの招待日時、およびアカウント取得日時を取得する

アカウント管理のアクセス許可を付与されたカスタム統合トークンが必要です。

GET graph.facebook.com
      /{member-id}?fields=account_invite_time,account_claim_time

これらのフィールドが存在するのは、そのメンバーが招待された場合またはアカウントを取得した場合だけです

メンバーのアカウントの閉鎖日時を取得する

アカウント管理のアクセス許可を付与されたカスタム統合トークンが必要です。

GET graph.facebook.com
      /{member-id}?fields=account_deactivate_time

これらのフィールドが存在するのは、そのメンバーのアカウントが閉鎖されている場合だけです

Workplaceからユーザーをログアウトさせる

ログアウトのアクセス許可を付与されたアクセストークンが必要です。

POST graph.facebook.com
      /{member-id}/logout

プロフィール写真を設定する

仕事用プロフィールの管理のアクセス許可を付与されたアクセストークンが必要です。このリクエストの中で、ファイルURLとファイルアップロードの両方がサポートされます。

POST graph.facebook.com
      /{member-id}/profile_pictures?
      image_url={...}&
      caption={...}

POST graph.facebook.com
      /{member-id}/profile_pictures?
      caption={...}
Content-Type: multipart/form-data;
Content-Disposition: form-data; name="image_data"; filename="/profile_picture.png

メンバーの携帯電話を追加する

仕事用プロフィールの管理のアクセス許可を付与されたアクセストークンが必要です。

POST graph.facebook.com
      /{member-id}/phones?
      type={...}&
      primary={...}&
      number={...}

メンバーのスキルを取得する

仕事用プロフィールの読み取りアクセス許可を付与されたアクセストークンが必要です。

GET graph.facebook.com
      /{member-id}/skills

スキルを追加する

仕事用プロフィールの管理のアクセス許可を付与されたアクセストークンが必要です。

POST graph.facebook.com
      /{member-id}/skills?name={...}

スキルを削除する

仕事用プロフィールの管理のアクセス許可を付与されたアクセストークンが必要です。

DELETE graph.facebook.com
      /{member-id}/skills?name={...}

メンバーのバッジを取得する

仕事用プロフィールの読み取りアクセス許可を付与されたアクセストークンが必要です。

GET graph.facebook.com
      /{member-id}/badges?fields=id,name,description,icon,category

組み込みバッジをユーザーに贈る

バッジの管理のアクセス許可を付与されたアクセストークンが必要です。使用可能なバッジとそのIDのリストの取得については、コミュニティのドキュメントをご覧ください。

POST graph.facebook.com
      /{member-id}/badges?badge=workplace_champion

カスタムバッジをユーザーに贈る

バッジの管理のアクセス許可を付与されたアクセストークンが必要です。使用可能なバッジとそのIDのリストの取得については、コミュニティのドキュメントをご覧ください。URLの中の#はURLエンコードする必要があることに注意してください。

POST graph.facebook.com
      /{member-id}/badges?badge=workplace_custom#{badge_id}

メンバーを利用解除する

ユーザーアカウントのプロビジョニングのアクセス許可を付与されたアクセストークンが必要です。

POST graph.facebook.com
      /{member-id}?active=false

メンバーを削除する

ユーザーアカウントのプロビジョニングのアクセス許可を付与されたアクセストークンが必要です。

DELETE graph.facebook.com
      /{member-id}

削除可能なのはアカウント未取得のメンバーのみです。

ユーザーのフロントラインステータスを取得する

GET graph.facebook.com
      /{user-id}?fields=frontline
      
    {
      "frontline": {
        "is_frontline": true
      },
    "id": "100038142594104"
    }

メンバー

パス/{member-id}

パス: /community/members

external_idに基づくフィルタリング

パス: /community/organization_members

読み取り

アクセス許可

フィールド

公開

削除

更新

エッジ

例

コミュニティメンバーについての情報の取得

特定のメンバーの名前とメールアドレスを取得する。

メンバーのメールアドレスからそのメンバーのIDを取得する

ユーザーの外部IDに基づいて会社メンバーのリストを出力する

利用解除されたアカウントを含めて会社メンバーのリストを出力する

メンバーのイベントを取得する

ユーザーのマネージャと部下についての情報の取得

特定のメンバーの部下を取得する

特定のメンバーのマネージャを取得する

メンバーのメッセージを取得する

メンバーのスレッドを取得する(メッセージ、送信元、添付ファイルを含む)

メンバーのスレッドIDをスレッドごとに取得する

特定のユーザー、特定のスレッドIDのメッセージを取得する

ボットページのスレッドを取得する(メッセージおよび添付ファイルを含む)

カスタム統合トークンを使用して、メンバーの受信箱の中の特定のメッセージを削除する

メンバーの招待日時、およびアカウント取得日時を取得する

メンバーのアカウントの閉鎖日時を取得する

Workplaceからユーザーをログアウトさせる

プロフィール写真を設定する

メンバーの携帯電話を追加する

メンバーのスキルを取得する

スキルを追加する

スキルを削除する

メンバーのバッジを取得する

組み込みバッジをユーザーに贈る

カスタムバッジをユーザーに贈る

メンバーを利用解除する

メンバーを削除する

ユーザーのフロントラインステータスを取得する

パス`/{member-id}`

パス: `/community/members`

`external_id`に基づくフィルタリング

パス: `/community/organization_members`