Portability API के लिए, आर्काइव करने के किसी जॉब की स्थिति दिखाता है.
एचटीटीपी अनुरोध
GET https://dataportability.googleapis.com/v1/{name=archiveJobs/*/portabilityArchiveState}
यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.
पाथ पैरामीटर
| पैरामीटर | |
|---|---|
name |
ज़रूरी है. संग्रहित जॉब का आईडी, जो जॉब की स्थिति का अनुरोध करने पर दिखता है. इसका फ़ॉर्मैट यह है: archiveJobs/{archive_job}/portabilityArchiveState. archive_job, वह जॉब आईडी है जो InitiatePortabilityArchiveResponse से मिलता है. |
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
जवाब का मुख्य भाग
संसाधन, जिसमें संग्रह करने की प्रोसेस की स्थिति होती है.
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
| JSON के काेड में दिखाना |
|---|
{
"state": enum ( |
| फ़ील्ड | |
|---|---|
state |
संसाधन, जो संग्रहित करने की प्रोसेस की स्थिति दिखाता है. |
urls[] |
अगर स्थिति 'पूरा हुआ' है, तो यह तरीका Cloud Storage की बकेट में मौजूद ऑब्जेक्ट के हस्ताक्षर किए गए यूआरएल दिखाता है. |
name |
ArchiveJob के PortabilityArchiveState सिंगलटन का संसाधन नाम. इसका फ़ॉर्मैट यह है: archiveJobs/{archive_job}/portabilityArchiveState. archive_job, अनुरोध में दिया गया जॉब आईडी है. |
startTime |
वह टाइमस्टैंप जो एक्सपोर्ट किए जा रहे डेटा के शुरुआती पॉइंट को दिखाता है. यह फ़ील्ड सिर्फ़ तब सेट होता है, जब InitiatePortabilityArchiveRequest में startTime फ़ील्ड की जानकारी दी गई हो. आरएफ़सी 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़्ड होगा और इसमें 0, 3, 6 या 9 दशमलव अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: |
exportTime |
वह टाइमस्टैंप जो एक्सपोर्ट किए जा रहे डेटा के आखिरी पॉइंट को दिखाता है. अगर InitiatePortabilityArchiveRequest में endTime की वैल्यू सेट की गई है, तो यह फ़ील्ड उस वैल्यू पर सेट हो जाता है. अगर endTime सेट नहीं है, तो यह वैल्यू उस समय पर सेट हो जाती है जब एक्सपोर्ट का अनुरोध किया गया था. आरएफ़सी 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़्ड होगा और इसमें 0, 3, 6 या 9 दशमलव अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: |
अनुमति के दायरे
इसके लिए, OAuth के इनमें से किसी एक स्कोप की ज़रूरत होती है:
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
ज़्यादा जानकारी के लिए, OAuth 2.0 Overview देखें.
स्थिति
संग्रहित करने के जॉब की स्थिति. यह एनम फ़्रीज़ है.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
डिफ़ॉल्ट मान. इस वैल्यू का इस्तेमाल नहीं किया जाता. |
IN_PROGRESS |
यह प्रोसेस जारी है. |
COMPLETE |
काम पूरा हो गया है. |
FAILED |
जॉब पूरा नहीं हो सका. |
CANCELLED |
नौकरी रद्द कर दी गई है. |