Retrieves the state of an Archive job for the Portability API.
HTTP request
GET https://dataportability.googleapis.com/v1/{name=archiveJobs/*/portabilityArchiveState}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
Required. The archive job ID that is returned when you request the state of the job. The format is: archiveJobs/{archive_job}/portabilityArchiveState. archive_job is the job ID returned by the InitiatePortabilityArchiveResponse. |
Request body
The request body must be empty.
Response body
Resource that contains the state of an Archive job.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"state": enum ( |
Fields | |
---|---|
state |
Resource that represents the state of the Archive job. |
urls[] |
If the state is complete, this method returns the signed URLs of the objects in the Cloud Storage bucket. |
name |
The resource name of ArchiveJob's PortabilityArchiveState singleton. The format is: archiveJobs/{archive_job}/portabilityArchiveState. archive_job is the job ID provided in the request. |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/dataportability.alerts.subscriptions
https://www.googleapis.com/auth/dataportability.businessmessaging.conversations
https://www.googleapis.com/auth/dataportability.chrome.autofill
https://www.googleapis.com/auth/dataportability.chrome.bookmarks
https://www.googleapis.com/auth/dataportability.chrome.dictionary
https://www.googleapis.com/auth/dataportability.chrome.extensions
https://www.googleapis.com/auth/dataportability.chrome.history
https://www.googleapis.com/auth/dataportability.chrome.reading_list
https://www.googleapis.com/auth/dataportability.chrome.settings
https://www.googleapis.com/auth/dataportability.discover.follows
https://www.googleapis.com/auth/dataportability.discover.likes
https://www.googleapis.com/auth/dataportability.discover.not_interested
https://www.googleapis.com/auth/dataportability.maps.aliased_places
https://www.googleapis.com/auth/dataportability.maps.commute_routes
https://www.googleapis.com/auth/dataportability.maps.commute_settings
https://www.googleapis.com/auth/dataportability.maps.ev_profile
https://www.googleapis.com/auth/dataportability.maps.factual_contributions
https://www.googleapis.com/auth/dataportability.maps.offering_contributions
https://www.googleapis.com/auth/dataportability.maps.photos_videos
https://www.googleapis.com/auth/dataportability.maps.questions_answers
https://www.googleapis.com/auth/dataportability.maps.reviews
https://www.googleapis.com/auth/dataportability.maps.starred_places
https://www.googleapis.com/auth/dataportability.myactivity.maps
https://www.googleapis.com/auth/dataportability.myactivity.myadcenter
https://www.googleapis.com/auth/dataportability.myactivity.play
https://www.googleapis.com/auth/dataportability.myactivity.search
https://www.googleapis.com/auth/dataportability.myactivity.shopping
https://www.googleapis.com/auth/dataportability.myactivity.youtube
https://www.googleapis.com/auth/dataportability.mymaps.maps
https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations
https://www.googleapis.com/auth/dataportability.play.devices
https://www.googleapis.com/auth/dataportability.play.grouping
https://www.googleapis.com/auth/dataportability.play.installs
https://www.googleapis.com/auth/dataportability.play.library
https://www.googleapis.com/auth/dataportability.play.playpoints
https://www.googleapis.com/auth/dataportability.play.promotions
https://www.googleapis.com/auth/dataportability.play.purchases
https://www.googleapis.com/auth/dataportability.play.redemptions
https://www.googleapis.com/auth/dataportability.play.subscriptions
https://www.googleapis.com/auth/dataportability.play.usersettings
https://www.googleapis.com/auth/dataportability.saved.collections
https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars
https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers
https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs
https://www.googleapis.com/auth/dataportability.search_ugc.media.watched
https://www.googleapis.com/auth/dataportability.searchnotifications.settings
https://www.googleapis.com/auth/dataportability.searchnotifications.subscriptions
https://www.googleapis.com/auth/dataportability.shopping.addresses
https://www.googleapis.com/auth/dataportability.shopping.reviews
https://www.googleapis.com/auth/dataportability.streetview.imagery
https://www.googleapis.com/auth/dataportability.youtube.channel
https://www.googleapis.com/auth/dataportability.youtube.clips
https://www.googleapis.com/auth/dataportability.youtube.comments
https://www.googleapis.com/auth/dataportability.youtube.live_chat
https://www.googleapis.com/auth/dataportability.youtube.music
https://www.googleapis.com/auth/dataportability.youtube.playable
https://www.googleapis.com/auth/dataportability.youtube.posts
https://www.googleapis.com/auth/dataportability.youtube.private_playlists
https://www.googleapis.com/auth/dataportability.youtube.private_videos
https://www.googleapis.com/auth/dataportability.youtube.public_playlists
https://www.googleapis.com/auth/dataportability.youtube.public_videos
https://www.googleapis.com/auth/dataportability.youtube.shopping
https://www.googleapis.com/auth/dataportability.youtube.subscriptions
https://www.googleapis.com/auth/dataportability.youtube.unlisted_playlists
https://www.googleapis.com/auth/dataportability.youtube.unlisted_videos
For more information, see the OAuth 2.0 Overview.
State
The state of the Archive job. This enum is frozen.
Enums | |
---|---|
STATE_UNSPECIFIED |
Default value. This value is unused. |
IN_PROGRESS |
The job is in progress. |
COMPLETE |
The job is complete. |
FAILED |
The job failed. |
CANCELLED |
The job is cancelled. |