デバイスグループ管理API

Note: Sign in to the developer console to build or publish your skill.

デバイスグループ管理API

注：このAPIは、登録済みのAlexa Smart Properties in Hospitalityパートナーのみ使用できます。Alexa Smart Properties for Hospitality APIで開発を始めるを参照してください。

デバイスグループは、そのグループのメンバーであるAlexa搭載デバイスに話しかけることでユーザーがまとめて制御できるデバイスのグループを表します。ターゲット指定は明示的にも暗黙的にも行うことができます。明示的なターゲット指定では、「アレクサ、リビングの照明をつけて」のように、ユーザーがデバイスグループの名前を指定します。暗黙的なターゲット指定では、ユーザーはグループ名を指定しません。たとえば、デバイスグループに含まれているデバイスの1つに向かって「アレクサ、照明をつけて」と言うと、Alexaはグループ内のすべての照明をオンにします。デバイスグループ内のデバイスは同じ物理空間に存在するのが一般的ですが、これは必須の要件ではありません。

注：注： Alexa搭載デバイスが一度にメンバーになれるデバイスグループは1つのみです。

Alexa Smart Properties for Hospitalityでは、デバイスグループ管理APIを使用して、ユニット内にデバイスのグループを作成できます。

APIエンドポイント

デバイスグループ管理APIのエンドポイントは、https://api.amazonalexa.comです。

注：組織が所在する地域によっては、https://api.eu.amazonalexa.comも使用できます。

認証

すべてのAPIリクエストには認可ヘッダーが必要であり、その値にはLogin with Amazon（LWA）から取得したアクセストークンが入ります。

操作

デバイスグループAPIには、以下の操作が用意されています。

操作	HTTPメソッドとURI
デバイスグループを作成する	`POST /v1/deviceGroups`
デバイスグループにデバイスを追加する	`POST /v1/deviceGroups/{id}/memberDevices`
デバイスグループからデバイスを削除する	`DELETE /v1/deviceGroups/{id}/memberDevices/{endpointId}`
デバイスグループのフレンドリー名を変更する	`POST /v1/deviceGroups/{id}/friendlyName`
デバイスグループを削除する	`DELETE /v1/deviceGroups/{id}`
デバイスグループのリストを取得する	`GET /v1/deviceGroups`

デバイスグループを作成する

デバイスグループを作成するには、POST /v1/deviceGroupsを呼び出します。

この操作は以下の国で使用できます。

Healthcare	Hospitality	Residential	Senior Living	Core
米国	米国、英国、フランス、カナダ、イタリア、ドイツ	米国、カナダ	米国、英国、フランス、カナダ、イタリア、ドイツ	米国

リクエストの形式

POST /v1/deviceGroups HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWAトークン}

リクエストのパスパラメーター

ありません。

リクエスト本文の形式

{
  "friendlyName": {
    "type": "PLAIN",
    "value": {
      "text": "{groupFriendlyName}"
    }
  },
  "memberDevices": [
    {
      "id": "amzn1.alexa.endpoint.{endpointId}"
    }
  ],
  "associatedUnits": [
    {
      "id": "amzn1.alexa.unit.did.{UnitId}"
    }
  ]
}

リクエスト本文の例

{
  "friendlyName": {
    "type": "PLAIN",
    "value": {
      "text": "キッチン"
    }
  },
  "memberDevices": [
    {
      "id": "amzn1.alexa.endpoint.es2fiL0v9nOJlfYf5Raw7Ff90bv7tAJkie3p3Zzf4C7svpIEL4GcGh8lQdBbYWIjqfA2ydFEvzy_kG3QBOg2MRUBDR0StBHCwNombp4-2N7SY8H1JCQxKO0mKO1Ez5VX3QPItZ26rEvnqpjjday41DZ0lz4lNZAHpoc0GuvX6M4uRKO9wFuTklf7XZf1EOiRLyKQg0rPBE1V7epjFqVRKtAZluxMmZkCgQJ30Mwt4MxQFmha-Ypfm0s2vzpXqe6"
    }
  ],
  "associatedUnits": [
    {
      "id": "amzn1.alexa.unit.did.7R9ITXF3SHFHJDGQYSAXJ9C7E78CA2DD3C1NM2RN70BSELVVZ1EDZZC4KVQ6GLZ72W0QXDIQ49RT5CMPU91DW6ZTSKA6HPQI3LAPZYMY"
    }
  ]
}

