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