Method: portabilityArchive.initiate

Portability API के लिए, संग्रह करने का नया काम शुरू करता है.

एचटीटीपी अनुरोध

POST https://dataportability.googleapis.com/v1/portabilityArchive:initiate

यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.

अनुरोध का मुख्य भाग

अनुरोध के मुख्य भाग में नीचे दिए गए स्ट्रक्चर वाला डेटा होता है:

JSON के काेड में दिखाना 
{
  "resources": [
    string
  ],
  "startTime": string,
  "endTime": string
}
फ़ील्ड
resources[]

string

वे संसाधन जिनसे डेटा एक्सपोर्ट किया जा रहा है. ये वैल्यू, OAuth स्कोप के साथ 1:1 के हिसाब से काम करती हैं.
startTime

string (Timestamp format)

ज़रूरी नहीं. वह टाइमस्टैंप जो एक्सपोर्ट किए जा रहे डेटा के शुरुआती पॉइंट को दिखाता है. अगर InitiatePortabilityArchiveRequest में startTime की जानकारी नहीं दी गई है, तो फ़ील्ड को सबसे पहले उपलब्ध डेटा पर सेट कर दिया जाता है.

आरएफ़सी 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".
endTime

string (Timestamp format)

ज़रूरी नहीं. वह टाइमस्टैंप जो एक्सपोर्ट किए जा रहे डेटा के आखिरी पॉइंट को दिखाता है. अगर InitiatePortabilityArchiveRequest में endTime की जानकारी नहीं दी गई है, तो यह फ़ील्ड उपलब्ध सबसे नए डेटा पर सेट हो जाता है.

आरएफ़सी 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".

जवाब का मुख्य भाग

संग्रहित करने की प्रोसेस शुरू करने पर मिलने वाला जवाब.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

JSON के काेड में दिखाना 
{
  "archiveJobId": string,
  "accessType": enum (AccessType)
}
फ़ील्ड
archiveJobId

string

संग्रह करने का वह जॉब आईडी जो एपीआई में शुरू किया गया है. इसका इस्तेमाल, नौकरी की स्थिति जानने के लिए किया जा सकता है.
accessType

enum (AccessType)

एपीआई से शुरू किए गए संग्रहित करने के जॉब का ऐक्सेस टाइप.

अनुमति के दायरे

इसके लिए, 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 देखें.

AccessType

संग्रहित करने की प्रोसेस के लिए, ऐक्सेस टाइप की सूची.

Enums
ACCESS_TYPE_UNSPECIFIED डिफ़ॉल्ट मान. इस वैल्यू का इस्तेमाल नहीं किया जाता.
ACCESS_TYPE_ONE_TIME अनुरोध किए गए स्कोप का ऐक्सेस सिर्फ़ एक बार मिलता है.
ACCESS_TYPE_TIME_BASED 30 दिनों में एक से ज़्यादा बार एक्सपोर्ट करने की अनुमति है. लॉन्च से पहले, एनम की वैल्यू में बदलाव हो सकता है.