リクエスト本文のパラメーター

フィールド	説明	型	必須
`friendlyName`	デバイスグループのフレンドリー名です。`NameValue`オブジェクトとして指定します。ユニット内のすべてのデバイスグループには、一意の名前が必要です。	NameValueオブジェクト	◯
`memberDevices`	デバイスグループに追加するデバイスです。 • リスト内のすべてのエンドポイントが存在し、呼び出し元がそれらのエンドポイントへのアクセス権限を持っている必要があります。 • リスト内のすべてのデバイスは、作成するグループと同じユニットに関連付けられている必要があります。 • リストは空でも構いません。	`Endpoint`オブジェクトのリスト	✕
`associatedUnits`	デバイスグループに関連付けるユニットのIDです。 • ユニットは1つだけ指定する必要があります。 • 指定したユニットが存在し、呼び出し元がそのユニットへのアクセス権限を持っている必要があります。 • デバイスグループの作成後に、関連付けられたユニットを変更することはできません。 • デバイスグループの作成後に、そのデバイスグループにユニットを関連付けることはできません。	`Unit`オブジェクトのリスト	◯

NameValueオブジェクト

フィールド	説明	型
`type`	名前の値のタイプです。現在サポートされている値は、`"PLAIN"`のみです。	文字列
`value`	名前の値です。`Value`オブジェクトとして表します。	オブジェクト

Valueオブジェクト

フィールド	説明	型
`text`	文字列値です。	文字列

Endpointオブジェクト

フィールド	説明	型
`id`	エンドポイントIDです。`"amzn1.alexa.endpoint.{endpointId}"`というAmazon Common Identifier（ACI）形式で表します。	文字列

DeviceGroupオブジェクト

フィールド	説明	型
`id`	デバイスグループIDです。`"amzn1.alexa.endpointGroup.{deviceGroupId}"`というAmazon Common Identifier（ACI）形式で表します。	文字列
`friendlyName`	デバイスグループのフレンドリー名です。	`NameValue`オブジェクト
`memberDevices`	デバイスグループのメンバーにするデバイスです。	`Endpoint`オブジェクトのリスト
`associatedUnits`	デバイスグループに関連付けられるユニットのIDです。現在、指定できるユニットIDは1つだけです。	`Unit`オブジェクトのリスト

Unitオブジェクト

フィールド	説明	型
`id`	ユニットIDです。形式は`"amzn1.alexa.unit.did.{UnitId}"`です。	文字列

成功応答ヘッダー

注：応答ヘッダーで返されるHost値は、リクエストのHost値と同じになります。

HTTP/1.1 201 Created
Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

フィールド	説明	型	必須
`X-Amzn-RequestId`	リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。	文字列	◯

応答本文の例

{
    "id": "amzn1.alexa.endpointGroup.kMbAbfF9JTDyE7c8Tg2DzBOWhzAmLMq4MZwlbjGJ9rZ8QPm6bmbKPijbwoziWof5SzbBHWu7LOBa6z2N6mB64g"
}

応答本文のパラメーター

フィールド	説明	型	必須
`id`	新しいデバイスグループのデバイスグループIDです。形式は`"amzn1.alexa.endpointGroup.{deviceGroupId}"`です。	文字列	◯

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド	説明	型	必須
`type`	エラーのエラータイプです。	文字列	◯
`message`	エラーのエラーメッセージです。エラーメッセージはデバッグやログ記録のみを目的としたものであり、ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックは構築しないでください。	文字列	◯

