Method: archiveJobs.getPortabilityArchiveState

تسترجع حالة مهمة الأرشفة لواجهة برمجة التطبيقات Portability API.

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المعلمات
name

string

مطلوب. معرّف مهمة الأرشفة الذي يتم إرجاعه عند طلب حالة المهمة يكون التنسيق على النحو التالي: archiveJobs/{archive_job}/portabilityArchiveState. وarchive_job هو رقم تعريف المهمة الذي يعرضه InitiatePortabilityArchiveResponse.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

مورد يحتوي على حالة مهمة الأرشفة

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "state": enum (State),
  "urls": [
    string
  ],
  "name": string,
  "startTime": string,
  "exportTime": string
}
الحقول
state

enum (State)

مورد يمثّل حالة مهمة الأرشفة
urls[]

string

إذا كانت الحالة مكتملة، تعرض هذه الطريقة عناوين URL الموقَّعة للعناصر في حزمة Cloud Storage.
name

string

اسم المورد لعنصر PortabilityArchiveState الفردي في ArchiveJob يكون التنسيق على النحو التالي: archiveJobs/{archive_job}/portabilityArchiveState. وarchive_job هو معرّف الوظيفة المقدَّم في الطلب.
startTime

string (Timestamp format)

الطابع الزمني الذي يمثّل نقطة البداية للبيانات التي يتم تصديرها لا يتم ضبط هذا الحقل إلا إذا تم تحديد حقل startTime في InitiatePortabilityArchiveRequest.

يستخدم معيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه دائمًا مُعدَّلاً وفقًا لقاعدة Z ويستخدم 0 أو 3 أو 6 أو 9 أرقام عشرية. يتم أيضًا قبول العناصر غير "Z". أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30"
exportTime

string (Timestamp format)

الطابع الزمني الذي يمثّل نقطة نهاية البيانات التي يتم تصديرها في حال ضبط قيمة endTime في InitiatePortabilityArchiveRequest، يتم ضبط هذا الحقل على تلك القيمة. في حال عدم ضبط endTime، يتم ضبط هذه القيمة على وقت طلب التصدير.

يستخدم معيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه دائمًا مُعدَّلاً وفقًا لقاعدة Z ويستخدم 0 أو 3 أو 6 أو 9 أرقام عشرية. يتم أيضًا قبول العناصر غير "Z". أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30"

نطاقات التفويض

يتطلب أحد نطاقات OAuth التالية:

  • 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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.

الحالة

حالة مهمة الأرشفة تم تجميد هذه القائمة المحددة.

عمليات التعداد
STATE_UNSPECIFIED القيمة التلقائية هذه القيمة غير مستخدَمة.
IN_PROGRESS المهمة قيد التنفيذ.
COMPLETE اكتملت المهمة.
FAILED تعذّر إكمال المهمة.
CANCELLED يتم إلغاء المهمة.