簡介:使用 Data Portability API 開發應用程式

您可以使用 Data Portability API 建構應用程式,要求使用者授權將 Google 服務中的資料副本移至應用程式。這可讓資料可攜,並方便切換服務。

如要瞭解使用者如何分享資料,請參閱「與第三方分享資料副本」。

必要條件

應用程式必須先獲得 Google 核准,才能發布。

您也應確認所在地區的使用者可以使用 Data Portability API。如需支援的國家與地區清單,請參閱「與第三方共用資料副本」頁面的常見問題一節。

開發人員工作流程

以下是建立使用資料可攜權 API 的應用程式所需的步驟。

開發人員使用資料可攜權 API 建立應用程式的步驟

  1. 為使用者導入 OAuth 同意流程。在此範例中,使用者提供 YouTube 影片資料的存取權。

    1. 使用者點選「匯入 YouTube 影片」,然後登入 Google 帳戶。

    2. 應用程式會將使用者導向 OAuth 同意網址。請注意,以下示例網址為簡化內容,並缺少部分參數:

      https://accounts.google.com/o/oauth2/v2/auth?scope=https://www.googleapis.com/auth/dataportability.myactivity.youtube

    3. 使用者在 OAuth 同意畫面中按一下「Next」,同意分享自己的資料,並提供帳戶存取權。

    4. 系統會將使用者重新導向至應用程式。

    5. 開發人員為使用者取得 OAuth 權杖。

  2. 應用程式使用包含此 OAuth 範圍的附加 OAuth 憑證呼叫 InitiatePortabilityArchive(resources = ["myactivity.youtube"])

    https://www.googleapis.com/auth/dataportability.myactivity.youtube

    這個呼叫會啟動建立資料封存檔的程序。建議您在使用者授權後的 24 小時內啟動可攜權封存程序。

  3. 您的應用程式會使用附加的 OAuth 權杖呼叫 GetPortabilityArchiveState(job_id),該權杖包含以下 OAuth 範圍:

    https://www.googleapis.com/auth/dataportability.myactivity.youtube

    您可以多次呼叫這個方法,擷取封存工作狀態。該方法會傳回工作的狀態。如果狀態為「COMPLETE」,表示封存檔已準備就緒,並提供已簽署的 Cloud Storage 網址。請注意,完成封存要求所需的時間,可能因資料大小而異。

  4. 使用已簽署的網址下載資料封存檔。

  5. 使用附加的 OAuth 權杖呼叫 ResetAuthorization(),藉此重設用盡的資源,並移除所有 OAuth 同意聲明。

如要進一步瞭解如何使用 Data Portability API 方法,請參閱「呼叫 Data Portability API 方法」。

使用者如何與 Data Portability API 應用程式互動

此圖表顯示使用者如何與與資料可攜權 API 整合的應用程式互動。

使用者匯出資料的步驟

  1. 首先,系統會向使用者顯示資料擷取選項。

  2. 接著,使用者登入 Google 帳戶。

  3. 接著,在系統提示共用資料時點選「Next」,然後在系統提示接受隱私權政策時,按一下「Got it」

  4. 接著,系統會向使用者顯示 OAuth 同意畫面,讓使用者授權應用程式存取其資料。這裡的選項會與您設定的 OAuth 範圍相符。

  5. 授予存取權後,系統就會開始匯入資料。視資料大小而定,要求可能需要數分鐘到數小時才能完成。