CINXE.COM

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title> Module: Google::Apis::PeopleV1 — Documentation by YARD 0.9.26 </title> <link rel="stylesheet" href="../../css/style.css" type="text/css" /> <link rel="stylesheet" href="../../css/common.css" type="text/css" /> <script type="text/javascript"> pathId = "Google::Apis::PeopleV1"; relpath = '../../'; </script> <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script> </head> <body> <div class="nav_wrap"> <iframe id="nav" src="../../class_list.html?1"></iframe> <div id="resizer"></div> </div> <div id="main" tabindex="-1"> <div id="header"> <div id="menu"> <a href="../../_index.html">Index (P)</a> » <span class='title'><span class='object_link'><a href="../../Google.html" title="Google (module)">Google</a></span></span> » <span class='title'><span class='object_link'><a href="../Apis.html" title="Google::Apis (module)">Apis</a></span></span> » <span class="title">PeopleV1</span> </div> <div id="search"> <a class="full_list_link" id="class_list_link" href="../../class_list.html"> <svg width="24" height="24"> <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect> <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect> <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect> </svg> </a> </div> <div class="clear"></div> </div> <div id="content"><h1>Module: Google::Apis::PeopleV1 </h1> <div class="box_info"> <dl> <dt>Defined in:</dt> <dd>generated/google/apis/people_v1.rb<span class="defines">,<br /> generated/google/apis/people_v1/classes.rb,<br /> generated/google/apis/people_v1/service.rb,<br /> generated/google/apis/people_v1/representations.rb</span> </dd> </dl> </div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>People API</p> <p>Provides access to information about profiles and contacts.</p> </div> </div> <div class="tags"> <p class="tag_title">See Also:</p> <ul class="see"> <li><a href="https://developers.google.com/people/" target="_parent" title="https://developers.google.com/people/">https://developers.google.com/people/</a></li> </ul> </div><h2>Defined Under Namespace</h2> <p class="children"> <strong class="classes">Classes:</strong> <span class='object_link'><a href="PeopleV1/Address.html" title="Google::Apis::PeopleV1::Address (class)">Address</a></span>, <span class='object_link'><a href="PeopleV1/AgeRangeType.html" title="Google::Apis::PeopleV1::AgeRangeType (class)">AgeRangeType</a></span>, <span class='object_link'><a href="PeopleV1/BatchGetContactGroupsResponse.html" title="Google::Apis::PeopleV1::BatchGetContactGroupsResponse (class)">BatchGetContactGroupsResponse</a></span>, <span class='object_link'><a href="PeopleV1/Biography.html" title="Google::Apis::PeopleV1::Biography (class)">Biography</a></span>, <span class='object_link'><a href="PeopleV1/Birthday.html" title="Google::Apis::PeopleV1::Birthday (class)">Birthday</a></span>, <span class='object_link'><a href="PeopleV1/BraggingRights.html" title="Google::Apis::PeopleV1::BraggingRights (class)">BraggingRights</a></span>, <span class='object_link'><a href="PeopleV1/CalendarUrl.html" title="Google::Apis::PeopleV1::CalendarUrl (class)">CalendarUrl</a></span>, <span class='object_link'><a href="PeopleV1/ClientData.html" title="Google::Apis::PeopleV1::ClientData (class)">ClientData</a></span>, <span class='object_link'><a href="PeopleV1/ContactGroup.html" title="Google::Apis::PeopleV1::ContactGroup (class)">ContactGroup</a></span>, <span class='object_link'><a href="PeopleV1/ContactGroupMembership.html" title="Google::Apis::PeopleV1::ContactGroupMembership (class)">ContactGroupMembership</a></span>, <span class='object_link'><a href="PeopleV1/ContactGroupMetadata.html" title="Google::Apis::PeopleV1::ContactGroupMetadata (class)">ContactGroupMetadata</a></span>, <span class='object_link'><a href="PeopleV1/ContactGroupResponse.html" title="Google::Apis::PeopleV1::ContactGroupResponse (class)">ContactGroupResponse</a></span>, <span class='object_link'><a href="PeopleV1/CopyOtherContactToMyContactsGroupRequest.html" title="Google::Apis::PeopleV1::CopyOtherContactToMyContactsGroupRequest (class)">CopyOtherContactToMyContactsGroupRequest</a></span>, <span class='object_link'><a href="PeopleV1/CoverPhoto.html" title="Google::Apis::PeopleV1::CoverPhoto (class)">CoverPhoto</a></span>, <span class='object_link'><a href="PeopleV1/CreateContactGroupRequest.html" title="Google::Apis::PeopleV1::CreateContactGroupRequest (class)">CreateContactGroupRequest</a></span>, <span class='object_link'><a href="PeopleV1/Date.html" title="Google::Apis::PeopleV1::Date (class)">Date</a></span>, <span class='object_link'><a href="PeopleV1/DeleteContactPhotoResponse.html" title="Google::Apis::PeopleV1::DeleteContactPhotoResponse (class)">DeleteContactPhotoResponse</a></span>, <span class='object_link'><a href="PeopleV1/DomainMembership.html" title="Google::Apis::PeopleV1::DomainMembership (class)">DomainMembership</a></span>, <span class='object_link'><a href="PeopleV1/EmailAddress.html" title="Google::Apis::PeopleV1::EmailAddress (class)">EmailAddress</a></span>, <span class='object_link'><a href="PeopleV1/Empty.html" title="Google::Apis::PeopleV1::Empty (class)">Empty</a></span>, <span class='object_link'><a href="PeopleV1/Event.html" title="Google::Apis::PeopleV1::Event (class)">Event</a></span>, <span class='object_link'><a href="PeopleV1/ExternalId.html" title="Google::Apis::PeopleV1::ExternalId (class)">ExternalId</a></span>, <span class='object_link'><a href="PeopleV1/FieldMetadata.html" title="Google::Apis::PeopleV1::FieldMetadata (class)">FieldMetadata</a></span>, <span class='object_link'><a href="PeopleV1/FileAs.html" title="Google::Apis::PeopleV1::FileAs (class)">FileAs</a></span>, <span class='object_link'><a href="PeopleV1/Gender.html" title="Google::Apis::PeopleV1::Gender (class)">Gender</a></span>, <span class='object_link'><a href="PeopleV1/GetPeopleResponse.html" title="Google::Apis::PeopleV1::GetPeopleResponse (class)">GetPeopleResponse</a></span>, <span class='object_link'><a href="PeopleV1/ImClient.html" title="Google::Apis::PeopleV1::ImClient (class)">ImClient</a></span>, <span class='object_link'><a href="PeopleV1/Interest.html" title="Google::Apis::PeopleV1::Interest (class)">Interest</a></span>, <span class='object_link'><a href="PeopleV1/ListConnectionsResponse.html" title="Google::Apis::PeopleV1::ListConnectionsResponse (class)">ListConnectionsResponse</a></span>, <span class='object_link'><a href="PeopleV1/ListContactGroupsResponse.html" title="Google::Apis::PeopleV1::ListContactGroupsResponse (class)">ListContactGroupsResponse</a></span>, <span class='object_link'><a href="PeopleV1/ListDirectoryPeopleResponse.html" title="Google::Apis::PeopleV1::ListDirectoryPeopleResponse (class)">ListDirectoryPeopleResponse</a></span>, <span class='object_link'><a href="PeopleV1/ListOtherContactsResponse.html" title="Google::Apis::PeopleV1::ListOtherContactsResponse (class)">ListOtherContactsResponse</a></span>, <span class='object_link'><a href="PeopleV1/Locale.html" title="Google::Apis::PeopleV1::Locale (class)">Locale</a></span>, <span class='object_link'><a href="PeopleV1/Location.html" title="Google::Apis::PeopleV1::Location (class)">Location</a></span>, <span class='object_link'><a href="PeopleV1/Membership.html" title="Google::Apis::PeopleV1::Membership (class)">Membership</a></span>, <span class='object_link'><a href="PeopleV1/MiscKeyword.html" title="Google::Apis::PeopleV1::MiscKeyword (class)">MiscKeyword</a></span>, <span class='object_link'><a href="PeopleV1/ModifyContactGroupMembersRequest.html" title="Google::Apis::PeopleV1::ModifyContactGroupMembersRequest (class)">ModifyContactGroupMembersRequest</a></span>, <span class='object_link'><a href="PeopleV1/ModifyContactGroupMembersResponse.html" title="Google::Apis::PeopleV1::ModifyContactGroupMembersResponse (class)">ModifyContactGroupMembersResponse</a></span>, <span class='object_link'><a href="PeopleV1/Name.html" title="Google::Apis::PeopleV1::Name (class)">Name</a></span>, <span class='object_link'><a href="PeopleV1/Nickname.html" title="Google::Apis::PeopleV1::Nickname (class)">Nickname</a></span>, <span class='object_link'><a href="PeopleV1/Occupation.html" title="Google::Apis::PeopleV1::Occupation (class)">Occupation</a></span>, <span class='object_link'><a href="PeopleV1/Organization.html" title="Google::Apis::PeopleV1::Organization (class)">Organization</a></span>, <span class='object_link'><a href="PeopleV1/PeopleServiceService.html" title="Google::Apis::PeopleV1::PeopleServiceService (class)">PeopleServiceService</a></span>, <span class='object_link'><a href="PeopleV1/Person.html" title="Google::Apis::PeopleV1::Person (class)">Person</a></span>, <span class='object_link'><a href="PeopleV1/PersonMetadata.html" title="Google::Apis::PeopleV1::PersonMetadata (class)">PersonMetadata</a></span>, <span class='object_link'><a href="PeopleV1/PersonResponse.html" title="Google::Apis::PeopleV1::PersonResponse (class)">PersonResponse</a></span>, <span class='object_link'><a href="PeopleV1/PhoneNumber.html" title="Google::Apis::PeopleV1::PhoneNumber (class)">PhoneNumber</a></span>, <span class='object_link'><a href="PeopleV1/Photo.html" title="Google::Apis::PeopleV1::Photo (class)">Photo</a></span>, <span class='object_link'><a href="PeopleV1/ProfileMetadata.html" title="Google::Apis::PeopleV1::ProfileMetadata (class)">ProfileMetadata</a></span>, <span class='object_link'><a href="PeopleV1/Relation.html" title="Google::Apis::PeopleV1::Relation (class)">Relation</a></span>, <span class='object_link'><a href="PeopleV1/RelationshipInterest.html" title="Google::Apis::PeopleV1::RelationshipInterest (class)">RelationshipInterest</a></span>, <span class='object_link'><a href="PeopleV1/RelationshipStatus.html" title="Google::Apis::PeopleV1::RelationshipStatus (class)">RelationshipStatus</a></span>, <span class='object_link'><a href="PeopleV1/Residence.html" title="Google::Apis::PeopleV1::Residence (class)">Residence</a></span>, <span class='object_link'><a href="PeopleV1/SearchDirectoryPeopleResponse.html" title="Google::Apis::PeopleV1::SearchDirectoryPeopleResponse (class)">SearchDirectoryPeopleResponse</a></span>, <span class='object_link'><a href="PeopleV1/SipAddress.html" title="Google::Apis::PeopleV1::SipAddress (class)">SipAddress</a></span>, <span class='object_link'><a href="PeopleV1/Skill.html" title="Google::Apis::PeopleV1::Skill (class)">Skill</a></span>, <span class='object_link'><a href="PeopleV1/Source.html" title="Google::Apis::PeopleV1::Source (class)">Source</a></span>, <span class='object_link'><a href="PeopleV1/Status.html" title="Google::Apis::PeopleV1::Status (class)">Status</a></span>, <span class='object_link'><a href="PeopleV1/Tagline.html" title="Google::Apis::PeopleV1::Tagline (class)">Tagline</a></span>, <span class='object_link'><a href="PeopleV1/UpdateContactGroupRequest.html" title="Google::Apis::PeopleV1::UpdateContactGroupRequest (class)">UpdateContactGroupRequest</a></span>, <span class='object_link'><a href="PeopleV1/UpdateContactPhotoRequest.html" title="Google::Apis::PeopleV1::UpdateContactPhotoRequest (class)">UpdateContactPhotoRequest</a></span>, <span class='object_link'><a href="PeopleV1/UpdateContactPhotoResponse.html" title="Google::Apis::PeopleV1::UpdateContactPhotoResponse (class)">UpdateContactPhotoResponse</a></span>, <span class='object_link'><a href="PeopleV1/Url.html" title="Google::Apis::PeopleV1::Url (class)">Url</a></span>, <span class='object_link'><a href="PeopleV1/UserDefined.html" title="Google::Apis::PeopleV1::UserDefined (class)">UserDefined</a></span> </p> <h2> Constant Summary <small><a href="#" class="constants_summary_toggle">collapse</a></small> </h2> <dl class="constants"> <dt id="VERSION-constant" class="">VERSION = </dt> <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>V1</span><span class='tstring_end'>'</span></span></pre></dd> <dt id="REVISION-constant" class="">REVISION = </dt> <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>20201117</span><span class='tstring_end'>'</span></span></pre></dd> <dt id="AUTH_CONTACTS-constant" class="">AUTH_CONTACTS = <div class="docstring"> <div class="discussion"> <p>See, edit, download, and permanently delete your contacts</p> </div> </div> <div class="tags"> </div> </dt> <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://www.googleapis.com/auth/contacts</span><span class='tstring_end'>'</span></span></pre></dd> <dt id="AUTH_CONTACTS_OTHER_READONLY-constant" class="">AUTH_CONTACTS_OTHER_READONLY = <div class="docstring"> <div class="discussion"> <p>See and download contact info automatically saved in your "Other contacts"</p> </div> </div> <div class="tags"> </div> </dt> <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://www.googleapis.com/auth/contacts.other.readonly</span><span class='tstring_end'>'</span></span></pre></dd> <dt id="AUTH_CONTACTS_READONLY-constant" class="">AUTH_CONTACTS_READONLY = <div class="docstring"> <div class="discussion"> <p>See and download your contacts</p> </div> </div> <div class="tags"> </div> </dt> <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://www.googleapis.com/auth/contacts.readonly</span><span class='tstring_end'>'</span></span></pre></dd> <dt id="AUTH_DIRECTORY_READONLY-constant" class="">AUTH_DIRECTORY_READONLY = <div class="docstring"> <div class="discussion"> <p>See and download your organization's GSuite directory</p> </div> </div> <div class="tags"> </div> </dt> <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://www.googleapis.com/auth/directory.readonly</span><span class='tstring_end'>'</span></span></pre></dd> <dt id="AUTH_USER_ADDRESSES_READ-constant" class="">AUTH_USER_ADDRESSES_READ = <div class="docstring"> <div class="discussion"> <p>View your street addresses</p> </div> </div> <div class="tags"> </div> </dt> <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://www.googleapis.com/auth/user.addresses.read</span><span class='tstring_end'>'</span></span></pre></dd> <dt id="AUTH_USER_BIRTHDAY_READ-constant" class="">AUTH_USER_BIRTHDAY_READ = <div class="docstring"> <div class="discussion"> <p>View your complete date of birth</p> </div> </div> <div class="tags"> </div> </dt> <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://www.googleapis.com/auth/user.birthday.read</span><span class='tstring_end'>'</span></span></pre></dd> <dt id="AUTH_USER_EMAILS_READ-constant" class="">AUTH_USER_EMAILS_READ = <div class="docstring"> <div class="discussion"> <p>View your email addresses</p> </div> </div> <div class="tags"> </div> </dt> <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://www.googleapis.com/auth/user.emails.read</span><span class='tstring_end'>'</span></span></pre></dd> <dt id="AUTH_USER_GENDER_READ-constant" class="">AUTH_USER_GENDER_READ = <div class="docstring"> <div class="discussion"> <p>See your gender</p> </div> </div> <div class="tags"> </div> </dt> <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://www.googleapis.com/auth/user.gender.read</span><span class='tstring_end'>'</span></span></pre></dd> <dt id="AUTH_USER_ORGANIZATION_READ-constant" class="">AUTH_USER_ORGANIZATION_READ = <div class="docstring"> <div class="discussion"> <p>See your education, work history and org info</p> </div> </div> <div class="tags"> </div> </dt> <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://www.googleapis.com/auth/user.organization.read</span><span class='tstring_end'>'</span></span></pre></dd> <dt id="AUTH_USER_PHONENUMBERS_READ-constant" class="">AUTH_USER_PHONENUMBERS_READ = <div class="docstring"> <div class="discussion"> <p>View your phone numbers</p> </div> </div> <div class="tags"> </div> </dt> <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://www.googleapis.com/auth/user.phonenumbers.read</span><span class='tstring_end'>'</span></span></pre></dd> <dt id="AUTH_USERINFO_EMAIL-constant" class="">AUTH_USERINFO_EMAIL = <div class="docstring"> <div class="discussion"> <p>View your email address</p> </div> </div> <div class="tags"> </div> </dt> <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://www.googleapis.com/auth/userinfo.email</span><span class='tstring_end'>'</span></span></pre></dd> <dt id="AUTH_USERINFO_PROFILE-constant" class="">AUTH_USERINFO_PROFILE = <div class="docstring"> <div class="discussion"> <p>See your personal info, including any personal info you've made publicly available</p> </div> </div> <div class="tags"> </div> </dt> <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://www.googleapis.com/auth/userinfo.profile</span><span class='tstring_end'>'</span></span></pre></dd> </dl> </div> <div id="footer"> Generated on Mon Jan 18 18:30:47 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-2.6.6). </div> </div> <script src="/yoshi.js"></script> </body> </html>