יש כמה דרכים לבקש את אנשי הקשר של משתמשים משותפים:
- כל אנשי הקשר המשותפים
- קבוצה של אנשי קשר שתואמים לקריטריונים שצוינו
- איש קשר משותף אחד
- תמונה של איש קשר
כברירת מחדל, הרשומות בפיד לא ממוינות.
הצגת כל אנשי הקשר המשותפים
כדי לקבל את כל אנשי הקשר המשותפים, שולחים בקשת HTTP
GET
לכתובת ה-URL של פיד אנשי הקשר:GET https://www.google.com/m8/feeds/contacts/DOMAIN/PROJECTION
מחליפים את מה שכתוב בשדות הבאים:
DOMAIN
: כתובת ה-URL של הדומיין שלכם – לדוגמה, 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>
הפיד לא מחזיר יותר מ-10MB בתגובה אחת. כדי לקבל את רשימת אנשי הקשר המלאה, לוחצים שוב ושוב על הקישור הבא בפיד המוחזר עד שהקישור הזה לא מופיע יותר בפיד המוחזר.
אחזור של אנשי קשר משותפים באמצעות פרמטרים של שאילתות
אפשר לבקש קבוצה של אנשי קשר שתואמים לקריטריונים מסוימים, למשל אנשי קשר שעודכנו אחרי תאריך נתון. אין תמיכה בשאילתות של טקסט מלא או במציאת איש קשר לפי כתובת אימייל. רשימה מלאה של פרמטרים נתמכים לשאילתות מופיעה במדריך העזרה של Domain Shared Contacts API.
שולחים בקשת
HTTP GET
לכתובת ה-URL של פיד אנשי הקשר עם פרמטר מוגדר:GET https://www.google.com/m8/feeds/contacts/DOMAIN/PROJECTION?PARAMETER
מחליפים את מה שכתוב בשדות הבאים:
DOMAIN
: כתובת ה-URL של הדומיין שלכם – לדוגמה, example.com.PROJECTION
: ערך ההקרנה שמציין את הרכיביםgd:extendedProperty
. רשימה של הערכים הנתמכים מופיעה במאמר ערכים של הקרנה.PARAMETER
: אחד מהפרמטרים הנתמכים של השאילתה. מידע נוסף זמין במאמר מדריך העזרה של Domain Shared Contacts API.
לדוגמה, כדי לקבל את כל הרשומות של אנשי הקשר המשותפים לדומיין שהתעדכנו אחרי 16 במרץ 2022 ב-example.com, שולחים בקשת HTTP לכתובת ה-URL של פיד אנשי הקשר המשותפים לדומיין ומוסיפים את הפרמטר
updated-min
לכתובת ה-URL של הבקשה:GET https://www.google.com/m8/feeds/contacts/example.com/full?updated-min=2022-03-16T00:00:00
כששולחים את הבקשה
GET
, השרת מחזיר את קוד הסטטוס200 OK
של HTTP ופיד שמכיל את כל אנשי הקשר המשותפים של הדומיין שנוצרו או עודכנו אחרי התאריך שצוין.הפיד לא מחזיר יותר מ-10MB בתגובה אחת. כדי לקבל את רשימת אנשי הקשר המלאה לפי הקריטריונים שציינתם, צריך ללחוץ שוב ושוב על הקישור הבא בפיד המוחזר עד שהקישור הזה לא יופיע יותר בפיד המוחזר.
מעקב אחר שינויים מצטברים
כדי לעקוב אחרי שינויים מצטברים ברשימת אנשי הקשר המשותפת של הדומיין:
1. כששולחים בקשה לפיד, חשוב לעקוב אחרי הערך של הרכיב <updated>
בפיד.
1. כדי לקבל רק את אנשי הקשר המשותפים לדומיין שהשתנו מאז הבקשה הקודמת, צריך להגדיר את הפרמטר של השאילתה updated-min
לערך <updated>
הזה ולהגדיר את showdeleted
לערך true
.
קבלת איש קשר משותף אחד
כדי לקבל איש קשר אחד ששותף, צריך להשתמש בקישור של איש הקשר לעצמו. אפשר לקבל את הקישור לאיש הקשר ששותף רק על ידי איתור הרשומה שלו בפיד של אנשי הקשר המשותפים. אם אתם לא בטוחים באיזה ערך להשתמש בקישור העצמי, תוכלו לעיין במאמרים אחזור כל אנשי הקשר ואחזור אנשי קשר באמצעות פרמטרים של שאילתות.
- כדי לקבל איש קשר משותף של דומיין ספציפי, שולחים בקשת HTTP
GET
לקישור העצמי של איש הקשר: מחליפים את הפרטים הבאים:GET https://www.google.com/m8/feeds/contacts/DOMAIN/PROJECTION/:SELF_LINK>
DOMAIN
: כתובת ה-URL של הדומיין שלכם – לדוגמה, example.com.PROJECTION
: ערך ההקרנה שמציין את הרכיביםgd:extendedProperty
. רשימה של הערכים הנתמכים מופיעה במאמר ערכים של הקרנה.SELF_LINK
: ערך מספרי ייחודי שמייצג איש קשר אחד ששותף – לדוגמה, 12345.
לאחר מכן, השרת מחזיר את קוד הסטטוס 200 OK
של HTTP ואת הרשומה שמכילה את איש הקשר.
לדוגמה, כדי לקבל איש קשר משותף לדומיין שהקישור העצמי שלו מוגדר כ-https://www.google.com/m8/feeds/contacts/example.com/full/12345
, שולחים את בקשת ה-HTTP הבאה:
GET https://www.google.com/m8/feeds/contacts/example.com/full/12345