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

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

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

必要條件

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

此外,您也需確認所在地區的使用者能使用 Data Portability API。如需支援的國家/地區清單,請參閱「與第三方分享資料副本」頁面的常見問題

開發人員工作流程

下列步驟說明如何建立使用 Data Portability API 的應用程式。

開發人員使用 Data Portability API 建立應用程式的步驟

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

    1. 使用者按一下「Import YouTube Video」,然後登入 Google 帳戶。

    2. 應用程式將使用者轉送至 OAuth 同意網址。請注意,這個範例網址經過簡化,並缺少某些參數:

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

    3. 使用者在 OAuth 同意畫面中點選「下一步」,同意分享個人資料並提供帳戶存取權。

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

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

  2. 應用程式透過附加的 OAuth 權杖呼叫 InitiatePortabilityArchive(resources = ["myactivity.youtube"]),該權杖包含此 OAuth 範圍:

    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 方法,請參閱「呼叫資料可攜權 API 方法」一文。

使用者與 Data Portability API 應用程式互動的方式

此圖表顯示使用者與已整合 Data Portability API 的應用程式互動。

使用者匯出資料的步驟

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

  2. 接下來,使用者登入自己的 Google 帳戶。

  3. 當系統提示使用者分享資料時,請按一下「Next」(下一步),然後在系統提示使用者接受隱私權政策時按一下「Got it」(我知道了)

  4. 接著,使用者會看到 OAuth 同意畫面,用於允許應用程式存取其資料。此處的選項與您設定的 OAuth 範圍相符。

  5. 授予存取權後,資料匯入作業就會啟動。視資料的大小而定,要求可能需要數分鐘至數小時才能完成。