Method: archiveJobs.getPortabilityArchiveState

Ruft den Status eines Archivierungsjobs für die Portability API ab.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Erforderlich. Die ID des Archivjobs, die zurückgegeben wird, wenn Sie den Status des Jobs anfordern. Das Format lautet: archiveJobs/{archive_job}/portabilityArchiveState. „archive_job“ ist die Job-ID, die von der InitiatePortabilityArchiveResponse zurückgegeben wurde.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Ressource, die den Status eines Archivierungsjobs enthält.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "state": enum (State),
  "urls": [
    string
  ],
  "name": string,
  "startTime": string,
  "exportTime": string
}
Felder
state

enum (State)

Ressource, die den Status des Archivierungsjobs darstellt.
urls[]

string

Wenn der Status abgeschlossen ist, gibt diese Methode die signierten URLs der Objekte im Cloud Storage-Bucket zurück.
name

string

Der Ressourcenname des PortabilityArchiveState-Singletons von ArchiveJob. Das Format lautet: archiveJobs/{archive_job}/portabilityArchiveState. „archive_job“ ist die in der Anfrage angegebene Job-ID.
startTime

string (Timestamp format)

Der Zeitstempel, der den Startpunkt für die exportierten Daten darstellt. Dieses Feld wird nur festgelegt, wenn das Feld „startTime“ in der InitiatePortabilityArchiveRequest-Anfrage angegeben ist.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
exportTime

string (Timestamp format)

Der Zeitstempel, der den Endpunkt für die exportierten Daten darstellt. Wenn der Wert „endTime“ in der InitiatePortabilityArchiveRequest-Anfrage festgelegt ist, wird dieses Feld auf diesen Wert gesetzt. Wenn „endTime“ nicht festgelegt ist, wird dieser Wert auf die Uhrzeit festgelegt, zu der der Export angefordert wurde.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • 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

Weitere Informationen finden Sie unter OAuth 2.0 Overview.

Status

Der Status des Archivierungsjobs. Dieser Enum ist eingefroren.

Enums
STATE_UNSPECIFIED Standardwert Dieser Wert wird nicht verwendet.
IN_PROGRESS Der Job wird bearbeitet.
COMPLETE Der Job ist abgeschlossen.
FAILED Der Job ist fehlgeschlagen.
CANCELLED Der Job wird abgebrochen.