共有連絡先のカスタム特性を定義するには、拡張プロパティとプロジェクションを使用します。
拡張プロパティ
共有連絡先エントリの拡張プロパティとして、任意の名前と値のペアを使用して、共有連絡先に関連する追加情報を設定できます。キーの一意性を維持するのは、お客様の責任です。拡張プロパティの値は、値(任意の文字列)または XML BLOB(プレーン テキスト)として保存できます。共有連絡先ごとに、関連付けることができる拡張プロパティは最大 10 個です。拡張プロパティはそれぞれ適度なサイズにしてください。写真や着信音は使用しないでください。
例
次の例は、キーと値を持つ拡張プロパティを示しています。
<gd:extendedProperty name="com.google" value="<var>VALUE</var>"/>
次の例は、キーと XML BLOB を含む拡張プロパティを示しています。
<gd:extendedProperty name="com.google">
<<var>XML_PARAMETER</var>></<var>XML_PARAMETER</var>>
</gd:extendedProperty>
射影値
拡張プロパティの可視性を制限するには、プロジェクションを使用します。拡張プロパティ(gd:extendedElement 要素)の設定は、full または property-KEY 射影内でのみ許可されます。
次の表に、サポートされている投影値を示します。
| 予測名 | 説明 |
|---|---|
thin |
gd:extendedProperty 要素は返されず、更新もされません。 |
property-KEY |
KEY は、返される(GET リクエストの場合)または更新される(PUT または POST リクエストの場合)拡張プロパティ(gd:extendedProperty 要素)のキーを示します。更新オペレーションで拡張プロパティが使用されない場合、プロパティは削除されます。 |
full
| すべての gd:extendedProperty 要素が返され、更新時にすべての要素を含める必要があります。 |