HTTP応答コード

ステータスコード	タイプ	メッセージ	説明
201	CREATED	Created	リクエストが成功しました。
400	BAD_REQUEST	Bad Request	リクエストの形式が次のいずれかの理由で正しくありません。 • 指定されたフレンドリー名を持つデバイスグループが、指定された関連付け先のユニットに既に存在しています。 • 指定された関連付け先のユニットが存在しないか、呼び出し元にそのユニットへのアクセス権限がありません。 • 指定されたメンバーデバイスが存在しないか、呼び出し元にそのデバイスへのアクセス権限がありません。 • 指定されたメンバーデバイスに、デバイスグループと同じユニットが関連付けられていません。 • 指定されたAlexa搭載メンバーデバイスは、既に別のデバイスグループのメンバーデバイスです。
401	UNAUTHORIZED	Unauthorized	認可に失敗しました。
403	FORBIDDEN	Forbidden	リクエストを完了できませんでした。
429	TOO_MANY_REQUESTS	Too Many Requests	リクエストが制限されました。
500	INTERNAL_SERVER_ERROR	Internal Server Error	サーバー側でエラーが発生しました。
503	SERVICE_UNAVAILABLE	Service Unavailable	サービスが一時的に使用できません。

デバイスグループにデバイスを追加する

デバイスグループにデバイスを追加するには、POST /v1/deviceGroups/{id}/memberDevicesを呼び出します。

この操作は以下の国で使用できます。

Healthcare	Hospitality	Residential	Senior Living	Core
米国	米国、英国、フランス、カナダ、イタリア、ドイツ	米国、カナダ	米国、英国、フランス、カナダ、イタリア、ドイツ	米国

リクエストの形式

POST /v1/deviceGroups/{id}/memberDevices HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWAトークン}

リクエストのパスパラメーター

フィールド	説明	型	必須
`id`	デバイスグループIDです。有効なデバイスグループを表している必要があります。	文字列	◯

リクエスト本文の形式

{
    "memberDevice": {
      "id": "{endpointId}"
    }
}

リクエスト本文の例

{
    "memberDevice": {
      "id": "amzn1.alexa.endpoint.W28D0yZ5FzcjByRRnEQwmUHC1tZAncTyo8ekrOky8oVUtkayVpomPYpy7gjIVGDa5VoiRpNT8AKJGtmD92xmV2hlzIyBQSzYrELdsIBSXxSrahd375XACr2iuyo2POKCBbgYBaCSzIvXoklLdAEugOMk5WG8gi1sh4l7IBVoQ9RwzkPp731ZbTtnjHyC5WCceM4s5a9RFtrYDD3ejoER5RBX3o0W7FYtGlM3faDbgTPeL1Nr4cWoyIAguRK4J2P"
    }
}

リクエスト本文のパラメーター

フィールド	説明	型	必須
`memberDevice`	デバイスグループにメンバーとして追加するデバイスです。 • 有効なEndpointオブジェクトを表している必要があります。 • エンドポイントが存在し、呼び出し元がそのエンドポイントへのアクセス権限を持っている必要があります。 • エンドポイントは、追加先のデバイスグループと同じユニットに関連付けられている必要があります。	Endpointオブジェクト	◯

成功応答ヘッダー

注：応答ヘッダーで返されるHost値は、リクエストのHost値と同じになります。

HTTP/1.1 204 No Content
Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

フィールド	説明	型	必須
`X-Amzn-RequestId`	リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。	文字列	◯

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド	説明	型	必須
`type`	エラーのエラータイプです。	文字列	◯
`message`	エラーのエラーメッセージです。エラーメッセージはデバッグやログ記録のみを目的としたものであり、ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックは構築しないでください。	文字列	◯

HTTP応答コード

