عناصر مخاطبین مشترک

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

یک ورودی مخاطب به شکل یک نوع مخاطب توسعه‌یافته است که نشان‌دهنده یک شخص، یک مکان - مانند یک باشگاه یا رستوران - یا یک سازمان است. نوع مخاطب در XML به عنوان یک عنصر <atom:entry> ظاهر می‌شود که شامل عناصر توسعه‌یافته مختلفی از فضای نام Google Data است.

عنصر category که نشان می‌دهد ورودی یک مخاطب است، به شکل زیر است:

<atom:category scheme="http://schemas.google.com/g/2005#kind"
  term="http://schemas.google.com/contact/2008#contact"/>

در API مربوط به مخاطبین مشترک دامنه، چندین عنصر کمی محدودتر از نوع مخاطب هستند. برای عناصر زیر، شما یا یک ویژگی rel یا یک ویژگی label ارائه می‌دهید، اما نه هر دو:

  • gd:email
  • gd:im
  • gd:organization
  • gd:phoneNumber
  • gd:structuredPostalAddress

وقتی یک مخاطب مشترک ایجاد یا به‌روزرسانی می‌کنید، اگر برای هر یک از این عناصر، هم rel و هم label ارائه دهید یا هیچ‌کدام را وارد نکنید، سرور ورودی را رد می‌کند.

پشتیبانی از عکس‌ها

همراه با مقادیر ویژگی‌های استاندارد مانند self یا edit، می‌توانید از مقادیر rel برای عناصر atom:link استفاده کنید. هنگام استفاده از لینک‌های عکس، باید توکن مجوز در هدر HTTP مشخص شود. برای اطلاعات بیشتر، به «یادگیری درباره احراز هویت و مجوز» مراجعه کنید.

  • با یک دستور GET ، rel="http://schemas.google.com/contacts/2008/rel#photo" قابلیت خواندن عکس مرتبط با مخاطب را اضافه می‌کند. می‌توانید از URL مشخص شده در href برای خواندن آخرین نسخه عکس مرتبط با مخاطب استفاده کنید. اگر تصویری برای مخاطب وجود نداشته باشد، لینک نمایش داده نمی‌شود.

مثال:

<atom:link rel="http://schemas.google.com/contacts/2008/rel#photo"
           href="https://www.google.com/m8/feeds/photos/media/jo%40example.com/1234" type="image/*" />
  • با یک دستور PUT یا DELETE ، rel="http://schemas.google.com/contacts/2008/rel#edit-photo" قابلیت به‌روزرسانی یا حذف یک عکس محلی مرتبط با مخاطب را اضافه می‌کند.

مثال:

<atom:link rel="http://schemas.google.com/contacts/2008/rel#edit-photo"
           href="https://www.google.com/m8/feeds/photos/media/jo%40example.com/1234/photo4524" />

فضای نام gContact

آدرس اینترنتی فضای نام XML برای gContact ، http://schemas.google.com/contact/2008 است.

در این فضای نام، یک عنصر تعریف شده است که نشان‌دهنده‌ی گروهی است که مخاطب به آن تعلق دارد.

gContact:groupMembershipInfo properties

ملک توضیحات
href گروهی را که مخاطب به آن تعلق دارد یا دارد، مشخص می‌کند. این گروه با شناسه‌اش ارجاع داده می‌شود.
deleted="true" به این معنی است که عضویت گروه برای مخاطب حذف شده است. این ویژگی فقط در صورتی لحاظ می‌شود که showdeleted به عنوان پارامتر پرس‌وجو مشخص شده باشد، در غیر این صورت groupMembershipInfo برای گروه‌هایی که مخاطب دیگر به آنها تعلق ندارد، بازگردانده نمی‌شود.