2024-02-02
▼ ▲ dataportability.portabilityArchive.initiate
Flat Path: v1beta/portabilityArchive:initiate
Path: v1beta/portabilityArchive:initiate
Scopes:
Description: Initiates a new Takeout Archive job for the Portability API.
HTTP Method: POST
▼ ▲ dataportability.authorization.reset
Flat Path: v1beta/authorization:reset
Description: Revokes OAuth tokens and resets exhausted scopes for a user/project pair. This method allows you to initiate a Takeout request after a new consent is granted. This method also indicates that previous archives can be garbage collected. You should call this method when all jobs are complete and all archives are downloaded. Do not call it only when you start a new job.
HTTP Method: POST
Path: v1beta/authorization:reset
Scopes:
▼ ▲ dataportability.archiveJobs.retry
Parameter Order: name
Path: v1beta/{+name}:retry
Scopes:
HTTP Method: POST
Flat Path: v1beta/archiveJobs/{archiveJobsId}:retry
Parameters:
name
Pattern: ^archiveJobs/[^/]+$
Location: path
Required: Yes
Type: string
Description: Required. The archive job ID returned by the InitiatePortabilityArchiveResponse to be retried. Retrying is only executed if the initial job failed.
Description: Retries a failed Portability Archive job.
▼ ▲ dataportability.archiveJobs.getPortabilityArchiveState
Scopes:
HTTP Method: GET
Flat Path: v1beta/archiveJobs/{archiveJobsId}/portabilityArchiveState
Path: v1beta/{+name}
Parameter Order: name
Parameters:
name
Location: path
Type: string
Pattern: ^archiveJobs/[^/]+/portabilityArchiveState$
Description: Required. The archive job ID that is returned when you request the state of the job from Takeout. The format is: archiveJobs/{archive_job}/portabilityArchiveState. archive_job is the job ID returned by the InitiatePortabilityArchiveResponse.
Required: Yes
Description: Retrieves the state of a Takeout Archive job for the Portability API.