拡張プロパティとプロジェクション

共有連絡先のカスタム特性を定義するには、拡張プロパティとプロジェクションを使用します。

詳細プロパティ

共有の連絡先エントリに、任意の名前と値のペアを使用して、拡張プロパティとして追加の共有連絡先関連情報を設定できます。鍵の一意性を維持するのはお客様の責任です。拡張プロパティの値は、値(任意の文字列)または XML BLOB(プレーンテキスト)として保存できます。共有される各連絡先には、最大 10 個の拡張プロパティを関連付けることができます。各拡張プロパティは適度に小さくする必要があります。写真や着信音は使用しないでください。

次の例は、キーと値を持つ拡張プロパティを示しています。

&lt;gd:extendedProperty name="com.google" value="<var>VALUE</var>"/&gt;

次の例は、キーと XML の blob を含む拡張プロパティを示しています。

&lt;gd:extendedProperty name="com.google"&gt;
  &lt;<var>XML_PARAMETER</var>&gt;&lt;/<var>XML_PARAMETER</var>&gt;
&lt;/gd:extendedProperty>

予測値

拡張プロパティの公開範囲を制限するには、プロジェクションを使用します。拡張プロパティ(gd:extendedElement 要素)の設定は、full または property-KEY 投影内でのみ許可されます。

次の表に、サポートされている投影値を示します。

投影名 説明
thin gd:extendedProperty 要素は返されず、更新もされません。
property-KEY KEY は、返される(GET リクエストの場合)または更新が必要な(PUT または POST リクエストの場合)拡張プロパティ(gd:extendedProperty 要素)のキーを示します。更新オペレーション中に拡張プロパティが使用されていない場合、プロパティは削除されます。
full すべての gd:extendedProperty 要素が返され、更新時にはすべての要素を含める必要があります。