Method: archiveJobs.cancel

    • This information details how to cancel a Portability Archive job using an HTTP POST request.

    • The request requires a path parameter specifying the Archive job ID to be canceled, which is only effective if the job is in progress.

    • Both the request and response bodies for this operation are empty.

    • Multiple OAuth scopes are listed as authorization requirements to perform this action.

    Cancels a Portability Archive job.

    HTTP request

    POST https://dataportability.googleapis.com/v1/{name=archiveJobs/*}:cancel

    The URL uses gRPC Transcoding syntax.

    Path parameters

    Parameters
    name

    string

    Required. The Archive job ID you're canceling. This is returned by the InitiatePortabilityArchive response. The format is: archiveJobs/{archive_job}. Canceling is only executed if the job is in progress.

    Request body

    The request body must be empty.

    Response body

    If successful, the response body is empty.

    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.comments
    • 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 .
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: