نمای کلی API مخاطبین مشترک دامنه

API مربوط به مخاطبین مشترک دامنه (Domain Shared Contacts API) به برنامه‌ها اجازه می‌دهد مخاطبین خارجی مشترک با همه کاربران در یک دامنه Google Workspace را دریافت و به‌روزرسانی کنند. مخاطبین مشترک برای همه کاربران یک دامنه Google Workspace قابل مشاهده هستند و همه سرویس‌های Google به لیست مخاطبین دسترسی دارند.

از API مربوط به مخاطبین مشترک دامنه برای ایجاد، ویرایش یا حذف مخاطبین مشترک و جستجوی مخاطبین مطابق با معیارهای خاص استفاده کنید.

API مربوط به مخاطبین مشترک دامنه فقط برای حساب‌های کاربری گوگل ورک‌اسپیس در دسترس است. برای استفاده از API، API مربوط به مخاطبین مشترک دامنه را در کنسول مدیریت فعال کنید . تغییرات ممکن است تا ۲۴ ساعت طول بکشد تا در تکمیل خودکار و مدیریت مخاطبین منعکس شوند.

این سند، پیشینه‌ای در مورد API مخاطبین مشترک دامنه و مثال‌هایی برای مدیریت مخاطبین با استفاده از XML و HTTP ارائه می‌دهد. برای کسب اطلاعات بیشتر، به کتابخانه‌های کلاینت مراجعه کنید.

مخاطب

این سند برای توسعه‌دهندگانی است که برنامه‌های کلاینتی می‌نویسند که فهرست‌های مخاطبین گوگل را با استفاده از HTTP و XML دستکاری می‌کنند. این سند دانش پروتکل Google Data APIs را فرض می‌کند.

کاربران لینوکس و macOS می‌توانند مثال‌های موجود در این سند را با استفاده از curl یا wget امتحان کنند. به بخش «استفاده از curl با APIهای داده‌های گوگل» مراجعه کنید.

اصول

API مربوط به مخاطبین مشترک دامنه (Domain Shared Contacts API) از اصول APIهای داده‌های گوگل (Google Data APIs) پیروی می‌کند. APIهای داده‌های گوگل بر اساس Atom 1.0، RSS 2.0 و پروتکل انتشار Atom ساخته شده‌اند.

نسخه را مشخص کنید

تمام درخواست‌های ارسالی با استفاده از API مربوط به Domain Shared Contacts باید نسخه ۳.۰ را مشخص کنند:

GData-Version: 3.0

اگر نمی‌توانید هدرهای HTTP را تنظیم کنید، v=3.0 را به عنوان پارامتر پرس‌وجو مشخص کنید. روش هدر HTTP توصیه می‌شود.