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