このクイックスタートでは、アカウントの OAuth トークンを取得し、Data Portability API エンドポイントに定期的なリクエストを送信します。
このクイックスタートでは、Data Portability API を使用してユーザーデータに時間ベースでアクセスする方法について説明します。ユーザーデータへの 1 回限りのアクセスについては、Data Portability API の使用を開始するをご覧ください。リクエストに時間フィルタを適用する方法については、時間フィルタを適用するをご覧ください。
学習内容
このクイックスタートでは、次の方法について学習します。
- 有効な OAuth トークンを指定して、認証されたリクエストを
InitiatePortabilityArchiveエンドポイントに送信します。レスポンスには有効なjob_idが含まれている必要があります。 - 認証済みリクエストを
GetPortabilityArchiveStateエンドポイントに送信します。レスポンスには有効なジョブ状態が含まれ、ジョブが完了すると署名付き URL が含まれます。 - 同じ認証情報を使用して、有効な OAuth トークンを含む認証済みリクエストを
InitiatePortabilityArchiveエンドポイントに 2 回送信します。最初のリクエストから 24 時間以内にリクエストが行われた場合は、FAILED_PRECONDITIONエラーが返されます。
前提条件
このクイックスタートを実行するには、以下が必要です。
- ユーザーが Data Portability API を利用できることを確認します。サポートされている国と地域の一覧については、[データのコピーをサードパーティと共有する] ページのよくある質問をご覧ください。
- Data Portability API の設定手順を完了します。
- 手順に沿って、JavaScript ウェブアプリの OAuth を構成します。本番環境では、通常、ウェブサーバー アプリケーション用の OAuth フローなど、別のフローを使用します。このクイックスタートでは、簡潔にするため JavaScript ウェブアプリのフローを使用します。
- 認証情報を作成するときに、OAuth 2.0 クライアント ID と承認済みのリダイレクト URI（https://google.com など）をメモします。これらの値は、クイックスタートの後半で必要になります。
- Data Portability API のスコープを構成する際は、このクイックスタートで
myactivity.searchリソース グループ（https://www.googleapis.com/auth/dataportability.myactivity.search）が使用されることに注意してください。 - アクセスを許可する期間を選択する際は、時間ベースのアクセスをテストするために [30 日間] を選択する必要があります。
- OAuth トークンを取得します。
- 組織が所有または管理するアカウントへのアクセス権を取得します。このクイックスタートでは、このアカウントの検索アクティビティ データがエクスポートされます。
OAuth トークンを取得する
このクイックスタートでは、認可リクエストを送信して URL を使用して OAuth トークンを取得します。このプロセスでは、JavaScript ウェブアプリのフローを使用します。このフローでは更新トークンは返されません。
本番環境のアプリでは、通常、OAuth フローを使用して更新トークンを取得し、必要に応じてアクセス トークンを生成します。たとえば、サーバーサイド ウェブアプリのフローがこれに該当します。
OAuth トークンを取得するには:
次のような URL を作成します。
https://accounts.google.com/o/oauth2/v2/auth? client_id=client_id& redirect_uri=redirect_uri& response_type=token& scope=https://www.googleapis.com/auth/dataportability.myactivity.search& state=developer-specified-value
URL の場合:
client_idは OAuth クライアント ID です。redirect_uriは、承認済みリダイレクト URI です（例: https://google.com）。
このクイックスタートの URL で使用されているスコープは、検索アクティビティ スコープです。YouTube アクティビティ スコープまたは両方のスコープを使用することもできます。
URL をブラウザのアドレスバーに貼り付け、OAuth フローの手順に沿って操作します。このフローでは、このクイックスタートで使用する、組織が所有または管理するアカウントにログインする必要があります。
これは、OAuth スコープに同意するアカウントです。同意画面は次のようになります（画面上のテキストは、この画像のテキストとは異なる場合があります）。
アクセス権を付与するスコープと、アカウントのデータへのアクセス権を共有する期間（1 回、30 日間、180 日間）を選択します。このクイックスタートでは、[30 日] を選択します。
同意してアクセス期間を決定すると、リダイレクト URI（https://google.com）に転送されます。アドレスバーに生成された URL には、OAuth アクセス トークンが含まれています。
たとえば、ユーザー アカウントが
dataportability.myactivity.searchスコープへの OAuth アクセスを許可している場合、生成される URL は次のようになります。https://google.com/#state=developer-specified-value&access_token=your_OAuth_token&token_type=Bearer&expires_in=3599&scope=https://www.googleapis.com/auth/dataportability.myactivity.search
URL の your_OAuth_token は、トークンを表す文字列です。
OAuth トークンを検証するには、次の URL をブラウザに貼り付けます。
https://www.googleapis.com/oauth2/v3/tokeninfo?access_token=your_OAuth_token
レスポンスは次のようになります。
{ "azp": <your_azp_value>, "aud": <your_aud_value>, "scope": "https://www.googleapis.com/auth/dataportability.myactivity.search", "exp": "1694210968", "expires_in": "3334", "access_type": "online" }リクエストを送信するために
azpフィールドやaudフィールドを使用する必要はありません。azpフィールドは、承認済みプレゼンターのclient_idを表します。audフィールドは、このトークンの対象となるオーディエンスを識別します。これは、アプリのクライアント ID のいずれかと同じになります。OAuth トークンと API キーを取得します。Data Portability API を呼び出すには、これらが必要です。
エンドポイントにリクエストを送信する
このクイックスタートでは、curl コマンドを使用して Data Portability API エンドポイントを呼び出します。これらのコマンドには、前述で取得した OAuth トークンと API キーが必要です。
Data Portability API を呼び出すには:
まず、認証済みリクエストを
InitiatePortabilityArchiveエンドポイントに送信します。このリクエストにより、アーカイブ ジョブが開始されます。次の curl コマンドを実行します。
curl -H 'Authorization: Bearer your_OAuth_token' -X POST \ -H "Content-Type: application/json; charset=utf-8" \ --data '{"resources":["myactivity.search"]}' \ https://dataportability.googleapis.com/v1/portabilityArchive:initiate
コマンドは次のように変更してください。
your_OAuth_tokenは OAuth トークンです。
InitiatePortabilityArchiveリクエストはjob_idとaccessTypeを返します。ジョブ ID はデータ アーカイブの状態を取得するために使用され、アクセスタイプによって、データへの 1 回限りのアクセス権または時間ベースのアクセス権が付与されているかどうかが決まります。時間ベースのアクセスの場合、次の情報が表示されます。{ "archiveJobId": "<your_job_id>" "accessType": "ACCESS_TYPE_TIME_BASED" }有効な OAuth トークンを指定しなかった場合、次のエラー メッセージが返されます。
Request had invalid authentication credentials. Expected OAuth 2.0 access token, login cookie or other valid authentication credential. See https://developers.google.com/identity/sign-in/web/devconsole-project.
次に、認証済みリクエストを
GetPortabilityArchiveStateエンドポイントに送信して、アーカイブ ジョブのステータスを取得します。次の curl コマンドを実行します。
curl -H 'Authorization: Bearer your_OAuth_token' -X GET \ -H "Content-Type: application/json; charset=utf-8" \ https://dataportability.googleapis.com/v1/archiveJobs/your_job_id/portabilityArchiveState
コマンドは次のように変更してください。
your_OAuth_tokenは OAuth トークンです。your_job_idは、InitiatePortabilityArchiveリクエストによって返されたジョブ ID です。
レスポンスは、ジョブの状態に基づいています。ジョブが完了していない場合、レスポンスには現在の状態が示されます。ジョブが完了するまで、このエンドポイントに定期的にリクエストを送信する必要があります。
{ "state": "IN_PROGRESS" }ジョブが完了している場合、レスポンスには状態と、データ アーカイブのダウンロードに使用される 1 つ以上の署名付き URL が含まれます。
{ "state": "COMPLETE", "urls": [ "<signed_url>" ] }署名付き URL をブラウザに貼り付けて、データ アーカイブをダウンロードします。アーカイブの内容を調べて、想定される検索アクティビティ データが含まれていることを確認する必要があります。
レスポンスで
FAILEDステータスが返された場合は、RetryPortabilityArchiveメソッドを使用してエクスポートを再試行できます。前のコマンドを繰り返して、認証済みリクエストを
InitiatePortabilityArchiveエンドポイントに送信します。curl -H 'Authorization: Bearer your_OAuth_token' -X POST \ -H "Content-Type: application/json; charset=utf-8" \ --data '{"resources":["myactivity.search"]}' \ https://dataportability.googleapis.com/v1/portabilityArchive:initiate
コマンドは次のように変更してください。
your_OAuth_tokenは OAuth トークンです。
レスポンスには、
myactivity.searchリソースがすでにエクスポートされていること、および再試行できるタイムスタンプが表示されます。... "error": { "code": 429, "message": "Requested resources have already been exported. You can initiate another export after #{timestamp_after_24hrs}.", "status": "RESOURCE_EXHAUSTED", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "RESOURCE_EXHAUSTED_TIME_BASED", "domain": "dataportability.googleapis.com" "metadata": { "previous_job_ids": "#{previous_job_ids}" "access_type": "ACCESS_TYPE_TIME_BASED" "timestamp_after_24hrs": "#{timestamp_after_24hrs}" ...