ステータスコード	タイプ	メッセージ	説明
204	NO_CONTENT	No Content	リクエストが成功しました。
400	BAD_REQUEST	Bad Request	リクエストの形式が次のいずれかの理由で正しくありません。 • 指定されたメンバーデバイスが存在しないか、呼び出し元にそのデバイスを使用する権限がありません。 • 指定されたメンバーデバイスに、デバイスグループと同じユニットが関連付けられていません。 • 指定されたAlexa搭載メンバーデバイスは、既に別のデバイスグループのメンバーデバイスです。
401	UNAUTHORIZED	Unauthorized	認可に失敗しました。
403	FORBIDDEN	Forbidden	リクエストを完了できませんでした。
404	NOT_FOUND	Not Found	指定されたデバイスグループが存在しないか、呼び出し元にそのデバイスグループへのアクセス権限がありません。
429	TOO_MANY_REQUESTS	Too Many Requests	リクエストが制限されました。
500	INTERNAL_SERVER_ERROR	Internal Server Error	サーバー側でエラーが発生しました。
503	SERVICE_UNAVAILABLE	Service Unavailable	サービスが一時的に使用できません。

デバイスグループからデバイスを削除する

デバイスグループからデバイスを削除するには、DELETE /v1/deviceGroups/{id}/memberDevices/{endpointId}を呼び出します。

この操作は以下の国で使用できます。

Healthcare	Hospitality	Residential	Senior Living	Core
米国	米国、英国、フランス、カナダ、イタリア、ドイツ	米国、カナダ	米国、英国、フランス、カナダ、イタリア、ドイツ	米国

リクエストの形式

DELETE /v1/deviceGroups/{id}/memberDevices/{endpointId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWAトークン}

リクエストのパスパラメーター

フィールド	説明	型	必須
`id`	デバイスグループIDです。有効なデバイスグループを表している必要があります。	文字列	◯
`endpointId`	デバイスグループから削除するデバイスのエンドポイントIDです。デバイスグループのメンバーデバイスの有効なEndpointオブジェクトを表している必要があります。	文字列	◯

成功応答ヘッダー

注：応答ヘッダーで返されるHost値は、リクエストのHost値と同じになります。

HTTP/1.1 204 No Content
Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

フィールド	説明	型	必須
`X-Amzn-RequestId`	リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。	文字列	◯

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド	説明	型	必須
`type`	エラーのエラータイプです。	文字列	◯
`message`	エラーのエラーメッセージです。エラーメッセージはデバッグやログ記録のみを目的としたものであり、ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックは構築しないでください。	文字列	◯

HTTP応答コード

ステータスコード	タイプ	メッセージ	説明
204	NO_CONTENT	No Content	リクエストが成功しました。
400	BAD_REQUEST	Bad Request	リクエストの形式が正しくありません。
401	UNAUTHORIZED	Unauthorized	認可に失敗しました。
404	NOT_FOUND	Not Found	リクエストが次のいずれかの理由で失敗しました。 • 指定されたデバイスグループが存在しないか、呼び出し元にそのデバイスグループへのアクセス権限がありません。 • 指定されたメンバーデバイスがデバイスグループに存在しないか、呼び出し元にそのデバイスへのアクセス権限がありません。
429	TOO_MANY_REQUESTS	Too Many Requests	リクエストが制限されました。
500	INTERNAL_SERVER_ERROR	Internal Server Error	サーバー側でエラーが発生しました。
503	SERVICE_UNAVAILABLE	Service Unavailable	サービスが一時的に使用できません。

デバイスグループのフレンドリー名を変更する

デバイスグループのフレンドリー名を変更するには、POST /v1/deviceGroups/{id}/friendlyNameを呼び出します。

この操作は以下の国で使用できます。

Healthcare	Hospitality	Residential	Senior Living	Core
米国	米国、英国、フランス、カナダ、イタリア、ドイツ	米国、カナダ	米国、英国、フランス、カナダ、イタリア、ドイツ	米国

リクエストの形式

POST /v1/deviceGroups/{id}/friendlyName HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWAトークン}

リクエストのパスパラメーター

