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