Skip to content

NewsAPI

Jump to bottom
kishino edited this page Feb 28, 2022 · 4 revisions

お知らせ管理API

お知らせ管理APIは以下のメソッドを提供します。

以下のAPIはv1.2.0以降で、非推奨となりました。

ℹ️ v1.2.0より、お知らせの未読・既読情報の登録方法に新方式であるreadNewsが加わりました。readNewsで既読を登録すると、BaaS@rakuzaの管理者機能のお知らせ一覧にてお知らせの既読件数が管理できるようになります。

⚠️ v1.2.0より前のregistNewsReadHistoryは、v1.2.0との互換性はありません。そのためregistNewsReadHistoryを使って既読の登録を行なっている場合は、管理者機能のお知らせ一覧にお知らせの既読件数は表示されません。
また、registNewsReadHistoryを使用していたアプリケーションを、新方式のreadNewsに修正した場合、今までの既読情報は引き継がれないため、全てのお知らせ情報が未読状態として扱われます。

⚠️ v1.2.0にて追加されたreadNewsにてお知らせの既読を登録した場合、既読か未読かの状態を取得するのは、getNewsList、getSegmentNewsList、getReleasedNewsList、getReleasedSegmentNewsListにて取得します。
getNewsReadHistoryList、getNewsReadHistoryでは既読情報の取得は行えず、v1.2.0より前のregistNewsReadHistoryメソッドで登録した場合のみgetNewsReadHistoryList、getNewsReadHistoryメソッドで既読情報が取得できます。

既読登録API 既読情報の取得メソッド
registNewsReadHistory getNewsReadHistoryList
getNewsReadHistory
readNews getNewsList
getSegmentNewsList
getReleasedNewsList
getReleasedSegmentNewsList

getNewsListメソッド

全てのお知らせ情報を、リストで複数件取得します。

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

RKZClient.getNewsList(limit, searchConditions, sortConditions, extensionAttrribute, success, error);

  • limit: Number 取得件数

    取得件数の上限値を指定します。

    nullを指定すると、全件数取得します。

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

    検索条件を指定します。

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

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

  • extensionAttrribute: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 失敗時のコールバック関数

getPaginateNewsListメソッド

全てのお知らせ情報を、取得する件数 (limit) と取得する開始位置 (offset) を指定して、リストの形式で複数件数取得します。

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

RKZClient.getPaginateNewsList(limit, offset, searchConditions, sortConditions, extensionAttributes, success, error);

  • 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 失敗時のコールバック関数

getSegmentNewsListメソッド

セグメント(条件絞り込み)配信されたお知らせ情報を、リストで複数件取得します。

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

RKZClient.getSegmentNewsList(limit, userAccessToken, onlyMatchSegment, searchConditions, sortConditions, extensionAttribute, success, error);

  • limit: Number 取得件数

    取得件数の上限値を指定します。

    nullを指定すると、全件数取得します。

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

    セグメント配信を取得するユーザーのアクセストークンを指定します。

  • onlyMatchSegment: Boolean セグメント配信のみ取得有無 (必須)

    true
    セグメント配信のみ返却します。
    false
    全てのお知らせを返却します。

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

    検索条件を指定します。

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

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

  • extensionAttrribute: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 失敗時のコールバック関数

getPaginateSegmentNewsListメソッド

セグメント(条件絞り込み)配信されたお知らせ情報を、取得する件数 (limit) と取得する開始位置 (offset) を指定して、リストの形式で複数件数取得します。

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

RKZClient.getPaginateSegmentNewsList(limit, offset, userAccessToken, onlyMatchSegment, searchConditions, sortConditions, extensionAttributes, success, error);

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

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

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

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

    セグメント配信を取得するユーザーのアクセストークンを指定します。

  • onlyMatchSegment: Boolean セグメント配信のみ取得有無 (必須)

    true
    セグメント配信のみ返却します。
    false
    全てのお知らせを返却します。

  • 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 失敗時のコールバック関数

getReleasedNewsListメソッド

公開中のお知らせ情報のみを、リストで複数件取得します。

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

RKZClient.getReleasedNewsList(limit, searchConditions, sortConditions, extensionAttribute, success, error);

  • limit: Number 取得件数

    取得件数の上限値を指定します。

    nullを指定すると、全件数取得します。

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

    検索条件を指定します。

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

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

  • extensionAttrribute: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 失敗時のコールバック関数

getPaginateReleasedNewsListメソッド

公開中のお知らせ情報のみを、取得する件数 (limit) と取得する開始位置 (offset) を指定して、リストの形式で複数件数取得します。

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

