REST Resource: devices

資源:AmbientDevice

微光裝置的表示法。

JSON 表示法
{
  "id": string,
  "displayName": string,
  "mediaSources": [
    {
      object (AmbientMediaSource)
    }
  ],
  "settingsUri": string,
  "createTime": string,
  "pollingConfig": {
    object (PollingConfig)
  },
  "mediaSourcesSet": boolean
}
欄位
id

string

僅供輸出。裝置的專屬 ID。

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)

僅供輸出。輪詢要求之間的建議時間。

以秒為單位的時間長度,最多可有 9 個小數位數,結尾為「s」,例如:"3.5s"

方法

create

在使用者的 Google 相簿帳戶中建立微光裝置。

delete

將指定裝置從使用者的 Google 相簿帳戶中移除。

get

擷取指定裝置的相關資訊。

patch

更新指定裝置的相關資訊。