共有ユーザー連絡先は、さまざまな形式でリクエストできます。 方法:
- すべての共有連絡先
- 指定した条件に一致する連絡先のセット
- 単一の共有連絡先
- 連絡先の写真
デフォルトでは、フィード内のエントリは順序付けされていません。
すべての共有連絡先を取得する
すべての共有連絡先を取得するには、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 を返します。 フィードに格納されます。以下は連絡先の例です。 エントリが 1 つだけの場合:<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>
フィードは 1 回のレスポンスで 10 MB を超えて返しません。宛先 返されたフィードの情報を繰り返し [次へ] のリンクを、返品フィードにそのリンクが表示されなくなるまで表示し続けます。
クエリ パラメータを使用して共有連絡先を取得する
指定した条件に一致する連絡先のセットをリクエストできます。 たとえば、指定した日付より後に更新された連絡先など、特定の条件を指定できます。「 全文検索、メールアドレスによる連絡先の検索などが可能です。1 つの サポートされているクエリ パラメータの一覧については、以下をご覧ください。 Domain Shared Contacts API リファレンス ガイドをご覧ください。
定義した内容を指定して、連絡先フィードの URL に
HTTP GET
リクエストを送信します。 parameter:GET https://www.google.com/m8/feeds/contacts/DOMAIN/PROJECTION?PARAMETER
次のように置き換えます。
DOMAIN
: ドメインの URL(例: example.com です。PROJECTION
: 指定する射影値gd:extendedProperty
要素。サポートされている値の一覧については、以下をご覧ください。 射影値。PARAMETER
: サポートされているクエリのいずれか あります。詳細については、次をご覧ください: Domain Shared Contacts API リファレンス ガイドをご覧ください。
たとえば、次の日付以降にドメインの共有連絡先エントリをすべて更新するには、 2022 年 3 月 16 日(example.com の場合)は、共有されているドメインに HTTP リクエストを送信します 連絡先フィードの URL を指定し、リクエスト URL に
updated-min
パラメータを追加します。GET https://www.google.com/m8/feeds/contacts/example.com/full?updated-min=2022-03-16T00:00:00
この
GET
リクエストを送信すると、サーバーは HTTP200 OK
を返します。 ドメイン共有の連絡先を含むフィードが、 ユーザーが指定した日付より後に作成または更新された日です。フィードは 1 回のレスポンスで 10 MB を超えて返しません。宛先 指定した条件で連絡先リスト全体を取得し、 返されたフィードの [次へ] リンクが表示されなくなるまでたどる 返品されます。
増分変更の追跡
ドメインの共有連絡先リストに対する増分変更を追跡するには、次の操作を行います。
次のとおりです。
1.フィードのリクエストを送信する場合は、
フィードの <updated>
要素。
1. 取得できるのは、次の日付以降に変更されたドメインの共有の連絡先のみです
クエリ パラメータを設定して、前のリクエストの
updated-min
をその <updated>
の値に設定し、
showdeleted
から true
に変更。
共有の連絡先を 1 件取得する
共有の連絡先を 1 つ取得するには、その連絡先のセルフリンクを使用する必要があります。Google Chat では 共有の連絡先のエントリを できます。セルフリンクの値がわからない場合は、 すべての連絡先を取得するをご覧ください。 および クエリ パラメータを使用して連絡先を取得する。
- ドメインの特定の共有連絡先を取得するには、HTTP
GET
を送信します。 次のリクエストを送信します。 次のように置き換えます。GET https://www.google.com/m8/feeds/contacts/DOMAIN/PROJECTION/:SELF_LINK>
DOMAIN
: ドメインの URL(例: 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