フィールド	説明	型	必須
`id`	デバイスグループIDです。有効なデバイスグループを表している必要があります。	文字列	◯

リクエスト本文の形式

{
  "type": "PLAIN",
  "value": {
    "text": "{groupFriendlyName}"
  }
}

リクエスト本文の例

{
  "type": "PLAIN",
  "value": {
    "text": "キッチン"
  }
}

リクエスト本文のパラメーター

フィールド	説明	型
`friendlyName`	デバイスグループの新しいフレンドリー名です。NameValueオブジェクトとして指定します。	NameValueオブジェクト	◯

成功応答ヘッダー

注：応答ヘッダーで返されるHost値は、リクエストのHost値と同じになります。

HTTP/1.1 204 No Content
Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

フィールド	説明	型	必須
`X-Amzn-RequestId`	リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。	文字列	◯

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド	説明	型	必須
`type`	エラーのエラータイプです。	文字列	◯
`message`	エラーのエラーメッセージです。エラーメッセージはデバッグやログ記録のみを目的としたものであり、ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックは構築しないでください。	文字列	◯

HTTP応答コード

ステータスコード	タイプ	メッセージ	説明
204	NO_CONTENT	No Content	リクエストが成功しました。
400	BAD_REQUEST	Bad Request	リクエストの形式が次のいずれかの理由で正しくありません。 • 指定されたフレンドリー名を持つデバイスグループが、指定された関連付け先のユニットに既に存在しています。
401	UNAUTHORIZED	Unauthorized	認可に失敗しました。
403	FORBIDDEN	Forbidden	リクエストを完了できませんでした。
404	NOT_FOUND	Not Found	指定されたデバイスグループが存在しないか、呼び出し元にそのデバイスグループへのアクセス権限がありません。
429	TOO_MANY_REQUESTS	Too Many Requests	リクエストが制限されました。
500	INTERNAL_SERVER_ERROR	Internal Server Error	サーバー側でエラーが発生しました。
503	SERVICE_UNAVAILABLE	Service Unavailable	サービスが一時的に使用できません。

デバイスグループを削除する

デバイスグループを削除するには、DELETE /v1/deviceGroups/{id}を呼び出します。削除を実行すると、デバイスグループからメンバーデバイスおよび関連付けられているユニットがすべて削除されますが、それらのデバイスとユニットは引き続き存在します。

この操作は以下の国で使用できます。

Healthcare	Hospitality	Residential	Senior Living	Core
米国	米国、英国、フランス、カナダ、イタリア、ドイツ	米国、カナダ	米国、英国、フランス、カナダ、イタリア、ドイツ	米国

リクエストの形式

DELETE /v1/deviceGroups/{id}  HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWAトークン}

リクエストのパスパラメーター

フィールド	説明	型	必須
`id`	デバイスグループIDです。有効なデバイスグループを表している必要があります。	文字列	◯

成功応答ヘッダー

注：応答ヘッダーで返されるHost値は、リクエストのHost値と同じになります。

HTTP/1.1 204 No Content
Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

フィールド	説明	型	必須
`X-Amzn-RequestId`	リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。	文字列	◯

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド	説明	型	必須
`type`	エラーのエラータイプです。	文字列	◯
`message`	エラーのエラーメッセージです。エラーメッセージはデバッグやログ記録のみを目的としたものであり、ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックは構築しないでください。	文字列	◯

HTTP応答コード

ステータスコード	タイプ	メッセージ	説明
204	NO_CONTENT	No Content	リクエストが成功しました。
400	BAD_REQUEST	Bad Request	リクエストの形式が正しくありません。
401	UNAUTHORIZED	Unauthorized	認可に失敗しました。
404	NOT_FOUND	Not Found	指定されたデバイスグループが存在しないか、呼び出し元にそのデバイスグループへのアクセス権限がありません。
429	TOO_MANY_REQUESTS	Too Many Requests	リクエストが制限されました。
500	INTERNAL_SERVER_ERROR	Internal Server Error	サーバー側でエラーが発生しました。
503	SERVICE_UNAVAILABLE	Service Unavailable	サービスが一時的に使用できません。

