SOAP API 開発者ガイド
j記事
記事には、知識ベースで入手できるようにする会社の商品およびサービスに関する情報が取り込まれます。知識ベースの記事を 1 つ以上のデータカテゴリに分類することにより、ユーザは必要な記事を見つけやすくなります。管理者は、データカテゴリを使用して記事へのアクセスを制御します。
- 記事タイプ
- Salesforce ナレッジのすべての記事は 1 つの記事タイプに割り当てられます。記事のタイプは、記事が含むコンテンツのタイプ、外観、および記事にアクセスできるユーザを特定します。たとえば、単純な FAQ の記事タイプには、[質問] および [回答] の 2 つのカスタム項目があり、記事マネージャが FAQ の記事の作成または更新時にそこにデータを入力します。より複雑な記事タイプでは、複数のセクションに分かれた多数の項目が必要な場合があります。レイアウトおよびテンプレートを使用することで、管理者は特定のコンテンツに対して最も効果的な方法で記事タイプを構築できます。記事タイプへのユーザのアクセスは権限によって制御されます。各記事タイプについて、管理者は「作成」、「参照」、「編集」、または「削除」権限をユーザに与えることができます。たとえば、記事マネージャが内部ユーザには FAQ を参照、作成、編集できるようにするけれども、パートナーユーザには FAQ の参照のみを可能にする場合などです。
- 記事タイプレイアウト
- 記事タイプレイアウトを使用して、管理者は記事に表示される項目を構成するセクションを作成し、ユーザが表示および編集可能な項目を選択できます。記事タイプごとに 1 つのレイアウトが使用可能です。管理者は、記事タイプの詳細ページからレイアウトを変更します。
- 記事タイプテンプレート
- 記事タイプテンプレートでは、記事タイプレイアウトでのセクションの表示方法を指定します。記事タイプは、その 4 つのチャネルそれぞれに異なるテンプレートを使用できます。たとえば、FAQ の記事タイプの [カスタマーポータル] チャネルをタブテンプレートに割り当てると、FAQ のレイアウトのセクションが、顧客が FAQ の記事を表示するときにタブとして表示されます。目次テンプレートの場合は、レイアウトで定義したセクションが、記事が表示されたときに 1 つのページにハイパーリンクと共に表示されます。Salesforce は、タブと目次の 2 つの標準記事タイプテンプレートを提供します。カスタムテンプレートは Visualforce で作成できます。
- チャネル
- チャネルとは、記事を利用可能にする媒体を指します。Salesforce ナレッジでは、記事を利用可能にできるチャネルを 4 つ提供しています。
- 内部アプリケーション: Salesforce のユーザが、ロールの表示設定に応じて [記事] タブで記事にアクセスできます。
- カスタマー: [記事] タブがコミュニティまたはカスタマーポータルで使用可能な場合、顧客が記事にアクセスできます。カスタマーユーザは、取引先でのマネージャのロール表示設定を継承します。コミュニティでは、カスタマーコミュニティまたはカスタマーコミュニティプラスライセンスを持つユーザのみが記事を使用できます。
- パートナー: [記事] タブがコミュニティまたはカスタマーポータルで使用可能な場合、パートナーが記事にアクセスできます。パートナーユーザは、取引先でのマネージャのロール表示設定を継承します。コミュニティでは、パートナコミュニティライセンスを持つユーザのみが記事を使用できます。
- 公開知識ベース: 記事は、AppExchange から Salesforce ナレッジのサンプル公開知識ベースアプリケーションを使用して公開知識ベースを作成することで、匿名ユーザに公開できます。公開知識ベースの作成には、サイトおよび Visualforce が必要です。
- 公開サイクル
- Salesforce ナレッジ記事は公開サイクルの作成から削除までの段階を移行していきます。公開サイクルには、3 つの異なる状況があります。Draft は、新しい記事が作成されるか既存の記事が更新される段階です。状況が Online である記事は、公開済みで、他のチャネルで利用できるようになったドラフト記事です。最後に、公開記事がサイクルの最終段階になると、Archived 状況に移行するか、または Draft に戻り後続のバージョンで更新されます。
API での記事の使用
記事は、API の KnowledgeArticleVersion オブジェクトおよび KnowledgeArticle オブジェクトを使用して利用できます。これらのオブジェクトは両方とも記事を表示しますが、異なる機能を提供します。
- KnowledgeArticleVersion
- Salesforce ナレッジの新しいドラフト記事には必ずバージョン番号があります。記事を公開しており、その記事を更新する必要がある場合は、個別のバージョン番号で新しい Draft を作成できます。各バージョンには独自の ID があります。更新されたバージョンを公開する準備が整ったら、前のバージョンと置き換え、バージョン番号を更新します。KnowledgeArticleVersion オブジェクトを使用して、記事バージョンの内容にアクセスしたり、Draft 状況または Online 状況で絞り込むことができます。たとえば、次のクエリではすべての記事タイプのすべての記事の Draft バージョンのタイトルをアメリカ英語で返します。
1SELECT Title 2FROM KnowledgeArticleVersion 3WHERE PublishStatus='Draft' 4AND language ='en_US'言語を変更して、知識ベースがサポートするその他の言語を返すようにすることができます。Salesforce オンラインヘルプの「マルチ言語の知識ベースの設定」を参照してください。
また、記事には記事番号が自動的に割り当てられます。この番号は個々の記事に対しては一意の ID ではありませんが、マスタ記事および利用可能なすべての翻訳に対しては 1 つの ID です。
- KnowledgeArticle
- KnowledgeArticleVersion とは異なり、KnowledgeArticle レコードの ID は、記事のバージョン (状況) に関係なく同じです。KnowledgeArticleVersion オブジェクトでは記事のカスタム項目値への API アクセスを提供する場合、KnowledgeArticle オブジェクトでは記事のメタデータ項目への API アクセスを提供します。
記事レコードは、公開の状況 (ドラフト、公開、アーカイブ済み) や言語を問わず、記事のすべてのバージョンの親コンテナです。KnowledgeArticle および KnowledgeArticleVersion では、知識ベースの任意の記事を表しますが、<Article Type>__ka および <Article Type>__kav はそれぞれ、特定の記事タイプの KnowledgeArticle (「__ka」サフィックス) および KnowledgeArticleVersion (「__kav」サフィックス) を具体的に表します。たとえば、Offer__kav はすべての Offer 記事へのアクセスを提供します。KnowledgeArticle および <Article Type>__ka はバージョンとは無関係に記事へのアクセスを提供します。KnowledgeArticleVersion および <ArticleType>__kav を使用すると、特定の記事のバージョンおよびそのすべての標準項目 (KnowledgeArticleVersion) およびカスタム項目 (<ArticleType>__kav) を取得できます。次のクエリでは、公開されたすべての Offer のタイトルがアメリカ英語で返されます。
1SELECT Title
2FROM Offer__kav
3WHERE PublishStatus='online'
4AND language ='en_US'次の表に、記事で作業するための API リソースのリストを示します。
| 名前 | 型 | 説明 |
|---|---|---|
| [記事タイプ]__DataCategorySelection | オブジェクト | 記事を分類するデータカテゴリを表します。 |
| [記事タイプ]__ka | オブジェクト | バージョンとは関係なく特定の記事タイプの記事へのアクセスを提供します。このオブジェクトは参照のみであるため、SOQL 句または WITH DATA CATEGORY DataCategorySpec SOSL 句では使用できません。詳細は、「KnowledgeArticle」を参照してください。 |
| [記事タイプ]__kav | オブジェクト | バージョンに応じて特定の記事タイプのすべての記事へのアクセスを提供します。このオブジェクトは、KnowledgeArticleVersion で使用可能な項目へのアクセスを提供します。詳細は、「KnowledgeArticleVersion」を参照してください。 |
| [記事タイプ]__Feed | オブジェクト | 記事の詳細ページに表示されるフィード内の単一フィード項目を表します。 |
| [記事タイプ]__ViewStat | オブジェクト | 特定の記事タイプの記事の参照回数の統計情報を提供します。詳細は、「KnowledgeArticleViewStat」を参照してください。 |
| [記事タイプ]__VoteStat | オブジェクト | 特定の記事タイプの記事の加重評価を 1 - 5 のスケールで提供します。詳細は、「KnowledgeArticleVoteStat」を参照してください。 |
| CaseArticle | オブジェクト | Case と KnowledgeArticle との間の関連を表します。 |
| FeedComment | オブジェクト | ユーザがフィードに追加したコメントを表します。このオブジェクトは、API バージョン 18.0 以降で使用できます。 |
| FeedItem | オブジェクト | FeedItem は、レコードフィードの変更 (テキスト投稿、リンク投稿、およびコンテンツ投稿を含む) などのフィードのエントリを表します。このオブジェクトは、API バージョン 21.0 以降で使用できます。このオブジェクトは FeedPost に代わって使用されます。 |
| KnowledgeArticle | オブジェクト | バージョンとは関係なく記事へのアクセスを提供します。このオブジェクトは参照のみであるため、SOQL 句または WITH DATA CATEGORY DataCategorySpec SOSL 句では使用できません。 |
| KnowledgeArticleVersion | オブジェクト | バージョンに応じて、すべての記事タイプを対象に記事の標準項目のグローバルな参照を提供します。このオブジェクトは、API バージョン 18.0 以降で使用できます。 |
| KnowledgeArticleViewStat | オブジェクト | すべての記事タイプを対象に指定記事の参照回数に関する統計情報を提供します。このオブジェクトは参照のみで、API バージョン 20 以降で使用できます。 |
| KnowledgeArticleVoteStat | オブジェクト | すべての記事タイプを対象に指定記事の加重評価を 1 - 5 のスケールで提供します。このオブジェクトは参照のみで、API バージョン 20 以降で使用できます。 |
| NewsFeed | オブジェクト | ユーザのホームの単一フィード項目を表します。Chatter フィードでは、ユーザがフォローするレコードに対する最新の変更が表示されます。 |
| UserProfileFeed | オブジェクト | ユーザプロファイルフィードを表します。このフィードは、フィード内で追跡可能なレコードに対するユーザによるすべてのアクションを追跡します。このフィードは、ユーザプロファイルページに表示されます。 |
| WITH DATA CATEGORY filteringExpression | SOQL 句 | 公開サイクルおよびデータカテゴリの状況に応じて記事を分類します。詳細は、『Salesforce SOQL および SOSL リファレンスガイド』を参照してください。 |
| WITH DATA CATEGORY DataCategorySpec | SOSL 句 | カテゴリに基づいて記事を検索します。詳細は、『Salesforce SOQL および SOSL リファレンスガイド』を参照してください。 |
