Skip to content

UserDetailAPI

Jump to bottom
kishino edited this page Sep 29, 2022 · 2 revisions

ユーザー詳細管理API

ユーザー詳細管理APIは以下のメソッドを提供します。

getUserDetailListメソッド

BaaS@rakuzaに設定されているユーザー詳細を、リストで複数件取得します。

検索条件およびソート条件を指定して取得することも可能です。

RKZClient.getUserDetailList(objectId, userAccessToken, searchConditions, sortConditions, extensionAttributes, success, error);

  • objectId: String オブジェクトID (必須)

  • userAccessToken: String ユーザーアクセストークン (必須)

  • searchConditions: Array RKZSearchConditionオブジェクトの配列

    検索条件を指定します。

  • sortConditions: Array RKZSortConditionオブジェクトの配列

    ソート条件を指定します。

  • extensionAttributes:Object　ユーザー詳細取得時の拡張パラメータが指定できます。(任意)

    お気に入りとして登録された内容を取得する場合は、以下のパラメータを指定します。

    {
    user_access_token: "user_access_tokenXXX",
    show_favorite: ture,
    show_favorite_summary: ture
}

    • user_access_token: String ユーザーアクセストークン

    • show_favorite: Boolean

      お気に入りとして登録しているかの状況を取得する場合trueを設定します。

    • show_favorite_summary: Boolean

      ユーザー詳細をお気に入りとして登録したユーザーの件数を取得する場合trueを設定します。

    ℹ️ ユーザー詳細のお気に入りを管理するには、お気に入り管理APIを参照してください。

  • success: function 成功時コールバック関数

    function(datas) {
    // 成功時の処理
}

  • error: function 失敗時のコールバック関数

getPaginateUserDetailListメソッド

BaaS@rakuzaに設定されているユーザー詳細を、取得する件数 (limit) と取得する開始位置 (offset) を指定して、リストの形式で複数件数取得します。

検索条件およびソート条件を指定して、絞り込んだ結果にlimitとoffsetを指定することも可能です。

RKZClient.getPaginateUserDetailList(objectId, userAccessToken, limit, offset, searchConditions, sortConditions, extensionAttributes, success, error);

  • objectId: String オブジェクトID (必須)

  • userAccessToken: String ユーザーアクセストークン (必須)

  • limit: Number 取得する件数 (必須)

  • offset: Number 取得するデータの開始位置 (必須)

    0〜の開始位置 (レコード位置) を指定します。

  • searchConditions: Array RKZSearchConditionオブジェクトの配列

    検索条件を指定します。

  • sortConditions: Array RKZSortConditionオブジェクトの配列

    ソート条件を指定します。

  • extensionAttributes:Object　ユーザー詳細取得時の拡張パラメータが指定できます。(任意)

    お気に入りとして登録された内容を取得する場合は、以下のパラメータを指定します。

    {
    user_access_token: "user_access_tokenXXX",
    show_favorite: ture,
    show_favorite_summary: ture
}

    • user_access_token: String ユーザーアクセストークン

    • show_favorite: Boolean

      お気に入りとして登録しているかの状況を取得する場合trueを設定します。

    • show_favorite_summary: Boolean

      ユーザー詳細をお気に入りとして登録したユーザーの件数を取得する場合trueを設定します。

    ℹ️ ユーザー詳細のお気に入りを管理するには、お気に入り管理APIを参照してください。

  • success: function 成功時コールバック関数

    function(data) {
    // 成功時の処理
}

  • error: function 失敗時のコールバック関数

getUserDetailメソッド

BaaS@rakuzaに設定されているユーザー詳細を、ユーザー詳細IDを指定して一件取得します。