デバイスグループのリストを取得する

デバイスグループのリストを取得するには、GET /v1/deviceGroupsを呼び出します。

この操作は以下の国で使用できます。

Healthcare	Hospitality	Residential	Senior Living	Core
米国	米国、英国、フランス、カナダ、イタリア、ドイツ	米国、カナダ	米国、英国、フランス、カナダ、イタリア、ドイツ	米国

リクエストの形式

GET /v1/deviceGroups?associatedUnits.id={UnitId}&maxResults={maxResults}&nextToken={nextToken} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWAトークン}

リクエストのパスパラメーター

ありません。

リクエストと応答の例

以下の例では、この呼び出しの使用方法を示します。

デフォルトの情報のみを含める

この例では、各デバイスグループのデフォルトの情報のみを含める方法を示します。

リクエストは以下のようになります。

GET /v1/deviceGroups?associatedUnits.id=amzn1.alexa.unit.did.KOHSO00IAQYD6S0W5GWBKF1U2JQFDK1GHAJFNPAK4MTCHO0VJNMTJQOQVOVHMOUW4CW5XM0TC4LDRKBA1NLOS6EKPAXDD5AVEY3E5QVN HTTP/1.1

応答は以下のようになります。

HTTP/1.1 200 OK

{
  "paginationContext": {
    "nextToken": null
  },
  "results": [
    {
      "deviceGroup": {
        "id": "amzn1.alexa.endpointGroup.kMbAbfF9JTDyE7c8Tg2DzBOWhzAmLMq4MZwlbjGJ9rZ8QPm6bmbKPijbwoziWof5SzbBHWu7LOBa6z2N6mB64g"
      }
    }
  ]
}

各デバイスグループの詳細を含める

この例では、expand=allパラメーターを使用して各デバイスグループの詳細を含める方法を示します。

リクエストは以下のようになります。

GET /v1/deviceGroups?associatedUnits.id=amzn1.alexa.unit.did.GMCCVDN5EIN4PBFQMNRHT7U6H4RDMXNEYAIHYX4C1IVX3RARAEAZJU1KMAC74VFK00TPD0PWWITP991M4E6UE14KW2Q4BGM0X0PEMEHD&expand=all HTTP/1.1

応答は以下のようになります。

HTTP/1.1 200 OK

{
  "paginationContext": {
    "nextToken": null
  },
  "results": [
    {
      "deviceGroup": {
        "id": "amzn1.alexa.endpointGroup.kMbAbfF9JTDyE7c8Tg2DzBOWhzAmLMq4MZwlbjGJ9rZ8QPm6bmbKPijbwoziWof5SzbBHWu7LOBa6z2N6mB64g",
        "friendlyName": {
          "type": "PLAIN",       
          "value": {
            "text": "キッチン"
          }
        },
        "memberDevices": [
          {
            "id": "amzn1.alexa.endpoint.BmX5E58b3nEKsmwSwKs6NofAP9eNe3jFs9C5aa3Ui49CAnpmkwKiZ58OhdPrsMVzxjZkgn5TWrFioHkACNhAmNKximBGWTpfBzh1IpJIR14b0gfT83evGBCvMBf0HpAz9HEzBqnToo1NnSjBGUqpiFUr8FfrCa26bNYdqhsIZ8aNlOdmb8UK4dT2tQnYn52MFP9x4lkfGsXN93YIaI3ur42GxuvO5CFOBgJ8ALPf7UDCMadoZ3WM3db2cZ2EW92"
          }
        ],
        "associatedUnits": [
          {
            "id": "amzn1.alexa.unit.did.7RBKKY0AGCGS9WWGNGG6QLFJQ2U6XADPWRQCS15O7DWNO62U0AAHYF5B79I018JMGLFWQTRUHTGSI7BA7A9CEOD929TBP253R82V03R3"
          }
        ]
      }
    }
  ]
}

