REST Resource: devices

リソース: AmbientDevice

アンビエント デバイスを表します。

JSON 表現
{
  "id": string,
  "displayName": string,
  "mediaSources": [
    {
      object (AmbientMediaSource)
    }
  ],
  "settingsUri": string,
  "createTime": string,
  "pollingConfig": {
    object (PollingConfig)
  },
  "mediaSourcesSet": boolean
}
フィールド
id

string

出力専用。このデバイスの一意の識別子。

displayName

string

必須。このデバイスのユーザー定義の表示名。

この名前は Google フォト アプリの設定でユーザーに表示されますが、編集できるのは API 経由のみです。

有効な表示名は 1 ~ 100 文字(両端を含む)にする必要があります。

mediaSources[]

object (AmbientMediaSource)

出力専用。このデバイスに設定されているメディアソース。

メディアソースは、ユーザーがデバイスに表示するために選択したアルバムまたは写真コレクションです。

ユーザーがこのデバイスのメディアソースを選択していない場合(mediaSourcesSet = false)、このフィールドは空になります。

settingsUri

string

出力専用。Google フォト アプリ内のデバイスの設定にユーザーをリダイレクトするために使用される URI。

createTime

string (Timestamp format)

出力専用。このデバイスが作成された時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

pollingConfig

object (PollingConfig)

出力専用。アプリケーションが devices.get をポーリングする際に使用することを推奨される構成。

mediaSourcesSet

boolean

出力専用。設定されている場合、このデバイスのメディアソースが構成されており、クライアントはこのデバイスのメディア アイテムのリストをリクエストできます。

AmbientMediaSource

ユーザーがアンビエント デバイス用に選択したメディアソースを表します。

JSON 表現
{
  "id": string,
  "displayName": string
}
フィールド
id

string

出力専用。アンビエント メディア ソースの ID。

displayName

string

出力専用。このメディアソースの表示名。

PollingConfig

API のポーリングの構成。

JSON 表現
{
  "pollInterval": string
}
フィールド
pollInterval

string (Duration format)

出力専用。ポーリング リクエスト間の推奨時間。

s で終わる小数点以下 9 桁までの秒単位の期間。例: "3.5s"

メソッド

create

ユーザーの Google フォト アカウントにアンビエント デバイスを作成します。

delete

指定したデバイスをユーザーの Google フォト アカウントから削除します。

get

指定したデバイスに関する情報を取得します。

patch

指定したデバイスに関する情報を更新します。