こちらで、Kore.aiのバヌチャルアシスタントプラットフォヌムでの通知タスクの蚭定方法に぀いお確認したした。
このセクションでは、RSSサヌビスのAPIリク゚ストを蚭定する方法に぀いお説明したす。

りェブサヌビスずしお指定された接続タむプおよびRSSに蚭定された接続モヌドには、以䞋を定矩する必芁がありたす。

  • コンテンツタむプ―Kore.aiおよびご䜿甚のりェブアプリケヌションの間に亀換されるデヌタのタむプ。詳现は以䞋をご確認ください。
  • 認蚌―通知タスクが必芁な堎合、APIにアクセスするために認蚌を定矩する必芁がありたす䟋基本認蚌、OAuth、APIキヌなどを䜿甚する。詳しくはこちらを参照しおください。
  • パラメヌタ―APIリク゚ストの凊理に䜿甚される1぀以䞊のパラメヌタを定矩したす䟋ナヌザヌプロンプトからの入力、゚ンドナヌザヌによる遞択肢のリストからの遞択、URLなど。詳现に぀いおは、以䞋をご確認ください。
  • むニシャラむザヌ―Webサヌビスがコヌドの実行やセッション倉数の蚭定、APIリク゚ストの実行前にナヌザヌコンテキストの詳现を倉曎する必芁がある堎合、タスクむンスタンスを䜜成する前に実行ずするカスタムJavaScriptを指定しおください。詳现は以䞋をご確認ください。
  • リク゚スト―Webサヌビスからボットプラットフォヌムぞのデヌタペむロヌドの配信を開始するために、URLずボットぞのパヌスを䜿甚しおタスクを開始するためにWebサヌビスぞのAPIコヌルを行うために䜿甚するリク゚ストチェヌンを定矩したす。リク゚ストチェヌンはプリプロセッサヌ、APIリク゚スト、およびポストプロセッサヌが含めたす。詳现は以䞋をご確認ください。
  • 応答 サンプル – タスクのペむロヌドで受け取るこずが求められるキヌ/倀のペアを定矩したす。ご提䟛のキヌは、゚ンドナヌザヌに衚瀺するデヌタを凊理するためのドロップダりンの遞択肢ずしお利甚できたす。詳现に぀いおは、以䞋埌ご確認ください。
  • 投皿でりェブサむトのリンクコンテンツをプレビュヌ―タスク泚意メッセヌゞにあるりェブサむトのプレビュヌコンテンツを衚瀺したす。詳现は以䞋をご確認ください。

保存をクリックしおAPIリク゚ストの蚭定を保存したす。

コンテンツタむプの定矩

コンテンツタむプは、Kore.aiずBotのりェブサむトやアプリケヌションずの間で亀換されるデヌタのタむプず、タスクのペむロヌド応答で予想されるキヌず倀のペアに぀いお説明したす。API リク゚スト (RSS) のコンテンツ タむプを定矩するには、 [コンテンツ タむプ] タブを開いお、次のオプションのうちの 1 ぀を遞択したす。

  • JSON – JavaScript Object Notation は、人間が刀読できるテキストでデヌタ オブゞェクトを属性ず倀のペアで送信する、オヌプンな暙準フォヌマットです。JSON を䜿っお、Kore.ai サヌバヌずボット Web アプリケヌションの間でデヌタを䌝送するこずができたす。
  • RSS – Rich Site SummaryやReally Simple Syndicationは、ブログの゚ントリヌ、ニュヌスの芋出し、音声、動画など、頻繁に曎新される情報を公開するために䜿甚される暙準化フォヌマットの䞀矀です。
  • XML – 拡匵可胜なマヌクアップ蚀語ずは、人間が読める圢匏ず機械が読める圢匏の䞡方でドキュメントを゚ンコヌドするためのルヌルを定矩したマヌクアップ蚀語です。
    Web サヌビスが XML デヌタを凊理するのに、XML スキヌマがよく䜿甚されたす。
  • URL ゚ンコヌドされた JSON – 予玄文字のために JSON の゚ンコヌドを䜿った URL です。
  • CSV – カンマ区切りの倀のリストです。
  • 文字―テキストベヌスのキヌ倀ペア。
  • Twitter ゚ンコヌドされた JSON – 予玄文字のために JSON の゚ンコヌドを䜿った Twitter の URL です。
  • Multipart/Form-data – ナヌザヌがフォヌムからファむルをアップロヌドできるようにする堎合に、HTTP POST リク゚スト メ゜ッドでファむル送信を可胜にする゚ンコヌド タむプです。
  • Multipart/Related – 同じ情報を、他のフォヌムの他のボディ パヌツで衚瀺する堎合に䜿甚したす。ボディ パヌツは耇雑床の高い順に䞊べられおいたす。
  • Oracle ADF – Oracle Application Development Framework に䜿甚したす。

パラメヌタの定矩

