Method: archiveJobs.cancel
Stay organized with collections
Save and categorize content based on your preferences.
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.subscriptionshttps://www.googleapis.com/auth/dataportability.businessmessaging.conversationshttps://www.googleapis.com/auth/dataportability.chrome.autofillhttps://www.googleapis.com/auth/dataportability.chrome.bookmarkshttps://www.googleapis.com/auth/dataportability.chrome.dictionaryhttps://www.googleapis.com/auth/dataportability.chrome.extensionshttps://www.googleapis.com/auth/dataportability.chrome.historyhttps://www.googleapis.com/auth/dataportability.chrome.reading_listhttps://www.googleapis.com/auth/dataportability.chrome.settingshttps://www.googleapis.com/auth/dataportability.discover.followshttps://www.googleapis.com/auth/dataportability.discover.likeshttps://www.googleapis.com/auth/dataportability.discover.not_interestedhttps://www.googleapis.com/auth/dataportability.maps.aliased_placeshttps://www.googleapis.com/auth/dataportability.maps.commute_routeshttps://www.googleapis.com/auth/dataportability.maps.commute_settingshttps://www.googleapis.com/auth/dataportability.maps.ev_profilehttps://www.googleapis.com/auth/dataportability.maps.factual_contributionshttps://www.googleapis.com/auth/dataportability.maps.offering_contributionshttps://www.googleapis.com/auth/dataportability.maps.photos_videoshttps://www.googleapis.com/auth/dataportability.maps.questions_answershttps://www.googleapis.com/auth/dataportability.maps.reviewshttps://www.googleapis.com/auth/dataportability.maps.starred_placeshttps://www.googleapis.com/auth/dataportability.myactivity.mapshttps://www.googleapis.com/auth/dataportability.myactivity.myadcenterhttps://www.googleapis.com/auth/dataportability.myactivity.playhttps://www.googleapis.com/auth/dataportability.myactivity.searchhttps://www.googleapis.com/auth/dataportability.myactivity.shoppinghttps://www.googleapis.com/auth/dataportability.myactivity.youtubehttps://www.googleapis.com/auth/dataportability.mymaps.mapshttps://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservationshttps://www.googleapis.com/auth/dataportability.play.deviceshttps://www.googleapis.com/auth/dataportability.play.groupinghttps://www.googleapis.com/auth/dataportability.play.installshttps://www.googleapis.com/auth/dataportability.play.libraryhttps://www.googleapis.com/auth/dataportability.play.playpointshttps://www.googleapis.com/auth/dataportability.play.promotionshttps://www.googleapis.com/auth/dataportability.play.purchaseshttps://www.googleapis.com/auth/dataportability.play.redemptionshttps://www.googleapis.com/auth/dataportability.play.subscriptionshttps://www.googleapis.com/auth/dataportability.play.usersettingshttps://www.googleapis.com/auth/dataportability.saved.collectionshttps://www.googleapis.com/auth/dataportability.search_ugc.commentshttps://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_starshttps://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providershttps://www.googleapis.com/auth/dataportability.search_ugc.media.thumbshttps://www.googleapis.com/auth/dataportability.search_ugc.media.watchedhttps://www.googleapis.com/auth/dataportability.searchnotifications.settingshttps://www.googleapis.com/auth/dataportability.searchnotifications.subscriptionshttps://www.googleapis.com/auth/dataportability.shopping.addresseshttps://www.googleapis.com/auth/dataportability.shopping.reviewshttps://www.googleapis.com/auth/dataportability.streetview.imageryhttps://www.googleapis.com/auth/dataportability.youtube.channelhttps://www.googleapis.com/auth/dataportability.youtube.clipshttps://www.googleapis.com/auth/dataportability.youtube.commentshttps://www.googleapis.com/auth/dataportability.youtube.live_chathttps://www.googleapis.com/auth/dataportability.youtube.musichttps://www.googleapis.com/auth/dataportability.youtube.playablehttps://www.googleapis.com/auth/dataportability.youtube.postshttps://www.googleapis.com/auth/dataportability.youtube.private_playlistshttps://www.googleapis.com/auth/dataportability.youtube.private_videoshttps://www.googleapis.com/auth/dataportability.youtube.public_playlistshttps://www.googleapis.com/auth/dataportability.youtube.public_videoshttps://www.googleapis.com/auth/dataportability.youtube.shoppinghttps://www.googleapis.com/auth/dataportability.youtube.subscriptionshttps://www.googleapis.com/auth/dataportability.youtube.unlisted_playlistshttps://www.googleapis.com/auth/dataportability.youtube.unlisted_videos
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-13 UTC.
[null,null,["Last updated 2025-02-13 UTC."],[],[],null,["# Method: archiveJobs.cancel\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n\nCancels a Portability Archive job.\n\n### HTTP request\n\n`POST https://dataportability.googleapis.com/v1/{name=archiveJobs/*}:cancel`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body is empty.\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/dataportability.alerts.subscriptions`\n- `https://www.googleapis.com/auth/dataportability.businessmessaging.conversations`\n- `https://www.googleapis.com/auth/dataportability.chrome.autofill`\n- `https://www.googleapis.com/auth/dataportability.chrome.bookmarks`\n- `https://www.googleapis.com/auth/dataportability.chrome.dictionary`\n- `https://www.googleapis.com/auth/dataportability.chrome.extensions`\n- `https://www.googleapis.com/auth/dataportability.chrome.history`\n- `https://www.googleapis.com/auth/dataportability.chrome.reading_list`\n- `https://www.googleapis.com/auth/dataportability.chrome.settings`\n- `https://www.googleapis.com/auth/dataportability.discover.follows`\n- `https://www.googleapis.com/auth/dataportability.discover.likes`\n- `https://www.googleapis.com/auth/dataportability.discover.not_interested`\n- `https://www.googleapis.com/auth/dataportability.maps.aliased_places`\n- `https://www.googleapis.com/auth/dataportability.maps.commute_routes`\n- `https://www.googleapis.com/auth/dataportability.maps.commute_settings`\n- `https://www.googleapis.com/auth/dataportability.maps.ev_profile`\n- `https://www.googleapis.com/auth/dataportability.maps.factual_contributions`\n- `https://www.googleapis.com/auth/dataportability.maps.offering_contributions`\n- `https://www.googleapis.com/auth/dataportability.maps.photos_videos`\n- `https://www.googleapis.com/auth/dataportability.maps.questions_answers`\n- `https://www.googleapis.com/auth/dataportability.maps.reviews`\n- `https://www.googleapis.com/auth/dataportability.maps.starred_places`\n- `https://www.googleapis.com/auth/dataportability.myactivity.maps`\n- `https://www.googleapis.com/auth/dataportability.myactivity.myadcenter`\n- `https://www.googleapis.com/auth/dataportability.myactivity.play`\n- `https://www.googleapis.com/auth/dataportability.myactivity.search`\n- `https://www.googleapis.com/auth/dataportability.myactivity.shopping`\n- `https://www.googleapis.com/auth/dataportability.myactivity.youtube`\n- `https://www.googleapis.com/auth/dataportability.mymaps.maps`\n- `https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations`\n- `https://www.googleapis.com/auth/dataportability.play.devices`\n- `https://www.googleapis.com/auth/dataportability.play.grouping`\n- `https://www.googleapis.com/auth/dataportability.play.installs`\n- `https://www.googleapis.com/auth/dataportability.play.library`\n- `https://www.googleapis.com/auth/dataportability.play.playpoints`\n- `https://www.googleapis.com/auth/dataportability.play.promotions`\n- `https://www.googleapis.com/auth/dataportability.play.purchases`\n- `https://www.googleapis.com/auth/dataportability.play.redemptions`\n- `https://www.googleapis.com/auth/dataportability.play.subscriptions`\n- `https://www.googleapis.com/auth/dataportability.play.usersettings`\n- `https://www.googleapis.com/auth/dataportability.saved.collections`\n- `https://www.googleapis.com/auth/dataportability.search_ugc.comments`\n- `https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars`\n- `https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers`\n- `https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs`\n- `https://www.googleapis.com/auth/dataportability.search_ugc.media.watched`\n- `https://www.googleapis.com/auth/dataportability.searchnotifications.settings`\n- `https://www.googleapis.com/auth/dataportability.searchnotifications.subscriptions`\n- `https://www.googleapis.com/auth/dataportability.shopping.addresses`\n- `https://www.googleapis.com/auth/dataportability.shopping.reviews`\n- `https://www.googleapis.com/auth/dataportability.streetview.imagery`\n- `https://www.googleapis.com/auth/dataportability.youtube.channel`\n- `https://www.googleapis.com/auth/dataportability.youtube.clips`\n- `https://www.googleapis.com/auth/dataportability.youtube.comments`\n- `https://www.googleapis.com/auth/dataportability.youtube.live_chat`\n- `https://www.googleapis.com/auth/dataportability.youtube.music`\n- `https://www.googleapis.com/auth/dataportability.youtube.playable`\n- `https://www.googleapis.com/auth/dataportability.youtube.posts`\n- `https://www.googleapis.com/auth/dataportability.youtube.private_playlists`\n- `https://www.googleapis.com/auth/dataportability.youtube.private_videos`\n- `https://www.googleapis.com/auth/dataportability.youtube.public_playlists`\n- `https://www.googleapis.com/auth/dataportability.youtube.public_videos`\n- `https://www.googleapis.com/auth/dataportability.youtube.shopping`\n- `https://www.googleapis.com/auth/dataportability.youtube.subscriptions`\n- `https://www.googleapis.com/auth/dataportability.youtube.unlisted_playlists`\n- `https://www.googleapis.com/auth/dataportability.youtube.unlisted_videos`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]