Recommendations クラス

API バージョン

33.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.RecommendationCollection getRecommendationForUser(String communityId, String userId, ConnectApi.RecommendationActionType action, String objectId)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

userId

型: String

コンテキストユーザの ID またはキーワード me。

action

型: ConnectApi.​RecommendationActionType

おすすめに対して実行するアクションを指定します。

• follow — ファイル、レコード、またはユーザをフォローします。
• join — グループに参加します。
• view — ファイル、グループ、レコード、ユーザ、またはカスタムおすすめを表示します。

objectId

型: String

アクションを実行するオブジェクトを指定します。

• action が follow の場合、objectId は、ユーザ ID、ファイル ID、またはレコード ID です。
• action が join の場合、objectId はグループ ID です。
• action が view の場合、objectId は、ユーザ ID、ファイル ID、グループ ID、レコード ID、またはカスタムのおすすめ ID です (バージョン 34.0 以降)。

戻り値

型: ConnectApi.RecommendationCollection

API バージョン

33.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.RecommendationCollection getRecommendationsForUser(String communityId, String userId, ConnectApi.RecommendationActionType contextAction, String contextObjectId, Integer maxResults)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

userId

型: String

コンテキストユーザの ID またはキーワード me。

contextAction

型: ConnectApi.​RecommendationActionType

コンテキストユーザが直前に実行したアクション。サポートされている値は、次のとおりです。

• follow
• view

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

contextObjectId

型: String

コンテキストユーザが直前に実行したアクションのオブジェクトの ID。

• contextAction が follow の場合、contextObjectId は、ユーザ ID、ファイル ID、またはレコード ID です。
• contextAction が view の場合、contextObjectId は、ユーザ ID、ファイル ID、グループ ID、またはレコード ID です。

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

maxResults

型: Integer

おすすめの結果の最大数。デフォルトは 10 です。値は 0 よりも大きくする必要があります。

戻り値

型: ConnectApi.RecommendationCollection

使用方法

実行された最新のアクション (ユーザのフォローなど) に基づいておすすめを取得するには、contextAction と contextObjectId を一緒に使用します。たとえば、直前に Pam をフォローした場合、contextAction に follow、contextObjectId に Pam のユーザ ID を指定します。

この方法により、Pam をフォローするユーザがフォローしているユーザのみが推奨されます。この例では、John が Pam をフォローしており、John は Suzanne もフォローしているため、Suzanne をフォローするためのおすすめが返されます。

API バージョン

33.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.RecommendationCollection getRecommendationsForUser(String communityId, String userId, ConnectApi.RecommendationActionType action, ConnectApi.RecommendationActionType contextAction, String contextObjectId, Integer maxResults)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

userId

型: String

コンテキストユーザの ID またはキーワード me。

action

型: ConnectApi.​RecommendationActionType

おすすめに対して実行するアクションを指定します。

• follow — ファイル、レコード、またはユーザをフォローします。
• join — グループに参加します。
• view — ファイル、グループ、レコード、ユーザ、またはカスタムおすすめを表示します。

contextAction

型: ConnectApi.​RecommendationActionType

コンテキストユーザが直前に実行したアクション。サポートされている値は、次のとおりです。

• follow
• view

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

contextObjectId

型: String

コンテキストユーザが直前に実行したアクションのオブジェクトの ID。

• contextAction が follow の場合、contextObjectId は、ユーザ ID、ファイル ID、またはレコード ID です。
• contextAction が view の場合、contextObjectId は、ユーザ ID、ファイル ID、グループ ID、またはレコード ID です。

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

maxResults

型: Integer

おすすめの結果の最大数。デフォルトは 10 です。値は 0 よりも大きくする必要があります。

戻り値

型: ConnectApi.RecommendationCollection

使用方法

実行された最新のアクション (ユーザのフォローなど) に基づいておすすめを取得するには、contextAction と contextObjectId を一緒に使用します。たとえば、直前に Pam をフォローした場合、contextAction に follow、contextObjectId に Pam のユーザ ID を指定します。

この方法により、Pam をフォローするユーザがフォローしているユーザのみが推奨されます。この例では、John が Pam をフォローしており、John は Suzanne もフォローしているため、Suzanne をフォローするためのおすすめが返されます。

API バージョン

33.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.RecommendationCollection getRecommendationsForUser(String communityId, String userId, ConnectApi.RecommendationActionType action, String objectCategory, ConnectApi.RecommendationActionType contextAction, String contextObjectId, Integer maxResults)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

userId

型: String

コンテキストユーザの ID またはキーワード me。

action

型: ConnectApi.​RecommendationActionType

おすすめに対して実行するアクションを指定します。