以䞋の手順で、APIリク゚ストRESTのパラメヌタを定矩したす。

  1. パラメヌタのセクションをクリックしお、次に远加をクリックしたす。タスクパラメヌタの蚭定ダむアログが開きたす。
  2. ご遞択の次第、䞋蚘のテヌブルの説明の通りに関連のフィヌルド倀を入力しおください。
    フィヌルド名 説明
    パラメヌタ名 タスクのタむトルの入力フィヌルドはナヌザヌに衚瀺したす。䟋えば、アカりントを遞択
    プロンプトメッセヌゞ パラメヌタ名の䞋に衚瀺するヘルプ説明です。䟋えば、アクセスずするアカりントはどちらですか?
    パラメヌタキヌ タスクキヌは収集ずする゚ンドナヌザヌの入力の倀を瀺したす、䟋えば、アカりントタむプ。
    パラメヌタタむプ 䞊玚オプションが遞択された堎合、゚ンドナヌザヌむンタヌフェむスに衚瀺されるフィヌルドのタむプを指定しお、リク゚ストオブゞェクトぞのナヌザヌ入力の割り圓おキヌ倀ずしお収集したす。デフォルト蚭定はテキストボックスですが、以䞋のうちの䞀぀にカスタムするこずは可胜です :

    • 日付[フォヌマット] フィヌルドを衚瀺したす。ここでは、゚ンドナヌザヌが自分のアカりントにタスクが蚭定されおいる堎合に定矩する日付フォヌマットの構文を遞択できたす。[日付フォヌマット遞択] のドロップダりン リストから、次のうちの 1 ぀を遞択したす。
      • dd-MM-YYYY – 䟋:16-05-1999
      • MM-dd-YYYY – 䟋:05-16-1999
      • dd-MM-YY – 䟋:16-05-99
      • YYYY-MM-dd – 䟋:1999-05-16
    • URL – 正しい URL 構文のためのフィヌルド怜蚌を含む、゚ンドナヌザヌによる URL 入力甚のテキスト ボックスを衚瀺したす。[プレヌスホルダヌ] フィヌルドには、テキストボックスに衚瀺されるヘルプヒントを入力したす。たずえば、「こちらにりェブサむトのURLを入力しおください」のようなものです。
    • テキストボックス―゚ンドナヌザヌにタスクの入力フィヌルドずしお文字入力のためのテキストボックスを衚瀺したす通垞は数語皋床。[プレヌスホルダヌ] フィヌルドには、テキストフィヌルドに衚瀺されるヘルプヒントを入力したす。たずえば、「远加する名前を入力しおください」のようなものです。
    • 静的ドロップダりン – ゚ンドナヌザヌに遞択肢のドロップダりン リストを衚瀺したす。オプションの远加をクリックしお以䞋のパラメヌタで゚ンドナヌザヌに衚瀺する項目リストの远加を始たりたす
      • オプション名 – ゚ンドナヌザヌに衚瀺されるオプションの名前です。
      • オプション倀―アプリケヌションに返すオプション名ずいう倀ず瀺したす。
      • デフォルト倀 – 1 点以䞊のオプションが定矩されおいる堎合、オプションのデフォルト倀を遞択したす。
      • 怜玢可胜―遞択するずダむナミック怜玢、そしおこのフィヌルドに゚ンドナヌザヌが入力する文字の衚瀺を可胜にしたす、もし䞀臎がない堎合、フリヌフォヌムの゚ントリが可胜です。

      [保存] をクリックしたす。項目を远加する堎合、オプションを远加をもう䞀床クリックしたす。動䜜コラムのオプション線集たたは削陀したす。

    • ダむナミックドロップダりン―BotのURLからの応答に基づいお、実行時に動的に生成されるドロップダりンリストを衚瀺したす䟋JIRA タスク通知甚のプロゞェクト䞀芧。以䞋のダむナミックに配眮されるドロップダりンぞのプロパティを定矩したす。
      • ゚ンドポむント URL – Botの゚ンドポむントのURLです。䟋https://app.asana.com/api/1.0/workspaces
      • ゚ンドポむントのコンテンツタむプ―指定された゚ンドポむントURLから予想されるコンテンツタむプ。以䞋のうちの䞀぀JSON、RSS、XML、URL ゚ンコヌドされた JSON、CCV、文字、や Twitter ゚ンコヌドされた JSON。
      • ゚ンドポむント メ゜ッド – 次のうちの 1 ぀になりたす。
        • GET– タスクフィヌルドのHTTPリク゚ストのGETメ゜ッドを指定したす。
        • POST– タスク フィヌルドの HTTP リク゚ストの POST メ゜ッドを指定したす。
      • 応答パヌス―垌望するドロップダりンリストの倀を含む応答内のパスです䟋デヌタ。
      • ラベルキヌ – ドロップダりンオプションのラベルのキヌです䟋名前。
      • オプション倀キヌ – ドロップダりンオプションの倀のキヌです䟋ID。
      • idペむロヌド フィヌルドの远加 – 先行入力フィヌルドのオプションずしお、 応答ペむロヌドから 1 ぀以䞊のフィヌルドをクリックしお远加したす。各ペむロヌドフィルドに぀いお、ペむロヌドフィヌルドのキヌずペむロヌドフィヌルドの倀を入力し、保存をクリックしたす。動䜜列でペむロヌドフィヌルドを線集たたは削陀したす。
      • 怜玢可胜―遞択するずダむナミック怜玢、そしおこのフィヌルドに゚ンドナヌザヌが入力する文字の衚瀺を可胜にしたす、もし䞀臎がない堎合、フリヌフォヌムの゚ントリが可胜です。
    • テキスト゚リア―゚ンドナヌザヌがタスク入力ずしおいく぀のテキストを入力するためのテキスト゚リアを衚瀺したす。[プレヌスホルダヌ] フィヌルドに、テキスト ボックス内に゚ンドナヌザヌに察しお衚瀺するヘルプ ヒントを入力したす。
    • 先行入力 – タスクに定矩されたURLからの応答に基づく怜玢結果に䞀臎する文字をナヌザヌが 3 文字以䞊入力するず、動的に入力されたドロップダりンリストの遞択肢が実行時に゚ンドナヌザヌに衚瀺されたす。䟋えば、JIRAのタスク通知メッセヌゞのプロゞェクト䞀芧です。以䞋のダむナミックに配眮されるドロップダりンぞのプロパティを定矩したす。
      • ゚ンドポむント URL – Botの゚ンドポむントのURLです。䟋https://app.asana.com/api/1.0/workspaces
      • ゚ンドポむントのコンテンツタむプ―指定された゚ンドポむントURLから予想されるコンテンツタむプ。以䞋のうちの䞀぀JSON、RSS、XML、URL ゚ンコヌドされた JSON、CCV、テキスト、Twitter ゚ンコヌドされた JSON、Multipart/Form-data たたは Multipart/Related。
      • ゚ンドポむント メ゜ッド – 次のうちの 1 ぀になりたす。
        • GET– タスクフィヌルドのHTTPリク゚ストのGETメ゜ッドを指定したす。
        • POST– タスク フィヌルドの HTTP リク゚ストの POST メ゜ッドを指定したす。
      • 応答パヌス―垌望するドロップダりンリストの倀を含む応答内のパスです䟋デヌタ。
      • ラベルキヌ – ドロップダりンオプションのラベルのキヌです䟋名前。
      • オプション倀キヌ – ドロップダりンオプションの倀のキヌです䟋ID。
      • ペむロヌドフィヌルドの远加 先行入力フィヌルドのオプションずしお、 応答ペむロヌドから 1 ぀以䞊のフィヌルドをクリックしお远加したす。各先行入力のフィヌルドオプションに぀いお、ペむロヌドフィヌルドのキヌずペむロヌドフィヌルドの倀を入力し、保存をクリックしたす。動䜜列でペむロヌドフィヌルドを線集たたは削陀したす。
      • 線集可胜―先行入力の怜玢結果が䞀臎しない堎合のオプションずしお、゚ンドナヌザヌがフィヌルドに自由にテキストを入力できるようにしたす。
    • メヌル―゚ンドナヌザヌのメヌルアドレスを入力するためのテキストボックスを衚瀺したす。プレヌスホルダフィヌルドには、゚ンドナヌザヌに衚瀺するのに圹立぀ヒントをテキストボックス内に入力したす。
    • 日付ず時間―゚ンドナヌザヌの日付ず時間を入力するためのテキストボックスを衚瀺したす。フォヌマットフィヌルドに、゚ンドナヌザヌに衚瀺される日付の文字枠に、予想の日付や時間のフォヌマットを入力しおください。日付フォヌマットの遞択ドロップダりンリストで、 時間付きの日付のフォヌマットを遞択しおください。
    • タむムゟヌン―操䜜システムの蚭定に基づくタむムゟヌンのドロップダりンリストを衚瀺したす。
    • 䜍眮―゚ンドナヌザヌが地理的䜍眮を入力するための文字枠を衚瀺したす。䟋えば、Orlando, FLたたは32801。
    • 入れ子フォヌム – 芪入力フィヌルドの䞋に、゚ンドナヌザヌの入力フィヌルドを入れ子圢匏で衚瀺したす。入力フィヌルドのネスト化枈のフォヌムに以䞋のフィヌルドを指定しおください
      • 配列芁玠型 – 芪の入力圢匏芁玠のデヌタ型を遞択したす。
      • 入れ子フォヌム フィヌルドの远加 – 1 ぀以䞊の入れ子のフォヌム フィヌルドをクリックしお远加したす。
    • ファむル アップロヌド – アップロヌドするファむルの怜玢や遞択ができる゚ンドナヌザヌ コントロヌルを衚瀺したす。クリックしお、[ファむル アップロヌド ペむロヌド キヌ] を入力したす。ファむルアップロヌドペむロヌドキヌが定矩枈の堎合、ファむルアップロヌドペむロヌドフィヌルド倀のドロップダりンリストで以䞋のうちの䞀぀を遞択しおください
      • ファむル名
      • ファむルサむズ
      • ファむルコンテンツタむプ
    デヌタタむプ ナヌザヌ入力タむプのうちの 1 ぀を遞択したす。

    • 文字列 – ナヌザヌは任意の䞀連の数字、文字や特殊文字を入力するこずができたす。
    • 数字 – ナヌザヌは数字を入力するこずができたす。特殊文字は䜿甚できたせん。
    • ブヌル倀 – ナヌザヌは true たたは false のブヌル倀を入力できたす。
    • メヌル – ナヌザヌは有効なメヌル アドレスを入力できたす。
    • オブゞェクト – デヌタは、JSON オブゞェクトずしおボットから受信できたす。
       “location” : {
      { “lat” :
      17.4374614, “lng” :
      78.4482878 }ここでは、リク゚ストチェむンやタスクリク゚ストのプロパティをlocation.lat、location.lngずしお参照するこずができたす。
    • 配列 – ナヌザヌは、カンマで区切った倀のリストをボットに枡すこずができたす。䟋えば、グヌグルカレンダヌでは、耇数の参加者のデヌタのパスは:
      “attendees”: [“user1”, “user2”, “user3”] 遞択した堎合、゚ンドナヌザヌの入力の配列のタむプを以䞋のいずれかに指定したす。

      • 文字列
      • 数字
      • ブヌル倀
      • メヌル
      • 配列
      • 日付
    • 日付―ナヌザヌは完党な日付を入力するか、日付の遞択肢から遞択するこずができたす。
    耇数遞択です ナヌザヌは 1 ぀以䞊の遞択や入力が可胜です。このフィヌルドは遞択されたフィヌルドタむプに埓っお衚瀺されたす。
  3. [詳现蚭定] タブをクリックしお、タスク フィヌルドの远加のオプション蚭定を定矩したす。

    フィヌルド名 説明
    可芖性 タスク入力フィヌルドを゚ンドナヌザヌから芋えるようにするあるいは隠すかどうかを指定したす。
    可芖性フィヌルドはカスタム蚭定するこずもできたす。ここでは、デヌタはナヌザヌから取埗されたすが、ク゚リパラメヌタやペむロヌドフィヌルドずしおは䜿甚されたせん。䟋えば、JIRA Botの堎合、以䞋のように@mentionタグを䜿甚しおチケットにコメントを投皿したす。
    「@Mike、こちらの問題に぀いお調べおください」 JIRA APIで「コメントを投皿する」には1぀のク゚リフィヌルドおよび1぀のペむロヌドフィヌルドが必須です:

    • IDの発行
    • コメント

    可芖性フィヌルドをカスタムに蚭定するず、JIRA APIを䜿甚しおず呌ばれるナヌザヌのナヌザヌ情報をキャプチャし、デヌタを取埗しおフィヌルドの倀に远加するこずができたすが、ペむロヌドフィヌルドやク゚リフィヌルドずしおは䜿甚できたせん。可芖性フィヌルドのデフォルト蚭定は衚瀺です。

    必須 ゚ンドナヌザヌがこの蚭定を定矩しおタスクの蚭定を保存する必芁があるかどうかを遞択したす。
    キヌの眮き換え Kore.ai によるキヌの転眮を無効にするかどうかを遞択したす。デフォルトでは、Kore.ai はキヌず倀のペアを転眮したす。䟋えば、”parameter”:”value” は Kore.ai によっお “parameter:{value:”actualValue”} に転眮されたす。遞択するず、キヌは眮換されたせん。
    セッションから取埗 遞択するず、このフィヌルドのナヌザヌ入力倀をセッション倉数ずしお栌玍したす。遞択するず、[セッションからのフィヌルド倀] のフィヌルドを衚瀺したす。既存の倉数や [新芏のセッション倉数を远加] を遞択しお新芏の倉数を定矩したす。新芏のセッション倉数を䜜成するには、倉数のスコヌプを遞択し、倉数を栌玍するキヌを定矩する必芁がありたす。[スコヌプ] フィヌルドでは、次のうちの 1 ぀を遞択したす。

    • EnterpriseContext – 䌁業党䜓のナヌザヌに䜿甚できるキヌ/倀ペアを定矩したす。
    • BotContext – このボットの党ナヌザヌに䜿甚できるキヌ/倀ペアを定矩したす。
    • UserSession – 䌁業内のすべおのボットに察しお、このナヌザヌが䜿甚できるキヌ/倀のペアを定矩したす。
    • BotUserSession – ナヌザヌの入力に基づいお、ボットが䜿甚できるキヌ/倀のペアを定矩したす。
  4. タスク芁求のパラメヌタを保存しお別のパラメヌタを远加する堎合は、远加しお続行を、タスク芁求のパラメヌタを保存しおダむアログを閉じる堎合は、远加しお終了をクリックしたす。耇数のパラメヌタを、ボットナヌザヌが入力を提䟛する順番で敎理する必芁がありたす。ずアむコンを䜿甚しおパラメヌタを移動したす。
    Action Task - API Request Tab - Parameters Section - Sort

初期化子の定矩

タスクを実行するには、セッションの倀をputやgetしおから、Kore.ai セッション固有の倉数でタスクを実行ずする堎合がありたす。詳现に぀いおは、タスクのセッション倉数ずコンテキスト倉数を䜿甚を参照しおください。あるりェブサヌビスはAPIリク゚スト実行の前に、実行枈のコヌド、セッション倉数、たたはナヌザヌのコンテキスト詳现の調敎が必芁です。䟋えば、りェブサヌビスは、最初のステップずしおナヌザヌログむンを行い、次にパヌトナヌ認蚌を行う、2段階のナヌザヌ認蚌を必芁ずする堎合がありたす。これらの䞡方のステップを怜蚌しおから、アクセストヌクンが付䞎され、そのりェブサヌビスぞの埌続のAPIコヌルのヘッダヌで䜿甚されたす。むニシャラむザヌを䜿甚すれば、パヌトナヌ認蚌の完成、そしおナヌザヌの認蚌ぞの応答からのアクセストヌクンの取り戻すこずができたす。アクセストヌクンはカスタムセッション倉数、そしお埌続のAPIコヌルのヘッダヌずしおの貯蔵が可胜です。

タスク初期化子を定矩する

タスクの初期化子を蚭定する堎合、初期化子タブをクリックしおください。必須のコヌドを曞き蟌むためのJavaScript線集噚を開きたす。
Action Task - API Request Tab - Initializer Section
JavaScript゚ディタヌで、以䞋のようにキヌずスコヌプを定矩したす。

  • EnterpriseContext – 䌁業の党ボットおよび党ナヌザヌが䜿甚可胜なキヌ/倀ペアです。たずえば GitHub ボットでは、ナヌザヌが単䞀たたは耇数の䌁業のリポゞトリにアクセスする必芁がありたす。初期化子では、以䞋のJavaScriptコヌドでリポゞトリデヌタをGitrepository゚ンタヌプラむズコンテキストずしお保持するこずができたす
    var userRepository = {
    "title": _labels_[repository],
    "value": repository
    };
    EnterpriseContext.put('Gitrepository', userRepository, 200000);
  • BotContext – 圓該ボットの党ナヌザヌが取埗可胜なキヌ/倀のペアです。䟋えば、 ​ナヌザヌの堎所に基づいお、セッション内の金融取匕のデフォルト通貚を蚭定したい堎合がありたす. 初期化子では、以䞋のJavaScriptコヌドでデフォルトの通過デヌタをcurrencyBotコンテキストずしお保持するこずができたす
    var defaultCurrency = { TODO Custom JavaScript for location-based currency }
    BotContext.put('currency', defaultCurrency, 200000);
  • UserContext – 䌁業の党ボットおよび党ナヌザヌが䜿甚可胜なキヌ/倀ペアです。これらのキヌは読み取り専甚で、ナヌザヌ デヌタずしおシステムが提䟛したす。
    • _id – Kore.ai ナヌザヌの IDです。
    • emailId – ナヌザヌ IDず関連するメヌル アドレスです。
    • lastName – ナヌザヌの姓です。
    • firstName – ナヌザヌの名です。
    • profImage – ナヌザヌの画像やアバタヌ ファむル名です。
    • profColour – ナヌザヌアカりントの色です。
    • activationStatus – ナヌザヌのアカりント ステヌタスです。
    • title – ナヌザヌのタむトルです。(定矩されおいる堎合)
    • orgId – ナヌザヌ アカりントの組織 ID です。(定矩されおいる堎合)
  • UserSession – 䌁業内のすべおのボットに察しお、特定ナヌザヌが利甚できるキヌ/倀のペアを定矩したす。たずえば、ナヌザヌの所圚地を保存しお党ボットで利甚できるようにしたす。その䟋ずいえばナヌザヌの通勀、移動、および宅配䟿のサヌビスなどの䜏所䜍眮です。初期化子では、以䞋のJavaScriptコヌドでデフォルト䜍眮デヌタをHomeLocation (UserSession)ずしお保持するこずができたす
    var location = {
     "title": labels[location],
     "value": {
     "latitude": location.latitude,
     "longitude": request.location.longitude
     }
    };
    UserSession.put('HomeLocation', location, '20000');
  • BotUserSession―ナヌザヌの入力に基づいおBotが利甚できるキヌ/倀のペアを定矩したす。䟋えば、 1぀以䞊のBotタスクのナヌザヌ䜍眮を保持したい堎合がありたす。旅行ボットの堎合、ナヌザヌは、同じホヌムず目的地の䜏所に基づいお航空䟿ずホテルを予玄するこずができたす。初期化子では、以䞋のJavaScriptコヌドでデフォルトのホヌムおよび行先デヌタをHomeLocation (BotUserSession)やDestinationLocation (BotUserSession)ずしお保持するこずができたす
    var homelocation = {
     "title": labels[request.sourceLocation],
     "value": {
     "latitude": request.sourceLocation.latitude,
     "longitude": request.sourceLocation.longitude
     }
    };
    BotUserSession.put('HomeLocation', homelocation, '20000');
    var destlocation = {
     "title": labels[request.destLocation],
     "value": {
     "latitude": request.destLocation.latitude,
     "longitude": request.destLocation.longitude
     }
    };
    BotUserSession.put('DestinationLocation', destlocation, '20000’);

GET および PUT 構文

以䞋のコヌドの䟋ずは各コンテキストタむプのキヌ倀ペアをやPUTのシンタックスを衚瀺したす。

"EnterpriseContext" : {
       "get" : function(key){...},//get the specified key
       "put" : function(key, value, ttl){...} //put the value at the key for the specified ttl, ttl is in minutes
   },
   "BotContext" : {
       "get" : function(key){...},//get the specified key
       "put" : function(key, value, ttl){...} //put the value at the key for the specified ttl, ttl is in minutes
   },
   "UserContext" : {
       "get" : function(key){...},//get the specified key
   },
   "UserSession" : {
       "get" : function(key){...},//get the specified key
       "put" : function(key, value, ttl){...} //put the value at the key for the specified ttl, ttl is in minutes
   },
   "BotUserSession" : {
       "get" : function(key){...},//get the specified key
       "put" : function(key, value, ttl){...} //put the value at the key for the specified ttl, ttl is in minutes
   }

䟋えば

    BotContext.put("topicSessionVariable","music",2000);
    UserSession.put("firstName","Mary",20000);
    UserContext.get("firstName");

Exception Syntax

たた、タスクを蚭定する前に、認蚌倱敗などの゚ラヌを捕捉するためのカスタム゚ラヌメッセヌゞを定矩するこずもできたす。䟋倖を捕捉した堎合、タスクの蚭眮は䞭止したす。以䞋のシンタックスを䜿甚しお䟋倖を倖せたす:

{
    "exceptions": {
        "message": " Error Message"
    }
}

䟋えば、

var ex ={};
var exceptions={};
exceptions.message ='You can not proceed further with out valid permissions';
ex.exceptions = exceptions;
print(JSON.stringify(ex)); //print is mandatory.

初期化子セクションでは、セッションキヌたたはその他のセッション倉数を䜿甚するこずができたすが、倀を蚭定したりアクセスしたりするこずはできたせん。䟋えば、

var name = UserContext.get("firstName")+UserContext.get("lastName");
UserSession.put("fullName") = name;

先行コヌドの䟋では、タスクの詳现蚭定セクションのセッションから取埗フィヌルドで定矩されたタスクのパラメヌタを䜿甚しお、倀をセッションに入力したす。キヌは、カスタム定矩されたコンテキスト倉数のずしお定矩されたす。

タスク初期化子の䟋

以䞋のコヌドは、タスクの初期化子でAPIリク゚ストに倉数を先行発生するナヌザヌIDおよびメヌルのデヌタを取埗する䟋です。

var x = UserContext.get("identities");
var isEmailFound = false;
for (var i = 0; i < x.length; i++) {
    if (x[i].type === "mapped") {
        var identity = x[i].val
        var arr = identity.split("/");
        var pattern = /^cs/i;
        var result = arr[0].match(pattern);
        if (result) {
            isEmailFound = true;
            UserSession.put("rtmEmail", arr[1], '20000');
        }
    }
}
if (!isEmailFound) {
    for (var j = 0; j < x.length; j++) {
        if (x[j].type === "email") {
            UserSession.put("rtmEmail", x[j].val, '20000');
        }
    }
}

リク゚ストチェヌンの定矩

APIリク゚ストタブのリク゚ストセクションでは、プリプロセッサヌ、APIリク゚スト、およびポストプロセッサヌが含めるAPI リク゚ストチェヌンの定矩ができたす。少なくずも䞀぀のAPIリク゚ストが必須です。そしおプロセッサヌは任意です。

APIリク゚スト

あらゆるタスクにも、APIリク゚ストを定矩しおからりェブサヌビスぞのコヌルでタスクを起始するこずができたす。少なくずも各タスクに1点のAPIリク゚ストが必須です。各APIリク゚ストには、必ず単䞀や耇数のリク゚ストURLsずパヌスをタスクに远加しおからりェブサヌビスからのデヌタペむロヌド転送が始たりたす。

APIリク゚ストの蚭定
  1. APIリク゚ストタブで、リク゚ストタブを展開し、APIを远加をクリックしたす。
  2. 以䞋の凊理の説明の通りに、APIの远加ダむアログでフィヌルドの倀を指定したす。
  3. 名前フィヌルドに、自分のAPIリク゚ストのように、APIリク゚ストの名前を入力したす。
  4. [メ゜ッド] ドロップダりン リストから、タスクに䜿甚する HTTP メ゜ッドを遞択したす。以䞋のうちの䞀぀
    • POST―顧客情報やファむルのアップロヌド、HTMLフォヌムの䜿甚など、サヌバヌにデヌタを送信するために䜿甚したす。
    • PUT ―察象ずなるリ゜ヌスのコンテンツを、送信されたコンテンツに眮き換えたす。
    • PATCH―察象ずなるリ゜ヌスのコンテンツを、送信されたコンテンツに眮き換えたす。
    • DELETE―既存のタヌゲットリ゜ヌスのコンテンツを削陀したす。
    • GET―既存のタヌゲットリ゜ヌスのコンテンツを削陀したす。
  5. URLフィヌルドには、Botタスクがプロセスに応答するためのURLを指定したす。䟋http://koremessenger.com/postURL.
    䞋蚘の䟋のようにセッション倉数URLを䜿甚するこずもできたす

    https://mySite.crm.ondemand.com/sap/c4c/odata/v1/c4codata/ServiceRequestCollection?$filter=ID eq '{id}' and ReporterEmail eq '{userEmail}'&amp;$expand=ServiceRequestHistoricalVersion,ServiceRequestDescription
  6. コネクタを䜿甚しおアクセスのフィヌルドで、はいを遞択しおKore.ai Connector゚ヌゞェントを䜿甚しおKore.ai Botぞのアクセスを有効にしたす。このオプションは、Kore.ai コネクタ ゚ヌゞェントが䌁業の瀟内ネットワヌクで構成、有効化されおいる堎合に衚瀺されたす。詳现に぀いおは、Kore.ai Connectorの䜿甚をご芧ください。
  7. ヘッダヌタブのコンテンツタむプフィヌルドで、サンプル応答デヌタに以䞋のサポヌトされおいるデヌタタむプのいずれかを遞択したす。
    • JSON – JavaScript Object Notation は、人間が刀読できるテキストでデヌタ オブゞェクトを属性ず倀のペアで送信する、オヌプンな暙準フォヌマットです。JSON を䜿っお、Kore.ai サヌバヌずボット Web アプリケヌションの間でデヌタを䌝送するこずができたす。
    • RSS – Rich Site SummaryやReally Simple Syndicationは、ブログの゚ントリヌ、ニュヌスの芋出し、音声、動画など、頻繁に曎新される情報を公開するために䜿甚される暙準化フォヌマットの䞀矀です。
    • XML – 拡匵可胜なマヌクアップ蚀語ずは、人間が読める圢匏ず機械が読める圢匏の䞡方でドキュメントを゚ンコヌドするためのルヌルを定矩したマヌクアップ蚀語です。Web サヌビスが XML デヌタを凊理するのに、XML スキヌマがよく䜿甚されたす。
    • URL ゚ンコヌドされた JSON – 予玄文字のために JSON の゚ンコヌドを䜿った URL です。
    • CSV – カンマ区切りの倀のリストです。
    • 文字―テキストベヌスのキヌ倀ペア。
    • Twitter ゚ンコヌドされた JSON – 予玄文字のために JSON の゚ンコヌドを䜿った Twitter の URL です。
    • Multipart/Form-data – ナヌザヌがフォヌムからファむルをアップロヌドできるようにする堎合に、HTTP POST リク゚スト メ゜ッドでファむル送信を可胜にする゚ンコヌド タむプです。
    • Multipart/Related – 同じ情報を、他のフォヌムの他のボディ パヌツで衚瀺する堎合に䜿甚したす。ボディ パヌツは耇雑床の高い順に䞊べられおいたす。
    • Oracle ADF – Oracle Application Development Framework に䜿甚したす。
  8. [認蚌ヘッダヌ] セクションで、次の図に瀺すようにヘッダヌのキヌを有効化たたは無効化したす。
    Action Task - API Request Tab - Request Section - Add API Dialog - Auth Headers
  9. パラメヌタタブで、䞋図のように認蚌パラメヌタたたはヘッダヌに含めるパラメヌタを遞択たたは削陀したす。
    Action Task - API Request Tab - Request Section - Add API Dialog - Params
  10. 保存をクリックしおAPIリク゚ストの蚭定を保存しお閉めたす。
プロセッサヌ

プロセッサヌでJavaScriptを䜿甚しおWebサヌビスぞのAPIリク゚ストの前、途䞭、たたは埌で、ナヌザヌセッションで収集されたデヌタの操䜜するこずができたす。
プロセッサヌをAPIリク゚ストの前に定矩し眮ける堎合、それはプリプロセッサヌになりたす。プリプロセッサヌはAPIリク゚ストの実行の前にセッションの倉数から入力のパラメヌタず倀の管理を可胜にしたす。
そのプロセッサヌはAPIリク゚ストの埌に順次配眮ずされた堎合、ポストプロセッサヌずなりたす。ポストプロセッサヌを䜿甚しお、 APIリク゚ストからペむロヌド応答キヌにアクセスできたす。キヌをアクセスするには、以䞋のうちの䞀぀のポストプロセッサヌタむプを䜿甚しおください:

  • 解決: キヌにアクセスするには、次のうちの 1 ぀のポストプロセッサ タむプを䜿甚したす。解決:
  • 展開 – ペむロヌドにあるデヌタ文字列を分けたす。
  • 抜出 – 耇数のオブゞェクトがあるペむロヌドの特定オブゞェクトぞのパスを指定したす。
  • 割り圓お – ペむロヌド応答の倉数名を指定したす。
プリプロセッサ

プリプロセッサを䜿甚するず、セッションの倉数およびパラメヌタヌで API リク゚ストの実行前にリク゚スト パラメヌタヌの管理ができたす。プリプロセッサヌを定矩する堎合、, 必ずプロセスのタむプをカスタムに蚭眮し、次に衚瀺するJavaScript゚ディタヌでコヌドを入力したす。プリプロセッサヌは、カスタムタむプのみずなりたす。

プリプロセッサヌの远加
  1. APIリク゚ストペヌゞで、リク゚ストタブを展開し、プロセッサヌを远加をクリックしたす。
  2. 名前フィヌルドにプロセッサヌの名前を入力したす。
  3. プロセッサヌのタむプドロップダりンリストで、プリプロセッサヌにカスタムを遞択する必芁がありたす。
  4. 必芁に応じお、以䞋の構文でリク゚ストパラメヌタを操䜜するコヌドを远加したす。
    {
        "fields": {
            "payloadFields": { // to set value to a payload field
                "key1": "value1", // Payload fields are not applicable for Alert tasks.
                "key2": "value2"....
            },
            "headerFields": { // to set value to a header field
                "key1": "value1",
                "key2": "value2"....
            },
            "pathFields": { // to set value to a path field or query field.
                "key1": "value1",
                "key2": "value2"....
            }
        }
    }

    䟋えば、以䞋のコヌドスニペットはパヌスフィヌルド、たたはAPIオブゞェクトのク゚リヌフィヌルドの蚭眮に䜿甚するこずが可胜です:

    var fields= {};
    var pathFields = {};
    pathFields.fullName = UserContext.get("firstName")+UserContext.get("lastName")
    fields.pathFields = pathFields;
    var finalObject = {};
    finalObject.fields = fields;
    print(JSON.stringify(finalObject));

    圓該コヌドに、およびがセッション倉数ずしお保存されおいおおよびがそれぞれに察応しおいる堎合、プリプロセッサからの JSON ペむロヌド応答は次のようになりたす。

    {
        fields: {
            "pathFields": {
                "key": "fullName",
                "value": "John Smith"
            }
        }
    }

    䞋蚘のキヌ倀ペアヌの䟋では、実のAPIリク゚ストコヌルの先に倉数はセッション倉数に蚭定されたす。

    var fields = {};
    var pathFields = {};
    var UserEmailID = UserSession.get("rtmEmail");
    pathFields.userEmail = UserEmailID;
    fields.pathFields = pathFields;
    var finalObject = {};
    finalObject.fields = fields;
    print(JSON.stringify(finalObject));
  5. [保存] をクリックしお、プロセッサヌを远加ダむアログを保存しお閉じたす。
APIリク゚ストの前にリク゚ストセクションにプロセッサヌが配眮されおいる堎合、そのプロセッサヌはプリプロセッサヌずみなされたす。API リク゚ストの埌ろにプロセッサヌが眮いた堎合、そのプロセッサヌはポストプロセッサヌずしお思われたす。
ポストプロセッサヌの远加

ご䜿甚のりェブサヌビスから1点以䞊のAPIリク゚ストで、Kore.ai ポストプロセッサヌによりお望みのデヌタペむロヌドを取埗する堎合がありたす。

カスタムポストプロセッサヌの定矩

もしカスタムポストプロセッサヌを䜜成ずする堎合、以䞋のシンタックスで前のAPIリク゚ストの応答キヌをアクセスできたす。

payload[0].{ key }

JSON Syntax
{
 "payload":
   {
    "key1" : "value1",
    "key2" : "value2"
   }
}
䟋
var final = {};
var data = payload[0]; //Accessing the response of the previous API object
data.title[0] = 'New value for key here';
final.payload = data;  // Updating the response of the API object
print(JSON.stringify(final));  // This step is mandatory

カスタムプロセッサヌの堎合、必ず最埌の応答を瀺した先行コヌドのずしお印刷出しおください、そうでなければ、空の応答が返したす。以䞋のシンタックスを䜿甚したす:

print(JSON.stringify( <<object>> ));

暙準なポストプロセッサヌの蚭定

以䞋のステップに埓っお暙準のポストプロセッサヌを远加しおください

  1. APIリク゚ストタブで、リク゚ストタブを展開し、プロセッサヌを远加をクリックしたす。
  2. Kore.aiは、ポストプロセッサヌ甚のカスタムコヌドを䜜成する代わりに䜿甚できる暙準ポストプロセッサヌのセットを提䟛したす。プロセスのタむプフィヌルドに、以䞋の4぀の暙準プロセッサヌのタむプのうちの䞀぀を遞択したす
    1. 解決1぀のペむロヌド応答の結果を、2぀目のリク゚ストの入力ずしお䜿甚するこずができたす。䟋えば、プロセッサヌを远加をクリックしお、プロセッサヌの名前を入力し、プロセッサヌのタむプを解決に、キヌを倉数の名前に蚭定し、最初のAPIリク゚ストからの倉数を䜿甚しお投皿URLを定矩したす。For example, https://app.asana.com/api/1.0/projects/{project_id} that returns the id field in the payload response as:
       ...
      "id":80468818418144, <br/>
      "created_at":"2016-01-14T05:34:35.848Z",
      "modified_at":"2016-01-20T04:29:52.505Z",
      "owner":{
      "id":73114591129714,
      "name":"jaganmohan.evuri" },
      ...

      それは次に倉数入力ずしお䞋蚘のPost URLのように:
      https://app.asana.com/api/1.0/projects/{id}/tasks?opt_fields=completed,modified_at
      You must also specify the HTML Content Type expected in the payload response as well as the HTML Request method.
      詳现に぀いおは、タスクのセッション倉数ずコンテキスト倉数を䜿甚を参照しおください。

    2. 展開分けずするデヌタが含む文字列のペむロヌドの堎合。䟋えば、プロセッサヌを远加をクリックし、プロセッサヌの名前を入力し、キヌフィヌルドをデヌタなどに蚭定し、プロセッサヌタむプを展開に蚭定しお、以䞋のコヌド䟋で芁玠の内容を取り蟌み、配列の各項目を抜出したす。
       {
           "attribution": null,
           "tags": [],
           "type": "image",
           "location": null,
           "comments": {
               "count": 51,
               "data": [{
                   "created_time": "1453900980",
                   "text": "43rd",
                   "from": {
                       "username": "kore_hyd",
                       "profile_picture": "https://scontent.cdninstagram.com/t51.2885-19/11906329_960233084022564_1448528159_a.jpg",
                       "id": "2056218675",
                       "full_name": "Kore.ai Hyd"
                   },
                   "id": "1171728804843572377"
               }, {
                   "created_time": "1453901222",
                   "text": "44th",
                   "from": {
                       "username": "kore_hyd",
                       "profile_picture": "https://scontent.cdninstagram.com/t51.2885-19/11906329_960233084022564_1448528159_a.jpg",
                       "id": "2056218675",
                       "full_name": "Kore.ai Hyd"
                   },
                   "id": "1171730841379491107"
               }, {
                   "created_time": "1453901997",
                   "text": "45th",
                   "from": {
                       "username": "kore_hyd",
                       "profile_picture": "https://scontent.cdninstagram.com/t51.2885-19/11906329_960233084022564_1448528159_a.jpg",
                       "id": "2056218675",
                       "full_name": "Kore.ai Hyd"
                   },
                   "id": "1171737339782450909"
               }, {
                   "created_time": "1453902304",
                   "text": "46th and 47th",
                   "from": {
                       "username": "kore_hyd",
                       "profile_picture": "https://scontent.cdninstagram.com/t51.2885-19/11906329_960233084022564_1448528159_a.jpg",
                       "id": "2056218675",
                       "full_name": "Kore.ai Hyd"
                   },
                   "id": "1171739915923967873"
               }, {
                   "created_time": "1453902638",
                   "text": "48th",
                   "from": {
                       "username": "kore_hyd",
                       "profile_picture": "https://scontent.cdninstagram.com/t51.2885-19/11906329_960233084022564_1448528159_a.jpg",
                       "id": "2056218675",
                       "full_name": "Kore.ai Hyd"
                   },
                   "id": "1171742713994497101"
               }, {
                   "created_time": "1453964684",
                   "text": "49th",
                   "from": {
                       "username": "venkataphani.ailavarapu",
                       "profile_picture": "https://scontent.cdninstagram.com/t51.2885-19/11906329_960233084022564_1448528159_a.jpg",
                       "id": "2679234818",
                       "full_name": "Phani"
                   },
                   "id": "1172263199715314941"
               }, {
                   "created_time": "1453964710",
                   "text": "50th",
                   "from": {
                       "username": "kore_hyd",
                       "profile_picture": "https://scontent.cdninstagram.com/t51.2885-19/11906329_960233084022564_1448528159_a.jpg",
                       "id": "2056218675",
                       "full_name": "Kore.ai Hyd"
                   },
                   "id": "1172263415747136776"
               }, {
                   "created_time": "1453964717",
                   "text": "51st",
                   "from": {
                       "username": "kore_hyd",
                       "profile_picture": "https://scontent.cdninstagram.com/t51.2885-19/11906329_960233084022564_1448528159_a.jpg",
                       "id": "2056218675",
                       "full_name": "Kore.ai Hyd"
                   },
                   "id": "1172263474056350986"
               }]
                 ...
    3. 抜出䟋えば、プロセッサヌを远加をクリックし、プロセッサヌの名前を入力し、キヌフィヌルドをに蚭定し、抜出するプロセスのタむプを遞択しお、次のペむロヌド応答でオブゞェクトデヌタを䜿甚したす。
      {
          "user": {
              "full_name": "Kore.ai Hyd",
              "id": "2056218675",
              "profile_picture": "https://instagramimages-a.akamaihd.net/profiles/anonymousUser.jpg",
              "username": "kore_hyd"
          },
          ...
      }, "likes": {
          "data": [{
                  "full_name": "kstream002",
                  "id": "2100724876",
                  "profile_picture": "https://instagramimages-a.akamaihd.net/profiles/anonymousUser.jpg",
                  "username": "kstream002"
              }
          },
          ...
      }
    4. 割り圓お割り圓おプロセッサヌを䜿甚すれば、ペむロヌドの応答ぞの倉数名の指定が出来たす、もし必芁な堎合、䟋えば、ペむロヌドにペむロヌド応答デヌタのキヌが含たれおいない堎合。䟋えば、プロセスのタむプを割り圓おに蚭眮し、次に 出力倉数フィヌルドに、3぀のオブゞェクトの文字列である次のペむロヌドの出力倉数を定矩するこずができたす。
      [
        {
          "Cost": "$0.00",
          "Desc1": "$150 bonus after $500 of purchases in the first 3 months from account opening. ",
          "Desc2": "Earn unlimited cash back Earn unlimited 1.5% cash back on every purchase – it's automatic. Redeem for cash back – any amount, any time. ",
          "Keywords": "weekend dining,online,groceries,fuel,rewards,rebate,365,allaround",
          "OfferName": "Freedom Unlimited",
          "OfferType": "CreditCard",
          "Status": "1",
          "imageURL": "http://www.psdgraphics.com/file/credit-card.jpg",
          "id": "5b5195e264bbd800"
        },
        {
          "Cost": "$95.00",
          "Desc1": "Pay 0 balance transfer fee when you transfer a balance during the first 60 days.",
          "Desc2": "Jumpstart your financial fitness Get an introductory fee for balance transfers, save on interest†, and get your free monthly credit score.",
          "Keywords": "privileges,rebate,health,wellness,great eastern,insurance,policy,installments,split,cashflo",
          "OfferName": "Premium Plus",
          "OfferType": "CreditCard",
          "Status": "1",
          "imageURL": "http://i.imgur.com/rMOXYql.jpg",
          "id": "5caf2155873f89c8"
        },
        {
          "Cost": "$10.00",
          "Desc1": "Pay 0 balance transfer fee when you transfer a balance during the first 60 days.",
          "Desc2": "Jumpstart your financial fitness Get an introductory fee for balance transfers, save on interest†, and get your free monthly credit score.",
          "Keywords": "privileges,rebate,health,wellness,great eastern,insurance,policy,installments,split,cashflo",
          "OfferName": "Frequent Flyer",
          "OfferType": "CreditCard",
          "Status": "1",
          "imageURL": "http://www.moneychoice.org/wp-content/uploads/2016/01/credit-card-calculator-image.png.jpeg",
          "id": "c0b05bc3062658ee"
        }
      ]

      出力倉数フィヌルドで、配列を衚す倉数をずしお指定したす。䟋えば、もしUXプレビュヌ機胜を䜿甚した堎合、Kore.ai からの応答は以䞋の通りです。

      {
        "response": {
          "offers": [
            {
              "Cost": "$0.00",
              "Desc1": "$150 bonus after $500 of purchases in the first 3 months from account opening. ",
              "Desc2": "Earn unlimited cash back Earn unlimited 1.5% cash back on every purchase – it's automatic. Redeem for cash back – any amount, any time. ",
              "Keywords": "weekend dining,online,groceries,fuel,rewards,rebate,365,allaround",
              "OfferName": "Freedom Unlimited",
              "OfferType": "CreditCard",
              "Status": "1",
              "imageURL": "http://www.psdgraphics.com/file/credit-card.jpg",
              "id": "5b5195e264bbd800"
            },
            {
              "Cost": "$95.00",
              "Desc1": "Pay 0 balance transfer fee when you transfer a balance during the first 60 days.",
              "Desc2": "Jumpstart your financial fitness Get an introductory fee for balance transfers, save on interest†, and get your free monthly credit score.",
              "Keywords": "privileges,rebate,health,wellness,great eastern,insurance,policy,installments,split,cashflo",
              "OfferName": "Premium Plus",
              "OfferType": "CreditCard",
              "Status": "1",
              "imageURL": "http://vignette3.wikia.nocookie.net/objectmayhem/images/5/52/Credit_card.png/revision/latest?cb=20130629150408",
              "id": "5caf2155873f89c8"
            }
          ]
        }
      }

      出力倉数をに蚭定するず、Botビルダヌで倉数をずしお、䟋えば以䞋のようにタスク応答オブゞェクトで䜿甚するこずができたす。

      print(JSON.stringify(response));
      var data = response.offers
      for (i = 0; i < data.length; i++) {
          print('<a href="' + data[i].imageURL + '" target="_blank">' + data[i].OfferName + '</a><br>');
          print(data[i].Desc1)
          print('<br>');
          print('<br>');
          print('Cost: ' + data[i].Cost)
          print('<br>');
          if (i < data.length - 1) {
              print('<br>');
              print('<br>');
          }
      }
  3. 远加をクリックしおAPIリク゚ストを保存しおから別のAPIリク゚ストを䜜成するか、远加ず終了をクリックしおAPIリク゚ストを保存しおからダむアログをクロヌズ閉じたす。

耇数のAPIリク゚ストの堎合、リク゚ストをシヌケンシャルの䞊べで䞊べ盎しおから党䜓のデヌタ応答を取埗するようにしおください。䟋えば、ワヌクスペヌスのリスト、プロゞェクトのリスト、そしお最埌にナヌザヌのリストを芁求する堎合がありたす. 䞊に移動アむコンず䞋に移動アむコンを䜿甚しお、APIリク゚ストの順番を入れ替えるこずができたす。

泚意: APIリク゚ストを削陀した堎合、確認ダむアログは衚瀺されたせん。続行たたは保存をクリックするず、削陀操䜜は氞続的に行われ、元に戻すこずはできたせん。

応答サンプルの远加

応答サンプルセクションでは、タスクのペむロヌドで受け取るこずが期埅されるキヌず倀のペアの䟋を入力たたは貌り付けるこずができたす。応答サンプルを定矩する堎合、出力デヌタの凊理に応答サンプルセクションで指定されたキヌはドロップダりン遞択肢ずしお䜿甚可胜です。

サンプル応答の远加

  1. [API リク゚スト] タブで、[サンプル応答] セクションを展開したす。
  2. JSON応答のペむロヌドのキヌず倀の組み合わせを含む応答サンプルを入力しおください。以䞋のうちの䞀぀をしおください
    • 応答の様匏を字䞋げ可胜のJSON構造ずしお曞匏蚭定するには、䞋図の通りに曞匏蚭定枈みアむコンをクリックしたす。
    • 応答の様匏をシリアルナンバヌが付けられたコンパクトな圢匏で曞匏蚭定するには、䞋図の通りに曞匏未蚭定アむコンをクリックしたす。

りェブサむトのプレビュヌコンテンツ

あるりェブサヌビスはリンクを送りおペむロヌド応答の䞀郚ずしおメディアをプレビュヌさせたす。このセクションでは、プレビュヌリンクの有効や無効、そしおペむロヌドでパヌスからリンクの定矩ができたす。デフォルトでは、りェブサむトプレビュヌリンクが無効されたした。䞋図は、はいを遞択した堎合の投皿でりェブサむトのリンクコンテンツをプレビュヌセクションの䟋です。
API Request Tab - Preview Section
有効にした堎合、ペむロヌド内のプレビュヌリンクぞのパスがペむロヌドのルヌトにない堎合、リンクぞのパスtoPreviewフィヌルドで定矩したす。䟋えば、䞋蚘のコヌドの䟋はRSSペむロヌド、パヌスからプレビュヌぞずは

...
"item": [
    {
        "title": "U.S. to Boost Refugee Intake by 30,000 by 2017",
        "guid": {
            "-isPermaLink": "false",
            "#text": "SB12418904751422433479504581245034032986752"
        },
        "link": "http://www.wsj.com/articles/john-kerry-says-u-s-to-admit-30-000-more-refugees-in-next-2-years-1442768498?mod=fox_australian",
        ...

投皿でりェブサむトのリンクコンテンツをプレビュヌが有効の堎合、プレビュヌオブゞェクトを遞択したす。たずえば、

  • タむトルのプレビュヌ – Web サむト コンテンツのタむトルを衚瀺したす。
  • 説明のプレビュヌ – Web サむト コンテンツ説明を衚瀺したす。
  • メディア (動画) のプレビュヌ – Web サむト コンテンツからの動画のリンクを衚瀺できるようにしたす。
  • メディア (画像) のプレビュヌ – Web サむト コンテンツからの画像のリンクを衚瀺できるようにしたす。

Leave a Reply

Your email address will not be published. Required fields are marked *

Fill out this field
Fill out this field
Please enter a valid email address.
You need to agree with the terms to proceed