RKZClient.getPaginateReleasedNewsList(limit, offset, searchConditions, sortConditions, extensionAttributes, success, error);

  • 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 失敗時のコールバック関数

getReleasedSegmentNewsListメソッド

セグメント(条件絞り込み)配信された公開中のお知らせ情報を、リストで複数件取得します。

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

RKZClient.getReleasedSegmentNewsList(limit, userAccessToken, onlyMatchSegment, searchConditions, sortConditions, extensionAttribute, success, error);

  • limit: Number 取得件数

    取得件数の上限値を指定します。

    nullを指定すると、全件数取得します。

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

    セグメント配信を取得するユーザーのアクセストークンを指定します。

  • onlyMatchSegment: Boolean セグメント配信のみ取得有無 (必須)

    true
    セグメント配信のみ返却します。
    false
    全てのお知らせを返却します。

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

    検索条件を指定します。

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

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

  • extensionAttrribute: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 失敗時のコールバック関数

getPaginateReleasedSegmentNewsListメソッド

セグメント(条件絞り込み)配信された公開中のお知らせ情報を、取得する件数 (limit) と取得する開始位置 (offset) を指定して、リストの形式で複数件数取得します。

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

RKZClient.getPaginateReleasedSegmentNewsList(limit, offset, userAccessToken, onlyMatchSegment, searchConditions, sortConditions, extensionAttributes, success, error);

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

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

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

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

    セグメント配信を取得するユーザーのアクセストークンを指定します。

  • onlyMatchSegment: Boolean セグメント配信のみ取得有無 (必須)

    true
    セグメント配信のみ返却します。
    false
    全てのお知らせを返却します。

  • 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 失敗時のコールバック関数

getNewsメソッド

お知らせ情報のキー情報を指定してお知らせ情報を一件取得します。

RKZClient.getNews(params, success, error);

  • params: Object お知らせキー情報オブジェクト

    {
    news_id: "1",
    tenant_id: "99999"
}

    • news_id String お知らせID (必須)

    • tenant_id String テナントID

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

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

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

getNewsReadHistoryListメソッド

ユーザーのお知らせ既読情報を全件取得します。

⚠️registNewsReadHistoryメソッドで登録したお知らせ既読情報のみ取得可能です。readNewsメソッドで登録したお知らせ既読情報は取得できません。

RKZClient.getNewsReadHistoryList(userAccessToken, success, error);

getNewsReadHistoryメソッド

お知らせ情報のキー情報を指定して、ユーザーのお知らせ既読情報を一件取得します。

⚠️registNewsReadHistoryメソッドで登録したお知らせ既読情報のみ取得可能です。readNewsメソッドで登録したお知らせ既読情報は取得できません。

RKZClient.getNewsReadHistory(params, userAccessToken, success, error);

  • params: Object お知らせキー情報オブジェクト

    {
    news_id: "1",
    tenant_id: "99999"
}

    • news_id String お知らせID (必須)

    • tenant_id String テナントID

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

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

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

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

registNewsReadHistoryメソッド

お知らせ既読情報の登録を行います。

⚠️本メソッドで登録したお知らせ既読情報は、getNewsReadHistoryメソッド、または、getNewsReadHistoryListメソッドで取得可能です。

RKZClient.registNewsReadHistory(params, userAccessToken, success, error);

  • params: Object お知らせ既読情報オブジェクト

    既読にする対象のお知らせ情報を設定します。

    {
    news_id: "1",
    tenant_id: "",
    read_date: "2017-01-24 13:00:00+0900"
}
    • news_id String お知らせID (必須)
    • tenant_id String テナントID
    • read_date Date 既読日時

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

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

    function(statusCode) {
    // 成功時の処理
}
    • statusCode: String 正常終了のステータスコード

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

readNewsメソッド

お知らせ既読情報の登録を行います。

⚠️本メソッドで登録したお知らせ既読情報は、getNewsListメソッド、getSegmentNewsListメソッド、getReleasedNewsListメソッド、getReleasedSegmentNewsListで、extensionAttributeのパラメータを指定することで取得可能です。

RKZClient.readNews(params, userAccessToken, success, error);

  • params: Object お知らせ既読情報オブジェクト

    既読にする対象のお知らせ情報を設定します。

    {
    news_id: "1",
}
    • news_id String お知らせID (必須)

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

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

    function(statusCode) {
    // 成功時の処理
}
    • statusCode: String 正常終了のステータスコード

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

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

リファレンス

Clone this wiki locally