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

API مخاطبین مشترک دامنه به برنامه‌های شما اجازه می‌دهد مخاطبین خارجی را که با همه کاربران در یک دامنه Google Workspace به اشتراک گذاشته شده‌اند، دریافت و به‌روزرسانی کنند. مخاطبین مشترک برای همه کاربران یک دامنه Google Workspace قابل مشاهده هستند و همه سرویس‌های Google به لیست مخاطبین دسترسی دارند.

هشدار: API مخاطبین مشترک دامنه فقط برای مخاطبین خارجی در نظر گرفته شده است. استفاده از این API برای ایجاد اطلاعات تماس برای کاربران یا گروه‌های دامنه (داخلی) می‌تواند منجر به اطلاعات تماس تکراری برای آن کاربران و گروه‌ها شود که ممکن است منجر به رفتار غیرمنتظره‌ای شود. برای دریافت و به‌روزرسانی اطلاعات تماس کاربران دامنه (داخلی) Google Workspace، به جای آن از API دایرکتوری استفاده کنید.

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

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

این سند علاوه بر ارائه پیش‌زمینه در مورد قابلیت‌های API مربوط به Domain Shared Contacts، نمونه‌هایی در مورد نحوه مدیریت مخاطبین با استفاده از XML و HTTP ارائه می‌دهد. پس از مطالعه این سند، می‌توانید با استفاده از کتابخانه‌های کلاینت ما، اطلاعات بیشتری در مورد تعامل با API کسب کنید.

مخاطب

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

اگر از سیستم عامل یونیکس استفاده می‌کنید و می‌خواهید مثال‌های این سند را بدون نوشتن هیچ کدی امتحان کنید، از ابزارهای خط فرمان یونیکس curl یا wget استفاده کنید. یاد بگیرید که چگونه از cURL با سرویس‌های داده گوگل استفاده کنید .

اصول

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

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

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

GData-Version: 3.0

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

نکته: کتابخانه‌های کلاینت به طور خودکار هدرهای نسخه مناسب را ارائه می‌دهند، بنابراین هنگام استفاده از یک کتابخانه کلاینت از پارامتر کوئری v=3.0 استفاده نکنید.