• follow — ファイル、レコード、またはユーザをフォローします。
• join — グループに参加します。
• view — ファイル、グループ、レコード、ユーザ、またはカスタムおすすめを表示します。

objectCategory

型: String

• action が follow の場合、objectCategory は users、files、または records になります。
• action が join の場合、objectCategory は groups になります。
• action が view の場合、objectCategory は users、files、groups、records、または custom になります。

オブジェクト ID の先頭 3 文字のキープレフィックスを objectCategory として指定することもできます。有効な値は、次のとおりです。

• action が follow の場合、objectCategory は 005 (ユーザ)、069 (ファイル)、または 001 (取引先) です。
• action が join の場合、objectCategory は 0F9 (グループ) です。
• action が view の場合、objectCategory は 005 (ユーザ)、069 (ファイル)、0F9 (グループ)、0RD (カスタムおすすめ)、または 001 (取引先) です。

contextAction

型: ConnectApi.​RecommendationActionType

コンテキストユーザが直前に実行したアクション。サポートされている値は、次のとおりです。

• follow
• view

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

contextObjectId

型: String

コンテキストユーザが直前に実行したアクションのオブジェクトの ID。

• contextAction が follow の場合、contextObjectId は、ユーザ ID、ファイル ID、またはレコード ID です。
• contextAction が view の場合、contextObjectId は、ユーザ ID、ファイル ID、グループ ID、またはレコード ID です。

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

maxResults

型: Integer

おすすめの結果の最大数。デフォルトは 10 です。値は 0 よりも大きくする必要があります。

戻り値

型: ConnectApi.RecommendationCollection

使用方法

実行された最新のアクション (ユーザのフォローなど) に基づいておすすめを取得するには、contextAction と contextObjectId を一緒に使用します。たとえば、直前に Pam をフォローした場合、contextAction に follow、contextObjectId に Pam のユーザ ID を指定します。

この方法により、Pam をフォローするユーザがフォローしているユーザのみが推奨されます。この例では、John が Pam をフォローしており、John は Suzanne もフォローしているため、Suzanne をフォローするためのおすすめが返されます。

API バージョン

33.0

Chatter が必要かどうか

はい

署名

public static rejectRecommendationForUser(String communityId, String userId, ConnectApi.RecommendationActionType action, String objectId)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

userId

型: String

コンテキストユーザの ID またはキーワード me。

action

型: ConnectApi.​RecommendationActionType

おすすめに対して実行するアクションを指定します。サポートされている値は、次のとおりです。

• follow — ファイル、レコード、またはユーザをフォローします。
• join — グループに参加します。
• view — ファイル、グループ、レコード、ユーザ、またはカスタムおすすめを表示します。

objectId

型: String

アクションを実行するオブジェクトを指定します。

• action が follow の場合、objectId は、ユーザ ID、ファイル ID、またはレコード ID です。
• action が join の場合、objectId はグループ ID です。
• action が view の場合、objectId はカスタムおすすめ ID です。

戻り値

型: Void

API バージョン

34.0

Chatter が必要かどうか

はい

署名

public static rejectRecommendationForUser(String communityId, String userId, ConnectApi.RecommendationActionType action, ConnectApi.RecommendedObjectType objectEnum)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

userId

型: String

コンテキストユーザの ID またはキーワード me。

action

型: ConnectApi.​RecommendationActionType

おすすめに対して実行するアクションを指定します。サポートされている値は、次のとおりです。

• view — 静的なおすすめを表示します。

objectEnum

型: ConnectApi.​RecommendedObjectType

アクションを実行するオブジェクト種別を指定します。

• Today — ID のない静的なおすすめ (Today アプリケーションのおすすめなど)。

戻り値

型: Void

API バージョン

33.0

Chatter が必要かどうか

はい

署名

public static Void setTestGetRecommendationForUser(String communityId, String userId, ConnectApi.RecommendationActionType action, String objectId, ConnectApi.RecommendationCollection result)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

userId

型: String

コンテキストユーザの ID またはキーワード me。

action

型: ConnectApi.​RecommendationActionType

おすすめに対して実行するアクションを指定します。

• follow — ファイル、レコード、またはユーザをフォローします。
• join — グループに参加します。
• view — ファイル、グループ、レコード、ユーザ、またはカスタムおすすめを表示します。

objectId

型: String

アクションを実行するオブジェクトを指定します。

• action が follow の場合、objectId は、ユーザ ID、ファイル ID、またはレコード ID です。
• action が join の場合、objectId はグループ ID です。
• action が view の場合、objectId は、ユーザ ID、ファイル ID、グループ ID、レコード ID、またはカスタムおすすめ ID です。

result

型: ConnectApi.RecommendationCollection

テストデータを含むオブジェクト。

戻り値

型: Void