リクエストのクエリパラメーター

フィールド	説明	型	必須
`associatedUnits.id`	デバイスグループをフィルタリングして、指定したユニットに関連付けられているデバイスグループだけを取得します。	文字列	◯
`maxResults`	1回の呼び出しで取得する結果の最大数です。値は1～10の間で指定します。デフォルト値は10です。	整数	✕
`nextToken`	`nextToken`の値を次回のリクエストで継続トークン（`nextToken`クエリパラメーター）として使用すると、結果の次のページを取得できます。最初のリクエストと同じフィルターパラメーターを渡す必要があります。フィルターパラメーターが変更されると、400 Bad Requestが返されます。詳細については、クエリ結果のページ分割を処理するを参照してください。	文字列	✕
`expand`	応答で返すプロパティのセットです。現在サポートされている値は、`"all"`のみです。このパラメーターが指定されていない場合は、`"id"`プロパティだけが返されます。	文字列	✕

成功応答ヘッダー

注：応答ヘッダーで返されるHost値は、リクエストのHost値と同じになります。

HTTP/1.1 200 OK
Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

フィールド	説明	型	必須
`X-Amzn-RequestId`	リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。	文字列	◯

応答本文のパラメーター

フィールド	説明	型	詳細な結果にのみ存在
`paginationContext`	ページ分割情報を含むオブジェクトです。これが存在する場合、応答に含まれている結果は完全ではありません。存在しない場合、すべての結果が既に返されています。詳細については、クエリ結果のページ分割を処理するを参照してください。	オブジェクト	✕
`paginationContext.nextToken`	`nextToken`の値を次回のリクエストで継続トークンとして使用すると、オブジェクトの次のセットを取得できます。	文字列	✕
`results`	クエリへの応答として返されたデバイスグループのリストです。	`DeviceGroup`オブジェクトのリスト	✕
`results.deviceGroup`	デバイスグループオブジェクトです。	`DeviceGroup`オブジェクト	✕
`results.deviceGroup.id`	デバイスグループIDです。`"amzn1.alexa.endpointGroup.{deviceGroupId}"`というAmazon Common Identifier（ACI）形式で表します。	文字列	✕
`results.deviceGroup.friendlyName`	デバイスグループのフレンドリー名です。	`NameValue`オブジェクト	◯
`results.deviceGroup.memberDevices`	デバイスグループのメンバーにするデバイスです。	`Endpoint`オブジェクトのリスト	◯
`results.deviceGroup.associatedUnits`	デバイスグループに関連付けられるユニットのIDです。現在、指定できるユニットIDは1つだけです。	`Unit`オブジェクトのリスト	◯

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド	説明	型	必須
`type`	エラーのエラータイプです。	文字列	◯
`message`	エラーのエラーメッセージです。エラーメッセージはデバッグやログ記録のみを目的としたものであり、ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックは構築しないでください。	文字列	◯

HTTP応答コード

ステータスコード	タイプ	メッセージ	説明
200	OK	OK	リクエストが成功しました。
400	BAD_REQUEST	Bad Request	リクエストの形式が次のいずれかの理由で正しくありません。 • 指定された`nextToken`の値が無効か、有効期限が切れています。 • 指定された`nextToken`の値は有効ですが、フィルターパラメーターが前回のリクエストと一致しませんでした。 • 指定された`maxResults`の値が無効です。
401	UNAUTHORIZED	Unauthorized	認可に失敗しました。
403	FORBIDDEN	Forbidden	リクエストを完了できませんでした。
429	TOO_MANY_REQUESTS	Too Many Requests	リクエストが制限されました。
500	INTERNAL_SERVER_ERROR	Internal Server Error	サーバー側でエラーが発生しました。
503	SERVICE_UNAVAILABLE	Service Unavailable	サービスが一時的に使用できません。

このページは役に立ちましたか？

フィードバックを送信

最終更新日: 2023 年 03 月 16 日