Method: portabilityArchive.initiate

Initiates a new Archive job for the Portability API.

HTTP request

POST https://dataportability.googleapis.com/v1/portabilityArchive:initiate

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "resources": [
    string
  ]
}
Fields
resources[]

string

The resources from which you're exporting data. These values have a 1:1 correspondence with the OAuth scopes.

Response body

Response from initiating an Archive job.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "archiveJobId": string
}
Fields
archiveJobId

string

The archive job ID that is initiated in the API. This can be used to get the state of the job.

Authorization scopes

Requires one of the following OAuth scopes:

  • 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.not_interested
  • https://www.googleapis.com/auth/dataportability.discover.likes
  • https://www.googleapis.com/auth/dataportability.maps.reviews
  • https://www.googleapis.com/auth/dataportability.maps.starred_places
  • 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.myactivity.youtube
  • https://www.googleapis.com/auth/dataportability.myactivity.maps
  • https://www.googleapis.com/auth/dataportability.myactivity.search
  • https://www.googleapis.com/auth/dataportability.myactivity.myadcenter
  • https://www.googleapis.com/auth/dataportability.myactivity.shopping
  • https://www.googleapis.com/auth/dataportability.myactivity.play
  • https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations
  • https://www.googleapis.com/auth/dataportability.mymaps.maps
  • https://www.googleapis.com/auth/dataportability.play.installs
  • https://www.googleapis.com/auth/dataportability.play.purchases
  • https://www.googleapis.com/auth/dataportability.play.subscriptions
  • https://www.googleapis.com/auth/dataportability.play.library
  • https://www.googleapis.com/auth/dataportability.play.redemptions
  • https://www.googleapis.com/auth/dataportability.play.usersettings
  • https://www.googleapis.com/auth/dataportability.play.devices
  • https://www.googleapis.com/auth/dataportability.play.playpoints
  • https://www.googleapis.com/auth/dataportability.play.promotions
  • https://www.googleapis.com/auth/dataportability.play.grouping
  • https://www.googleapis.com/auth/dataportability.saved.collections
  • https://www.googleapis.com/auth/dataportability.searchnotifications.settings
  • https://www.googleapis.com/auth/dataportability.searchnotifications.subscriptions
  • https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs
  • 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.watched
  • https://www.googleapis.com/auth/dataportability.shopping.reviews
  • https://www.googleapis.com/auth/dataportability.shopping.addresses
  • https://www.googleapis.com/auth/dataportability.streetview.imagery
  • https://www.googleapis.com/auth/dataportability.youtube.private_videos
  • https://www.googleapis.com/auth/dataportability.youtube.unlisted_videos
  • https://www.googleapis.com/auth/dataportability.youtube.public_videos
  • https://www.googleapis.com/auth/dataportability.youtube.channel
  • https://www.googleapis.com/auth/dataportability.youtube.subscriptions
  • https://www.googleapis.com/auth/dataportability.youtube.private_playlists
  • https://www.googleapis.com/auth/dataportability.youtube.unlisted_playlists
  • https://www.googleapis.com/auth/dataportability.youtube.public_playlists
  • https://www.googleapis.com/auth/dataportability.youtube.comments
  • https://www.googleapis.com/auth/dataportability.youtube.live_chat
  • https://www.googleapis.com/auth/dataportability.youtube.posts
  • https://www.googleapis.com/auth/dataportability.youtube.music
  • https://www.googleapis.com/auth/dataportability.youtube.shopping
  • https://www.googleapis.com/auth/dataportability.youtube.playable

For more information, see the OAuth 2.0 Overview.