ServiceAlexa開発者フォーラムAlexaデザインガイドAlexaスキルマーケティングガイドラインAlexaリマインダーAPIリファレンス﻿AlexaリマインダーAPIリファレンスAlexaリマインダーAPIを使用して、スキルからリマインダーを作成および管理します。このリファレンスでは、AlexaリマインダーAPIで使用できるオペレーションについて説明します。リマインダー時刻におけるタイムゾーンの動作エラーメッセージリマインダーイベントのサブスクリプションイベントで使用されるapiEndpoint値JSON形式のリマインダーイベントReminderStartedReminderCreatedReminderDeletedReminderUpdatedAlexaリマインダーAPIのエンドポイントと認可APIのエンドポイントは、受信リクエストのcontextオブジェクトのapiEndpoint値から取得します。Amazonから取得したアクセストークンでなければなりません。一部のオペレーションで使用されるidは、リマインダーのidを指します。これはリマインダーが作成されるときに自動的に生成されます。AlexaリマインダーAPIのセッション内およびセッション外の動作リマインダーはセッション内アクセストークンを使用してのみ作成できます。GET、UPDATE、およびDELETEオペレーションは、セッション内およびセッション外の両方のアクセストークンで動作します。セッション外の対話リマインダーの作成このAPIは、現在のスキルの新しいリマインダーを作成するために呼び出されます。タイムゾーンの動作で説明されているように、timezoneIdフィールドを使用して実際にリマインダーが通知される日時を考慮します。イベントが実際に発生した時刻を記述します。リマインダーのトリガーに関する情報を含みます。トリガーのタイプを示します。SCHEDULED_ABSOLUTEまたはSCHEDULED_RELATIVEです。trigger.typeがSCHEDULED_RELATIVEに設定された場合は、このフィールドを使用して、リマインダーが鳴らされるまでの時間を指定します(秒)。タイムゾーンのIDを含む文字列です。タイムゾーンの動作を参照してください。トリガーの繰り返し情報に関する情報を含みます。次のいずれかになります。WEEKLY、DAILY。反復の頻度のタイプです。曜日のリストを指定します。標準的な2文字の略語を使用します。アラートに関する情報を含みます。アラートに含まれる発話コンテンツに関する情報を含みます。アラートのコンテンツを含みます。値の指定に使用されるロケールです。表示および読み上げ用に使用されるテキストです。プッシュ通知に関する情報を含みます。次のいずれかになります。文字列リマインダーの取得このAPIは、現在のスキルの特定のリマインダーを取得するために呼び出されます。"string"}リマインダーの複数取得このAPIはスキルによって呼び出され、スキルのすべてのリマインダーを取得します。ステータスが「OFF」の完了済みのリマインダーも含まれます。"string"}リマインダーの更新このAPIは、現在のスキルのリマインダーを更新するために呼び出されます。タイムゾーンの動作で説明されているように、timezoneIdフィールドを使用して実際にリマインダーが通知される日時を考慮します。文字列リマインダーの削除このAPIは、現在のスキルの特定のリマインダーを削除するために呼び出されます。このオペレーションはアクティブなアラートのみを削除します。完了したものは削除しません。完了したリマインダーはAlexaアプリに3日間表示され、その後は自動的に削除されます。8601形式で表されたこのリマインダーアラートの作成時刻です。リマインダーのトリガー情報です。次のいずれかになります。SCHEDULED_ABSOLUTE、SCHEDULED_RELATIVE。リマインダーは、特定の時刻、またはrequestTimeを起点にoffsetInSecondsで計算された相対時刻に設定できます。8601形式で表されたトリガー予定時刻です。ABSOLUTEの場合に使用します。リマインダーの想定タイムゾーンです。VUI/GUI体裁のリマインダーのアラート情報です。リマインダーのVUI体裁です。読み上げ情報と表示情報は同じです。読み上げ情報と表示情報の内容。1つ以上のロケールにalertInfo.spokenInfo.content.textが必要です。読み上げテキストが出力されるロケールです。Alexaでサポートされるロケールのいずれかです(例:en-US)。プレーンテキスト形式の読み上げテキストです。Alexaモバイルアプリへのリマインダーのプッシュ通知を有効または無効にします。次のいずれかになります。ENABLED、DISABLED。デフォルトはENABLEDです。enumトリガー時刻の計算スキルは絶対時刻または相対時刻のどちらかを使用してリマインダーを設定できます。SCHEDULED_ABSOLUTEまたはSCHEDULED_RELATIVEのtrigger.typeを使用します。スキルで、6月1日の午後7時に薬を飲むリマインダーを設定します。絶対時刻を使用するリマインダーの場合、scheduledTimeは必須フィールドです。スキルで、1時間後に薬を飲むなど経過時間ベースのリマインダーを設定します。3600このオフセットはリクエスト内のrequestedTimeからの相対です。デバイスのタイムゾーンでのリマインダースキルがデバイスのタイムゾーンでリマインダーを設定します。この場合、timezoneIdは不要です。"2018-06-01T19:00:00"このリクエストでは、リマインダーはデバイスのタイムゾーンの午後7時に設定されます。アプリのタイムゾーンでのリマインダースキルは、リマインダーが設定されている日時とタイムゾーンを提供します。マイサロンで、ニューヨークの6月1日午後7時にお客様の予約のリマインダーを設定します。実際にリマインダーが通知される日時を考慮してtimezoneIdの値を設定したかどうか確認してください。"America/New_York"ユーザーのデバイスがアプリリクエストとは異なるタイムゾーンの場合、Alexaは読み上げおよび表示用に時刻をデバイスのタイムゾーンに変換します。6月2日午前8時になります。リクエストの日時形式が正しくありません。タイプとフィールドが一致しません。SCHEDULED_ABSOLUTEにoffsetInSecondsが設定されているか、SCHEDULED_RELATIVEにscheduledTimeが設定されています。日付形式がサポートされていません。タイムゾーンが有効ではありません。繰り返しパターンが無効です。繰り返しパターンが有効ですが現在はサポートされていません。アラート情報にロケールがないか、無効なロケール形式です。テキスト文字列が長すぎます。無効な相対時刻のオフセットです。トークンは有効ですが適切な権限がありません。アクセストークンがありません。無効または誤ったアクセストークンです。アクセストークンが失効しています。デバイスのリマインダーの上限(500など)に達しました。アラートが存在しません。TPSに調整されます。デバイスにアクセスできません。デバイスがオフラインです。Alexaスキルのスキルイベントリマインダーイベントをサブスクリプションすると、AlexaリマインダーAPIを呼び出さずにスキルにこれらのイベントを通知できます。スキルでは、アカウントリンクを使用して外部アプリを組み込み、これらのイベントの通知を使用して、アプリ内のリマインダーの削除や変更など、アプリの変更を行うことができます。イベントの通知は順不同で届くので、リマインダーイベントの結果としてスキルが実行するアクションでは、イベントのタイムスタンプに注意する必要があります。リマインダーが2回更新され、先に更新されたイベントが次に更新されたイベントの後に届いた場合、先に更新されたものは破棄される必要があります。Alexaは、スキルサービスが応答で確認を送信しなかった場合、イベントの再配信を試行します。スキルサービスは過去のイベントをAlexaから取得することはできず、配信されたイベントを利用する必要があります。イベントで使用されるapiEndpoint値エンドポイントは、https://api.amazonalexa.comです。JSON形式のリマインダーイベントスキルサービスでのイベントの使用に従ってリマインダーイベントをサブスクリプションするようにスキルを設定し、skill.jsonマニフェストファイルを設定できます。利用可能なリマインダーイベントは次のとおりです。REMINDER_STARTEDREMINDER_CREATEDREMINDER_UPDATEDREMINDER_STATUS_CHANGEDREMINDER_DELETEDReminderStartedこのイベントは、リマインダーが鳴り始めたときに生成されます。このイベントはspeechletのNotificationStartedイベントによって生成されます。}}ReminderCreatedこのイベントは、Alexaシステムでリマインダーが作成されたときに生成されます。リマインダーが作成されたことをスキルに通知します。このイベントはリマインダーの作成者には送信されません。}}ReminderDeletedこのイベントは、リマインダーがユーザーによって削除されたときに生成されます。}}ReminderUpdatedこのイベントは、リマインダーが更新されたときに生成されます。スヌーズ、オン、トリガー時刻の更新、ラベルの更新などです。リマインダーの現在の状態以外の更新の詳細は提供されません。更新の詳細を取得するには、スキルでリマインダーの取得を使用して更新の詳細を取得する必要があります。