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

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

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

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

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

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

حضار

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

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

اصول

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

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

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

GData-Version: 3.0

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

توجه: کتابخانه های سرویس گیرنده سرصفحه های نسخه مناسب را به صورت خودکار ارائه می کنند، بنابراین زمانی که از کتابخانه مشتری استفاده می کنید از پارامتر query v=3.0 استفاده نکنید.