Method: archiveJobs.getPortabilityArchiveState

Récupère l'état d'une tâche d'archivage pour l'API Portability.

Requête HTTP

GET https://dataportability.googleapis.com/v1/{name=archiveJobs/*/portabilityArchiveState}

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Obligatoire. ID de la tâche d'archivage renvoyé lorsque vous demandez l'état de la tâche. Le format est le suivant: archiveJobs/{archive_job}/portabilityArchiveState. archive_job correspond à l'ID de tâche renvoyé par InitiatePortabilityArchiveResponse.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Ressource contenant l'état d'une tâche d'archivage.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "state": enum (State),
  "urls": [
    string
  ],
  "name": string,
  "startTime": string,
  "exportTime": string
}
Champs
state

enum (State)

Ressource représentant l'état de la tâche d'archivage.
urls[]

string

Si l'état est terminé, cette méthode renvoie les URL signées des objets du bucket Cloud Storage.
name

string

Nom de ressource du singleton PortabilityArchiveState d'ArchiveJob. Le format est le suivant: archiveJobs/{archive_job}/portabilityArchiveState. archive_job correspond à l'ID de la tâche fourni dans la requête.
startTime

string (Timestamp format)

Code temporel représentant le point de départ des données que vous exportez. Ce champ n'est défini que si le champ startTime est spécifié dans InitiatePortabilityArchiveRequest.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
exportTime

string (Timestamp format)

Code temporel représentant le point final des données que vous exportez. Si la valeur endTime est définie dans InitiatePortabilityArchiveRequest, ce champ est défini sur cette valeur. Si la valeur "endTime" n'est pas définie, elle est définie sur l'heure à laquelle l'exportation a été demandée.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • 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

Pour en savoir plus, consultez OAuth 2.0 Overview.

État

État de la tâche d'archivage. Cette énumération est figée.

Enums
STATE_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
IN_PROGRESS La tâche est en cours.
COMPLETE La tâche est terminée.
FAILED La tâche a échoué.
CANCELLED La tâche est annulée.