شما می توانید مخاطبین مشترک کاربر را به روش های مختلفی درخواست کنید:
- همه مخاطبین به اشتراک گذاشته شده
- مجموعه ای از مخاطبین که با معیارهای مشخص مطابقت دارند
- یک مخاطب مشترک
- یک عکس برای یک مخاطب
بهطور پیشفرض، ورودیهای یک فید مرتب نیستند.
همه مخاطبین مشترک را دریافت کنید
برای دریافت همه مخاطبین به اشتراک گذاشته شده، یک درخواست HTTP
GET
به URL فید مخاطبین ارسال کنید:GET https://www.google.com/m8/feeds/contacts/
DOMAIN /PROJECTION موارد زیر را جایگزین کنید:
-
DOMAIN
: نشانی اینترنتی دامنه شما—مثلا example.com. -
PROJECTION
: مقدار طرح ریزی که عناصرgd:extendedProperty
را مشخص می کند. برای فهرستی از مقادیر پشتیبانی شده، به مقادیر طرح ریزی مراجعه کنید.
فید یک کد وضعیت
HTTP 200 OK
و یک فید استاندارد Atom 1.0 حاوی مخاطبین را برمی گرداند. نمونه زیر نمونه ای از فید مخاطبین با تنها یک ورودی است:<feed xmlns='http://www.w3.org/2005/Atom' xmlns:openSearch='http://a9.com/-/spec/opensearchrss/1.0/' xmlns:gd='http://schemas.google.com/g/2005' xmlns:gContact='http://schemas.google.com/contact/2008' xmlns:batch='http://schemas.google.com/gdata/batch'> <id>https://www.google.com/m8/feeds/contacts/example.com/base</id> <updated>2008-03-05T12:36:38.836Z</updated> <category scheme='http://schemas.google.com/g/2005#kind' term='http://schemas.google.com/contact/2008#contact' /> <title type='text'>example.com's Contacts</title> <link rel='http://schemas.google.com/g/2005#feed' type='application/atom+xml' href='https://www.google.com/m8/feeds/contacts/example.com/full' /> <link rel='http://schemas.google.com/g/2005#post' type='application/atom+xml' href='https://www.google.com/m8/feeds/contacts/example.com/full' /> <link rel='http://schemas.google.com/g/2005#batch' type='application/atom+xml' href='https://www.google.com/m8/feeds/contacts/example.com/full/batch' /> <link rel='self' type='application/atom+xml' href='https://www.google.com/m8/feeds/contacts/example.com/full?max-results=25' /> <author> <name>example.com</name> <email>example.com</email> </author> <generator version='1.0' uri='https://www.google.com/m8/feeds/contacts'> Contacts </generator> <openSearch:totalResults>1</openSearch:totalResults> <openSearch:startIndex>1</openSearch:startIndex> <openSearch:itemsPerPage>25</openSearch:itemsPerPage> <entry> <id> https://www.google.com/m8/feeds/contacts/example.com/base/c9012de </id> <updated>2008-03-05T12:36:38.835Z</updated> <category scheme='http://schemas.google.com/g/2005#kind' term='http://schemas.google.com/contact/2008#contact' /> <title type='text'>Fitzgerald</title> <gd:name> <gd:fullName>Fitzgerald</gd:fullName> </gd:name> <link rel="http://schemas.google.com/contacts/2008/rel#photo" type="image/*" href="http://google.com/m8/feeds/photos/media/example.com/c9012de"/> <link rel='self' type='application/atom+xml' href='https://www.google.com/m8/feeds/contacts/example.com/full/c9012de' /> <link rel='edit' type='application/atom+xml' href='https://www.google.com/m8/feeds/contacts/example.com/full/c9012de/1204720598835000' /> <gd:phoneNumber rel='http://schemas.google.com/g/2005#home' primary='true'> 456 </gd:phoneNumber> <gd:extendedProperty name="pet" value="hamster" /> </entry> </feed>
-
فید در یک پاسخ بیش از 10 مگابایت بر نمی گرداند. برای دریافت کل لیست مخاطبین، مکرراً پیوند بعدی فید برگشتی را دنبال کنید تا زمانی که دیگر آن پیوند را در فید برگشتی مشاهده نکنید.
با استفاده از پارامترهای پرس و جو، مخاطبین به اشتراک گذاشته شده را دریافت کنید
میتوانید مجموعهای از مخاطبین را درخواست کنید که با معیارهای مشخص شده مطابقت داشته باشند، مانند درخواست مخاطبینی که پس از یک تاریخ معین بهروزرسانی شوند. هیچ پشتیبانی برای پرس و جوهای متن کامل یا تعیین محل مخاطب از طریق آدرس ایمیل وجود ندارد. برای فهرست کاملی از پارامترهای پرس و جو پشتیبانی شده، راهنمای مرجع API مخاطبین مشترک دامنه را ببینید.
یک درخواست
HTTP GET
با یک پارامتر تعریف شده به URL فید مخاطبین ارسال کنید:GET https://www.google.com/m8/feeds/contacts/
DOMAIN /PROJECTION ?PARAMETER موارد زیر را جایگزین کنید:
-
DOMAIN
: نشانی اینترنتی دامنه شما—مثلا example.com. -
PROJECTION
: مقدار طرح ریزی که عناصرgd:extendedProperty
را مشخص می کند. برای فهرستی از مقادیر پشتیبانی شده، به مقادیر طرح ریزی مراجعه کنید. -
PARAMETER
: یکی از پارامترهای پرس و جو پشتیبانی شده است. برای اطلاعات بیشتر، راهنمای مرجع Domain Shared Contacts API را ببینید.
به عنوان مثال، برای بهروزرسانی همه ورودیهای تماس مشترک دامنه پس از ۱۶ مارس ۲۰۲۲ برای example.com، یک درخواست HTTP به نشانی اینترنتی فید مخاطب مشترک دامنه ارسال کنید و پارامتر
updated-min
را به URL درخواست اضافه کنید:GET https://www.google.com/m8/feeds/contacts/example.com/full?updated-min=2022-03-16T00:00:00
هنگامی که آن درخواست
GET
را ارسال می کنید، سرور یک کد وضعیت HTTP200 OK
و یک فید حاوی هر مخاطب مشترک دامنه ای را که پس از تاریخ مشخص شده ایجاد یا به روز شده اند، برمی گرداند.-
فید در یک پاسخ بیش از 10 مگابایت بر نمی گرداند. برای دریافت کل لیست مخاطبین با معیارهای مشخص شده، به طور مکرر پیوند بعدی فید برگشتی را دنبال کنید تا زمانی که دیگر آن پیوند را در فید برگشتی مشاهده نکنید.
ردیابی تغییرات افزایشی
برای ردیابی تغییرات تدریجی در لیست مخاطبین اشتراکگذاری شده دامنه، موارد زیر را انجام دهید: 1. هنگامی که درخواستی برای فید ارسال میکنید، مقدار عنصر <updated>
فید را پیگیری کنید. 1. با تنظیم پارامتر query updated-min
روی مقدار <updated>
و تنظیم showdeleted
روی true
می توانید فقط مخاطبین اشتراک گذاری شده دامنه را دریافت کنید که از درخواست قبلی تغییر کرده اند.
یک مخاطب مشترک دریافت کنید
برای دریافت یک مخاطب مشترک، باید از پیوند خود مخاطب استفاده کنید. فقط با قرار دادن ورودی مخاطب در فید مخاطبین مشترک، میتوانید پیوند خود مخاطب مشترک را دریافت کنید. اگر مطمئن نیستید از چه مقداری برای پیوند خود استفاده کنید، به دریافت همه مخاطبین و دریافت مخاطبین با استفاده از پارامترهای جستجو مراجعه کنید.
- برای دریافت یک مخاطب مشترک دامنه خاص، یک درخواست HTTP
GET
به پیوند خود یک مخاطب ارسال کنید: موارد زیر را جایگزین کنید:GET https://www.google.com/m8/feeds/contacts/
DOMAIN /PROJECTION /:SELF_LINK >
-
DOMAIN
: نشانی اینترنتی دامنه شما—مثلا example.com. -
PROJECTION
: مقدار طرح ریزی که عناصرgd:extendedProperty
را مشخص می کند. برای فهرستی از مقادیر پشتیبانی شده، به مقادیر طرح ریزی مراجعه کنید. -
SELF_LINK
: یک مقدار عددی منحصربهفرد که یک مخاطب مشترک را نشان میدهد - به عنوان مثال، 12345.
سپس سرور یک کد وضعیت HTTP 200 OK
و یک ورودی حاوی مخاطب را برمی گرداند.
به عنوان مثال، برای دریافت یک مخاطب اشتراکگذاری شده دامنه با پیوند شخصی که روی https://www.google.com/m8/feeds/contacts/example.com/full/12345
تنظیم شده است، درخواست HTTP زیر را ارسال کنید:
GET https://www.google.com/m8/feeds/contacts/example.com/full/12345
مراحل بعدی
،شما می توانید مخاطبین مشترک کاربر را به روش های مختلفی درخواست کنید:
- همه مخاطبین به اشتراک گذاشته شده
- مجموعه ای از مخاطبین که با معیارهای مشخص مطابقت دارند
- یک مخاطب مشترک
- یک عکس برای یک مخاطب
بهطور پیشفرض، ورودیهای یک فید مرتب نیستند.
همه مخاطبین مشترک را دریافت کنید
برای دریافت همه مخاطبین به اشتراک گذاشته شده، یک درخواست HTTP
GET
به URL فید مخاطبین ارسال کنید:GET https://www.google.com/m8/feeds/contacts/
DOMAIN /PROJECTION موارد زیر را جایگزین کنید:
-
DOMAIN
: نشانی اینترنتی دامنه شما—مثلا example.com. -
PROJECTION
: مقدار طرح ریزی که عناصرgd:extendedProperty
را مشخص می کند. برای فهرستی از مقادیر پشتیبانی شده، به مقادیر طرح ریزی مراجعه کنید.
فید یک کد وضعیت
HTTP 200 OK
و یک فید استاندارد Atom 1.0 حاوی مخاطبین را برمی گرداند. نمونه زیر نمونه ای از فید مخاطبین با تنها یک ورودی است:<feed xmlns='http://www.w3.org/2005/Atom' xmlns:openSearch='http://a9.com/-/spec/opensearchrss/1.0/' xmlns:gd='http://schemas.google.com/g/2005' xmlns:gContact='http://schemas.google.com/contact/2008' xmlns:batch='http://schemas.google.com/gdata/batch'> <id>https://www.google.com/m8/feeds/contacts/example.com/base</id> <updated>2008-03-05T12:36:38.836Z</updated> <category scheme='http://schemas.google.com/g/2005#kind' term='http://schemas.google.com/contact/2008#contact' /> <title type='text'>example.com's Contacts</title> <link rel='http://schemas.google.com/g/2005#feed' type='application/atom+xml' href='https://www.google.com/m8/feeds/contacts/example.com/full' /> <link rel='http://schemas.google.com/g/2005#post' type='application/atom+xml' href='https://www.google.com/m8/feeds/contacts/example.com/full' /> <link rel='http://schemas.google.com/g/2005#batch' type='application/atom+xml' href='https://www.google.com/m8/feeds/contacts/example.com/full/batch' /> <link rel='self' type='application/atom+xml' href='https://www.google.com/m8/feeds/contacts/example.com/full?max-results=25' /> <author> <name>example.com</name> <email>example.com</email> </author> <generator version='1.0' uri='https://www.google.com/m8/feeds/contacts'> Contacts </generator> <openSearch:totalResults>1</openSearch:totalResults> <openSearch:startIndex>1</openSearch:startIndex> <openSearch:itemsPerPage>25</openSearch:itemsPerPage> <entry> <id> https://www.google.com/m8/feeds/contacts/example.com/base/c9012de </id> <updated>2008-03-05T12:36:38.835Z</updated> <category scheme='http://schemas.google.com/g/2005#kind' term='http://schemas.google.com/contact/2008#contact' /> <title type='text'>Fitzgerald</title> <gd:name> <gd:fullName>Fitzgerald</gd:fullName> </gd:name> <link rel="http://schemas.google.com/contacts/2008/rel#photo" type="image/*" href="http://google.com/m8/feeds/photos/media/example.com/c9012de"/> <link rel='self' type='application/atom+xml' href='https://www.google.com/m8/feeds/contacts/example.com/full/c9012de' /> <link rel='edit' type='application/atom+xml' href='https://www.google.com/m8/feeds/contacts/example.com/full/c9012de/1204720598835000' /> <gd:phoneNumber rel='http://schemas.google.com/g/2005#home' primary='true'> 456 </gd:phoneNumber> <gd:extendedProperty name="pet" value="hamster" /> </entry> </feed>
-
فید در یک پاسخ بیش از 10 مگابایت بر نمی گرداند. برای دریافت کل لیست مخاطبین، مکرراً پیوند بعدی فید برگشتی را دنبال کنید تا زمانی که دیگر آن پیوند را در فید برگشتی مشاهده نکنید.
با استفاده از پارامترهای پرس و جو، مخاطبین به اشتراک گذاشته شده را دریافت کنید
میتوانید مجموعهای از مخاطبین را درخواست کنید که با معیارهای مشخص شده مطابقت داشته باشند، مانند درخواست مخاطبینی که پس از یک تاریخ معین بهروزرسانی شوند. هیچ پشتیبانی برای پرس و جوهای متن کامل یا تعیین محل مخاطب از طریق آدرس ایمیل وجود ندارد. برای فهرست کامل پارامترهای پرس و جو پشتیبانی شده، راهنمای مرجع API مخاطبین اشتراکگذاری شده دامنه را ببینید.
یک درخواست
HTTP GET
با یک پارامتر تعریف شده به URL فید مخاطبین ارسال کنید:GET https://www.google.com/m8/feeds/contacts/
DOMAIN /PROJECTION ?PARAMETER موارد زیر را جایگزین کنید:
-
DOMAIN
: نشانی اینترنتی دامنه شما—مثلا example.com. -
PROJECTION
: مقدار طرح ریزی که عناصرgd:extendedProperty
را مشخص می کند. برای فهرستی از مقادیر پشتیبانی شده، به مقادیر طرح ریزی مراجعه کنید. -
PARAMETER
: یکی از پارامترهای پرس و جو پشتیبانی شده است. برای اطلاعات بیشتر، راهنمای مرجع Domain Shared Contacts API را ببینید.
به عنوان مثال، برای بهروزرسانی همه ورودیهای تماس مشترک دامنه پس از ۱۶ مارس ۲۰۲۲ برای example.com، یک درخواست HTTP به نشانی اینترنتی فید مخاطب مشترک دامنه ارسال کنید و پارامتر
updated-min
را به URL درخواست اضافه کنید:GET https://www.google.com/m8/feeds/contacts/example.com/full?updated-min=2022-03-16T00:00:00
هنگامی که آن درخواست
GET
را ارسال می کنید، سرور یک کد وضعیت HTTP200 OK
و یک فید حاوی هر مخاطب مشترک دامنه ای را که پس از تاریخ مشخص شده ایجاد یا به روز شده اند، برمی گرداند.-
فید در یک پاسخ بیش از 10 مگابایت بر نمی گرداند. برای دریافت کل لیست مخاطبین با معیارهای مشخص شده، به طور مکرر پیوند بعدی فید برگشتی را دنبال کنید تا زمانی که دیگر آن پیوند را در فید برگشتی مشاهده نکنید.
ردیابی تغییرات افزایشی
برای ردیابی تغییرات تدریجی در لیست مخاطبین اشتراکگذاری شده دامنه، موارد زیر را انجام دهید: 1. هنگامی که درخواستی برای فید ارسال میکنید، مقدار عنصر <updated>
فید را پیگیری کنید. 1. با تنظیم پارامتر query updated-min
روی مقدار <updated>
و تنظیم showdeleted
روی true
می توانید فقط مخاطبین اشتراک گذاری شده دامنه را دریافت کنید که از درخواست قبلی تغییر کرده اند.
یک مخاطب مشترک دریافت کنید
برای دریافت یک مخاطب مشترک، باید از پیوند خود مخاطب استفاده کنید. فقط با قرار دادن ورودی مخاطب در فید مخاطبین مشترک، میتوانید پیوند خود مخاطب مشترک را دریافت کنید. اگر مطمئن نیستید از چه مقداری برای پیوند خود استفاده کنید، به دریافت همه مخاطبین و دریافت مخاطبین با استفاده از پارامترهای جستجو مراجعه کنید.
- برای دریافت یک مخاطب مشترک دامنه خاص، یک درخواست HTTP
GET
به پیوند خود یک مخاطب ارسال کنید: موارد زیر را جایگزین کنید:GET https://www.google.com/m8/feeds/contacts/
DOMAIN /PROJECTION /:SELF_LINK >
-
DOMAIN
: نشانی اینترنتی دامنه شما—مثلا example.com. -
PROJECTION
: مقدار طرح ریزی که عناصرgd:extendedProperty
را مشخص می کند. برای فهرستی از مقادیر پشتیبانی شده، به مقادیر طرح ریزی مراجعه کنید. -
SELF_LINK
: یک مقدار عددی منحصربهفرد که یک مخاطب مشترک را نشان میدهد - به عنوان مثال، 12345.
سپس سرور یک کد وضعیت HTTP 200 OK
و یک ورودی حاوی مخاطب را برمی گرداند.
به عنوان مثال، برای دریافت یک مخاطب اشتراکگذاری شده دامنه با پیوند شخصی که روی https://www.google.com/m8/feeds/contacts/example.com/full/12345
تنظیم شده است، درخواست HTTP زیر را ارسال کنید:
GET https://www.google.com/m8/feeds/contacts/example.com/full/12345