RKZClient.getUserDetail(objectId, userAccessToken, userDetailId, extensionAttributes, success, error);

  • objectId: String オブジェクトID (必須)

  • userAccessToken: String ユーザーアクセストークン (必須)

  • userDetailId: String ユーザー詳細ID (必須)

  • extensionAttributes:Object　ユーザー詳細取得時の拡張パラメータが指定できます。(任意)

    お気に入りとして登録された内容を取得する場合は、以下のパラメータを指定します。

    {
    user_access_token: "user_access_tokenXXX",
    show_favorite: ture,
    show_favorite_summary: ture
}

    • user_access_token: String ユーザーアクセストークン

    • show_favorite: Boolean

      お気に入りとして登録しているかの状況を取得する場合trueを設定します。

    • show_favorite_summary: Boolean

      ユーザー詳細をお気に入りとして登録したユーザーの件数を取得する場合trueを設定します。

    ℹ️ ユーザー詳細のお気に入りを管理するには、お気に入り管理APIを参照してください。

  • success: function 成功時コールバック関数

    function(data) {
    // 成功時の処理
}

  • error: function 失敗時のコールバック関数

addUserDetailメソッド

BaaS@rakuzaに設定されているユーザー詳細にデータを追加します。

RKZClient.addUserDetail(userDetail, userAccessToken, success, error);

editUserDetailメソッド

BaaS@rakuzaに設定されているユーザー詳細を、ユーザー詳細IDを指定して一件更新します。

RKZClient.editUserDetail(userDetail, userAccessToken, success, error);

deleteUserDetailメソッド

BaaS@rakuzaに設定されているユーザー詳細を、検索条件を指定して削除します。

RKZClient.deleteUserDetail(objectId, userAccessToken, searchConditions, success, error);

  • objectId: String オブジェクトID (必須)

  • userAccessToken: String ユーザーアクセストークン (必須)

  • searchConditions: Array RKZSearchConditionオブジェクトの配列

    削除条件を指定します。

  • success: function 成功時コールバック関数

    function(deleteCount) {
    // 成功時の処理
}
    • deleteCount: Number 削除データ件数

  • error: function 失敗時のコールバック関数

deleteAllUserDetailメソッド

BaaS@rakuzaに設定されているユーザー詳細を、すべて削除します。

RKZClient.deleteAllUserDetail(objectId, userAccessToken, success, error);

  • objectId: String オブジェクトID (必須)

  • userAccessToken: String ユーザーアクセストークン (必須)

  • success: function 成功時コールバック関数

    function(deleteCount) {
    // 成功時の処理
}
    • deleteCount: Number 削除データ件数

  • error: function 失敗時のコールバック関数

getSharedUserDetailListメソッド

公開されているユーザー詳細を、リストで複数件取得します。

検索条件およびソート条件を指定して取得することも可能です。

RKZClient.getSharedUserDetailList(objectId, userAccessToken, visibility, searchConditions, sortConditions, success, error);

getPaginateSharedUserDetailListメソッド

公開されているユーザー詳細を、取得する件数 (limit) と取得する開始位置 (offset) を指定して、リストの形式で複数件数取得します。

検索条件およびソート条件を指定して、絞り込んだ結果にlimitとoffsetを指定することも可能です。

RKZClient.getPaginateSharedUserDetailList(objectId, userAccessToken, limit, offset, visibility, searchConditions, sortConditions, success, error);

  • objectId: String オブジェクトID (必須)

  • userAccessToken: String ユーザーアクセストークン (必須)

  • limit: Number 取得する件数 (必須)

  • offset: Number 取得するデータの開始位置 (必須)

    0〜の開始位置 (レコード位置) を指定します。

  • visibility: Array 取得対象の公開範囲の配列

  • searchConditions: Array RKZSearchConditionオブジェクトの配列

    検索条件を指定します。

  • sortConditions: Array RKZSortConditionオブジェクトの配列

    ソート条件を指定します。

  • success: function 成功時コールバック関数

    function(data) {
    // 成功時の処理
}

  • error: function 失敗時のコールバック関数

getSharedUserDetailメソッド

公開されているユーザー詳細を、ユーザー詳細IDを指定して一件取得します。

RKZClient.getSharedUserDetail(objectId, userAccessToken, userDetailId, visibility, success, error);

  • objectId: String オブジェクトID (必須)

  • userAccessToken: String ユーザーアクセストークン (必須)

  • userDetailId: String ユーザー詳細ID (必須)

  • visibility: Array 取得対象の公開範囲の配列

  • success: function 成功時コールバック関数

    function(data) {
    // 成功時の処理
}

  • error: function 失敗時のコールバック関数

Copyright (c) people software corporation. All Rights Reserved.

リファレンス

Clone this wiki locally