Amazon FireOS Native Client API參考 amazon-fireos-native-client-api-reference

狀態：可以使用下列其中一個值：

• AccessEnabler.ACCESS_ENABLER_STATUS_SUCCESS — 設定
  階段已成功完成
• AccessEnabler.ACCESS_ENABLER_STATUS_ERROR — 設定
  階段失敗

選項：包含全域SDK選項的對應<字串，字串>。 目前提供下列選項：

• applicationProfile — 它可用來根據這個值設定伺服器組態。
• ap_vi -Experience Cloud識別碼服務。 此值稍後可用於進階分析報表。
• device_info — 裝置資訊，如​ 傳遞裝置資訊逐步指南 ​中所述

狀態：可以使用下列其中一個值：

• AccessEnabler.ACCESS_ENABLER_STATUS_SUCCESS — 驗證流程已成功完成
• AccessEnabler.ACCESS_ENABLER_STATUS_ERROR — 驗證流程失敗
• AccessEnabler.ACCESS_ENABLER_STATUS_LOGOUT — 登出

代碼：顯示狀態的原因。 如果​ 狀態 ​為AccessEnabler.ACCESS_ENABLER_STATUS_SUCCESS，則​ 代碼 ​為空字串（亦即，由AccessEnabler.USER_AUTHENTICATED常數定義）。 如果未驗證，此引數可以有下列其中一個值：

• AccessEnabler.USER_NOT_AUTHENTICATED_ERROR — 使用者未驗證。 當本機權杖快取中沒有有效的驗證權杖時，回應​ checkAuthentication() ​方法呼叫。
• AccessEnabler.PROVIDER_NOT_SELECTED_ERROR — 在上層應用程式將​ null ​傳遞到setSelectedProvider()之後，AccessEnabler已重設驗證狀態電腦，以中止驗證流程。 使用者可能已取消驗證流程（亦即按下「上一步」按鈕）。
• AccessEnabler.GENERIC_AUTHENTICATION_ERROR — 由於網路無法使用或使用者明確取消驗證流程等原因，驗證流程失敗。
• AccessEnabler.LOGOUT — 由於登出動作，使用者未經驗證。

• AccessEnabler.USER_NOT_AUTHORIZED_ERROR — 使用者無法授權指定的資源

metadataKey：封裝索引鍵和args變數的資料結構，其含義如下：

• 如果金鑰為METADATA_KEY_TTL_AUTHN，則會進行查詢以取得驗證權杖到期時間。

• 如果索引鍵是METADATA_KEY_TTL_AUTHZ，而且引數包含名稱= METADATA_ARG_RESOURCE_ID且值= [resource_id]的SerializableNameValuePair物件，則會進行查詢以取得與指定資源關聯的授權權杖的到期時間。

• 如果索引鍵是METADATA_KEY_DEVICE_ID，則會進行查詢以取得目前的裝置識別碼。 請注意，此功能預設為停用，程式設計師應聯絡Adobe以取得有關啟用和費用的資訊。

• 如果索引鍵是METADATA_KEY_USER_META，而且引數包含名稱= METADATA_KEY_USER_META且值= [metadata_name]的SerializableNameValuePair物件，則會針對使用者中繼資料進行查詢。 目前可用的使用者中繼資料型別清單：

  • zip — 郵遞區號
  • householdID — 家庭識別碼。 如果MVPD不支援附屬帳戶，這將會與userID相同。
  • maxRating — 使用者的家長評等上限
  • userID — 使用者識別碼。 如果MVPD支援附屬帳戶，且使用者不是主帳戶，
  • channelID — 使用者有權檢視的管道清單

key：包含要求中繼資料值的索引鍵和相關引數的MetadataKey物件（如需參考實作，請參閱示範應用程式）。

result：包含所要求中繼資料的複合物件。 物件包含下列欄位：

• simpleResult：字串，代表驗證TTL、授權TTL或裝置ID要求時的中繼資料值。 如果針對使用者中繼資料提出要求，則此值為Null。

• userMetadataResult：包含JSON使用者中繼資料承載之Java表示法的物件。 例如：

  code language-json
  { "street": "Main Avenue", "buildings": ["150", "320"] }

  會轉譯為Java，如下所示：

  code language-java
  Map("street" -> "Main Avenue", "buildings" -> List("150", "320")))

  使用者中繼資料物件的實際結構類似下列：

  code language-json
  { updated: 1334243471, encrypted: ["encryptedProp"], data: { zip: ["12345", "34567"], maxRating: { "MPAA": "PG-13", "VCHIP": "TV-Y", "URL": "http://exam.pl/e/manage/ratings" }, householdID: "3456", userID: "BgSdasfsdk23/dsaf3+saASesadgfsShggssd=", channelID: ["channel-1", "channel-2"] } }

裝置型別的可能值：

• computer
• tablet
• mobile
• gameconsole
• unknown

Access Enabler使用者端型別的可能值：

• flash
• html5
• ios
• tvos
• android
• firetv

event：正在追蹤的事件。 追蹤事件型別共有三種：

• authorizationDetection： ​當授權權杖要求傳回時（事件型別為EVENT_AUTHZ_DETECTION）
• authenticationDetection： ​任何時候發生驗證檢查時（事件型別為EVENT_AUTHN_DETECTION）
• mvpdSelection： (當使用者在MVPD選擇表單中選取MVPD （事件型別為EVENT_MVPD_SELECTION）)

資料：與報告事件相關的其他資料。 此資料會以值清單的形式呈現。

事件型別​ EVENT_AUTHN_DETECTION：

• 0 — 權杖要求是否成功(true/false)，如果以上為true：
• 1 - MVPD ID字串
• 2 - GUID （md5雜湊）
• 3 — 權杖已在快取中(true/false)
• 4 — 裝置型別
• 5 — 存取啟用程式使用者端型別
• 6 — 作業系統型別

針對事件型別EVENT_AUTHZ_DETECTION

• 0 — 權杖要求是否成功(true/false)，如果成功：
• 1 - MVPD ID
• 2 - GUID （md5雜湊）
• 3 — 權杖已在快取中(true/false)
• 4 — 錯誤
• 5 — 詳細資料
• 6 — 裝置型別
• 7 — 存取啟用程式使用者端型別
• 8 — 作業系統型別

針對事件型別EVENT_MVPD_SELECTION

• 0 — 目前所選MVPD的識別碼
• 1 — 裝置型別
• 2 — 存取啟用程式使用者端型別
• 3 — 作業系統型別