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