در این شروع سریع، یک توکن OAuth برای حساب خود دریافت میکنید و با استفاده از یک اسکریپت پایتون، درخواستهایی را به نقاط پایانی API انتقال داده ارسال میکنید.
چیزی که یاد می گیرید
در این شروع سریع از یک اسکریپت پایتون برای موارد زیر استفاده می کنید:
- با ارائه یک نشانه OAuth معتبر، یک درخواست احراز هویت را به نقطه پایانی
InitiatePortabilityArchive
ارسال کنید. پاسخ یکjob_id
معتبر است. - یک درخواست احراز هویت شده را به نقطه پایانی
GetPortabilityArchiveState
ارسال کنید و داده ها را دانلود کنید. پاسخ باید شامل یک وضعیت شغلی معتبر و پس از تکمیل کار، یک URL امضا شده باشد. - یک درخواست احراز هویت شده به نقطه پایانی
ResetAuthorization
ارسال کنید. این درخواست همه دامنه های OAuth اعطایی شده توسط کاربر را لغو می کند.
پیش نیازها
برای اجرای این شروع سریع، باید:
- بررسی کنید که Data Portability API در دسترس شما باشد. برای فهرستی از کشورها و مناطق پشتیبانی شده، به سوالات متداول در صفحه "به اشتراک گذاری یک نسخه از داده های خود با شخص ثالث" مراجعه کنید.
- مراحل راه اندازی Data Portability API را کامل کنید و بررسی کنید که از پروژه جدیدی استفاده می کنید.
- به یک حساب متعلق به یا تحت کنترل سازمان خود دسترسی پیدا کنید. دادههای فعالیت جستجوی این حساب در این شروع سریع صادر میشود.
قبل از شروع این شروع سریع، همچنین باید OAuth، Python و بسته OAuth را برای کتابخانه های کلاینت پایتون تنظیم کنید.
OAuth را راه اندازی کنید
- مراحل را برای پیکربندی OAuth برای برنامه های نصب شده دنبال کنید. این جریان مشابه جریان OAuth برای برنامه های کاربردی وب سرور است. وقتی شناسه مشتری OAuth خود را پیکربندی میکنید:
- نوع برنامه باید برنامه دسکتاپ باشد.
- پس از ایجاد شناسه مشتری، رمز سرویس گیرنده را با فرمت JSON دانلود کنید و نام فایل را بگذارید:
client_secrets.json
. - هنگامی که دامنه ها را برای API انتقال داده پیکربندی می کنید، توجه داشته باشید که این شروع سریع از این گروه های منابع استفاده می کند:
-
myactivity.search
: https://www.googleapis.com/auth/dataportability.myactivity.search -
myactivity.youtube
: https://www.googleapis.com/auth/dataportability.myactivity.youtube
-
پایتون را راه اندازی کنید
برای اجرای اسکریپت مورد استفاده در این شروع سریع باید پایتون را روی ماشین محلی خود راه اندازی کنید. برای راه اندازی پایتون:
- ابزار مدیریت بسته Pip و Python 3.9 (یا بالاتر) را نصب کنید.
- Google API Client Library را برای Python نصب کنید.
با اجرای این دستور بسته
google_auth_oauthlib
را برای کتابخانه کلاینت پایتون نصب کنید. این بسته یکپارچه سازی oauthlib باgoogle-auth
-کتابخانه احراز هویت گوگل برای پایتون را فراهم می کند.pip install google-auth-oauthlib google-api-python-client --upgrade
اسکریپت را اجرا کنید
این اسکریپت از تغییر مسیر محلی میزبان در جریان OAuth استفاده می کند. این گزینه به برنامه نیاز دارد تا به یک پورت لوکال هاست گوش دهد و سپس مرورگر سیستم را برای شروع جریان مجوز OAuth باز کند.
برای باز کردن اسکریپت روی این پیوند کلیک کنید یا با کلیک راست روی پیوند، یک کپی از اسکریپت را دانلود کنید.
اسکریپت شروع سریع پایتون API قابلیت حمل داده
برای اجرای اسکریپت این دستور را وارد کنید:
python3 data-portability-quickstart.py
اقدامات انجام شده توسط فیلمنامه در نظرات به تفصیل آمده است.