API バージョン

33.0

Chatter が必要かどうか

はい

署名

public static Void setTestGetRecommendationsForUser(String communityId, String userId, ConnectApi.RecommendationActionType contextAction, String contextObjectId, Integer maxResults, ConnectApi.RecommendationCollection result)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

userId

型: String

コンテキストユーザの ID またはキーワード me。

contextAction

型: ConnectApi.​RecommendationActionType

コンテキストユーザが直前に実行したアクション。サポートされている値は、次のとおりです。

• follow
• view

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

contextObjectId

型: String

コンテキストユーザが直前に実行したアクションのオブジェクトの ID。

• contextAction が follow の場合、contextObjectId は、ユーザ ID、ファイル ID、またはレコード ID です。
• contextAction が view の場合、contextObjectId は、ユーザ ID、ファイル ID、グループ ID、またはレコード ID です。

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

maxResults

型: Integer

おすすめの結果の最大数。デフォルトは 10 です。値は 0 よりも大きくする必要があります。

result

型: ConnectApi.RecommendationCollection

テストデータを含むオブジェクト。

戻り値

型: Void

API バージョン

33.0

Chatter が必要かどうか

はい

署名

public static Void setTestGetRecommendationsForUser(String communityId, String userId, ConnectApi.RecommendationActionType action, ConnectApi.RecommendationActionType contextAction, String contextObjectId, Integer maxResults, ConnectApi.RecommendationCollection result)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

userId

型: String

コンテキストユーザの ID またはキーワード me。

action

型: ConnectApi.​RecommendationActionType

おすすめに対して実行するアクションを指定します。

• follow — ファイル、レコード、またはユーザをフォローします。
• join — グループに参加します。
• view — ファイル、グループ、レコード、ユーザ、またはカスタムおすすめを表示します。

contextAction

型: ConnectApi.​RecommendationActionType

コンテキストユーザが直前に実行したアクション。サポートされている値は、次のとおりです。

• follow
• view

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

contextObjectId

型: String

コンテキストユーザが直前に実行したアクションのオブジェクトの ID。

• contextAction が follow の場合、contextObjectId は、ユーザ ID、ファイル ID、またはレコード ID です。
• contextAction が view の場合、contextObjectId は、ユーザ ID、ファイル ID、グループ ID、またはレコード ID です。

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

maxResults

型: Integer

おすすめの結果の最大数。デフォルトは 10 です。値は 0 よりも大きくする必要があります。

result

型: ConnectApi.RecommendationCollection

テストデータを含むオブジェクト。

戻り値

型: Void

API バージョン

33.0

Chatter が必要かどうか

はい

署名

public static Void setTestGetRecommendationsForUser(String communityId, String userId, ConnectApi.RecommendationActionType action, String objectCategory, ConnectApi.RecommendationActionType contextAction, String contextObjectId, Integer maxResults, ConnectApi.RecommendationCollection result)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

userId

型: String

コンテキストユーザの ID またはキーワード me。

action

型: ConnectApi.​RecommendationActionType

おすすめに対して実行するアクションを指定します。

• follow — ファイル、レコード、またはユーザをフォローします。
• join — グループに参加します。
• view — ファイル、グループ、レコード、ユーザ、またはカスタムおすすめを表示します。

objectCategory

型: String

• action が follow の場合、objectCategory は users、files、または records になります。
• action が join の場合、objectCategory は groups になります。
• action が view の場合、objectCategory は users、files、groups、records、または custom になります。

オブジェクト ID の先頭 3 文字のキープレフィックスを objectCategory として指定することもできます。有効な値は、次のとおりです。

• action が follow の場合、objectCategory は 005 (ユーザ)、069 (ファイル)、または 001 (取引先) です。
• action が join の場合、objectCategory は 0F9 (グループ) です。
• action が view の場合、objectCategory は 005 (ユーザ)、069 (ファイル)、0F9 (グループ)、0RD (カスタムおすすめ)、または 001 (取引先) です。

contextAction

型: ConnectApi.​RecommendationActionType

コンテキストユーザが直前に実行したアクション。サポートされている値は、次のとおりです。

• follow
• view

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

contextObjectId

型: String

コンテキストユーザが直前に実行したアクションのオブジェクトの ID。

• contextAction が follow の場合、contextObjectId は、ユーザ ID、ファイル ID、またはレコード ID です。
• contextAction が view の場合、contextObjectId は、ユーザ ID、ファイル ID、グループ ID、またはレコード ID です。

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

maxResults

型: Integer

おすすめの結果の最大数。デフォルトは 10 です。値は 0 よりも大きくする必要があります。

result

型: ConnectApi.RecommendationCollection

テストデータを含むオブジェクト。

戻り値

型: Void