Joe Gregorio | 2401bd6 | 2011-12-15 09:18:49 -0500 | [diff] [blame^] | 1 | |
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| 3 | <html><head><title>Python: class Resource</title> |
| 4 | </head><body bgcolor="#f0f0f8"> |
| 5 | <p> |
| 6 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 7 | <tr bgcolor="#ffc8d8"> |
| 8 | <td colspan=3 valign=bottom> <br> |
| 9 | <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> |
| 10 | |
| 11 | <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| 12 | <td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr> |
| 13 | <tr><td> </td> |
| 14 | <td width="100%">Methods defined here:<br> |
| 15 | <dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl> |
| 16 | |
| 17 | <dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Delete a contact entry.<br> |
| 18 | <br> |
| 19 | Args:<br> |
| 20 | userId: string, The user whose contacts are being deleted. (required)<br> |
| 21 | contactId: string, The id of the contact being deleted. (required)</tt></dd></dl> |
| 22 | |
| 23 | <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> |
| 24 | <br> |
| 25 | Args:<br> |
| 26 | userId: string, The user whose contacts's extended property is being deleted. (required)<br> |
| 27 | contactId: string, Contact whose extended property is being deleted. (required)<br> |
| 28 | key: string, Extended property key whose value is being deleted. (required)</tt></dd></dl> |
| 29 | |
| 30 | <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> |
| 31 | <br> |
| 32 | Args:<br> |
| 33 | userId: string, The user whose contacts's user defined property is being deleted. (required)<br> |
| 34 | contactId: string, Contacts whose user defined property is being deleted. (required)<br> |
| 35 | key: string, User defined property key whose value is being deleted. (required)</tt></dd></dl> |
| 36 | |
| 37 | <dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets contact details for given contactId belonging to My Contacts.<br> |
| 38 | <br> |
| 39 | Args:<br> |
| 40 | projection: string, Additional information to return.<br> |
| 41 | Allowed values<br> |
| 42 | FULL - Returns the extended properties of a contact.<br> |
| 43 | THIN - Returns properties of a contact.<br> |
| 44 | userId: string, The user whose contacts are being requested. (required)<br> |
| 45 | contactId: string, The id of the contact being requested. (required)<br> |
| 46 | <br> |
| 47 | Returns:<br> |
| 48 | An object of the form<br> |
| 49 | <br> |
| 50 | {<br> |
| 51 | "phoneNumbers": [ # Phone information of the contact.<br> |
| 52 | {<br> |
| 53 | "type": "A String",<br> |
| 54 | "phoneType": "A String",<br> |
| 55 | "value": "A String",<br> |
| 56 | "primary": True or False,<br> |
| 57 | },<br> |
| 58 | ],<br> |
| 59 | "addresses": [ # Address information of the contact.<br> |
| 60 | {<br> |
| 61 | "sourceIsStructured": True or False,<br> |
| 62 | "poBox": "A String",<br> |
| 63 | "countryCode": "A String",<br> |
| 64 | "locality": "A String",<br> |
| 65 | "country": "A String",<br> |
| 66 | "region": "A String",<br> |
| 67 | "customType": "A String",<br> |
| 68 | "formatted": "A String",<br> |
| 69 | "primary": True or False,<br> |
| 70 | "streetAddress": "A String",<br> |
| 71 | "postalCode": "A String",<br> |
| 72 | "extendedAddress": "A String",<br> |
| 73 | "type": "A String",<br> |
| 74 | },<br> |
| 75 | ],<br> |
| 76 | "lastUpdateTime": "A String", # Last updated time of the entry.contact (in microseconds).<br> |
| 77 | "maidenName": "A String", # Maiden name of the contact. Maiden can not be repeated.<br> |
| 78 | "locations": [ # Locations the contact.<br> |
| 79 | {<br> |
| 80 | "customType": "A String",<br> |
| 81 | "type": "A String",<br> |
| 82 | "value": "A String",<br> |
| 83 | },<br> |
| 84 | ],<br> |
| 85 | "userDefinedProperties": [ # UserDefined fields of the contact profile.<br> |
| 86 | {<br> |
| 87 | "value": "A String",<br> |
| 88 | "key": "A String",<br> |
| 89 | },<br> |
| 90 | ],<br> |
| 91 | "hobbies": [<br> |
| 92 | "A String",<br> |
| 93 | ],<br> |
| 94 | "id": "A String", # Contact identifier.<br> |
| 95 | "occupation": "A String", # Occupation of the contact. Occupation can not be repeated.<br> |
| 96 | "calendarLinks": [ # Calendar information of the contact.<br> |
| 97 | {<br> |
| 98 | "customType": "A String",<br> |
| 99 | "type": "A String",<br> |
| 100 | "primary": True or False,<br> |
| 101 | "value": "A String",<br> |
| 102 | },<br> |
| 103 | ],<br> |
| 104 | "relations": [ # Relationship with the entry.contact.<br> |
| 105 | {<br> |
| 106 | "type": "A String",<br> |
| 107 | "customeType": "A String",<br> |
| 108 | "value": "A String",<br> |
| 109 | },<br> |
| 110 | ],<br> |
| 111 | "languages": [ # Languages of the contact.<br> |
| 112 | {<br> |
| 113 | "code": "A String",<br> |
| 114 | "value": "A String",<br> |
| 115 | },<br> |
| 116 | ],<br> |
| 117 | "ims": [ # Instant messanger related information of the contact.<br> |
| 118 | {<br> |
| 119 | "customType": "A String",<br> |
| 120 | "protocol": "A String",<br> |
| 121 | "customProtocol": "A String",<br> |
| 122 | "primary": True or False,<br> |
| 123 | "im": "A String",<br> |
| 124 | "type": "A String",<br> |
| 125 | },<br> |
| 126 | ],<br> |
| 127 | "events": [ # Events information of the contact.<br> |
| 128 | {<br> |
| 129 | "customType": "A String",<br> |
| 130 | "type": "A String",<br> |
| 131 | "startTime": "",<br> |
| 132 | "endTime": "",<br> |
| 133 | },<br> |
| 134 | ],<br> |
| 135 | "externalIds": [ # Information regarding External Ids of the contact.<br> |
| 136 | {<br> |
| 137 | "customType": "A String",<br> |
| 138 | "type": "A String",<br> |
| 139 | "id": "A String",<br> |
| 140 | },<br> |
| 141 | ],<br> |
| 142 | "deleted": True or False, # If this contact has been deleted (boolean field).<br> |
| 143 | "extendedProperties": [ # Extended properties of the contact. Available only in full projection.<br> |
| 144 | {<br> |
| 145 | "name": "A String",<br> |
| 146 | "value": "A String",<br> |
| 147 | },<br> |
| 148 | ],<br> |
| 149 | "birthday": { # Birthday of the contact in YYYY-MM-DD format.<br> |
| 150 | "year": 42,<br> |
| 151 | "day": 42,<br> |
| 152 | "value": "A String",<br> |
| 153 | "month": 42,<br> |
| 154 | },<br> |
| 155 | "groups": [ # Group information of the contact.<br> |
| 156 | {<br> |
| 157 | "deleted": True or False,<br> |
| 158 | "groupId": "A String",<br> |
| 159 | },<br> |
| 160 | ],<br> |
| 161 | "others": [ # Other proeprties of a contact (equivalent to jot in gdata).<br> |
| 162 | {<br> |
| 163 | "customType": "A String",<br> |
| 164 | "type": "A String",<br> |
| 165 | "value": "A String",<br> |
| 166 | },<br> |
| 167 | ],<br> |
| 168 | "shortName": "A String", # Short name of the contact. Short name can not be repeated.<br> |
| 169 | "emails": [ # Email information of the contact.<br> |
| 170 | {<br> |
| 171 | "customType": "A String",<br> |
| 172 | "type": "A String",<br> |
| 173 | "primary": True or False,<br> |
| 174 | "address": "A String",<br> |
| 175 | },<br> |
| 176 | ],<br> |
| 177 | "organizations": [ # Organizations information of the contact.<br> |
| 178 | {<br> |
| 179 | "domain": "A String",<br> |
| 180 | "description": "A String",<br> |
| 181 | "title": "A String",<br> |
| 182 | "symbol": "A String",<br> |
| 183 | "customType": "A String",<br> |
| 184 | "primary": True or False,<br> |
| 185 | "location": "A String",<br> |
| 186 | "department": "A String",<br> |
| 187 | "type": "A String",<br> |
| 188 | "name": "A String",<br> |
| 189 | },<br> |
| 190 | ],<br> |
| 191 | "kind": "contacts#contact", # Type of the resource. This is always "contacts#contact".<br> |
| 192 | "photoId": "A String", # Contacts's photoId.<br> |
| 193 | "name": { # Detailed name information of the contact.<br> |
| 194 | "nameSuffix": "A String",<br> |
| 195 | "familyName": "A String",<br> |
| 196 | "additionalName": "A String",<br> |
| 197 | "namePrefix": "A String",<br> |
| 198 | "fullName": "A String",<br> |
| 199 | "givenName": "A String",<br> |
| 200 | },<br> |
| 201 | "gender": "A String", # Standard gender of the contact. It must be mapped to one of the gender specified in GenderTypes map.<br> |
| 202 | "outlookInformation": {<br> |
| 203 | },<br> |
| 204 | "urls": [ # Contact's various websites information.<br> |
| 205 | {<br> |
| 206 | "href": "A String",<br> |
| 207 | "customType": "A String",<br> |
| 208 | "type": "A String",<br> |
| 209 | "primary": True or False,<br> |
| 210 | },<br> |
| 211 | ],<br> |
| 212 | "selfLink": "A String", # URL pointing to this contact. Used to retrieve, update, or delete this contact.<br> |
| 213 | "initials": "A String", # Initials of the contact. Initials can not be repeated and hence only one value is possible for it.<br> |
| 214 | }</tt></dd></dl> |
| 215 | |
| 216 | <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> |
| 217 | <br> |
| 218 | Args:<br> |
| 219 | userId: string, The user whose contacts's extended property is being requested. (required)<br> |
| 220 | contactId: string, Contacts whose extended property is being requested. (required)<br> |
| 221 | key: string, Extended property key whose value is being requested. (required)<br> |
| 222 | <br> |
| 223 | Returns:<br> |
| 224 | An object of the form<br> |
| 225 | <br> |
| 226 | {<br> |
| 227 | "value": "A String",<br> |
| 228 | }</tt></dd></dl> |
| 229 | |
| 230 | <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> |
| 231 | <br> |
| 232 | Args:<br> |
| 233 | userId: string, The user whose contacts's user defined property is being requested. (required)<br> |
| 234 | contactId: string, Contacts whose user defined property is being requested. (required)<br> |
| 235 | key: string, User defined property key whose value is being requested. (required)<br> |
| 236 | <br> |
| 237 | Returns:<br> |
| 238 | An object of the form<br> |
| 239 | <br> |
| 240 | {<br> |
| 241 | "value": "A String",<br> |
| 242 | }</tt></dd></dl> |
| 243 | |
| 244 | <dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Insert a contact entry to My Contacts.<br> |
| 245 | <br> |
| 246 | Args:<br> |
| 247 | body: object, The request body. (required)<br> |
| 248 | The object takes the form of:<br> |
| 249 | <br> |
| 250 | {<br> |
| 251 | "phoneNumbers": [ # Phone information of the contact.<br> |
| 252 | {<br> |
| 253 | "type": "A String",<br> |
| 254 | "phoneType": "A String",<br> |
| 255 | "value": "A String",<br> |
| 256 | "primary": True or False,<br> |
| 257 | },<br> |
| 258 | ],<br> |
| 259 | "addresses": [ # Address information of the contact.<br> |
| 260 | {<br> |
| 261 | "sourceIsStructured": True or False,<br> |
| 262 | "poBox": "A String",<br> |
| 263 | "countryCode": "A String",<br> |
| 264 | "locality": "A String",<br> |
| 265 | "country": "A String",<br> |
| 266 | "region": "A String",<br> |
| 267 | "customType": "A String",<br> |
| 268 | "formatted": "A String",<br> |
| 269 | "primary": True or False,<br> |
| 270 | "streetAddress": "A String",<br> |
| 271 | "postalCode": "A String",<br> |
| 272 | "extendedAddress": "A String",<br> |
| 273 | "type": "A String",<br> |
| 274 | },<br> |
| 275 | ],<br> |
| 276 | "lastUpdateTime": "A String", # Last updated time of the entry.contact (in microseconds).<br> |
| 277 | "maidenName": "A String", # Maiden name of the contact. Maiden can not be repeated.<br> |
| 278 | "locations": [ # Locations the contact.<br> |
| 279 | {<br> |
| 280 | "customType": "A String",<br> |
| 281 | "type": "A String",<br> |
| 282 | "value": "A String",<br> |
| 283 | },<br> |
| 284 | ],<br> |
| 285 | "userDefinedProperties": [ # UserDefined fields of the contact profile.<br> |
| 286 | {<br> |
| 287 | "value": "A String",<br> |
| 288 | "key": "A String",<br> |
| 289 | },<br> |
| 290 | ],<br> |
| 291 | "hobbies": [<br> |
| 292 | "A String",<br> |
| 293 | ],<br> |
| 294 | "id": "A String", # Contact identifier.<br> |
| 295 | "occupation": "A String", # Occupation of the contact. Occupation can not be repeated.<br> |
| 296 | "calendarLinks": [ # Calendar information of the contact.<br> |
| 297 | {<br> |
| 298 | "customType": "A String",<br> |
| 299 | "type": "A String",<br> |
| 300 | "primary": True or False,<br> |
| 301 | "value": "A String",<br> |
| 302 | },<br> |
| 303 | ],<br> |
| 304 | "relations": [ # Relationship with the entry.contact.<br> |
| 305 | {<br> |
| 306 | "type": "A String",<br> |
| 307 | "customeType": "A String",<br> |
| 308 | "value": "A String",<br> |
| 309 | },<br> |
| 310 | ],<br> |
| 311 | "languages": [ # Languages of the contact.<br> |
| 312 | {<br> |
| 313 | "code": "A String",<br> |
| 314 | "value": "A String",<br> |
| 315 | },<br> |
| 316 | ],<br> |
| 317 | "ims": [ # Instant messanger related information of the contact.<br> |
| 318 | {<br> |
| 319 | "customType": "A String",<br> |
| 320 | "protocol": "A String",<br> |
| 321 | "customProtocol": "A String",<br> |
| 322 | "primary": True or False,<br> |
| 323 | "im": "A String",<br> |
| 324 | "type": "A String",<br> |
| 325 | },<br> |
| 326 | ],<br> |
| 327 | "events": [ # Events information of the contact.<br> |
| 328 | {<br> |
| 329 | "customType": "A String",<br> |
| 330 | "type": "A String",<br> |
| 331 | "startTime": "",<br> |
| 332 | "endTime": "",<br> |
| 333 | },<br> |
| 334 | ],<br> |
| 335 | "externalIds": [ # Information regarding External Ids of the contact.<br> |
| 336 | {<br> |
| 337 | "customType": "A String",<br> |
| 338 | "type": "A String",<br> |
| 339 | "id": "A String",<br> |
| 340 | },<br> |
| 341 | ],<br> |
| 342 | "deleted": True or False, # If this contact has been deleted (boolean field).<br> |
| 343 | "extendedProperties": [ # Extended properties of the contact. Available only in full projection.<br> |
| 344 | {<br> |
| 345 | "name": "A String",<br> |
| 346 | "value": "A String",<br> |
| 347 | },<br> |
| 348 | ],<br> |
| 349 | "birthday": { # Birthday of the contact in YYYY-MM-DD format.<br> |
| 350 | "year": 42,<br> |
| 351 | "day": 42,<br> |
| 352 | "value": "A String",<br> |
| 353 | "month": 42,<br> |
| 354 | },<br> |
| 355 | "groups": [ # Group information of the contact.<br> |
| 356 | {<br> |
| 357 | "deleted": True or False,<br> |
| 358 | "groupId": "A String",<br> |
| 359 | },<br> |
| 360 | ],<br> |
| 361 | "others": [ # Other proeprties of a contact (equivalent to jot in gdata).<br> |
| 362 | {<br> |
| 363 | "customType": "A String",<br> |
| 364 | "type": "A String",<br> |
| 365 | "value": "A String",<br> |
| 366 | },<br> |
| 367 | ],<br> |
| 368 | "shortName": "A String", # Short name of the contact. Short name can not be repeated.<br> |
| 369 | "emails": [ # Email information of the contact.<br> |
| 370 | {<br> |
| 371 | "customType": "A String",<br> |
| 372 | "type": "A String",<br> |
| 373 | "primary": True or False,<br> |
| 374 | "address": "A String",<br> |
| 375 | },<br> |
| 376 | ],<br> |
| 377 | "organizations": [ # Organizations information of the contact.<br> |
| 378 | {<br> |
| 379 | "domain": "A String",<br> |
| 380 | "description": "A String",<br> |
| 381 | "title": "A String",<br> |
| 382 | "symbol": "A String",<br> |
| 383 | "customType": "A String",<br> |
| 384 | "primary": True or False,<br> |
| 385 | "location": "A String",<br> |
| 386 | "department": "A String",<br> |
| 387 | "type": "A String",<br> |
| 388 | "name": "A String",<br> |
| 389 | },<br> |
| 390 | ],<br> |
| 391 | "kind": "contacts#contact", # Type of the resource. This is always "contacts#contact".<br> |
| 392 | "photoId": "A String", # Contacts's photoId.<br> |
| 393 | "name": { # Detailed name information of the contact.<br> |
| 394 | "nameSuffix": "A String",<br> |
| 395 | "familyName": "A String",<br> |
| 396 | "additionalName": "A String",<br> |
| 397 | "namePrefix": "A String",<br> |
| 398 | "fullName": "A String",<br> |
| 399 | "givenName": "A String",<br> |
| 400 | },<br> |
| 401 | "gender": "A String", # Standard gender of the contact. It must be mapped to one of the gender specified in GenderTypes map.<br> |
| 402 | "outlookInformation": {<br> |
| 403 | },<br> |
| 404 | "urls": [ # Contact's various websites information.<br> |
| 405 | {<br> |
| 406 | "href": "A String",<br> |
| 407 | "customType": "A String",<br> |
| 408 | "type": "A String",<br> |
| 409 | "primary": True or False,<br> |
| 410 | },<br> |
| 411 | ],<br> |
| 412 | "selfLink": "A String", # URL pointing to this contact. Used to retrieve, update, or delete this contact.<br> |
| 413 | "initials": "A String", # Initials of the contact. Initials can not be repeated and hence only one value is possible for it.<br> |
| 414 | }<br> |
| 415 | <br> |
| 416 | userId: string, The user whose contacts are being requested. (required)<br> |
| 417 | <br> |
| 418 | Returns:<br> |
| 419 | An object of the form<br> |
| 420 | <br> |
| 421 | {<br> |
| 422 | "phoneNumbers": [ # Phone information of the contact.<br> |
| 423 | {<br> |
| 424 | "type": "A String",<br> |
| 425 | "phoneType": "A String",<br> |
| 426 | "value": "A String",<br> |
| 427 | "primary": True or False,<br> |
| 428 | },<br> |
| 429 | ],<br> |
| 430 | "addresses": [ # Address information of the contact.<br> |
| 431 | {<br> |
| 432 | "sourceIsStructured": True or False,<br> |
| 433 | "poBox": "A String",<br> |
| 434 | "countryCode": "A String",<br> |
| 435 | "locality": "A String",<br> |
| 436 | "country": "A String",<br> |
| 437 | "region": "A String",<br> |
| 438 | "customType": "A String",<br> |
| 439 | "formatted": "A String",<br> |
| 440 | "primary": True or False,<br> |
| 441 | "streetAddress": "A String",<br> |
| 442 | "postalCode": "A String",<br> |
| 443 | "extendedAddress": "A String",<br> |
| 444 | "type": "A String",<br> |
| 445 | },<br> |
| 446 | ],<br> |
| 447 | "lastUpdateTime": "A String", # Last updated time of the entry.contact (in microseconds).<br> |
| 448 | "maidenName": "A String", # Maiden name of the contact. Maiden can not be repeated.<br> |
| 449 | "locations": [ # Locations the contact.<br> |
| 450 | {<br> |
| 451 | "customType": "A String",<br> |
| 452 | "type": "A String",<br> |
| 453 | "value": "A String",<br> |
| 454 | },<br> |
| 455 | ],<br> |
| 456 | "userDefinedProperties": [ # UserDefined fields of the contact profile.<br> |
| 457 | {<br> |
| 458 | "value": "A String",<br> |
| 459 | "key": "A String",<br> |
| 460 | },<br> |
| 461 | ],<br> |
| 462 | "hobbies": [<br> |
| 463 | "A String",<br> |
| 464 | ],<br> |
| 465 | "id": "A String", # Contact identifier.<br> |
| 466 | "occupation": "A String", # Occupation of the contact. Occupation can not be repeated.<br> |
| 467 | "calendarLinks": [ # Calendar information of the contact.<br> |
| 468 | {<br> |
| 469 | "customType": "A String",<br> |
| 470 | "type": "A String",<br> |
| 471 | "primary": True or False,<br> |
| 472 | "value": "A String",<br> |
| 473 | },<br> |
| 474 | ],<br> |
| 475 | "relations": [ # Relationship with the entry.contact.<br> |
| 476 | {<br> |
| 477 | "type": "A String",<br> |
| 478 | "customeType": "A String",<br> |
| 479 | "value": "A String",<br> |
| 480 | },<br> |
| 481 | ],<br> |
| 482 | "languages": [ # Languages of the contact.<br> |
| 483 | {<br> |
| 484 | "code": "A String",<br> |
| 485 | "value": "A String",<br> |
| 486 | },<br> |
| 487 | ],<br> |
| 488 | "ims": [ # Instant messanger related information of the contact.<br> |
| 489 | {<br> |
| 490 | "customType": "A String",<br> |
| 491 | "protocol": "A String",<br> |
| 492 | "customProtocol": "A String",<br> |
| 493 | "primary": True or False,<br> |
| 494 | "im": "A String",<br> |
| 495 | "type": "A String",<br> |
| 496 | },<br> |
| 497 | ],<br> |
| 498 | "events": [ # Events information of the contact.<br> |
| 499 | {<br> |
| 500 | "customType": "A String",<br> |
| 501 | "type": "A String",<br> |
| 502 | "startTime": "",<br> |
| 503 | "endTime": "",<br> |
| 504 | },<br> |
| 505 | ],<br> |
| 506 | "externalIds": [ # Information regarding External Ids of the contact.<br> |
| 507 | {<br> |
| 508 | "customType": "A String",<br> |
| 509 | "type": "A String",<br> |
| 510 | "id": "A String",<br> |
| 511 | },<br> |
| 512 | ],<br> |
| 513 | "deleted": True or False, # If this contact has been deleted (boolean field).<br> |
| 514 | "extendedProperties": [ # Extended properties of the contact. Available only in full projection.<br> |
| 515 | {<br> |
| 516 | "name": "A String",<br> |
| 517 | "value": "A String",<br> |
| 518 | },<br> |
| 519 | ],<br> |
| 520 | "birthday": { # Birthday of the contact in YYYY-MM-DD format.<br> |
| 521 | "year": 42,<br> |
| 522 | "day": 42,<br> |
| 523 | "value": "A String",<br> |
| 524 | "month": 42,<br> |
| 525 | },<br> |
| 526 | "groups": [ # Group information of the contact.<br> |
| 527 | {<br> |
| 528 | "deleted": True or False,<br> |
| 529 | "groupId": "A String",<br> |
| 530 | },<br> |
| 531 | ],<br> |
| 532 | "others": [ # Other proeprties of a contact (equivalent to jot in gdata).<br> |
| 533 | {<br> |
| 534 | "customType": "A String",<br> |
| 535 | "type": "A String",<br> |
| 536 | "value": "A String",<br> |
| 537 | },<br> |
| 538 | ],<br> |
| 539 | "shortName": "A String", # Short name of the contact. Short name can not be repeated.<br> |
| 540 | "emails": [ # Email information of the contact.<br> |
| 541 | {<br> |
| 542 | "customType": "A String",<br> |
| 543 | "type": "A String",<br> |
| 544 | "primary": True or False,<br> |
| 545 | "address": "A String",<br> |
| 546 | },<br> |
| 547 | ],<br> |
| 548 | "organizations": [ # Organizations information of the contact.<br> |
| 549 | {<br> |
| 550 | "domain": "A String",<br> |
| 551 | "description": "A String",<br> |
| 552 | "title": "A String",<br> |
| 553 | "symbol": "A String",<br> |
| 554 | "customType": "A String",<br> |
| 555 | "primary": True or False,<br> |
| 556 | "location": "A String",<br> |
| 557 | "department": "A String",<br> |
| 558 | "type": "A String",<br> |
| 559 | "name": "A String",<br> |
| 560 | },<br> |
| 561 | ],<br> |
| 562 | "kind": "contacts#contact", # Type of the resource. This is always "contacts#contact".<br> |
| 563 | "photoId": "A String", # Contacts's photoId.<br> |
| 564 | "name": { # Detailed name information of the contact.<br> |
| 565 | "nameSuffix": "A String",<br> |
| 566 | "familyName": "A String",<br> |
| 567 | "additionalName": "A String",<br> |
| 568 | "namePrefix": "A String",<br> |
| 569 | "fullName": "A String",<br> |
| 570 | "givenName": "A String",<br> |
| 571 | },<br> |
| 572 | "gender": "A String", # Standard gender of the contact. It must be mapped to one of the gender specified in GenderTypes map.<br> |
| 573 | "outlookInformation": {<br> |
| 574 | },<br> |
| 575 | "urls": [ # Contact's various websites information.<br> |
| 576 | {<br> |
| 577 | "href": "A String",<br> |
| 578 | "customType": "A String",<br> |
| 579 | "type": "A String",<br> |
| 580 | "primary": True or False,<br> |
| 581 | },<br> |
| 582 | ],<br> |
| 583 | "selfLink": "A String", # URL pointing to this contact. Used to retrieve, update, or delete this contact.<br> |
| 584 | "initials": "A String", # Initials of the contact. Initials can not be repeated and hence only one value is possible for it.<br> |
| 585 | }</tt></dd></dl> |
| 586 | |
| 587 | <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves list of contacts belonging to My Contacts for the provided user.<br> |
| 588 | <br> |
| 589 | Args:<br> |
| 590 | orderBy: string, Sorting criterion<br> |
| 591 | Allowed values<br> |
| 592 | LAST_MODIFIED - Order by last modified contact<br> |
| 593 | group: string, Limit the listing to the specified group<br> |
| 594 | projection: string, Additional information to return.<br> |
| 595 | Allowed values<br> |
| 596 | FULL - Returns properties of a contact including extended properties.<br> |
| 597 | THIN - Returns properties of a contact.<br> |
| 598 | pageToken: string, A continuation token that allows pagination.<br> |
| 599 | updatedMin: integer, The lower bound on entry update dates (seconds from epcoh).<br> |
| 600 | 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> |
| 601 | queryString: string, A parameter<br> |
| 602 | maxResults: integer, Maximum number of contact entries to return.<br> |
| 603 | q: string, A parameter<br> |
| 604 | showDeleted: boolean, Flag to include deleted contacts<br> |
| 605 | sortOrder: string, Sorting order of the result<br> |
| 606 | Allowed values<br> |
| 607 | ascending - Use ascending sort order<br> |
| 608 | descending - Use decending sort order<br> |
| 609 | alt: string, Specifies an alternative representation type.<br> |
| 610 | Allowed values<br> |
| 611 | atom - Use Atom XML format<br> |
| 612 | json - Use JSON format<br> |
| 613 | userId: string, The user whose contacts are being listed. (required)<br> |
| 614 | <br> |
| 615 | Returns:<br> |
| 616 | An object of the form<br> |
| 617 | <br> |
| 618 | {<br> |
| 619 | "nextPageToken": "A String",<br> |
| 620 | "items": [<br> |
| 621 | {<br> |
| 622 | "phoneNumbers": [ # Phone information of the contact.<br> |
| 623 | {<br> |
| 624 | "type": "A String",<br> |
| 625 | "phoneType": "A String",<br> |
| 626 | "value": "A String",<br> |
| 627 | "primary": True or False,<br> |
| 628 | },<br> |
| 629 | ],<br> |
| 630 | "addresses": [ # Address information of the contact.<br> |
| 631 | {<br> |
| 632 | "sourceIsStructured": True or False,<br> |
| 633 | "poBox": "A String",<br> |
| 634 | "countryCode": "A String",<br> |
| 635 | "locality": "A String",<br> |
| 636 | "country": "A String",<br> |
| 637 | "region": "A String",<br> |
| 638 | "customType": "A String",<br> |
| 639 | "formatted": "A String",<br> |
| 640 | "primary": True or False,<br> |
| 641 | "streetAddress": "A String",<br> |
| 642 | "postalCode": "A String",<br> |
| 643 | "extendedAddress": "A String",<br> |
| 644 | "type": "A String",<br> |
| 645 | },<br> |
| 646 | ],<br> |
| 647 | "lastUpdateTime": "A String", # Last updated time of the entry.contact (in microseconds).<br> |
| 648 | "maidenName": "A String", # Maiden name of the contact. Maiden can not be repeated.<br> |
| 649 | "locations": [ # Locations the contact.<br> |
| 650 | {<br> |
| 651 | "customType": "A String",<br> |
| 652 | "type": "A String",<br> |
| 653 | "value": "A String",<br> |
| 654 | },<br> |
| 655 | ],<br> |
| 656 | "userDefinedProperties": [ # UserDefined fields of the contact profile.<br> |
| 657 | {<br> |
| 658 | "value": "A String",<br> |
| 659 | "key": "A String",<br> |
| 660 | },<br> |
| 661 | ],<br> |
| 662 | "hobbies": [<br> |
| 663 | "A String",<br> |
| 664 | ],<br> |
| 665 | "id": "A String", # Contact identifier.<br> |
| 666 | "occupation": "A String", # Occupation of the contact. Occupation can not be repeated.<br> |
| 667 | "calendarLinks": [ # Calendar information of the contact.<br> |
| 668 | {<br> |
| 669 | "customType": "A String",<br> |
| 670 | "type": "A String",<br> |
| 671 | "primary": True or False,<br> |
| 672 | "value": "A String",<br> |
| 673 | },<br> |
| 674 | ],<br> |
| 675 | "relations": [ # Relationship with the entry.contact.<br> |
| 676 | {<br> |
| 677 | "type": "A String",<br> |
| 678 | "customeType": "A String",<br> |
| 679 | "value": "A String",<br> |
| 680 | },<br> |
| 681 | ],<br> |
| 682 | "languages": [ # Languages of the contact.<br> |
| 683 | {<br> |
| 684 | "code": "A String",<br> |
| 685 | "value": "A String",<br> |
| 686 | },<br> |
| 687 | ],<br> |
| 688 | "ims": [ # Instant messanger related information of the contact.<br> |
| 689 | {<br> |
| 690 | "customType": "A String",<br> |
| 691 | "protocol": "A String",<br> |
| 692 | "customProtocol": "A String",<br> |
| 693 | "primary": True or False,<br> |
| 694 | "im": "A String",<br> |
| 695 | "type": "A String",<br> |
| 696 | },<br> |
| 697 | ],<br> |
| 698 | "events": [ # Events information of the contact.<br> |
| 699 | {<br> |
| 700 | "customType": "A String",<br> |
| 701 | "type": "A String",<br> |
| 702 | "startTime": "",<br> |
| 703 | "endTime": "",<br> |
| 704 | },<br> |
| 705 | ],<br> |
| 706 | "externalIds": [ # Information regarding External Ids of the contact.<br> |
| 707 | {<br> |
| 708 | "customType": "A String",<br> |
| 709 | "type": "A String",<br> |
| 710 | "id": "A String",<br> |
| 711 | },<br> |
| 712 | ],<br> |
| 713 | "deleted": True or False, # If this contact has been deleted (boolean field).<br> |
| 714 | "extendedProperties": [ # Extended properties of the contact. Available only in full projection.<br> |
| 715 | {<br> |
| 716 | "name": "A String",<br> |
| 717 | "value": "A String",<br> |
| 718 | },<br> |
| 719 | ],<br> |
| 720 | "birthday": { # Birthday of the contact in YYYY-MM-DD format.<br> |
| 721 | "year": 42,<br> |
| 722 | "day": 42,<br> |
| 723 | "value": "A String",<br> |
| 724 | "month": 42,<br> |
| 725 | },<br> |
| 726 | "groups": [ # Group information of the contact.<br> |
| 727 | {<br> |
| 728 | "deleted": True or False,<br> |
| 729 | "groupId": "A String",<br> |
| 730 | },<br> |
| 731 | ],<br> |
| 732 | "others": [ # Other proeprties of a contact (equivalent to jot in gdata).<br> |
| 733 | {<br> |
| 734 | "customType": "A String",<br> |
| 735 | "type": "A String",<br> |
| 736 | "value": "A String",<br> |
| 737 | },<br> |
| 738 | ],<br> |
| 739 | "shortName": "A String", # Short name of the contact. Short name can not be repeated.<br> |
| 740 | "emails": [ # Email information of the contact.<br> |
| 741 | {<br> |
| 742 | "customType": "A String",<br> |
| 743 | "type": "A String",<br> |
| 744 | "primary": True or False,<br> |
| 745 | "address": "A String",<br> |
| 746 | },<br> |
| 747 | ],<br> |
| 748 | "organizations": [ # Organizations information of the contact.<br> |
| 749 | {<br> |
| 750 | "domain": "A String",<br> |
| 751 | "description": "A String",<br> |
| 752 | "title": "A String",<br> |
| 753 | "symbol": "A String",<br> |
| 754 | "customType": "A String",<br> |
| 755 | "primary": True or False,<br> |
| 756 | "location": "A String",<br> |
| 757 | "department": "A String",<br> |
| 758 | "type": "A String",<br> |
| 759 | "name": "A String",<br> |
| 760 | },<br> |
| 761 | ],<br> |
| 762 | "kind": "contacts#contact", # Type of the resource. This is always "contacts#contact".<br> |
| 763 | "photoId": "A String", # Contacts's photoId.<br> |
| 764 | "name": { # Detailed name information of the contact.<br> |
| 765 | "nameSuffix": "A String",<br> |
| 766 | "familyName": "A String",<br> |
| 767 | "additionalName": "A String",<br> |
| 768 | "namePrefix": "A String",<br> |
| 769 | "fullName": "A String",<br> |
| 770 | "givenName": "A String",<br> |
| 771 | },<br> |
| 772 | "gender": "A String", # Standard gender of the contact. It must be mapped to one of the gender specified in GenderTypes map.<br> |
| 773 | "outlookInformation": {<br> |
| 774 | },<br> |
| 775 | "urls": [ # Contact's various websites information.<br> |
| 776 | {<br> |
| 777 | "href": "A String",<br> |
| 778 | "customType": "A String",<br> |
| 779 | "type": "A String",<br> |
| 780 | "primary": True or False,<br> |
| 781 | },<br> |
| 782 | ],<br> |
| 783 | "selfLink": "A String", # URL pointing to this contact. Used to retrieve, update, or delete this contact.<br> |
| 784 | "initials": "A String", # Initials of the contact. Initials can not be repeated and hence only one value is possible for it.<br> |
| 785 | },<br> |
| 786 | ],<br> |
| 787 | "kind": "contacts#contactList", # Type of the resource. This is always "contacts#contactList".<br> |
| 788 | "prevPageToken": "A String",<br> |
| 789 | }</tt></dd></dl> |
| 790 | |
| 791 | <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> |
| 792 | <br> |
| 793 | Args:<br> |
| 794 | previous_request: The request for the previous page.<br> |
| 795 | previous_response: The response from the request for the previous page.<br> |
| 796 | <br> |
| 797 | Returns:<br> |
| 798 | A request object that you can call 'execute()' on to request the next<br> |
| 799 | page. Returns None if there are no more items in the collection.</tt></dd></dl> |
| 800 | |
| 801 | <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> |
| 802 | <br> |
| 803 | Args:<br> |
| 804 | body: object, The request body. (required)<br> |
| 805 | The object takes the form of:<br> |
| 806 | <br> |
| 807 | {<br> |
| 808 | "phoneNumbers": [ # Phone information of the contact.<br> |
| 809 | {<br> |
| 810 | "type": "A String",<br> |
| 811 | "phoneType": "A String",<br> |
| 812 | "value": "A String",<br> |
| 813 | "primary": True or False,<br> |
| 814 | },<br> |
| 815 | ],<br> |
| 816 | "addresses": [ # Address information of the contact.<br> |
| 817 | {<br> |
| 818 | "sourceIsStructured": True or False,<br> |
| 819 | "poBox": "A String",<br> |
| 820 | "countryCode": "A String",<br> |
| 821 | "locality": "A String",<br> |
| 822 | "country": "A String",<br> |
| 823 | "region": "A String",<br> |
| 824 | "customType": "A String",<br> |
| 825 | "formatted": "A String",<br> |
| 826 | "primary": True or False,<br> |
| 827 | "streetAddress": "A String",<br> |
| 828 | "postalCode": "A String",<br> |
| 829 | "extendedAddress": "A String",<br> |
| 830 | "type": "A String",<br> |
| 831 | },<br> |
| 832 | ],<br> |
| 833 | "lastUpdateTime": "A String", # Last updated time of the entry.contact (in microseconds).<br> |
| 834 | "maidenName": "A String", # Maiden name of the contact. Maiden can not be repeated.<br> |
| 835 | "locations": [ # Locations the contact.<br> |
| 836 | {<br> |
| 837 | "customType": "A String",<br> |
| 838 | "type": "A String",<br> |
| 839 | "value": "A String",<br> |
| 840 | },<br> |
| 841 | ],<br> |
| 842 | "userDefinedProperties": [ # UserDefined fields of the contact profile.<br> |
| 843 | {<br> |
| 844 | "value": "A String",<br> |
| 845 | "key": "A String",<br> |
| 846 | },<br> |
| 847 | ],<br> |
| 848 | "hobbies": [<br> |
| 849 | "A String",<br> |
| 850 | ],<br> |
| 851 | "id": "A String", # Contact identifier.<br> |
| 852 | "occupation": "A String", # Occupation of the contact. Occupation can not be repeated.<br> |
| 853 | "calendarLinks": [ # Calendar information of the contact.<br> |
| 854 | {<br> |
| 855 | "customType": "A String",<br> |
| 856 | "type": "A String",<br> |
| 857 | "primary": True or False,<br> |
| 858 | "value": "A String",<br> |
| 859 | },<br> |
| 860 | ],<br> |
| 861 | "relations": [ # Relationship with the entry.contact.<br> |
| 862 | {<br> |
| 863 | "type": "A String",<br> |
| 864 | "customeType": "A String",<br> |
| 865 | "value": "A String",<br> |
| 866 | },<br> |
| 867 | ],<br> |
| 868 | "languages": [ # Languages of the contact.<br> |
| 869 | {<br> |
| 870 | "code": "A String",<br> |
| 871 | "value": "A String",<br> |
| 872 | },<br> |
| 873 | ],<br> |
| 874 | "ims": [ # Instant messanger related information of the contact.<br> |
| 875 | {<br> |
| 876 | "customType": "A String",<br> |
| 877 | "protocol": "A String",<br> |
| 878 | "customProtocol": "A String",<br> |
| 879 | "primary": True or False,<br> |
| 880 | "im": "A String",<br> |
| 881 | "type": "A String",<br> |
| 882 | },<br> |
| 883 | ],<br> |
| 884 | "events": [ # Events information of the contact.<br> |
| 885 | {<br> |
| 886 | "customType": "A String",<br> |
| 887 | "type": "A String",<br> |
| 888 | "startTime": "",<br> |
| 889 | "endTime": "",<br> |
| 890 | },<br> |
| 891 | ],<br> |
| 892 | "externalIds": [ # Information regarding External Ids of the contact.<br> |
| 893 | {<br> |
| 894 | "customType": "A String",<br> |
| 895 | "type": "A String",<br> |
| 896 | "id": "A String",<br> |
| 897 | },<br> |
| 898 | ],<br> |
| 899 | "deleted": True or False, # If this contact has been deleted (boolean field).<br> |
| 900 | "extendedProperties": [ # Extended properties of the contact. Available only in full projection.<br> |
| 901 | {<br> |
| 902 | "name": "A String",<br> |
| 903 | "value": "A String",<br> |
| 904 | },<br> |
| 905 | ],<br> |
| 906 | "birthday": { # Birthday of the contact in YYYY-MM-DD format.<br> |
| 907 | "year": 42,<br> |
| 908 | "day": 42,<br> |
| 909 | "value": "A String",<br> |
| 910 | "month": 42,<br> |
| 911 | },<br> |
| 912 | "groups": [ # Group information of the contact.<br> |
| 913 | {<br> |
| 914 | "deleted": True or False,<br> |
| 915 | "groupId": "A String",<br> |
| 916 | },<br> |
| 917 | ],<br> |
| 918 | "others": [ # Other proeprties of a contact (equivalent to jot in gdata).<br> |
| 919 | {<br> |
| 920 | "customType": "A String",<br> |
| 921 | "type": "A String",<br> |
| 922 | "value": "A String",<br> |
| 923 | },<br> |
| 924 | ],<br> |
| 925 | "shortName": "A String", # Short name of the contact. Short name can not be repeated.<br> |
| 926 | "emails": [ # Email information of the contact.<br> |
| 927 | {<br> |
| 928 | "customType": "A String",<br> |
| 929 | "type": "A String",<br> |
| 930 | "primary": True or False,<br> |
| 931 | "address": "A String",<br> |
| 932 | },<br> |
| 933 | ],<br> |
| 934 | "organizations": [ # Organizations information of the contact.<br> |
| 935 | {<br> |
| 936 | "domain": "A String",<br> |
| 937 | "description": "A String",<br> |
| 938 | "title": "A String",<br> |
| 939 | "symbol": "A String",<br> |
| 940 | "customType": "A String",<br> |
| 941 | "primary": True or False,<br> |
| 942 | "location": "A String",<br> |
| 943 | "department": "A String",<br> |
| 944 | "type": "A String",<br> |
| 945 | "name": "A String",<br> |
| 946 | },<br> |
| 947 | ],<br> |
| 948 | "kind": "contacts#contact", # Type of the resource. This is always "contacts#contact".<br> |
| 949 | "photoId": "A String", # Contacts's photoId.<br> |
| 950 | "name": { # Detailed name information of the contact.<br> |
| 951 | "nameSuffix": "A String",<br> |
| 952 | "familyName": "A String",<br> |
| 953 | "additionalName": "A String",<br> |
| 954 | "namePrefix": "A String",<br> |
| 955 | "fullName": "A String",<br> |
| 956 | "givenName": "A String",<br> |
| 957 | },<br> |
| 958 | "gender": "A String", # Standard gender of the contact. It must be mapped to one of the gender specified in GenderTypes map.<br> |
| 959 | "outlookInformation": {<br> |
| 960 | },<br> |
| 961 | "urls": [ # Contact's various websites information.<br> |
| 962 | {<br> |
| 963 | "href": "A String",<br> |
| 964 | "customType": "A String",<br> |
| 965 | "type": "A String",<br> |
| 966 | "primary": True or False,<br> |
| 967 | },<br> |
| 968 | ],<br> |
| 969 | "selfLink": "A String", # URL pointing to this contact. Used to retrieve, update, or delete this contact.<br> |
| 970 | "initials": "A String", # Initials of the contact. Initials can not be repeated and hence only one value is possible for it.<br> |
| 971 | }<br> |
| 972 | <br> |
| 973 | userId: string, The user whose contacts are being updated. (required)<br> |
| 974 | contactId: string, The id of the contact being updated. (required)<br> |
| 975 | <br> |
| 976 | Returns:<br> |
| 977 | An object of the form<br> |
| 978 | <br> |
| 979 | {<br> |
| 980 | "phoneNumbers": [ # Phone information of the contact.<br> |
| 981 | {<br> |
| 982 | "type": "A String",<br> |
| 983 | "phoneType": "A String",<br> |
| 984 | "value": "A String",<br> |
| 985 | "primary": True or False,<br> |
| 986 | },<br> |
| 987 | ],<br> |
| 988 | "addresses": [ # Address information of the contact.<br> |
| 989 | {<br> |
| 990 | "sourceIsStructured": True or False,<br> |
| 991 | "poBox": "A String",<br> |
| 992 | "countryCode": "A String",<br> |
| 993 | "locality": "A String",<br> |
| 994 | "country": "A String",<br> |
| 995 | "region": "A String",<br> |
| 996 | "customType": "A String",<br> |
| 997 | "formatted": "A String",<br> |
| 998 | "primary": True or False,<br> |
| 999 | "streetAddress": "A String",<br> |
| 1000 | "postalCode": "A String",<br> |
| 1001 | "extendedAddress": "A String",<br> |
| 1002 | "type": "A String",<br> |
| 1003 | },<br> |
| 1004 | ],<br> |
| 1005 | "lastUpdateTime": "A String", # Last updated time of the entry.contact (in microseconds).<br> |
| 1006 | "maidenName": "A String", # Maiden name of the contact. Maiden can not be repeated.<br> |
| 1007 | "locations": [ # Locations the contact.<br> |
| 1008 | {<br> |
| 1009 | "customType": "A String",<br> |
| 1010 | "type": "A String",<br> |
| 1011 | "value": "A String",<br> |
| 1012 | },<br> |
| 1013 | ],<br> |
| 1014 | "userDefinedProperties": [ # UserDefined fields of the contact profile.<br> |
| 1015 | {<br> |
| 1016 | "value": "A String",<br> |
| 1017 | "key": "A String",<br> |
| 1018 | },<br> |
| 1019 | ],<br> |
| 1020 | "hobbies": [<br> |
| 1021 | "A String",<br> |
| 1022 | ],<br> |
| 1023 | "id": "A String", # Contact identifier.<br> |
| 1024 | "occupation": "A String", # Occupation of the contact. Occupation can not be repeated.<br> |
| 1025 | "calendarLinks": [ # Calendar information of the contact.<br> |
| 1026 | {<br> |
| 1027 | "customType": "A String",<br> |
| 1028 | "type": "A String",<br> |
| 1029 | "primary": True or False,<br> |
| 1030 | "value": "A String",<br> |
| 1031 | },<br> |
| 1032 | ],<br> |
| 1033 | "relations": [ # Relationship with the entry.contact.<br> |
| 1034 | {<br> |
| 1035 | "type": "A String",<br> |
| 1036 | "customeType": "A String",<br> |
| 1037 | "value": "A String",<br> |
| 1038 | },<br> |
| 1039 | ],<br> |
| 1040 | "languages": [ # Languages of the contact.<br> |
| 1041 | {<br> |
| 1042 | "code": "A String",<br> |
| 1043 | "value": "A String",<br> |
| 1044 | },<br> |
| 1045 | ],<br> |
| 1046 | "ims": [ # Instant messanger related information of the contact.<br> |
| 1047 | {<br> |
| 1048 | "customType": "A String",<br> |
| 1049 | "protocol": "A String",<br> |
| 1050 | "customProtocol": "A String",<br> |
| 1051 | "primary": True or False,<br> |
| 1052 | "im": "A String",<br> |
| 1053 | "type": "A String",<br> |
| 1054 | },<br> |
| 1055 | ],<br> |
| 1056 | "events": [ # Events information of the contact.<br> |
| 1057 | {<br> |
| 1058 | "customType": "A String",<br> |
| 1059 | "type": "A String",<br> |
| 1060 | "startTime": "",<br> |
| 1061 | "endTime": "",<br> |
| 1062 | },<br> |
| 1063 | ],<br> |
| 1064 | "externalIds": [ # Information regarding External Ids of the contact.<br> |
| 1065 | {<br> |
| 1066 | "customType": "A String",<br> |
| 1067 | "type": "A String",<br> |
| 1068 | "id": "A String",<br> |
| 1069 | },<br> |
| 1070 | ],<br> |
| 1071 | "deleted": True or False, # If this contact has been deleted (boolean field).<br> |
| 1072 | "extendedProperties": [ # Extended properties of the contact. Available only in full projection.<br> |
| 1073 | {<br> |
| 1074 | "name": "A String",<br> |
| 1075 | "value": "A String",<br> |
| 1076 | },<br> |
| 1077 | ],<br> |
| 1078 | "birthday": { # Birthday of the contact in YYYY-MM-DD format.<br> |
| 1079 | "year": 42,<br> |
| 1080 | "day": 42,<br> |
| 1081 | "value": "A String",<br> |
| 1082 | "month": 42,<br> |
| 1083 | },<br> |
| 1084 | "groups": [ # Group information of the contact.<br> |
| 1085 | {<br> |
| 1086 | "deleted": True or False,<br> |
| 1087 | "groupId": "A String",<br> |
| 1088 | },<br> |
| 1089 | ],<br> |
| 1090 | "others": [ # Other proeprties of a contact (equivalent to jot in gdata).<br> |
| 1091 | {<br> |
| 1092 | "customType": "A String",<br> |
| 1093 | "type": "A String",<br> |
| 1094 | "value": "A String",<br> |
| 1095 | },<br> |
| 1096 | ],<br> |
| 1097 | "shortName": "A String", # Short name of the contact. Short name can not be repeated.<br> |
| 1098 | "emails": [ # Email information of the contact.<br> |
| 1099 | {<br> |
| 1100 | "customType": "A String",<br> |
| 1101 | "type": "A String",<br> |
| 1102 | "primary": True or False,<br> |
| 1103 | "address": "A String",<br> |
| 1104 | },<br> |
| 1105 | ],<br> |
| 1106 | "organizations": [ # Organizations information of the contact.<br> |
| 1107 | {<br> |
| 1108 | "domain": "A String",<br> |
| 1109 | "description": "A String",<br> |
| 1110 | "title": "A String",<br> |
| 1111 | "symbol": "A String",<br> |
| 1112 | "customType": "A String",<br> |
| 1113 | "primary": True or False,<br> |
| 1114 | "location": "A String",<br> |
| 1115 | "department": "A String",<br> |
| 1116 | "type": "A String",<br> |
| 1117 | "name": "A String",<br> |
| 1118 | },<br> |
| 1119 | ],<br> |
| 1120 | "kind": "contacts#contact", # Type of the resource. This is always "contacts#contact".<br> |
| 1121 | "photoId": "A String", # Contacts's photoId.<br> |
| 1122 | "name": { # Detailed name information of the contact.<br> |
| 1123 | "nameSuffix": "A String",<br> |
| 1124 | "familyName": "A String",<br> |
| 1125 | "additionalName": "A String",<br> |
| 1126 | "namePrefix": "A String",<br> |
| 1127 | "fullName": "A String",<br> |
| 1128 | "givenName": "A String",<br> |
| 1129 | },<br> |
| 1130 | "gender": "A String", # Standard gender of the contact. It must be mapped to one of the gender specified in GenderTypes map.<br> |
| 1131 | "outlookInformation": {<br> |
| 1132 | },<br> |
| 1133 | "urls": [ # Contact's various websites information.<br> |
| 1134 | {<br> |
| 1135 | "href": "A String",<br> |
| 1136 | "customType": "A String",<br> |
| 1137 | "type": "A String",<br> |
| 1138 | "primary": True or False,<br> |
| 1139 | },<br> |
| 1140 | ],<br> |
| 1141 | "selfLink": "A String", # URL pointing to this contact. Used to retrieve, update, or delete this contact.<br> |
| 1142 | "initials": "A String", # Initials of the contact. Initials can not be repeated and hence only one value is possible for it.<br> |
| 1143 | }</tt></dd></dl> |
| 1144 | |
| 1145 | <dl><dt><a name="Resource-photos"><strong><a href="contacts.v1beta1.contacts.photos.html">photos</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl> |
| 1146 | |
| 1147 | <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> |
| 1148 | <br> |
| 1149 | Args:<br> |
| 1150 | body: object, The request body. (required)<br> |
| 1151 | The object takes the form of:<br> |
| 1152 | <br> |
| 1153 | {<br> |
| 1154 | "value": "A String",<br> |
| 1155 | }<br> |
| 1156 | <br> |
| 1157 | userId: string, The user whose contacts's extended property is being requested. (required)<br> |
| 1158 | contactId: string, Contacts whose extended property is being requested. (required)<br> |
| 1159 | key: string, Extended property key whose value is being requested. (required)<br> |
| 1160 | <br> |
| 1161 | Returns:<br> |
| 1162 | An object of the form<br> |
| 1163 | <br> |
| 1164 | {<br> |
| 1165 | "value": "A String",<br> |
| 1166 | }</tt></dd></dl> |
| 1167 | |
| 1168 | <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> |
| 1169 | <br> |
| 1170 | Args:<br> |
| 1171 | body: object, The request body. (required)<br> |
| 1172 | The object takes the form of:<br> |
| 1173 | <br> |
| 1174 | {<br> |
| 1175 | "value": "A String",<br> |
| 1176 | }<br> |
| 1177 | <br> |
| 1178 | userId: string, The user whose contacts's user defined property is being requested. (required)<br> |
| 1179 | contactId: string, Contacts whose user defined property is being requested. (required)<br> |
| 1180 | key: string, User defined property key whose value is being requested. (required)<br> |
| 1181 | <br> |
| 1182 | Returns:<br> |
| 1183 | An object of the form<br> |
| 1184 | <br> |
| 1185 | {<br> |
| 1186 | "value": "A String",<br> |
| 1187 | }</tt></dd></dl> |
| 1188 | |
| 1189 | <dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Update a contact entry.<br> |
| 1190 | <br> |
| 1191 | Args:<br> |
| 1192 | body: object, The request body. (required)<br> |
| 1193 | The object takes the form of:<br> |
| 1194 | <br> |
| 1195 | {<br> |
| 1196 | "phoneNumbers": [ # Phone information of the contact.<br> |
| 1197 | {<br> |
| 1198 | "type": "A String",<br> |
| 1199 | "phoneType": "A String",<br> |
| 1200 | "value": "A String",<br> |
| 1201 | "primary": True or False,<br> |
| 1202 | },<br> |
| 1203 | ],<br> |
| 1204 | "addresses": [ # Address information of the contact.<br> |
| 1205 | {<br> |
| 1206 | "sourceIsStructured": True or False,<br> |
| 1207 | "poBox": "A String",<br> |
| 1208 | "countryCode": "A String",<br> |
| 1209 | "locality": "A String",<br> |
| 1210 | "country": "A String",<br> |
| 1211 | "region": "A String",<br> |
| 1212 | "customType": "A String",<br> |
| 1213 | "formatted": "A String",<br> |
| 1214 | "primary": True or False,<br> |
| 1215 | "streetAddress": "A String",<br> |
| 1216 | "postalCode": "A String",<br> |
| 1217 | "extendedAddress": "A String",<br> |
| 1218 | "type": "A String",<br> |
| 1219 | },<br> |
| 1220 | ],<br> |
| 1221 | "lastUpdateTime": "A String", # Last updated time of the entry.contact (in microseconds).<br> |
| 1222 | "maidenName": "A String", # Maiden name of the contact. Maiden can not be repeated.<br> |
| 1223 | "locations": [ # Locations the contact.<br> |
| 1224 | {<br> |
| 1225 | "customType": "A String",<br> |
| 1226 | "type": "A String",<br> |
| 1227 | "value": "A String",<br> |
| 1228 | },<br> |
| 1229 | ],<br> |
| 1230 | "userDefinedProperties": [ # UserDefined fields of the contact profile.<br> |
| 1231 | {<br> |
| 1232 | "value": "A String",<br> |
| 1233 | "key": "A String",<br> |
| 1234 | },<br> |
| 1235 | ],<br> |
| 1236 | "hobbies": [<br> |
| 1237 | "A String",<br> |
| 1238 | ],<br> |
| 1239 | "id": "A String", # Contact identifier.<br> |
| 1240 | "occupation": "A String", # Occupation of the contact. Occupation can not be repeated.<br> |
| 1241 | "calendarLinks": [ # Calendar information of the contact.<br> |
| 1242 | {<br> |
| 1243 | "customType": "A String",<br> |
| 1244 | "type": "A String",<br> |
| 1245 | "primary": True or False,<br> |
| 1246 | "value": "A String",<br> |
| 1247 | },<br> |
| 1248 | ],<br> |
| 1249 | "relations": [ # Relationship with the entry.contact.<br> |
| 1250 | {<br> |
| 1251 | "type": "A String",<br> |
| 1252 | "customeType": "A String",<br> |
| 1253 | "value": "A String",<br> |
| 1254 | },<br> |
| 1255 | ],<br> |
| 1256 | "languages": [ # Languages of the contact.<br> |
| 1257 | {<br> |
| 1258 | "code": "A String",<br> |
| 1259 | "value": "A String",<br> |
| 1260 | },<br> |
| 1261 | ],<br> |
| 1262 | "ims": [ # Instant messanger related information of the contact.<br> |
| 1263 | {<br> |
| 1264 | "customType": "A String",<br> |
| 1265 | "protocol": "A String",<br> |
| 1266 | "customProtocol": "A String",<br> |
| 1267 | "primary": True or False,<br> |
| 1268 | "im": "A String",<br> |
| 1269 | "type": "A String",<br> |
| 1270 | },<br> |
| 1271 | ],<br> |
| 1272 | "events": [ # Events information of the contact.<br> |
| 1273 | {<br> |
| 1274 | "customType": "A String",<br> |
| 1275 | "type": "A String",<br> |
| 1276 | "startTime": "",<br> |
| 1277 | "endTime": "",<br> |
| 1278 | },<br> |
| 1279 | ],<br> |
| 1280 | "externalIds": [ # Information regarding External Ids of the contact.<br> |
| 1281 | {<br> |
| 1282 | "customType": "A String",<br> |
| 1283 | "type": "A String",<br> |
| 1284 | "id": "A String",<br> |
| 1285 | },<br> |
| 1286 | ],<br> |
| 1287 | "deleted": True or False, # If this contact has been deleted (boolean field).<br> |
| 1288 | "extendedProperties": [ # Extended properties of the contact. Available only in full projection.<br> |
| 1289 | {<br> |
| 1290 | "name": "A String",<br> |
| 1291 | "value": "A String",<br> |
| 1292 | },<br> |
| 1293 | ],<br> |
| 1294 | "birthday": { # Birthday of the contact in YYYY-MM-DD format.<br> |
| 1295 | "year": 42,<br> |
| 1296 | "day": 42,<br> |
| 1297 | "value": "A String",<br> |
| 1298 | "month": 42,<br> |
| 1299 | },<br> |
| 1300 | "groups": [ # Group information of the contact.<br> |
| 1301 | {<br> |
| 1302 | "deleted": True or False,<br> |
| 1303 | "groupId": "A String",<br> |
| 1304 | },<br> |
| 1305 | ],<br> |
| 1306 | "others": [ # Other proeprties of a contact (equivalent to jot in gdata).<br> |
| 1307 | {<br> |
| 1308 | "customType": "A String",<br> |
| 1309 | "type": "A String",<br> |
| 1310 | "value": "A String",<br> |
| 1311 | },<br> |
| 1312 | ],<br> |
| 1313 | "shortName": "A String", # Short name of the contact. Short name can not be repeated.<br> |
| 1314 | "emails": [ # Email information of the contact.<br> |
| 1315 | {<br> |
| 1316 | "customType": "A String",<br> |
| 1317 | "type": "A String",<br> |
| 1318 | "primary": True or False,<br> |
| 1319 | "address": "A String",<br> |
| 1320 | },<br> |
| 1321 | ],<br> |
| 1322 | "organizations": [ # Organizations information of the contact.<br> |
| 1323 | {<br> |
| 1324 | "domain": "A String",<br> |
| 1325 | "description": "A String",<br> |
| 1326 | "title": "A String",<br> |
| 1327 | "symbol": "A String",<br> |
| 1328 | "customType": "A String",<br> |
| 1329 | "primary": True or False,<br> |
| 1330 | "location": "A String",<br> |
| 1331 | "department": "A String",<br> |
| 1332 | "type": "A String",<br> |
| 1333 | "name": "A String",<br> |
| 1334 | },<br> |
| 1335 | ],<br> |
| 1336 | "kind": "contacts#contact", # Type of the resource. This is always "contacts#contact".<br> |
| 1337 | "photoId": "A String", # Contacts's photoId.<br> |
| 1338 | "name": { # Detailed name information of the contact.<br> |
| 1339 | "nameSuffix": "A String",<br> |
| 1340 | "familyName": "A String",<br> |
| 1341 | "additionalName": "A String",<br> |
| 1342 | "namePrefix": "A String",<br> |
| 1343 | "fullName": "A String",<br> |
| 1344 | "givenName": "A String",<br> |
| 1345 | },<br> |
| 1346 | "gender": "A String", # Standard gender of the contact. It must be mapped to one of the gender specified in GenderTypes map.<br> |
| 1347 | "outlookInformation": {<br> |
| 1348 | },<br> |
| 1349 | "urls": [ # Contact's various websites information.<br> |
| 1350 | {<br> |
| 1351 | "href": "A String",<br> |
| 1352 | "customType": "A String",<br> |
| 1353 | "type": "A String",<br> |
| 1354 | "primary": True or False,<br> |
| 1355 | },<br> |
| 1356 | ],<br> |
| 1357 | "selfLink": "A String", # URL pointing to this contact. Used to retrieve, update, or delete this contact.<br> |
| 1358 | "initials": "A String", # Initials of the contact. Initials can not be repeated and hence only one value is possible for it.<br> |
| 1359 | }<br> |
| 1360 | <br> |
| 1361 | userId: string, The user whose contacts are being updated. (required)<br> |
| 1362 | contactId: string, The id of the contact being updated. (required)<br> |
| 1363 | <br> |
| 1364 | Returns:<br> |
| 1365 | An object of the form<br> |
| 1366 | <br> |
| 1367 | {<br> |
| 1368 | "phoneNumbers": [ # Phone information of the contact.<br> |
| 1369 | {<br> |
| 1370 | "type": "A String",<br> |
| 1371 | "phoneType": "A String",<br> |
| 1372 | "value": "A String",<br> |
| 1373 | "primary": True or False,<br> |
| 1374 | },<br> |
| 1375 | ],<br> |
| 1376 | "addresses": [ # Address information of the contact.<br> |
| 1377 | {<br> |
| 1378 | "sourceIsStructured": True or False,<br> |
| 1379 | "poBox": "A String",<br> |
| 1380 | "countryCode": "A String",<br> |
| 1381 | "locality": "A String",<br> |
| 1382 | "country": "A String",<br> |
| 1383 | "region": "A String",<br> |
| 1384 | "customType": "A String",<br> |
| 1385 | "formatted": "A String",<br> |
| 1386 | "primary": True or False,<br> |
| 1387 | "streetAddress": "A String",<br> |
| 1388 | "postalCode": "A String",<br> |
| 1389 | "extendedAddress": "A String",<br> |
| 1390 | "type": "A String",<br> |
| 1391 | },<br> |
| 1392 | ],<br> |
| 1393 | "lastUpdateTime": "A String", # Last updated time of the entry.contact (in microseconds).<br> |
| 1394 | "maidenName": "A String", # Maiden name of the contact. Maiden can not be repeated.<br> |
| 1395 | "locations": [ # Locations the contact.<br> |
| 1396 | {<br> |
| 1397 | "customType": "A String",<br> |
| 1398 | "type": "A String",<br> |
| 1399 | "value": "A String",<br> |
| 1400 | },<br> |
| 1401 | ],<br> |
| 1402 | "userDefinedProperties": [ # UserDefined fields of the contact profile.<br> |
| 1403 | {<br> |
| 1404 | "value": "A String",<br> |
| 1405 | "key": "A String",<br> |
| 1406 | },<br> |
| 1407 | ],<br> |
| 1408 | "hobbies": [<br> |
| 1409 | "A String",<br> |
| 1410 | ],<br> |
| 1411 | "id": "A String", # Contact identifier.<br> |
| 1412 | "occupation": "A String", # Occupation of the contact. Occupation can not be repeated.<br> |
| 1413 | "calendarLinks": [ # Calendar information of the contact.<br> |
| 1414 | {<br> |
| 1415 | "customType": "A String",<br> |
| 1416 | "type": "A String",<br> |
| 1417 | "primary": True or False,<br> |
| 1418 | "value": "A String",<br> |
| 1419 | },<br> |
| 1420 | ],<br> |
| 1421 | "relations": [ # Relationship with the entry.contact.<br> |
| 1422 | {<br> |
| 1423 | "type": "A String",<br> |
| 1424 | "customeType": "A String",<br> |
| 1425 | "value": "A String",<br> |
| 1426 | },<br> |
| 1427 | ],<br> |
| 1428 | "languages": [ # Languages of the contact.<br> |
| 1429 | {<br> |
| 1430 | "code": "A String",<br> |
| 1431 | "value": "A String",<br> |
| 1432 | },<br> |
| 1433 | ],<br> |
| 1434 | "ims": [ # Instant messanger related information of the contact.<br> |
| 1435 | {<br> |
| 1436 | "customType": "A String",<br> |
| 1437 | "protocol": "A String",<br> |
| 1438 | "customProtocol": "A String",<br> |
| 1439 | "primary": True or False,<br> |
| 1440 | "im": "A String",<br> |
| 1441 | "type": "A String",<br> |
| 1442 | },<br> |
| 1443 | ],<br> |
| 1444 | "events": [ # Events information of the contact.<br> |
| 1445 | {<br> |
| 1446 | "customType": "A String",<br> |
| 1447 | "type": "A String",<br> |
| 1448 | "startTime": "",<br> |
| 1449 | "endTime": "",<br> |
| 1450 | },<br> |
| 1451 | ],<br> |
| 1452 | "externalIds": [ # Information regarding External Ids of the contact.<br> |
| 1453 | {<br> |
| 1454 | "customType": "A String",<br> |
| 1455 | "type": "A String",<br> |
| 1456 | "id": "A String",<br> |
| 1457 | },<br> |
| 1458 | ],<br> |
| 1459 | "deleted": True or False, # If this contact has been deleted (boolean field).<br> |
| 1460 | "extendedProperties": [ # Extended properties of the contact. Available only in full projection.<br> |
| 1461 | {<br> |
| 1462 | "name": "A String",<br> |
| 1463 | "value": "A String",<br> |
| 1464 | },<br> |
| 1465 | ],<br> |
| 1466 | "birthday": { # Birthday of the contact in YYYY-MM-DD format.<br> |
| 1467 | "year": 42,<br> |
| 1468 | "day": 42,<br> |
| 1469 | "value": "A String",<br> |
| 1470 | "month": 42,<br> |
| 1471 | },<br> |
| 1472 | "groups": [ # Group information of the contact.<br> |
| 1473 | {<br> |
| 1474 | "deleted": True or False,<br> |
| 1475 | "groupId": "A String",<br> |
| 1476 | },<br> |
| 1477 | ],<br> |
| 1478 | "others": [ # Other proeprties of a contact (equivalent to jot in gdata).<br> |
| 1479 | {<br> |
| 1480 | "customType": "A String",<br> |
| 1481 | "type": "A String",<br> |
| 1482 | "value": "A String",<br> |
| 1483 | },<br> |
| 1484 | ],<br> |
| 1485 | "shortName": "A String", # Short name of the contact. Short name can not be repeated.<br> |
| 1486 | "emails": [ # Email information of the contact.<br> |
| 1487 | {<br> |
| 1488 | "customType": "A String",<br> |
| 1489 | "type": "A String",<br> |
| 1490 | "primary": True or False,<br> |
| 1491 | "address": "A String",<br> |
| 1492 | },<br> |
| 1493 | ],<br> |
| 1494 | "organizations": [ # Organizations information of the contact.<br> |
| 1495 | {<br> |
| 1496 | "domain": "A String",<br> |
| 1497 | "description": "A String",<br> |
| 1498 | "title": "A String",<br> |
| 1499 | "symbol": "A String",<br> |
| 1500 | "customType": "A String",<br> |
| 1501 | "primary": True or False,<br> |
| 1502 | "location": "A String",<br> |
| 1503 | "department": "A String",<br> |
| 1504 | "type": "A String",<br> |
| 1505 | "name": "A String",<br> |
| 1506 | },<br> |
| 1507 | ],<br> |
| 1508 | "kind": "contacts#contact", # Type of the resource. This is always "contacts#contact".<br> |
| 1509 | "photoId": "A String", # Contacts's photoId.<br> |
| 1510 | "name": { # Detailed name information of the contact.<br> |
| 1511 | "nameSuffix": "A String",<br> |
| 1512 | "familyName": "A String",<br> |
| 1513 | "additionalName": "A String",<br> |
| 1514 | "namePrefix": "A String",<br> |
| 1515 | "fullName": "A String",<br> |
| 1516 | "givenName": "A String",<br> |
| 1517 | },<br> |
| 1518 | "gender": "A String", # Standard gender of the contact. It must be mapped to one of the gender specified in GenderTypes map.<br> |
| 1519 | "outlookInformation": {<br> |
| 1520 | },<br> |
| 1521 | "urls": [ # Contact's various websites information.<br> |
| 1522 | {<br> |
| 1523 | "href": "A String",<br> |
| 1524 | "customType": "A String",<br> |
| 1525 | "type": "A String",<br> |
| 1526 | "primary": True or False,<br> |
| 1527 | },<br> |
| 1528 | ],<br> |
| 1529 | "selfLink": "A String", # URL pointing to this contact. Used to retrieve, update, or delete this contact.<br> |
| 1530 | "initials": "A String", # Initials of the contact. Initials can not be repeated and hence only one value is possible for it.<br> |
| 1531 | }</tt></dd></dl> |
| 1532 | |
| 1533 | <hr> |
| 1534 | Data descriptors defined here:<br> |
| 1535 | <dl><dt><strong>__dict__</strong></dt> |
| 1536 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 1537 | </dl> |
| 1538 | <dl><dt><strong>__weakref__</strong></dt> |
| 1539 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 1540 | </dl> |
| 1541 | </td></tr></table> |
| 1542 | </body></html> |