共有の連絡先を取得する

共有ユーザーの連絡先は、さまざまな方法でリクエストできます。

  • すべての共有連絡先
  • 指定した条件に一致する連絡先のセット
  • 単一の共有連絡先
  • 連絡先の写真

デフォルトでは、フィード内のエントリは並べ替えられません。

すべての共有連絡先を取得する

  1. すべての共有連絡先を取得するには、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>

  2. フィードが 1 回のレスポンスで 10 MB を超えるものを返さない。連絡先リスト全体を取得するには、返されたフィードの [次へ] リンクが返信フィードに表示されなくなるまで繰り返します。

クエリ パラメータを使用して共有連絡先を取得する

特定の日付以降に更新された連絡先など、指定した条件に一致する連絡先のセットをリクエストできます。全文クエリやメールアドレスによる連絡先の検索はサポートされていません。サポートされているクエリ パラメータの一覧については、Domain Shared Contacts API のリファレンス ガイドをご覧ください。

  1. 定義済みのパラメータを含む 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 のリファレンス ガイドをご覧ください。

    たとえば、example.com の 2022 年 3 月 16 日以降に更新されたすべてのドメインの共有連絡先エントリを取得するには、HTTP リクエストをドメインの共有の連絡先フィード URL に送信し、updated-min パラメータをリクエスト URL に追加します。

    GET https://www.google.com/m8/feeds/contacts/example.com/full?updated-min=2022-03-16T00:00:00

    この GET リクエストを送信すると、サーバーは HTTP 200 OK ステータス コードと、指定した日付以降に作成または更新されたドメインの共有連絡先を含むフィードを返します。

  2. フィードが 1 回のレスポンスで 10 MB を超えるものを返さない。指定した条件で連絡先リスト全体を取得するには、戻りフィードにそのリンクが表示されなくなるまで、返されたフィードの [Next] リンクを繰り返し操作します。

増分変更を追跡する

ドメインの共有連絡先リストの増分変更を追跡するには、次の操作を行います。 1. フィードのリクエストを送信するときは、フィードの <updated> 要素の値をトラッキングします。1. クエリ パラメータ updated-min をその <updated> 値に設定し、showdeleted を true に設定すると、前回のリクエスト以降に変更されたドメインの共有連絡先のみを取得できます。

単一の共有連絡先を取得する

単一の共有連絡先を取得するには、連絡先のセルフリンクを使用する必要があります。共有連絡先のセルフリンクは、共有連絡先フィードでその連絡先のエントリを見つけることでのみ取得できます。セルフリンクにどの値を使用すればよいかわからない場合は、すべての連絡先を取得するとクエリ パラメータを使用して連絡先を取得するをご覧ください。

  1. 特定のドメインの共有連絡先を取得するには、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

次のステップ