مقدمه: برنامه ها را با استفاده از Data Portability API توسعه دهید

Data Portability API به شما امکان می‌دهد برنامه‌هایی بسازید که درخواست مجوز از کاربر برای انتقال یک نسخه از داده‌ها از سرویس‌های Google به برنامه شما می‌دهند. این قابلیت حمل داده ها را ممکن می کند و خدمات سوئیچینگ را تسهیل می کند.

اگر به دنبال اطلاعاتی در مورد نحوه اشتراک‌گذاری داده‌ها توسط کاربران هستید، به اشتراک‌گذاری یک کپی از داده‌های خود با شخص ثالث مراجعه کنید.

پیش نیازها

قبل از انتشار برنامه، باید توسط Google تأیید شود.

همچنین باید بررسی کنید که Data Portability API برای کاربرانی که در مکان شما هستند در دسترس است. برای فهرستی از کشورها و مناطق پشتیبانی شده، به سوالات متداول در صفحه "به اشتراک گذاری یک نسخه از داده های خود با شخص ثالث" مراجعه کنید.

گردش کار برنامه نویس

این مراحلی است که برای ایجاد برنامه ای که از Data Portability API استفاده می کند، دنبال می کنید.

1. جریان رضایت OAuth را برای کاربر اجرا کنید. در این مثال، کاربر امکان دسترسی به داده های ویدیوی YouTube را فراهم می کند.

   1. کاربر روی Import Videos YouTube کلیک می کند و به حساب Google خود وارد می شود.

   2. برنامه کاربر را به URL رضایت OAuth هدایت می کند. توجه داشته باشید که این URL مثال ساده شده است و برخی از پارامترها را ندارد:

      https://accounts.google.com/o/oauth2/v2/auth?scope=https://www.googleapis.com/auth/dataportability.myactivity.youtube

   3. کاربر روی Next در صفحه رضایت OAuth کلیک می کند، با اشتراک گذاری داده های خود موافقت می کند و دسترسی به حساب را فراهم می کند.

   4. کاربر به برنامه هدایت می شود.

   5. توسعه دهنده یک نشانه OAuth برای کاربر دریافت می کند.

2. برنامه شما InitiatePortabilityArchive(resources = ["myactivity.youtube"]) را با یک نشانه OAuth پیوست که حاوی این محدوده OAuth است فراخوانی می کند:

   https://www.googleapis.com/auth/dataportability.myactivity.youtube

   این فراخوانی فرآیند ایجاد آرشیو داده ها را آغاز می کند. باید ظرف 24 ساعت پس از مجوز کاربر، بایگانی قابل حمل را راه اندازی کنید.

3. برنامه شما GetPortabilityArchiveState(job_id) را با یک نشانه OAuth پیوست شده که شامل این محدوده OAuth است فراخوانی می کند:

   https://www.googleapis.com/auth/dataportability.myactivity.youtube

   برای بازیابی وضعیت کار بایگانی می توانید چندین بار با این روش تماس بگیرید. متد وضعیت کار را برمی گرداند. اگر وضعیت کامل باشد، بایگانی آماده است و نشانی‌های اینترنتی ذخیره‌سازی ابری امضا شده ارائه می‌شوند. توجه داشته باشید که زمان تکمیل درخواست بایگانی بسته به اندازه داده ها می تواند از چند دقیقه تا چند ساعت متفاوت باشد.

4. بایگانی داده ها را با استفاده از URL های امضا شده دانلود کنید.

5. ResetAuthorization() را با یک نشانه OAuth پیوست شده برای بازنشانی منابع تمام شده و حذف همه رضایت‌های OAuth فراخوانی کنید.

برای اطلاعات بیشتر در مورد استفاده از روش‌های API انتقال داده، به روش‌های API انتقال داده تماس بگیرید.

نحوه تعامل کاربران با یک برنامه API Portability Data

این نمودار نحوه تعامل کاربران با برنامه‌ای که با Data Portability API یکپارچه شده است را نشان می‌دهد.

1. ابتدا گزینه ای برای بازیابی اطلاعات به کاربر ارائه می شود.

2. در مرحله بعد، کاربر وارد حساب Google خود می شود.

3. سپس، زمانی که کاربر از او خواسته شد تا داده‌های خود را به اشتراک بگذارد، روی Next کلیک می‌کند و زمانی که از او خواسته شد سیاست حفظ حریم خصوصی را بپذیرد، روی Got it کلیک می‌کند.

4. سپس، یک صفحه رضایت OAuth به کاربر نشان داده می‌شود که از آن برای دسترسی برنامه به داده‌هایش استفاده می‌شود. گزینه‌های اینجا با دامنه‌های OAuth که پیکربندی کرده‌اید مطابقت دارند.

5. پس از اجازه دسترسی، وارد کردن داده ها شروع می شود. بسته به اندازه داده ها، تکمیل درخواست ممکن است چند دقیقه تا چند ساعت طول بکشد.