تبدأ مهمة أرشفة جديدة لواجهة برمجة التطبيقات Portability API.
طلب HTTP
POST https://dataportability.googleapis.com/v1/portabilityArchive:initiate
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
نص الطلب
يحتوي نص الطلب على بيانات بالبنية التالية:
| تمثيل JSON |
|---|
{ "resources": [ string ], "startTime": string, "endTime": string } |
| الحقول | |
|---|---|
resources[] |
الموارد التي تُصدِّر البيانات منها تتطابق هذه القيم مع نطاقات OAuth بنسبة 1:1. |
startTime |
اختياريّ. الطابع الزمني الذي يمثّل نقطة البداية للبيانات التي يتم تصديرها في حال عدم تحديد startTime في InitiatePortabilityArchiveRequest، يتم ضبط الحقل على أقدم البيانات المتاحة. يستخدم معيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه دائمًا مُعدَّلاً وفقًا لقاعدة Z ويستخدم 0 أو 3 أو 6 أو 9 أرقام عشرية. يتم أيضًا قبول العناصر غير "Z". أمثلة: |
endTime |
اختياريّ. الطابع الزمني الذي يمثّل نقطة نهاية البيانات التي يتم تصديرها في حال عدم تحديد endTime في InitiatePortabilityArchiveRequest، يتم ضبط هذا الحقل على أحدث البيانات المتاحة. يستخدم معيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه دائمًا مُعدَّلاً وفقًا لقاعدة Z ويستخدم 0 أو 3 أو 6 أو 9 أرقام عشرية. يتم أيضًا قبول العناصر غير "Z". أمثلة: |
نص الاستجابة
استجابة من بدء مهمة أرشفة
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
| تمثيل JSON |
|---|
{
"archiveJobId": string,
"accessType": enum ( |
| الحقول | |
|---|---|
archiveJobId |
معرّف مهمة الأرشفة الذي يتمّ بدؤه في واجهة برمجة التطبيقات. يمكن استخدام هذا الإجراء للحصول على حالة المهمة. |
accessType |
نوع الوصول إلى وظيفة الأرشفة التي بدأتها واجهة برمجة التطبيقات. |
نطاقات التفويض
يتطلب أحد نطاقات 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.
AccessType
تعداد أنواع الوصول لوظيفتَي "الأرشفة" و"الحفظ المؤقت"
| عمليات التعداد | |
|---|---|
ACCESS_TYPE_UNSPECIFIED |
القيمة التلقائية هذه القيمة غير مستخدَمة. |
ACCESS_TYPE_ONE_TIME |
الوصول لمرة واحدة إلى النطاقات المطلوبة |
ACCESS_TYPE_TIME_BASED |
يُسمح بعمليات تصدير متعددة على مدار 30 يومًا. قيمة التعداد خاضعة للتغيير قبل الإطلاق. |