1 <html><body> 2 <style> 3 4 body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13 } 14 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51 } 52 53 .toc_element { 54 margin-top: 0.5em; 55 } 56 57 .firstline { 58 margin-left: 2 em; 59 } 60 61 .method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66 } 67 68 .details { 69 font-weight: bold; 70 font-size: 14px; 71 } 72 73 </style> 74 75 <h1><a href="people_v1.html">Google People API</a> . <a href="people_v1.people.html">people</a> . <a href="people_v1.people.connections.html">connections</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#list">list(resourceName, pageSize=None, x__xgafv=None, pageToken=None, sortOrder=None, requestSyncToken=None, syncToken=None, requestMask_includeField=None)</a></code></p> 79 <p class="firstline">Provides a list of the authenticated user's contacts merged with any</p> 80 <p class="toc_element"> 81 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 82 <p class="firstline">Retrieves the next page of results.</p> 83 <h3>Method Details</h3> 84 <div class="method"> 85 <code class="details" id="list">list(resourceName, pageSize=None, x__xgafv=None, pageToken=None, sortOrder=None, requestSyncToken=None, syncToken=None, requestMask_includeField=None)</code> 86 <pre>Provides a list of the authenticated user's contacts merged with any 87 linked profiles. 88 89 Args: 90 resourceName: string, The resource name to return connections for. Only `people/me` is valid. (required) 91 pageSize: integer, The number of connections to include in the response. Valid values are 92 between 1 and 2000, inclusive. Defaults to 100. 93 x__xgafv: string, V1 error format. 94 Allowed values 95 1 - v1 error format 96 2 - v2 error format 97 pageToken: string, The token of the page to be returned. 98 sortOrder: string, The order in which the connections should be sorted. Defaults to 99 `LAST_MODIFIED_ASCENDING`. 100 requestSyncToken: boolean, Whether the response should include a sync token, which can be used to get 101 all changes since the last request. 102 syncToken: string, A sync token, returned by a previous call to `people.connections.list`. 103 Only resources changed since the sync token was created will be returned. 104 requestMask_includeField: string, Required. Comma-separated list of person fields to be included in the 105 response. Each path should start with `person.`: for example, 106 `person.names` or `person.photos`. 107 108 Returns: 109 An object of the form: 110 111 { 112 "totalPeople": 42, # DEPRECATED(Please use total_items). The total number of people in the list 113 # without pagination. 114 "nextPageToken": "A String", # The token that can be used to retrieve the next page of results. 115 "connections": [ # The list of people that the requestor is connected to. 116 { # Information about a person merged from various data sources such as the 117 # authenticated user's contacts and profile data. 118 # 119 # Most fields can have multiple items. The items in a field have no guaranteed 120 # order, but each non-empty field is guaranteed to have exactly one field with 121 # `metadata.primary` set to true. 122 "braggingRights": [ # The person's bragging rights. 123 { # A person's bragging rights. 124 "value": "A String", # The bragging rights; for example, `climbed mount everest`. 125 "metadata": { # Metadata about a field. # Metadata about the bragging rights. 126 "source": { # The source of a field. # The source of the field. 127 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 128 # source. Used for web cache validation. Only populated in 129 # person.metadata.sources. 130 "type": "A String", # The source type. 131 "id": "A String", # The unique identifier within the source type generated by the server. 132 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE. 133 "objectType": "A String", # The profile object type. 134 }, 135 }, 136 "verified": True or False, # True if the field is verified; false if the field is unverified. A 137 # verified field is typically a name, email address, phone number, or 138 # website that has been confirmed to be owned by the person. 139 "primary": True or False, # True if the field is the primary field; false if the field is a secondary 140 # field. 141 }, 142 }, 143 ], 144 "addresses": [ # The person's street addresses. 145 { # A person's physical address. May be a P.O. box or street address. All fields 146 # are optional. 147 "formattedType": "A String", # The read-only type of the address translated and formatted in the viewer's 148 # account locale or the `Accept-Language` HTTP header locale. 149 "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country 150 # code of the address. 151 "city": "A String", # The city of the address. 152 "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it 153 # will be automatically constructed from structured values. 154 "region": "A String", # The region of the address; for example, the state or province. 155 "poBox": "A String", # The P.O. box of the address. 156 "streetAddress": "A String", # The street address. 157 "country": "A String", # The country of the address. 158 "postalCode": "A String", # The postal code of the address. 159 "extendedAddress": "A String", # The extended address of the address; for example, the apartment number. 160 "type": "A String", # The type of the address. The type can be custom or predefined. 161 # Possible values include, but are not limited to, the following: 162 # 163 # * `home` 164 # * `work` 165 # * `other` 166 "metadata": { # Metadata about a field. # Metadata about the address. 167 "source": { # The source of a field. # The source of the field. 168 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 169 # source. Used for web cache validation. Only populated in 170 # person.metadata.sources. 171 "type": "A String", # The source type. 172 "id": "A String", # The unique identifier within the source type generated by the server. 173 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE. 174 "objectType": "A String", # The profile object type. 175 }, 176 }, 177 "verified": True or False, # True if the field is verified; false if the field is unverified. A 178 # verified field is typically a name, email address, phone number, or 179 # website that has been confirmed to be owned by the person. 180 "primary": True or False, # True if the field is the primary field; false if the field is a secondary 181 # field. 182 }, 183 }, 184 ], 185 "nicknames": [ # The person's nicknames. 186 { # A person's nickname. 187 "type": "A String", # The type of the nickname. 188 "value": "A String", # The nickname. 189 "metadata": { # Metadata about a field. # Metadata about the nickname. 190 "source": { # The source of a field. # The source of the field. 191 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 192 # source. Used for web cache validation. Only populated in 193 # person.metadata.sources. 194 "type": "A String", # The source type. 195 "id": "A String", # The unique identifier within the source type generated by the server. 196 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE. 197 "objectType": "A String", # The profile object type. 198 }, 199 }, 200 "verified": True or False, # True if the field is verified; false if the field is unverified. A 201 # verified field is typically a name, email address, phone number, or 202 # website that has been confirmed to be owned by the person. 203 "primary": True or False, # True if the field is the primary field; false if the field is a secondary 204 # field. 205 }, 206 }, 207 ], 208 "occupations": [ # The person's occupations. 209 { # A person's occupation. 210 "value": "A String", # The occupation; for example, `carpenter`. 211 "metadata": { # Metadata about a field. # Metadata about the occupation. 212 "source": { # The source of a field. # The source of the field. 213 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 214 # source. Used for web cache validation. Only populated in 215 # person.metadata.sources. 216 "type": "A String", # The source type. 217 "id": "A String", # The unique identifier within the source type generated by the server. 218 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE. 219 "objectType": "A String", # The profile object type. 220 }, 221 }, 222 "verified": True or False, # True if the field is verified; false if the field is unverified. A 223 # verified field is typically a name, email address, phone number, or 224 # website that has been confirmed to be owned by the person. 225 "primary": True or False, # True if the field is the primary field; false if the field is a secondary 226 # field. 227 }, 228 }, 229 ], 230 "phoneNumbers": [ # The person's phone numbers. 231 { # A person's phone number. 232 "formattedType": "A String", # The read-only type of the phone number translated and formatted in the 233 # viewer's account locale or the the `Accept-Language` HTTP header locale. 234 "canonicalForm": "A String", # The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) 235 # form of the phone number. 236 "type": "A String", # The type of the phone number. The type can be custom or predefined. 237 # Possible values include, but are not limited to, the following: 238 # 239 # * `home` 240 # * `work` 241 # * `mobile` 242 # * `homeFax` 243 # * `workFax` 244 # * `otherFax` 245 # * `pager` 246 # * `workMobile` 247 # * `workPager` 248 # * `main` 249 # * `googleVoice` 250 # * `other` 251 "value": "A String", # The phone number. 252 "metadata": { # Metadata about a field. # Metadata about the phone number. 253 "source": { # The source of a field. # The source of the field. 254 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 255 # source. Used for web cache validation. Only populated in 256 # person.metadata.sources. 257 "type": "A String", # The source type. 258 "id": "A String", # The unique identifier within the source type generated by the server. 259 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE. 260 "objectType": "A String", # The profile object type. 261 }, 262 }, 263 "verified": True or False, # True if the field is verified; false if the field is unverified. A 264 # verified field is typically a name, email address, phone number, or 265 # website that has been confirmed to be owned by the person. 266 "primary": True or False, # True if the field is the primary field; false if the field is a secondary 267 # field. 268 }, 269 }, 270 ], 271 "names": [ # The person's names. 272 { # A person's name. If the name is a mononym, the family name is empty. 273 "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound. 274 "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.` 275 "phoneticFamilyName": "A String", # The family name spelled as it sounds. 276 "displayName": "A String", # The read-only display name formatted according to the locale specified by 277 # the viewer's account or the <code>Accept-Language</code> HTTP header. 278 "displayNameLastFirst": "A String", # The read-only display name with the last name first formatted according to 279 # the locale specified by the viewer's account or the 280 # <code>Accept-Language</code> HTTP header. 281 "middleName": "A String", # The middle name(s). 282 "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound. 283 "familyName": "A String", # The family name. 284 "phoneticFullName": "A String", # The full name spelled as it sounds. 285 "phoneticGivenName": "A String", # The given name spelled as it sounds. 286 "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound. 287 "givenName": "A String", # The given name. 288 "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.` 289 "metadata": { # Metadata about a field. # Metadata about the name. 290 "source": { # The source of a field. # The source of the field. 291 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 292 # source. Used for web cache validation. Only populated in 293 # person.metadata.sources. 294 "type": "A String", # The source type. 295 "id": "A String", # The unique identifier within the source type generated by the server. 296 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE. 297 "objectType": "A String", # The profile object type. 298 }, 299 }, 300 "verified": True or False, # True if the field is verified; false if the field is unverified. A 301 # verified field is typically a name, email address, phone number, or 302 # website that has been confirmed to be owned by the person. 303 "primary": True or False, # True if the field is the primary field; false if the field is a secondary 304 # field. 305 }, 306 }, 307 ], 308 "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string 309 # with a max length of 27 characters, in the form of `people/<person_id>`. 310 "ageRanges": [ # The person's age ranges. 311 { # A person's age range. 312 "ageRange": "A String", # The age range. 313 "metadata": { # Metadata about a field. # Metadata about the age range. 314 "source": { # The source of a field. # The source of the field. 315 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 316 # source. Used for web cache validation. Only populated in 317 # person.metadata.sources. 318 "type": "A String", # The source type. 319 "id": "A String", # The unique identifier within the source type generated by the server. 320 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE. 321 "objectType": "A String", # The profile object type. 322 }, 323 }, 324 "verified": True or False, # True if the field is verified; false if the field is unverified. A 325 # verified field is typically a name, email address, phone number, or 326 # website that has been confirmed to be owned by the person. 327 "primary": True or False, # True if the field is the primary field; false if the field is a secondary 328 # field. 329 }, 330 }, 331 ], 332 "birthdays": [ # The person's birthdays. 333 { # A person's birthday. At least one of the `date` and `text` fields are 334 # specified. The `date` and `text` fields typically represent the same 335 # date, but are not guaranteed to. 336 "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the birthday. 337 # of day and time zone are either specified elsewhere or are not 338 # significant. The date is relative to the 339 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). 340 # The day may be 0 to represent a year and month where the day is not 341 # significant. The year may be 0 to represent a month and day independent 342 # of year; for example, anniversary date. 343 "month": 42, # Month of year. Must be from 1 to 12. 344 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 345 # if specifying a year/month where the day is not significant. 346 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without 347 # a year. 348 }, 349 "text": "A String", # A free-form string representing the user's birthday. 350 "metadata": { # Metadata about a field. # Metadata about the birthday. 351 "source": { # The source of a field. # The source of the field. 352 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 353 # source. Used for web cache validation. Only populated in 354 # person.metadata.sources. 355 "type": "A String", # The source type. 356 "id": "A String", # The unique identifier within the source type generated by the server. 357 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE. 358 "objectType": "A String", # The profile object type. 359 }, 360 }, 361 "verified": True or False, # True if the field is verified; false if the field is unverified. A 362 # verified field is typically a name, email address, phone number, or 363 # website that has been confirmed to be owned by the person. 364 "primary": True or False, # True if the field is the primary field; false if the field is a secondary 365 # field. 366 }, 367 }, 368 ], 369 "relations": [ # The person's relations. 370 { # A person's relation to another person. 371 "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account 372 # locale or the locale specified in the Accept-Language HTTP header. 373 "metadata": { # Metadata about a field. # Metadata about the relation. 374 "source": { # The source of a field. # The source of the field. 375 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 376 # source. Used for web cache validation. Only populated in 377 # person.metadata.sources. 378 "type": "A String", # The source type. 379 "id": "A String", # The unique identifier within the source type generated by the server. 380 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE. 381 "objectType": "A String", # The profile object type. 382 }, 383 }, 384 "verified": True or False, # True if the field is verified; false if the field is unverified. A 385 # verified field is typically a name, email address, phone number, or 386 # website that has been confirmed to be owned by the person. 387 "primary": True or False, # True if the field is the primary field; false if the field is a secondary 388 # field. 389 }, 390 "type": "A String", # The person's relation to the other person. The type can be custom or predefined. 391 # Possible values include, but are not limited to, the following values: 392 # 393 # * `spouse` 394 # * `child` 395 # * `mother` 396 # * `father` 397 # * `parent` 398 # * `brother` 399 # * `sister` 400 # * `friend` 401 # * `relative` 402 # * `domesticPartner` 403 # * `manager` 404 # * `assistant` 405 # * `referredBy` 406 # * `partner` 407 "person": "A String", # The name of the other person this relation refers to. 408 }, 409 ], 410 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 411 # resource. Used for web cache validation. 412 "relationshipStatuses": [ # The person's relationship statuses. 413 { # A person's read-only relationship status. 414 "formattedValue": "A String", # The read-only value of the relationship status translated and formatted in 415 # the viewer's account locale or the `Accept-Language` HTTP header locale. 416 "value": "A String", # The relationship status. The value can be custom or predefined. 417 # Possible values include, but are not limited to, the following: 418 # 419 # * `single` 420 # * `inARelationship` 421 # * `engaged` 422 # * `married` 423 # * `itsComplicated` 424 # * `openRelationship` 425 # * `widowed` 426 # * `inDomesticPartnership` 427 # * `inCivilUnion` 428 "metadata": { # Metadata about a field. # Metadata about the relationship status. 429 "source": { # The source of a field. # The source of the field. 430 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 431 # source. Used for web cache validation. Only populated in 432 # person.metadata.sources. 433 "type": "A String", # The source type. 434 "id": "A String", # The unique identifier within the source type generated by the server. 435 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE. 436 "objectType": "A String", # The profile object type. 437 }, 438 }, 439 "verified": True or False, # True if the field is verified; false if the field is unverified. A 440 # verified field is typically a name, email address, phone number, or 441 # website that has been confirmed to be owned by the person. 442 "primary": True or False, # True if the field is the primary field; false if the field is a secondary 443 # field. 444 }, 445 }, 446 ], 447 "skills": [ # The person's skills. 448 { # A skill that the person has. 449 "value": "A String", # The skill; for example, `underwater basket weaving`. 450 "metadata": { # Metadata about a field. # Metadata about the skill. 451 "source": { # The source of a field. # The source of the field. 452 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 453 # source. Used for web cache validation. Only populated in 454 # person.metadata.sources. 455 "type": "A String", # The source type. 456 "id": "A String", # The unique identifier within the source type generated by the server. 457 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE. 458 "objectType": "A String", # The profile object type. 459 }, 460 }, 461 "verified": True or False, # True if the field is verified; false if the field is unverified. A 462 # verified field is typically a name, email address, phone number, or 463 # website that has been confirmed to be owned by the person. 464 "primary": True or False, # True if the field is the primary field; false if the field is a secondary 465 # field. 466 }, 467 }, 468 ], 469 "imClients": [ # The person's instant messaging clients. 470 { # A person's instant messaging client. 471 "username": "A String", # The user name used in the IM client. 472 "formattedType": "A String", # The read-only type of the IM client translated and formatted in the 473 # viewer's account locale or the `Accept-Language` HTTP header locale. 474 "protocol": "A String", # The protocol of the IM client. The protocol can be custom or predefined. 475 # Possible values include, but are not limited to, the following: 476 # 477 # * `aim` 478 # * `msn` 479 # * `yahoo` 480 # * `skype` 481 # * `qq` 482 # * `googleTalk` 483 # * `icq` 484 # * `jabber` 485 # * `netMeeting` 486 "formattedProtocol": "A String", # The read-only protocol of the IM client formatted in the viewer's account 487 # locale or the `Accept-Language` HTTP header locale. 488 "type": "A String", # The type of the IM client. The type can be custom or predefined. 489 # Possible values include, but are not limited to, the following: 490 # 491 # * `home` 492 # * `work` 493 # * `other` 494 "metadata": { # Metadata about a field. # Metadata about the IM client. 495 "source": { # The source of a field. # The source of the field. 496 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 497 # source. Used for web cache validation. Only populated in 498 # person.metadata.sources. 499 "type": "A String", # The source type. 500 "id": "A String", # The unique identifier within the source type generated by the server. 501 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE. 502 "objectType": "A String", # The profile object type. 503 }, 504 }, 505 "verified": True or False, # True if the field is verified; false if the field is unverified. A 506 # verified field is typically a name, email address, phone number, or 507 # website that has been confirmed to be owned by the person. 508 "primary": True or False, # True if the field is the primary field; false if the field is a secondary 509 # field. 510 }, 511 }, 512 ], 513 "events": [ # The person's events. 514 { # An event related to the person. 515 "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the event. 516 # of day and time zone are either specified elsewhere or are not 517 # significant. The date is relative to the 518 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). 519 # The day may be 0 to represent a year and month where the day is not 520 # significant. The year may be 0 to represent a month and day independent 521 # of year; for example, anniversary date. 522 "month": 42, # Month of year. Must be from 1 to 12. 523 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 524 # if specifying a year/month where the day is not significant. 525 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without 526 # a year. 527 }, 528 "formattedType": "A String", # The read-only type of the event translated and formatted in the 529 # viewer's account locale or the `Accept-Language` HTTP header locale. 530 "type": "A String", # The type of the event. The type can be custom or predefined. 531 # Possible values include, but are not limited to, the following: 532 # 533 # * `anniversary` 534 # * `other` 535 "metadata": { # Metadata about a field. # Metadata about the event. 536 "source": { # The source of a field. # The source of the field. 537 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 538 # source. Used for web cache validation. Only populated in 539 # person.metadata.sources. 540 "type": "A String", # The source type. 541 "id": "A String", # The unique identifier within the source type generated by the server. 542 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE. 543 "objectType": "A String", # The profile object type. 544 }, 545 }, 546 "verified": True or False, # True if the field is verified; false if the field is unverified. A 547 # verified field is typically a name, email address, phone number, or 548 # website that has been confirmed to be owned by the person. 549 "primary": True or False, # True if the field is the primary field; false if the field is a secondary 550 # field. 551 }, 552 }, 553 ], 554 "metadata": { # The read-only metadata about a person. # Metadata about the person. 555 "previousResourceNames": [ # Any former resource names this person has had. Populated only for 556 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests 557 # that include a sync token. 558 # 559 # The resource name may change when adding or removing fields that link a 560 # contact and profile such as a verified email, verified phone number, or 561 # profile URL. 562 "A String", 563 ], 564 "sources": [ # The sources of data for the person. 565 { # The source of a field. 566 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 567 # source. Used for web cache validation. Only populated in 568 # person.metadata.sources. 569 "type": "A String", # The source type. 570 "id": "A String", # The unique identifier within the source type generated by the server. 571 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE. 572 "objectType": "A String", # The profile object type. 573 }, 574 }, 575 ], 576 "linkedPeopleResourceNames": [ # Resource names of people linked to this resource. 577 "A String", 578 ], 579 "deleted": True or False, # True if the person resource has been deleted. Populated only for 580 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests 581 # that include a sync token. 582 "objectType": "A String", # DEPRECATED(Please read person.metadata.sources.profile_metadata instead). 583 # The type of the person object. 584 }, 585 "interests": [ # The person's interests. 586 { # One of the person's interests. 587 "value": "A String", # The interest; for example, `stargazing`. 588 "metadata": { # Metadata about a field. # Metadata about the interest. 589 "source": { # The source of a field. # The source of the field. 590 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 591 # source. Used for web cache validation. Only populated in 592 # person.metadata.sources. 593 "type": "A String", # The source type. 594 "id": "A String", # The unique identifier within the source type generated by the server. 595 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE. 596 "objectType": "A String", # The profile object type. 597 }, 598 }, 599 "verified": True or False, # True if the field is verified; false if the field is unverified. A 600 # verified field is typically a name, email address, phone number, or 601 # website that has been confirmed to be owned by the person. 602 "primary": True or False, # True if the field is the primary field; false if the field is a secondary 603 # field. 604 }, 605 }, 606 ], 607 "photos": [ # The person's photos. 608 { # A person's read-only photo. A picture shown next to the person's name to 609 # help others recognize the person. 610 "url": "A String", # The URL of the photo. You can change the desired size by appending a query 611 # parameter `sz=<size>` at the end of the url. Example: 612 # `https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50` 613 "metadata": { # Metadata about a field. # Metadata about the photo. 614 "source": { # The source of a field. # The source of the field. 615 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 616 # source. Used for web cache validation. Only populated in 617 # person.metadata.sources. 618 "type": "A String", # The source type. 619 "id": "A String", # The unique identifier within the source type generated by the server. 620 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE. 621 "objectType": "A String", # The profile object type. 622 }, 623 }, 624 "verified": True or False, # True if the field is verified; false if the field is unverified. A 625 # verified field is typically a name, email address, phone number, or 626 # website that has been confirmed to be owned by the person. 627 "primary": True or False, # True if the field is the primary field; false if the field is a secondary 628 # field. 629 }, 630 }, 631 ], 632 "residences": [ # The person's residences. 633 { # A person's past or current residence. 634 "current": True or False, # True if the residence is the person's current residence; 635 # false if the residence is a past residence. 636 "value": "A String", # The address of the residence. 637 "metadata": { # Metadata about a field. # Metadata about the residence. 638 "source": { # The source of a field. # The source of the field. 639 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 640 # source. Used for web cache validation. Only populated in 641 # person.metadata.sources. 642 "type": "A String", # The source type. 643 "id": "A String", # The unique identifier within the source type generated by the server. 644 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE. 645 "objectType": "A String", # The profile object type. 646 }, 647 }, 648 "verified": True or False, # True if the field is verified; false if the field is unverified. A 649 # verified field is typically a name, email address, phone number, or 650 # website that has been confirmed to be owned by the person. 651 "primary": True or False, # True if the field is the primary field; false if the field is a secondary 652 # field. 653 }, 654 }, 655 ], 656 "relationshipInterests": [ # The kind of relationship the person is looking for. 657 { # A person's read-only relationship interest . 658 "formattedValue": "A String", # The value of the relationship interest translated and formatted in the 659 # viewer's account locale or the locale specified in the Accept-Language 660 # HTTP header. 661 "value": "A String", # The kind of relationship the person is looking for. The value can be custom 662 # or predefined. Possible values include, but are not limited to, the 663 # following values: 664 # 665 # * `friend` 666 # * `date` 667 # * `relationship` 668 # * `networking` 669 "metadata": { # Metadata about a field. # Metadata about the relationship interest. 670 "source": { # The source of a field. # The source of the field. 671 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 672 # source. Used for web cache validation. Only populated in 673 # person.metadata.sources. 674 "type": "A String", # The source type. 675 "id": "A String", # The unique identifier within the source type generated by the server. 676 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE. 677 "objectType": "A String", # The profile object type. 678 }, 679 }, 680 "verified": True or False, # True if the field is verified; false if the field is unverified. A 681 # verified field is typically a name, email address, phone number, or 682 # website that has been confirmed to be owned by the person. 683 "primary": True or False, # True if the field is the primary field; false if the field is a secondary 684 # field. 685 }, 686 }, 687 ], 688 "coverPhotos": [ # The person's cover photos. 689 { # A person's read-only cover photo. A large image shown on the person's 690 # profile page that represents who they are or what they care about. 691 "default": True or False, # True if the cover photo is the default cover photo; 692 # false if the cover photo is a user-provided cover photo. 693 "url": "A String", # The URL of the cover photo. 694 "metadata": { # Metadata about a field. # Metadata about the cover photo. 695 "source": { # The source of a field. # The source of the field. 696 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 697 # source. Used for web cache validation. Only populated in 698 # person.metadata.sources. 699 "type": "A String", # The source type. 700 "id": "A String", # The unique identifier within the source type generated by the server. 701 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE. 702 "objectType": "A String", # The profile object type. 703 }, 704 }, 705 "verified": True or False, # True if the field is verified; false if the field is unverified. A 706 # verified field is typically a name, email address, phone number, or 707 # website that has been confirmed to be owned by the person. 708 "primary": True or False, # True if the field is the primary field; false if the field is a secondary 709 # field. 710 }, 711 }, 712 ], 713 "locales": [ # The person's locale preferences. 714 { # A person's locale preference. 715 "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) 716 # language tag representing the locale. 717 "metadata": { # Metadata about a field. # Metadata about the locale. 718 "source": { # The source of a field. # The source of the field. 719 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 720 # source. Used for web cache validation. Only populated in 721 # person.metadata.sources. 722 "type": "A String", # The source type. 723 "id": "A String", # The unique identifier within the source type generated by the server. 724 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE. 725 "objectType": "A String", # The profile object type. 726 }, 727 }, 728 "verified": True or False, # True if the field is verified; false if the field is unverified. A 729 # verified field is typically a name, email address, phone number, or 730 # website that has been confirmed to be owned by the person. 731 "primary": True or False, # True if the field is the primary field; false if the field is a secondary 732 # field. 733 }, 734 }, 735 ], 736 "organizations": [ # The person's past or current organizations. 737 { # A person's past or current organization. Overlapping date ranges are 738 # permitted. 739 "startDate": { # Represents a whole calendar date, for example a date of birth. The time # The start date when the person joined the organization. 740 # of day and time zone are either specified elsewhere or are not 741 # significant. The date is relative to the 742 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). 743 # The day may be 0 to represent a year and month where the day is not 744 # significant. The year may be 0 to represent a month and day independent 745 # of year; for example, anniversary date. 746 "month": 42, # Month of year. Must be from 1 to 12. 747 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 748 # if specifying a year/month where the day is not significant. 749 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without 750 # a year. 751 }, 752 "domain": "A String", # The domain name associated with the organization; for example, `google.com`. 753 "endDate": { # Represents a whole calendar date, for example a date of birth. The time # The end date when the person left the organization. 754 # of day and time zone are either specified elsewhere or are not 755 # significant. The date is relative to the 756 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). 757 # The day may be 0 to represent a year and month where the day is not 758 # significant. The year may be 0 to represent a month and day independent 759 # of year; for example, anniversary date. 760 "month": 42, # Month of year. Must be from 1 to 12. 761 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 762 # if specifying a year/month where the day is not significant. 763 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without 764 # a year. 765 }, 766 "name": "A String", # The name of the organization. 767 "title": "A String", # The person's job title at the organization. 768 "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker 769 # symbol, abbreviation, or acronym. 770 "current": True or False, # True if the organization is the person's current organization; 771 # false if the organization is a past organization. 772 "jobDescription": "A String", # The person's job description at the organization. 773 "location": "A String", # The location of the organization office the person works at. 774 "department": "A String", # The person's department at the organization. 775 "formattedType": "A String", # The read-only type of the organization translated and formatted in the 776 # viewer's account locale or the `Accept-Language` HTTP header locale. 777 "type": "A String", # The type of the organization. The type can be custom or predefined. 778 # Possible values include, but are not limited to, the following: 779 # 780 # * `work` 781 # * `school` 782 "phoneticName": "A String", # The phonetic name of the organization. 783 "metadata": { # Metadata about a field. # Metadata about the organization. 784 "source": { # The source of a field. # The source of the field. 785 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 786 # source. Used for web cache validation. Only populated in 787 # person.metadata.sources. 788 "type": "A String", # The source type. 789 "id": "A String", # The unique identifier within the source type generated by the server. 790 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE. 791 "objectType": "A String", # The profile object type. 792 }, 793 }, 794 "verified": True or False, # True if the field is verified; false if the field is unverified. A 795 # verified field is typically a name, email address, phone number, or 796 # website that has been confirmed to be owned by the person. 797 "primary": True or False, # True if the field is the primary field; false if the field is a secondary 798 # field. 799 }, 800 }, 801 ], 802 "biographies": [ # The person's biographies. 803 { # A person's short biography. 804 "contentType": "A String", # The content type of the biography. 805 "value": "A String", # The short biography. 806 "metadata": { # Metadata about a field. # Metadata about the biography. 807 "source": { # The source of a field. # The source of the field. 808 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 809 # source. Used for web cache validation. Only populated in 810 # person.metadata.sources. 811 "type": "A String", # The source type. 812 "id": "A String", # The unique identifier within the source type generated by the server. 813 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE. 814 "objectType": "A String", # The profile object type. 815 }, 816 }, 817 "verified": True or False, # True if the field is verified; false if the field is unverified. A 818 # verified field is typically a name, email address, phone number, or 819 # website that has been confirmed to be owned by the person. 820 "primary": True or False, # True if the field is the primary field; false if the field is a secondary 821 # field. 822 }, 823 }, 824 ], 825 "memberships": [ # The person's group memberships. 826 { # A person's read-only membership in a group. 827 "contactGroupMembership": { # A Google contact group membership. # The contact group membership. 828 "contactGroupId": "A String", # The contact group ID for the contact group membership. The contact group 829 # ID can be custom or predefined. Possible values include, but are not 830 # limited to, the following: 831 # 832 # * `myContacts` 833 # * `starred` 834 # * A numerical ID for user-created groups. 835 }, 836 "domainMembership": { # A Google Apps Domain membership. # The domain membership. 837 "inViewerDomain": True or False, # True if the person is in the viewer's Google Apps domain. 838 }, 839 "metadata": { # Metadata about a field. # Metadata about the membership. 840 "source": { # The source of a field. # The source of the field. 841 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 842 # source. Used for web cache validation. Only populated in 843 # person.metadata.sources. 844 "type": "A String", # The source type. 845 "id": "A String", # The unique identifier within the source type generated by the server. 846 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE. 847 "objectType": "A String", # The profile object type. 848 }, 849 }, 850 "verified": True or False, # True if the field is verified; false if the field is unverified. A 851 # verified field is typically a name, email address, phone number, or 852 # website that has been confirmed to be owned by the person. 853 "primary": True or False, # True if the field is the primary field; false if the field is a secondary 854 # field. 855 }, 856 }, 857 ], 858 "taglines": [ # The person's taglines. 859 { # A read-only brief one-line description of the person. 860 "value": "A String", # The tagline. 861 "metadata": { # Metadata about a field. # Metadata about the tagline. 862 "source": { # The source of a field. # The source of the field. 863 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 864 # source. Used for web cache validation. Only populated in 865 # person.metadata.sources. 866 "type": "A String", # The source type. 867 "id": "A String", # The unique identifier within the source type generated by the server. 868 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE. 869 "objectType": "A String", # The profile object type. 870 }, 871 }, 872 "verified": True or False, # True if the field is verified; false if the field is unverified. A 873 # verified field is typically a name, email address, phone number, or 874 # website that has been confirmed to be owned by the person. 875 "primary": True or False, # True if the field is the primary field; false if the field is a secondary 876 # field. 877 }, 878 }, 879 ], 880 "urls": [ # The person's associated URLs. 881 { # A person's associated URLs. 882 "formattedType": "A String", # The read-only type of the URL translated and formatted in the viewer's 883 # account locale or the `Accept-Language` HTTP header locale. 884 "type": "A String", # The type of the URL. The type can be custom or predefined. 885 # Possible values include, but are not limited to, the following: 886 # 887 # * `home` 888 # * `work` 889 # * `blog` 890 # * `profile` 891 # * `homePage` 892 # * `ftp` 893 # * `reservations` 894 # * `appInstallPage`: website for a Google+ application. 895 # * `other` 896 "value": "A String", # The URL. 897 "metadata": { # Metadata about a field. # Metadata about the URL. 898 "source": { # The source of a field. # The source of the field. 899 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 900 # source. Used for web cache validation. Only populated in 901 # person.metadata.sources. 902 "type": "A String", # The source type. 903 "id": "A String", # The unique identifier within the source type generated by the server. 904 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE. 905 "objectType": "A String", # The profile object type. 906 }, 907 }, 908 "verified": True or False, # True if the field is verified; false if the field is unverified. A 909 # verified field is typically a name, email address, phone number, or 910 # website that has been confirmed to be owned by the person. 911 "primary": True or False, # True if the field is the primary field; false if the field is a secondary 912 # field. 913 }, 914 }, 915 ], 916 "ageRange": "A String", # DEPRECATED(Please read person.age_ranges instead). The person's age range. 917 "genders": [ # The person's genders. 918 { # A person's gender. 919 "formattedValue": "A String", # The read-only value of the gender translated and formatted in the viewer's 920 # account locale or the `Accept-Language` HTTP header locale. 921 "value": "A String", # The gender for the person. The gender can be custom or predefined. 922 # Possible values include, but are not limited to, the 923 # following: 924 # 925 # * `male` 926 # * `female` 927 # * `other` 928 # * `unknown` 929 "metadata": { # Metadata about a field. # Metadata about the gender. 930 "source": { # The source of a field. # The source of the field. 931 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 932 # source. Used for web cache validation. Only populated in 933 # person.metadata.sources. 934 "type": "A String", # The source type. 935 "id": "A String", # The unique identifier within the source type generated by the server. 936 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE. 937 "objectType": "A String", # The profile object type. 938 }, 939 }, 940 "verified": True or False, # True if the field is verified; false if the field is unverified. A 941 # verified field is typically a name, email address, phone number, or 942 # website that has been confirmed to be owned by the person. 943 "primary": True or False, # True if the field is the primary field; false if the field is a secondary 944 # field. 945 }, 946 }, 947 ], 948 "emailAddresses": [ # The person's email addresses. 949 { # A person's email address. 950 "type": "A String", # The type of the email address. The type can be custom or predefined. 951 # Possible values include, but are not limited to, the following: 952 # 953 # * `home` 954 # * `work` 955 # * `other` 956 "formattedType": "A String", # The read-only type of the email address translated and formatted in the 957 # viewer's account locale or the `Accept-Language` HTTP header locale. 958 "displayName": "A String", # The display name of the email. 959 "value": "A String", # The email address. 960 "metadata": { # Metadata about a field. # Metadata about the email address. 961 "source": { # The source of a field. # The source of the field. 962 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the 963 # source. Used for web cache validation. Only populated in 964 # person.metadata.sources. 965 "type": "A String", # The source type. 966 "id": "A String", # The unique identifier within the source type generated by the server. 967 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE. 968 "objectType": "A String", # The profile object type. 969 }, 970 }, 971 "verified": True or False, # True if the field is verified; false if the field is unverified. A 972 # verified field is typically a name, email address, phone number, or 973 # website that has been confirmed to be owned by the person. 974 "primary": True or False, # True if the field is the primary field; false if the field is a secondary 975 # field. 976 }, 977 }, 978 ], 979 }, 980 ], 981 "nextSyncToken": "A String", # The token that can be used to retrieve changes since the last request. 982 "totalItems": 42, # The total number of items in the list without pagination. 983 }</pre> 984 </div> 985 986 <div class="method"> 987 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 988 <pre>Retrieves the next page of results. 989 990 Args: 991 previous_request: The request for the previous page. (required) 992 previous_response: The response from the request for the previous page. (required) 993 994 Returns: 995 A request object that you can call 'execute()' on to request the next 996 page. Returns None if there are no more items in the collection. 997 </pre> 998 </div> 999 1000 </body></html>
