| |
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <html><head><title>Python: class Resource</title> |
| </head><body bgcolor="#f0f0f8"> |
| <p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#ffc8d8"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> |
| |
| <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| <td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%">Methods defined here:<br> |
| <dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Delete a contact entry.<br> |
| <br> |
| Args:<br> |
| userId: string, The user whose all contacts are being deleted. (required)<br> |
| contactId: string, The id of the contact being deleted. (required)</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-deleteExtendedProperty"><strong>deleteExtendedProperty</strong></a> = method(self, **kwargs)</dt><dd><tt>Delete value of provided contact's extended property for the given key.<br> |
| <br> |
| Args:<br> |
| userId: string, The user whose contacts's extended property is being deleted. (required)<br> |
| contactId: string, Contact whose extended property is being deleted. (required)<br> |
| key: string, Extended property key whose value is being deleted. (required)</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-deleteUserDefinedProperty"><strong>deleteUserDefinedProperty</strong></a> = method(self, **kwargs)</dt><dd><tt>Delete value of provided contact's user defined property for the given key.<br> |
| <br> |
| Args:<br> |
| userId: string, The user whose contacts's user defined property is being deleted. (required)<br> |
| contactId: string, Contacts whose user defined property is being deleted. (required)<br> |
| key: string, User defined property key whose value is being deleted. (required)</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets contact details.<br> |
| <br> |
| Args:<br> |
| projection: string, Additional information to return.<br> |
| Allowed values<br> |
| FULL - Returns the extended properties of a contact.<br> |
| THIN - Returns properties of a contact.<br> |
| userId: string, The user whose all contacts are being requested. (required)<br> |
| contactId: string, The id of the contact being requested. (required)<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "phoneNumbers": [ # Phone information of the contact.<br> |
| {<br> |
| "type": "A String",<br> |
| "phoneType": "A String",<br> |
| "value": "A String",<br> |
| "primary": True or False,<br> |
| },<br> |
| ],<br> |
| "addresses": [ # Address information of the contact.<br> |
| {<br> |
| "sourceIsStructured": True or False,<br> |
| "poBox": "A String",<br> |
| "countryCode": "A String",<br> |
| "locality": "A String",<br> |
| "country": "A String",<br> |
| "region": "A String",<br> |
| "customType": "A String",<br> |
| "formatted": "A String",<br> |
| "primary": True or False,<br> |
| "streetAddress": "A String",<br> |
| "postalCode": "A String",<br> |
| "extendedAddress": "A String",<br> |
| "type": "A String",<br> |
| },<br> |
| ],<br> |
| "lastUpdateTime": "A String", # Last updated time of the entry.contact (in microseconds).<br> |
| "maidenName": "A String", # Maiden name of the contact. Maiden can not be repeated.<br> |
| "locations": [ # Locations the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "userDefinedProperties": [ # UserDefined fields of the contact profile.<br> |
| {<br> |
| "value": "A String",<br> |
| "key": "A String",<br> |
| },<br> |
| ],<br> |
| "hobbies": [<br> |
| "A String",<br> |
| ],<br> |
| "id": "A String", # Contact identifier.<br> |
| "occupation": "A String", # Occupation of the contact. Occupation can not be repeated.<br> |
| "calendarLinks": [ # Calendar information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "primary": True or False,<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "relations": [ # Relationship with the entry.contact.<br> |
| {<br> |
| "type": "A String",<br> |
| "customeType": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "languages": [ # Languages of the contact.<br> |
| {<br> |
| "code": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "ims": [ # Instant messanger related information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "protocol": "A String",<br> |
| "customProtocol": "A String",<br> |
| "primary": True or False,<br> |
| "im": "A String",<br> |
| "type": "A String",<br> |
| },<br> |
| ],<br> |
| "events": [ # Events information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "startTime": "",<br> |
| "endTime": "",<br> |
| },<br> |
| ],<br> |
| "externalIds": [ # Information regarding External Ids of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "id": "A String",<br> |
| },<br> |
| ],<br> |
| "deleted": True or False, # If this contact has been deleted (boolean field).<br> |
| "extendedProperties": [ # Extended properties of the contact. Available only in full projection.<br> |
| {<br> |
| "name": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "birthday": { # Birthday of the contact in YYYY-MM-DD format.<br> |
| "year": 42,<br> |
| "day": 42,<br> |
| "value": "A String",<br> |
| "month": 42,<br> |
| },<br> |
| "groups": [ # Group information of the contact.<br> |
| {<br> |
| "deleted": True or False,<br> |
| "groupId": "A String",<br> |
| },<br> |
| ],<br> |
| "others": [ # Other proeprties of a contact (equivalent to jot in gdata).<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "shortName": "A String", # Short name of the contact. Short name can not be repeated.<br> |
| "emails": [ # Email information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "primary": True or False,<br> |
| "address": "A String",<br> |
| },<br> |
| ],<br> |
| "organizations": [ # Organizations information of the contact.<br> |
| {<br> |
| "domain": "A String",<br> |
| "description": "A String",<br> |
| "title": "A String",<br> |
| "symbol": "A String",<br> |
| "customType": "A String",<br> |
| "primary": True or False,<br> |
| "location": "A String",<br> |
| "department": "A String",<br> |
| "type": "A String",<br> |
| "name": "A String",<br> |
| },<br> |
| ],<br> |
| "kind": "contacts#contact", # Type of the resource. This is always "contacts#contact".<br> |
| "photoId": "A String", # Contacts's photoId.<br> |
| "name": { # Detailed name information of the contact.<br> |
| "nameSuffix": "A String",<br> |
| "familyName": "A String",<br> |
| "additionalName": "A String",<br> |
| "namePrefix": "A String",<br> |
| "fullName": "A String",<br> |
| "givenName": "A String",<br> |
| },<br> |
| "gender": "A String", # Standard gender of the contact. It must be mapped to one of the gender specified in GenderTypes map.<br> |
| "outlookInformation": {<br> |
| },<br> |
| "urls": [ # Contact's various websites information.<br> |
| {<br> |
| "href": "A String",<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "primary": True or False,<br> |
| },<br> |
| ],<br> |
| "selfLink": "A String", # URL pointing to this contact. Used to retrieve, update, or delete this contact.<br> |
| "initials": "A String", # Initials of the contact. Initials can not be repeated and hence only one value is possible for it.<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-getExtendedProperty"><strong>getExtendedProperty</strong></a> = method(self, **kwargs)</dt><dd><tt>Get value of provided contact's extended property for the given key.<br> |
| <br> |
| Args:<br> |
| userId: string, The user whose all contacts's extended property is being requested. (required)<br> |
| contactId: string, Contacts whose extended property is being requested. (required)<br> |
| key: string, Extended property key whose value is being requested. (required)<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "value": "A String",<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-getUserDefinedProperty"><strong>getUserDefinedProperty</strong></a> = method(self, **kwargs)</dt><dd><tt>Get value of provided contact's user defined property for the given key.<br> |
| <br> |
| Args:<br> |
| userId: string, The user whose contacts's user defined property is being requested. (required)<br> |
| contactId: string, Contacts whose user defined property is being requested. (required)<br> |
| key: string, User defined property key whose value is being requested. (required)<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "value": "A String",<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Insert a contact entry.<br> |
| <br> |
| Args:<br> |
| body: object, The request body. (required)<br> |
| The object takes the form of:<br> |
| <br> |
| {<br> |
| "phoneNumbers": [ # Phone information of the contact.<br> |
| {<br> |
| "type": "A String",<br> |
| "phoneType": "A String",<br> |
| "value": "A String",<br> |
| "primary": True or False,<br> |
| },<br> |
| ],<br> |
| "addresses": [ # Address information of the contact.<br> |
| {<br> |
| "sourceIsStructured": True or False,<br> |
| "poBox": "A String",<br> |
| "countryCode": "A String",<br> |
| "locality": "A String",<br> |
| "country": "A String",<br> |
| "region": "A String",<br> |
| "customType": "A String",<br> |
| "formatted": "A String",<br> |
| "primary": True or False,<br> |
| "streetAddress": "A String",<br> |
| "postalCode": "A String",<br> |
| "extendedAddress": "A String",<br> |
| "type": "A String",<br> |
| },<br> |
| ],<br> |
| "lastUpdateTime": "A String", # Last updated time of the entry.contact (in microseconds).<br> |
| "maidenName": "A String", # Maiden name of the contact. Maiden can not be repeated.<br> |
| "locations": [ # Locations the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "userDefinedProperties": [ # UserDefined fields of the contact profile.<br> |
| {<br> |
| "value": "A String",<br> |
| "key": "A String",<br> |
| },<br> |
| ],<br> |
| "hobbies": [<br> |
| "A String",<br> |
| ],<br> |
| "id": "A String", # Contact identifier.<br> |
| "occupation": "A String", # Occupation of the contact. Occupation can not be repeated.<br> |
| "calendarLinks": [ # Calendar information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "primary": True or False,<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "relations": [ # Relationship with the entry.contact.<br> |
| {<br> |
| "type": "A String",<br> |
| "customeType": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "languages": [ # Languages of the contact.<br> |
| {<br> |
| "code": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "ims": [ # Instant messanger related information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "protocol": "A String",<br> |
| "customProtocol": "A String",<br> |
| "primary": True or False,<br> |
| "im": "A String",<br> |
| "type": "A String",<br> |
| },<br> |
| ],<br> |
| "events": [ # Events information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "startTime": "",<br> |
| "endTime": "",<br> |
| },<br> |
| ],<br> |
| "externalIds": [ # Information regarding External Ids of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "id": "A String",<br> |
| },<br> |
| ],<br> |
| "deleted": True or False, # If this contact has been deleted (boolean field).<br> |
| "extendedProperties": [ # Extended properties of the contact. Available only in full projection.<br> |
| {<br> |
| "name": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "birthday": { # Birthday of the contact in YYYY-MM-DD format.<br> |
| "year": 42,<br> |
| "day": 42,<br> |
| "value": "A String",<br> |
| "month": 42,<br> |
| },<br> |
| "groups": [ # Group information of the contact.<br> |
| {<br> |
| "deleted": True or False,<br> |
| "groupId": "A String",<br> |
| },<br> |
| ],<br> |
| "others": [ # Other proeprties of a contact (equivalent to jot in gdata).<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "shortName": "A String", # Short name of the contact. Short name can not be repeated.<br> |
| "emails": [ # Email information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "primary": True or False,<br> |
| "address": "A String",<br> |
| },<br> |
| ],<br> |
| "organizations": [ # Organizations information of the contact.<br> |
| {<br> |
| "domain": "A String",<br> |
| "description": "A String",<br> |
| "title": "A String",<br> |
| "symbol": "A String",<br> |
| "customType": "A String",<br> |
| "primary": True or False,<br> |
| "location": "A String",<br> |
| "department": "A String",<br> |
| "type": "A String",<br> |
| "name": "A String",<br> |
| },<br> |
| ],<br> |
| "kind": "contacts#contact", # Type of the resource. This is always "contacts#contact".<br> |
| "photoId": "A String", # Contacts's photoId.<br> |
| "name": { # Detailed name information of the contact.<br> |
| "nameSuffix": "A String",<br> |
| "familyName": "A String",<br> |
| "additionalName": "A String",<br> |
| "namePrefix": "A String",<br> |
| "fullName": "A String",<br> |
| "givenName": "A String",<br> |
| },<br> |
| "gender": "A String", # Standard gender of the contact. It must be mapped to one of the gender specified in GenderTypes map.<br> |
| "outlookInformation": {<br> |
| },<br> |
| "urls": [ # Contact's various websites information.<br> |
| {<br> |
| "href": "A String",<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "primary": True or False,<br> |
| },<br> |
| ],<br> |
| "selfLink": "A String", # URL pointing to this contact. Used to retrieve, update, or delete this contact.<br> |
| "initials": "A String", # Initials of the contact. Initials can not be repeated and hence only one value is possible for it.<br> |
| }<br> |
| <br> |
| userId: string, The user whose all contacts are being requested. (required)<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "phoneNumbers": [ # Phone information of the contact.<br> |
| {<br> |
| "type": "A String",<br> |
| "phoneType": "A String",<br> |
| "value": "A String",<br> |
| "primary": True or False,<br> |
| },<br> |
| ],<br> |
| "addresses": [ # Address information of the contact.<br> |
| {<br> |
| "sourceIsStructured": True or False,<br> |
| "poBox": "A String",<br> |
| "countryCode": "A String",<br> |
| "locality": "A String",<br> |
| "country": "A String",<br> |
| "region": "A String",<br> |
| "customType": "A String",<br> |
| "formatted": "A String",<br> |
| "primary": True or False,<br> |
| "streetAddress": "A String",<br> |
| "postalCode": "A String",<br> |
| "extendedAddress": "A String",<br> |
| "type": "A String",<br> |
| },<br> |
| ],<br> |
| "lastUpdateTime": "A String", # Last updated time of the entry.contact (in microseconds).<br> |
| "maidenName": "A String", # Maiden name of the contact. Maiden can not be repeated.<br> |
| "locations": [ # Locations the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "userDefinedProperties": [ # UserDefined fields of the contact profile.<br> |
| {<br> |
| "value": "A String",<br> |
| "key": "A String",<br> |
| },<br> |
| ],<br> |
| "hobbies": [<br> |
| "A String",<br> |
| ],<br> |
| "id": "A String", # Contact identifier.<br> |
| "occupation": "A String", # Occupation of the contact. Occupation can not be repeated.<br> |
| "calendarLinks": [ # Calendar information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "primary": True or False,<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "relations": [ # Relationship with the entry.contact.<br> |
| {<br> |
| "type": "A String",<br> |
| "customeType": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "languages": [ # Languages of the contact.<br> |
| {<br> |
| "code": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "ims": [ # Instant messanger related information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "protocol": "A String",<br> |
| "customProtocol": "A String",<br> |
| "primary": True or False,<br> |
| "im": "A String",<br> |
| "type": "A String",<br> |
| },<br> |
| ],<br> |
| "events": [ # Events information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "startTime": "",<br> |
| "endTime": "",<br> |
| },<br> |
| ],<br> |
| "externalIds": [ # Information regarding External Ids of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "id": "A String",<br> |
| },<br> |
| ],<br> |
| "deleted": True or False, # If this contact has been deleted (boolean field).<br> |
| "extendedProperties": [ # Extended properties of the contact. Available only in full projection.<br> |
| {<br> |
| "name": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "birthday": { # Birthday of the contact in YYYY-MM-DD format.<br> |
| "year": 42,<br> |
| "day": 42,<br> |
| "value": "A String",<br> |
| "month": 42,<br> |
| },<br> |
| "groups": [ # Group information of the contact.<br> |
| {<br> |
| "deleted": True or False,<br> |
| "groupId": "A String",<br> |
| },<br> |
| ],<br> |
| "others": [ # Other proeprties of a contact (equivalent to jot in gdata).<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "shortName": "A String", # Short name of the contact. Short name can not be repeated.<br> |
| "emails": [ # Email information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "primary": True or False,<br> |
| "address": "A String",<br> |
| },<br> |
| ],<br> |
| "organizations": [ # Organizations information of the contact.<br> |
| {<br> |
| "domain": "A String",<br> |
| "description": "A String",<br> |
| "title": "A String",<br> |
| "symbol": "A String",<br> |
| "customType": "A String",<br> |
| "primary": True or False,<br> |
| "location": "A String",<br> |
| "department": "A String",<br> |
| "type": "A String",<br> |
| "name": "A String",<br> |
| },<br> |
| ],<br> |
| "kind": "contacts#contact", # Type of the resource. This is always "contacts#contact".<br> |
| "photoId": "A String", # Contacts's photoId.<br> |
| "name": { # Detailed name information of the contact.<br> |
| "nameSuffix": "A String",<br> |
| "familyName": "A String",<br> |
| "additionalName": "A String",<br> |
| "namePrefix": "A String",<br> |
| "fullName": "A String",<br> |
| "givenName": "A String",<br> |
| },<br> |
| "gender": "A String", # Standard gender of the contact. It must be mapped to one of the gender specified in GenderTypes map.<br> |
| "outlookInformation": {<br> |
| },<br> |
| "urls": [ # Contact's various websites information.<br> |
| {<br> |
| "href": "A String",<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "primary": True or False,<br> |
| },<br> |
| ],<br> |
| "selfLink": "A String", # URL pointing to this contact. Used to retrieve, update, or delete this contact.<br> |
| "initials": "A String", # Initials of the contact. Initials can not be repeated and hence only one value is possible for it.<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves list of all contacts for the provided user.<br> |
| <br> |
| Args:<br> |
| orderBy: string, Sorting criterion<br> |
| Allowed values<br> |
| LAST_MODIFIED - Order by last modified contact<br> |
| group: string, Limit the listing to the specified group<br> |
| projection: string, Additional information to return.<br> |
| Allowed values<br> |
| FULL - Returns properties of a contact including extended properties.<br> |
| THIN - Returns properties of a contact.<br> |
| pageToken: string, A continuation token that allows pagination.<br> |
| updatedMin: integer, The lower bound on entry update dates (seconds from epcoh).<br> |
| requireAllDeleted: boolean, Only relevant if showdeleted and updated-min are also provided.It dictates the behavior of the server in case it detect that placeholders of some entries deleted since the point in time specified as updated-min may have been lost.<br> |
| queryString: string, A parameter<br> |
| maxResults: integer, Maximum number of contact entries to return.<br> |
| q: string, A parameter<br> |
| showDeleted: boolean, Flag to include deleted contacts<br> |
| sortOrder: string, Sorting order of the result<br> |
| Allowed values<br> |
| ascending - Use ascending sort order<br> |
| descending - Use decending sort order<br> |
| alt: string, Specifies an alternative representation type.<br> |
| Allowed values<br> |
| atom - Use Atom XML format<br> |
| json - Use JSON format<br> |
| userId: string, The user whose allcontacts are being listed. (required)<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "nextPageToken": "A String",<br> |
| "items": [<br> |
| {<br> |
| "phoneNumbers": [ # Phone information of the contact.<br> |
| {<br> |
| "type": "A String",<br> |
| "phoneType": "A String",<br> |
| "value": "A String",<br> |
| "primary": True or False,<br> |
| },<br> |
| ],<br> |
| "addresses": [ # Address information of the contact.<br> |
| {<br> |
| "sourceIsStructured": True or False,<br> |
| "poBox": "A String",<br> |
| "countryCode": "A String",<br> |
| "locality": "A String",<br> |
| "country": "A String",<br> |
| "region": "A String",<br> |
| "customType": "A String",<br> |
| "formatted": "A String",<br> |
| "primary": True or False,<br> |
| "streetAddress": "A String",<br> |
| "postalCode": "A String",<br> |
| "extendedAddress": "A String",<br> |
| "type": "A String",<br> |
| },<br> |
| ],<br> |
| "lastUpdateTime": "A String", # Last updated time of the entry.contact (in microseconds).<br> |
| "maidenName": "A String", # Maiden name of the contact. Maiden can not be repeated.<br> |
| "locations": [ # Locations the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "userDefinedProperties": [ # UserDefined fields of the contact profile.<br> |
| {<br> |
| "value": "A String",<br> |
| "key": "A String",<br> |
| },<br> |
| ],<br> |
| "hobbies": [<br> |
| "A String",<br> |
| ],<br> |
| "id": "A String", # Contact identifier.<br> |
| "occupation": "A String", # Occupation of the contact. Occupation can not be repeated.<br> |
| "calendarLinks": [ # Calendar information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "primary": True or False,<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "relations": [ # Relationship with the entry.contact.<br> |
| {<br> |
| "type": "A String",<br> |
| "customeType": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "languages": [ # Languages of the contact.<br> |
| {<br> |
| "code": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "ims": [ # Instant messanger related information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "protocol": "A String",<br> |
| "customProtocol": "A String",<br> |
| "primary": True or False,<br> |
| "im": "A String",<br> |
| "type": "A String",<br> |
| },<br> |
| ],<br> |
| "events": [ # Events information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "startTime": "",<br> |
| "endTime": "",<br> |
| },<br> |
| ],<br> |
| "externalIds": [ # Information regarding External Ids of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "id": "A String",<br> |
| },<br> |
| ],<br> |
| "deleted": True or False, # If this contact has been deleted (boolean field).<br> |
| "extendedProperties": [ # Extended properties of the contact. Available only in full projection.<br> |
| {<br> |
| "name": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "birthday": { # Birthday of the contact in YYYY-MM-DD format.<br> |
| "year": 42,<br> |
| "day": 42,<br> |
| "value": "A String",<br> |
| "month": 42,<br> |
| },<br> |
| "groups": [ # Group information of the contact.<br> |
| {<br> |
| "deleted": True or False,<br> |
| "groupId": "A String",<br> |
| },<br> |
| ],<br> |
| "others": [ # Other proeprties of a contact (equivalent to jot in gdata).<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "shortName": "A String", # Short name of the contact. Short name can not be repeated.<br> |
| "emails": [ # Email information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "primary": True or False,<br> |
| "address": "A String",<br> |
| },<br> |
| ],<br> |
| "organizations": [ # Organizations information of the contact.<br> |
| {<br> |
| "domain": "A String",<br> |
| "description": "A String",<br> |
| "title": "A String",<br> |
| "symbol": "A String",<br> |
| "customType": "A String",<br> |
| "primary": True or False,<br> |
| "location": "A String",<br> |
| "department": "A String",<br> |
| "type": "A String",<br> |
| "name": "A String",<br> |
| },<br> |
| ],<br> |
| "kind": "contacts#contact", # Type of the resource. This is always "contacts#contact".<br> |
| "photoId": "A String", # Contacts's photoId.<br> |
| "name": { # Detailed name information of the contact.<br> |
| "nameSuffix": "A String",<br> |
| "familyName": "A String",<br> |
| "additionalName": "A String",<br> |
| "namePrefix": "A String",<br> |
| "fullName": "A String",<br> |
| "givenName": "A String",<br> |
| },<br> |
| "gender": "A String", # Standard gender of the contact. It must be mapped to one of the gender specified in GenderTypes map.<br> |
| "outlookInformation": {<br> |
| },<br> |
| "urls": [ # Contact's various websites information.<br> |
| {<br> |
| "href": "A String",<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "primary": True or False,<br> |
| },<br> |
| ],<br> |
| "selfLink": "A String", # URL pointing to this contact. Used to retrieve, update, or delete this contact.<br> |
| "initials": "A String", # Initials of the contact. Initials can not be repeated and hence only one value is possible for it.<br> |
| },<br> |
| ],<br> |
| "kind": "contacts#contactList", # Type of the resource. This is always "contacts#contactList".<br> |
| "prevPageToken": "A String",<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br> |
| <br> |
| Args:<br> |
| previous_request: The request for the previous page.<br> |
| previous_response: The response from the request for the previous page.<br> |
| <br> |
| Returns:<br> |
| A request object that you can call 'execute()' on to request the next<br> |
| page. Returns None if there are no more items in the collection.</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Update a contact entry. This method supports patch semantics.<br> |
| <br> |
| Args:<br> |
| body: object, The request body. (required)<br> |
| The object takes the form of:<br> |
| <br> |
| {<br> |
| "phoneNumbers": [ # Phone information of the contact.<br> |
| {<br> |
| "type": "A String",<br> |
| "phoneType": "A String",<br> |
| "value": "A String",<br> |
| "primary": True or False,<br> |
| },<br> |
| ],<br> |
| "addresses": [ # Address information of the contact.<br> |
| {<br> |
| "sourceIsStructured": True or False,<br> |
| "poBox": "A String",<br> |
| "countryCode": "A String",<br> |
| "locality": "A String",<br> |
| "country": "A String",<br> |
| "region": "A String",<br> |
| "customType": "A String",<br> |
| "formatted": "A String",<br> |
| "primary": True or False,<br> |
| "streetAddress": "A String",<br> |
| "postalCode": "A String",<br> |
| "extendedAddress": "A String",<br> |
| "type": "A String",<br> |
| },<br> |
| ],<br> |
| "lastUpdateTime": "A String", # Last updated time of the entry.contact (in microseconds).<br> |
| "maidenName": "A String", # Maiden name of the contact. Maiden can not be repeated.<br> |
| "locations": [ # Locations the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "userDefinedProperties": [ # UserDefined fields of the contact profile.<br> |
| {<br> |
| "value": "A String",<br> |
| "key": "A String",<br> |
| },<br> |
| ],<br> |
| "hobbies": [<br> |
| "A String",<br> |
| ],<br> |
| "id": "A String", # Contact identifier.<br> |
| "occupation": "A String", # Occupation of the contact. Occupation can not be repeated.<br> |
| "calendarLinks": [ # Calendar information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "primary": True or False,<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "relations": [ # Relationship with the entry.contact.<br> |
| {<br> |
| "type": "A String",<br> |
| "customeType": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "languages": [ # Languages of the contact.<br> |
| {<br> |
| "code": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "ims": [ # Instant messanger related information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "protocol": "A String",<br> |
| "customProtocol": "A String",<br> |
| "primary": True or False,<br> |
| "im": "A String",<br> |
| "type": "A String",<br> |
| },<br> |
| ],<br> |
| "events": [ # Events information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "startTime": "",<br> |
| "endTime": "",<br> |
| },<br> |
| ],<br> |
| "externalIds": [ # Information regarding External Ids of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "id": "A String",<br> |
| },<br> |
| ],<br> |
| "deleted": True or False, # If this contact has been deleted (boolean field).<br> |
| "extendedProperties": [ # Extended properties of the contact. Available only in full projection.<br> |
| {<br> |
| "name": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "birthday": { # Birthday of the contact in YYYY-MM-DD format.<br> |
| "year": 42,<br> |
| "day": 42,<br> |
| "value": "A String",<br> |
| "month": 42,<br> |
| },<br> |
| "groups": [ # Group information of the contact.<br> |
| {<br> |
| "deleted": True or False,<br> |
| "groupId": "A String",<br> |
| },<br> |
| ],<br> |
| "others": [ # Other proeprties of a contact (equivalent to jot in gdata).<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "shortName": "A String", # Short name of the contact. Short name can not be repeated.<br> |
| "emails": [ # Email information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "primary": True or False,<br> |
| "address": "A String",<br> |
| },<br> |
| ],<br> |
| "organizations": [ # Organizations information of the contact.<br> |
| {<br> |
| "domain": "A String",<br> |
| "description": "A String",<br> |
| "title": "A String",<br> |
| "symbol": "A String",<br> |
| "customType": "A String",<br> |
| "primary": True or False,<br> |
| "location": "A String",<br> |
| "department": "A String",<br> |
| "type": "A String",<br> |
| "name": "A String",<br> |
| },<br> |
| ],<br> |
| "kind": "contacts#contact", # Type of the resource. This is always "contacts#contact".<br> |
| "photoId": "A String", # Contacts's photoId.<br> |
| "name": { # Detailed name information of the contact.<br> |
| "nameSuffix": "A String",<br> |
| "familyName": "A String",<br> |
| "additionalName": "A String",<br> |
| "namePrefix": "A String",<br> |
| "fullName": "A String",<br> |
| "givenName": "A String",<br> |
| },<br> |
| "gender": "A String", # Standard gender of the contact. It must be mapped to one of the gender specified in GenderTypes map.<br> |
| "outlookInformation": {<br> |
| },<br> |
| "urls": [ # Contact's various websites information.<br> |
| {<br> |
| "href": "A String",<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "primary": True or False,<br> |
| },<br> |
| ],<br> |
| "selfLink": "A String", # URL pointing to this contact. Used to retrieve, update, or delete this contact.<br> |
| "initials": "A String", # Initials of the contact. Initials can not be repeated and hence only one value is possible for it.<br> |
| }<br> |
| <br> |
| userId: string, The user whose all contacts are being updated. (required)<br> |
| contactId: string, The id of the contact being updated. (required)<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "phoneNumbers": [ # Phone information of the contact.<br> |
| {<br> |
| "type": "A String",<br> |
| "phoneType": "A String",<br> |
| "value": "A String",<br> |
| "primary": True or False,<br> |
| },<br> |
| ],<br> |
| "addresses": [ # Address information of the contact.<br> |
| {<br> |
| "sourceIsStructured": True or False,<br> |
| "poBox": "A String",<br> |
| "countryCode": "A String",<br> |
| "locality": "A String",<br> |
| "country": "A String",<br> |
| "region": "A String",<br> |
| "customType": "A String",<br> |
| "formatted": "A String",<br> |
| "primary": True or False,<br> |
| "streetAddress": "A String",<br> |
| "postalCode": "A String",<br> |
| "extendedAddress": "A String",<br> |
| "type": "A String",<br> |
| },<br> |
| ],<br> |
| "lastUpdateTime": "A String", # Last updated time of the entry.contact (in microseconds).<br> |
| "maidenName": "A String", # Maiden name of the contact. Maiden can not be repeated.<br> |
| "locations": [ # Locations the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "userDefinedProperties": [ # UserDefined fields of the contact profile.<br> |
| {<br> |
| "value": "A String",<br> |
| "key": "A String",<br> |
| },<br> |
| ],<br> |
| "hobbies": [<br> |
| "A String",<br> |
| ],<br> |
| "id": "A String", # Contact identifier.<br> |
| "occupation": "A String", # Occupation of the contact. Occupation can not be repeated.<br> |
| "calendarLinks": [ # Calendar information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "primary": True or False,<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "relations": [ # Relationship with the entry.contact.<br> |
| {<br> |
| "type": "A String",<br> |
| "customeType": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "languages": [ # Languages of the contact.<br> |
| {<br> |
| "code": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "ims": [ # Instant messanger related information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "protocol": "A String",<br> |
| "customProtocol": "A String",<br> |
| "primary": True or False,<br> |
| "im": "A String",<br> |
| "type": "A String",<br> |
| },<br> |
| ],<br> |
| "events": [ # Events information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "startTime": "",<br> |
| "endTime": "",<br> |
| },<br> |
| ],<br> |
| "externalIds": [ # Information regarding External Ids of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "id": "A String",<br> |
| },<br> |
| ],<br> |
| "deleted": True or False, # If this contact has been deleted (boolean field).<br> |
| "extendedProperties": [ # Extended properties of the contact. Available only in full projection.<br> |
| {<br> |
| "name": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "birthday": { # Birthday of the contact in YYYY-MM-DD format.<br> |
| "year": 42,<br> |
| "day": 42,<br> |
| "value": "A String",<br> |
| "month": 42,<br> |
| },<br> |
| "groups": [ # Group information of the contact.<br> |
| {<br> |
| "deleted": True or False,<br> |
| "groupId": "A String",<br> |
| },<br> |
| ],<br> |
| "others": [ # Other proeprties of a contact (equivalent to jot in gdata).<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "shortName": "A String", # Short name of the contact. Short name can not be repeated.<br> |
| "emails": [ # Email information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "primary": True or False,<br> |
| "address": "A String",<br> |
| },<br> |
| ],<br> |
| "organizations": [ # Organizations information of the contact.<br> |
| {<br> |
| "domain": "A String",<br> |
| "description": "A String",<br> |
| "title": "A String",<br> |
| "symbol": "A String",<br> |
| "customType": "A String",<br> |
| "primary": True or False,<br> |
| "location": "A String",<br> |
| "department": "A String",<br> |
| "type": "A String",<br> |
| "name": "A String",<br> |
| },<br> |
| ],<br> |
| "kind": "contacts#contact", # Type of the resource. This is always "contacts#contact".<br> |
| "photoId": "A String", # Contacts's photoId.<br> |
| "name": { # Detailed name information of the contact.<br> |
| "nameSuffix": "A String",<br> |
| "familyName": "A String",<br> |
| "additionalName": "A String",<br> |
| "namePrefix": "A String",<br> |
| "fullName": "A String",<br> |
| "givenName": "A String",<br> |
| },<br> |
| "gender": "A String", # Standard gender of the contact. It must be mapped to one of the gender specified in GenderTypes map.<br> |
| "outlookInformation": {<br> |
| },<br> |
| "urls": [ # Contact's various websites information.<br> |
| {<br> |
| "href": "A String",<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "primary": True or False,<br> |
| },<br> |
| ],<br> |
| "selfLink": "A String", # URL pointing to this contact. Used to retrieve, update, or delete this contact.<br> |
| "initials": "A String", # Initials of the contact. Initials can not be repeated and hence only one value is possible for it.<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-photos"><strong><a href="contacts.v1beta1.allcontacts.photos.html">photos</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-setExtendedProperty"><strong>setExtendedProperty</strong></a> = method(self, **kwargs)</dt><dd><tt>Set value of provided contact's extended property for the given key.<br> |
| <br> |
| Args:<br> |
| body: object, The request body. (required)<br> |
| The object takes the form of:<br> |
| <br> |
| {<br> |
| "value": "A String",<br> |
| }<br> |
| <br> |
| userId: string, The user whose all contacts's extended property is being requested. (required)<br> |
| contactId: string, Contacts whose extended property is being requested. (required)<br> |
| key: string, Extended property key whose value is being requested. (required)<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "value": "A String",<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-setUserDefinedProperty"><strong>setUserDefinedProperty</strong></a> = method(self, **kwargs)</dt><dd><tt>Set value of provided contact's user defined property for the given key.<br> |
| <br> |
| Args:<br> |
| body: object, The request body. (required)<br> |
| The object takes the form of:<br> |
| <br> |
| {<br> |
| "value": "A String",<br> |
| }<br> |
| <br> |
| userId: string, The user whose contacts's user defined property is being requested. (required)<br> |
| contactId: string, Contacts whose user defined property is being requested. (required)<br> |
| key: string, User defined property key whose value is being requested. (required)<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "value": "A String",<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Update a contact entry.<br> |
| <br> |
| Args:<br> |
| body: object, The request body. (required)<br> |
| The object takes the form of:<br> |
| <br> |
| {<br> |
| "phoneNumbers": [ # Phone information of the contact.<br> |
| {<br> |
| "type": "A String",<br> |
| "phoneType": "A String",<br> |
| "value": "A String",<br> |
| "primary": True or False,<br> |
| },<br> |
| ],<br> |
| "addresses": [ # Address information of the contact.<br> |
| {<br> |
| "sourceIsStructured": True or False,<br> |
| "poBox": "A String",<br> |
| "countryCode": "A String",<br> |
| "locality": "A String",<br> |
| "country": "A String",<br> |
| "region": "A String",<br> |
| "customType": "A String",<br> |
| "formatted": "A String",<br> |
| "primary": True or False,<br> |
| "streetAddress": "A String",<br> |
| "postalCode": "A String",<br> |
| "extendedAddress": "A String",<br> |
| "type": "A String",<br> |
| },<br> |
| ],<br> |
| "lastUpdateTime": "A String", # Last updated time of the entry.contact (in microseconds).<br> |
| "maidenName": "A String", # Maiden name of the contact. Maiden can not be repeated.<br> |
| "locations": [ # Locations the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "userDefinedProperties": [ # UserDefined fields of the contact profile.<br> |
| {<br> |
| "value": "A String",<br> |
| "key": "A String",<br> |
| },<br> |
| ],<br> |
| "hobbies": [<br> |
| "A String",<br> |
| ],<br> |
| "id": "A String", # Contact identifier.<br> |
| "occupation": "A String", # Occupation of the contact. Occupation can not be repeated.<br> |
| "calendarLinks": [ # Calendar information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "primary": True or False,<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "relations": [ # Relationship with the entry.contact.<br> |
| {<br> |
| "type": "A String",<br> |
| "customeType": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "languages": [ # Languages of the contact.<br> |
| {<br> |
| "code": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "ims": [ # Instant messanger related information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "protocol": "A String",<br> |
| "customProtocol": "A String",<br> |
| "primary": True or False,<br> |
| "im": "A String",<br> |
| "type": "A String",<br> |
| },<br> |
| ],<br> |
| "events": [ # Events information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "startTime": "",<br> |
| "endTime": "",<br> |
| },<br> |
| ],<br> |
| "externalIds": [ # Information regarding External Ids of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "id": "A String",<br> |
| },<br> |
| ],<br> |
| "deleted": True or False, # If this contact has been deleted (boolean field).<br> |
| "extendedProperties": [ # Extended properties of the contact. Available only in full projection.<br> |
| {<br> |
| "name": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "birthday": { # Birthday of the contact in YYYY-MM-DD format.<br> |
| "year": 42,<br> |
| "day": 42,<br> |
| "value": "A String",<br> |
| "month": 42,<br> |
| },<br> |
| "groups": [ # Group information of the contact.<br> |
| {<br> |
| "deleted": True or False,<br> |
| "groupId": "A String",<br> |
| },<br> |
| ],<br> |
| "others": [ # Other proeprties of a contact (equivalent to jot in gdata).<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "shortName": "A String", # Short name of the contact. Short name can not be repeated.<br> |
| "emails": [ # Email information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "primary": True or False,<br> |
| "address": "A String",<br> |
| },<br> |
| ],<br> |
| "organizations": [ # Organizations information of the contact.<br> |
| {<br> |
| "domain": "A String",<br> |
| "description": "A String",<br> |
| "title": "A String",<br> |
| "symbol": "A String",<br> |
| "customType": "A String",<br> |
| "primary": True or False,<br> |
| "location": "A String",<br> |
| "department": "A String",<br> |
| "type": "A String",<br> |
| "name": "A String",<br> |
| },<br> |
| ],<br> |
| "kind": "contacts#contact", # Type of the resource. This is always "contacts#contact".<br> |
| "photoId": "A String", # Contacts's photoId.<br> |
| "name": { # Detailed name information of the contact.<br> |
| "nameSuffix": "A String",<br> |
| "familyName": "A String",<br> |
| "additionalName": "A String",<br> |
| "namePrefix": "A String",<br> |
| "fullName": "A String",<br> |
| "givenName": "A String",<br> |
| },<br> |
| "gender": "A String", # Standard gender of the contact. It must be mapped to one of the gender specified in GenderTypes map.<br> |
| "outlookInformation": {<br> |
| },<br> |
| "urls": [ # Contact's various websites information.<br> |
| {<br> |
| "href": "A String",<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "primary": True or False,<br> |
| },<br> |
| ],<br> |
| "selfLink": "A String", # URL pointing to this contact. Used to retrieve, update, or delete this contact.<br> |
| "initials": "A String", # Initials of the contact. Initials can not be repeated and hence only one value is possible for it.<br> |
| }<br> |
| <br> |
| userId: string, The user whose all contacts are being updated. (required)<br> |
| contactId: string, The id of the contact being updated. (required)<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "phoneNumbers": [ # Phone information of the contact.<br> |
| {<br> |
| "type": "A String",<br> |
| "phoneType": "A String",<br> |
| "value": "A String",<br> |
| "primary": True or False,<br> |
| },<br> |
| ],<br> |
| "addresses": [ # Address information of the contact.<br> |
| {<br> |
| "sourceIsStructured": True or False,<br> |
| "poBox": "A String",<br> |
| "countryCode": "A String",<br> |
| "locality": "A String",<br> |
| "country": "A String",<br> |
| "region": "A String",<br> |
| "customType": "A String",<br> |
| "formatted": "A String",<br> |
| "primary": True or False,<br> |
| "streetAddress": "A String",<br> |
| "postalCode": "A String",<br> |
| "extendedAddress": "A String",<br> |
| "type": "A String",<br> |
| },<br> |
| ],<br> |
| "lastUpdateTime": "A String", # Last updated time of the entry.contact (in microseconds).<br> |
| "maidenName": "A String", # Maiden name of the contact. Maiden can not be repeated.<br> |
| "locations": [ # Locations the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "userDefinedProperties": [ # UserDefined fields of the contact profile.<br> |
| {<br> |
| "value": "A String",<br> |
| "key": "A String",<br> |
| },<br> |
| ],<br> |
| "hobbies": [<br> |
| "A String",<br> |
| ],<br> |
| "id": "A String", # Contact identifier.<br> |
| "occupation": "A String", # Occupation of the contact. Occupation can not be repeated.<br> |
| "calendarLinks": [ # Calendar information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "primary": True or False,<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "relations": [ # Relationship with the entry.contact.<br> |
| {<br> |
| "type": "A String",<br> |
| "customeType": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "languages": [ # Languages of the contact.<br> |
| {<br> |
| "code": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "ims": [ # Instant messanger related information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "protocol": "A String",<br> |
| "customProtocol": "A String",<br> |
| "primary": True or False,<br> |
| "im": "A String",<br> |
| "type": "A String",<br> |
| },<br> |
| ],<br> |
| "events": [ # Events information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "startTime": "",<br> |
| "endTime": "",<br> |
| },<br> |
| ],<br> |
| "externalIds": [ # Information regarding External Ids of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "id": "A String",<br> |
| },<br> |
| ],<br> |
| "deleted": True or False, # If this contact has been deleted (boolean field).<br> |
| "extendedProperties": [ # Extended properties of the contact. Available only in full projection.<br> |
| {<br> |
| "name": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "birthday": { # Birthday of the contact in YYYY-MM-DD format.<br> |
| "year": 42,<br> |
| "day": 42,<br> |
| "value": "A String",<br> |
| "month": 42,<br> |
| },<br> |
| "groups": [ # Group information of the contact.<br> |
| {<br> |
| "deleted": True or False,<br> |
| "groupId": "A String",<br> |
| },<br> |
| ],<br> |
| "others": [ # Other proeprties of a contact (equivalent to jot in gdata).<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "shortName": "A String", # Short name of the contact. Short name can not be repeated.<br> |
| "emails": [ # Email information of the contact.<br> |
| {<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "primary": True or False,<br> |
| "address": "A String",<br> |
| },<br> |
| ],<br> |
| "organizations": [ # Organizations information of the contact.<br> |
| {<br> |
| "domain": "A String",<br> |
| "description": "A String",<br> |
| "title": "A String",<br> |
| "symbol": "A String",<br> |
| "customType": "A String",<br> |
| "primary": True or False,<br> |
| "location": "A String",<br> |
| "department": "A String",<br> |
| "type": "A String",<br> |
| "name": "A String",<br> |
| },<br> |
| ],<br> |
| "kind": "contacts#contact", # Type of the resource. This is always "contacts#contact".<br> |
| "photoId": "A String", # Contacts's photoId.<br> |
| "name": { # Detailed name information of the contact.<br> |
| "nameSuffix": "A String",<br> |
| "familyName": "A String",<br> |
| "additionalName": "A String",<br> |
| "namePrefix": "A String",<br> |
| "fullName": "A String",<br> |
| "givenName": "A String",<br> |
| },<br> |
| "gender": "A String", # Standard gender of the contact. It must be mapped to one of the gender specified in GenderTypes map.<br> |
| "outlookInformation": {<br> |
| },<br> |
| "urls": [ # Contact's various websites information.<br> |
| {<br> |
| "href": "A String",<br> |
| "customType": "A String",<br> |
| "type": "A String",<br> |
| "primary": True or False,<br> |
| },<br> |
| ],<br> |
| "selfLink": "A String", # URL pointing to this contact. Used to retrieve, update, or delete this contact.<br> |
| "initials": "A String", # Initials of the contact. Initials can not be repeated and hence only one value is possible for it.<br> |
| }</tt></dd></dl> |
| |
| <hr> |
| Data descriptors defined here:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| </dl> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| </td></tr></table> |
| </body></html> |