blob: 80d8d817cb8cbcc915760149838056240b236325 [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001<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">
78 <code><a href="#list">list(resourceName, pageSize=None, x__xgafv=None, pageToken=None, sortOrder=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 linked profiles.</p>
80<p class="toc_element">
81 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="list">list(resourceName, pageSize=None, x__xgafv=None, pageToken=None, sortOrder=None, syncToken=None, requestMask_includeField=None)</code>
86 <pre>Provides a list of the authenticated user's contacts merged with any linked profiles.
87
88Args:
89 resourceName: string, The resource name to return connections for. Only `people/me` is valid. (required)
90 pageSize: integer, The number of connections to include in the response. Valid values are between 1 and 500, inclusive. Defaults to 100.
91 x__xgafv: string, V1 error format.
92 pageToken: string, The token of the page to be returned.
93 sortOrder: string, The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`.
94 syncToken: string, A sync token, returned by a previous call to `people.connections.list`. Only resources changed since the sync token was created are returned.
95 requestMask_includeField: string, Comma-separated list of fields to be included in the response. Omitting this field will include all fields. Each path should start with `person.`: for example, `person.names` or `person.photos`.
96
97Returns:
98 An object of the form:
99
100 {
101 "connections": [ # The list of people that the requestor is connected to.
102 { # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Fields other than IDs, metadata, and group memberships are user-edited. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.
103 "phoneNumbers": [ # The person's phone numbers.
104 { # A person's phone number.
105 "canonicalForm": "A String", # The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
106 "formattedType": "A String", # The read-only type of the phone number translated and formatted in the viewer's account locale or the the `Accept-Language` HTTP header locale.
107 "type": "A String", # The type of the phone number. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
108 "value": "A String", # The phone number.
109 "metadata": { # Metadata about a field. # Metadata about the phone number.
110 "source": { # The source of a field. # The source of the field.
111 "type": "A String", # The source type.
112 "id": "A String", # A unique identifier within the source type generated by the server.
113 },
114 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
115 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
116 },
117 },
118 ],
119 "addresses": [ # The person's street addresses.
120 { # A person's physical address. May be a P.O. box or street address. All fields are optional.
121 "formattedType": "A String", # The read-only type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
122 "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
123 "city": "A String", # The city of the address.
124 "formattedValue": "A String", # The read-only value of the address formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
125 "region": "A String", # The region of the address; for example, the state or province.
126 "poBox": "A String", # The P.O. box of the address.
127 "streetAddress": "A String", # The street address.
128 "country": "A String", # The country of the address.
129 "postalCode": "A String", # The postal code of the address.
130 "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
131 "type": "A String", # The type of the address. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
132 "metadata": { # Metadata about a field. # Metadata about the address.
133 "source": { # The source of a field. # The source of the field.
134 "type": "A String", # The source type.
135 "id": "A String", # A unique identifier within the source type generated by the server.
136 },
137 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
138 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
139 },
140 },
141 ],
142 "nicknames": [ # The person's nicknames.
143 { # A person's nickname.
144 "type": "A String", # The type of the nickname.
145 "value": "A String", # The nickname.
146 "metadata": { # Metadata about a field. # Metadata about the nickname.
147 "source": { # The source of a field. # The source of the field.
148 "type": "A String", # The source type.
149 "id": "A String", # A unique identifier within the source type generated by the server.
150 },
151 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
152 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
153 },
154 },
155 ],
156 "occupations": [ # The person's occupations.
157 { # A person's occupation.
158 "value": "A String", # The occupation; for example, `carpenter`.
159 "metadata": { # Metadata about a field. # Metadata about the occupation.
160 "source": { # The source of a field. # The source of the field.
161 "type": "A String", # The source type.
162 "id": "A String", # A unique identifier within the source type generated by the server.
163 },
164 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
165 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
166 },
167 },
168 ],
169 "braggingRights": [ # The person's bragging rights.
170 { # A person's bragging rights.
171 "value": "A String", # The bragging rights; for example, `climbed mount everest`.
172 "metadata": { # Metadata about a field. # Metadata about the bragging rights.
173 "source": { # The source of a field. # The source of the field.
174 "type": "A String", # The source type.
175 "id": "A String", # A unique identifier within the source type generated by the server.
176 },
177 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
178 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
179 },
180 },
181 ],
182 "names": [ # The person's names.
183 { # A person's name. If the name is a mononym, the family name is empty.
184 "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
185 "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
186 "phoneticFamilyName": "A String", # The family name spelled as it sounds.
187 "displayName": "A String", # The display name formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header.
188 "middleName": "A String", # The middle name(s).
189 "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
190 "familyName": "A String", # The family name.
191 "phoneticGivenName": "A String", # The given name spelled as it sounds.
192 "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
193 "givenName": "A String", # The given name.
194 "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
195 "metadata": { # Metadata about a field. # Metadata about the name.
196 "source": { # The source of a field. # The source of the field.
197 "type": "A String", # The source type.
198 "id": "A String", # A unique identifier within the source type generated by the server.
199 },
200 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
201 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
202 },
203 },
204 ],
205 "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters. Always starts with `people/`.
206 "birthdays": [ # The person's birthdays.
207 { # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.
208 "date": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The date of the birthday.
209 "month": 42, # Month of year. Must be from 1 to 12.
210 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
211 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
212 },
213 "text": "A String", # A free-form string representing the user's birthday.
214 "metadata": { # Metadata about a field. # Metadata about the birthday.
215 "source": { # The source of a field. # The source of the field.
216 "type": "A String", # The source type.
217 "id": "A String", # A unique identifier within the source type generated by the server.
218 },
219 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
220 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
221 },
222 },
223 ],
224 "relations": [ # The person's relations.
225 { # A person's relation to another person.
226 "person": "A String", # The name of the other person this relation refers to.
227 "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
228 "type": "A String", # The person's relation to the other person. The type can be custom or predefined. Possible values include, but are not limited to, the following values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
229 "metadata": { # Metadata about a field. # Metadata about the relation.
230 "source": { # The source of a field. # The source of the field.
231 "type": "A String", # The source type.
232 "id": "A String", # A unique identifier within the source type generated by the server.
233 },
234 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
235 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
236 },
237 },
238 ],
239 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
240 "relationshipStatuses": [ # The person's relationship statuses.
241 { # A person's relationship status.
242 "formattedValue": "A String", # The read-only value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
243 "value": "A String", # The relationship status. The value can be custom or predefined. Possible values include, but are not limited to, the following: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
244 "metadata": { # Metadata about a field. # Metadata about the relationship status.
245 "source": { # The source of a field. # The source of the field.
246 "type": "A String", # The source type.
247 "id": "A String", # A unique identifier within the source type generated by the server.
248 },
249 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
250 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
251 },
252 },
253 ],
254 "skills": [ # The person's skills.
255 { # A skill that the person has.
256 "value": "A String", # The skill; for example, `underwater basket weaving`.
257 "metadata": { # Metadata about a field. # Metadata about the skill.
258 "source": { # The source of a field. # The source of the field.
259 "type": "A String", # The source type.
260 "id": "A String", # A unique identifier within the source type generated by the server.
261 },
262 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
263 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
264 },
265 },
266 ],
267 "imClients": [ # The person's instant messaging clients.
268 { # A person's instant messaging client.
269 "username": "A String", # The user name used in the IM client.
270 "formattedType": "A String", # The read-only type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
271 "protocol": "A String", # The protocol of the IM client. The protocol can be custom or predefined. Possible values include, but are not limited to, the following: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
272 "formattedProtocol": "A String", # The read-only protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
273 "type": "A String", # The type of the IM client. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
274 "metadata": { # Metadata about a field. # Metadata about the IM client.
275 "source": { # The source of a field. # The source of the field.
276 "type": "A String", # The source type.
277 "id": "A String", # A unique identifier within the source type generated by the server.
278 },
279 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
280 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
281 },
282 },
283 ],
284 "events": [ # The person's events.
285 { # An event related to the person.
286 "date": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The date of the event.
287 "month": 42, # Month of year. Must be from 1 to 12.
288 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
289 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
290 },
291 "formattedType": "A String", # The read-only type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
292 "type": "A String", # The type of the event. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `anniversary` * `other`
293 "metadata": { # Metadata about a field. # Metadata about the event.
294 "source": { # The source of a field. # The source of the field.
295 "type": "A String", # The source type.
296 "id": "A String", # A unique identifier within the source type generated by the server.
297 },
298 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
299 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
300 },
301 },
302 ],
303 "metadata": { # Metadata about a person. # Metadata about the person.
304 "previousResourceNames": [ # Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
305 "A String",
306 ],
307 "sources": [ # The sources of data for the person.
308 { # The source of a field.
309 "type": "A String", # The source type.
310 "id": "A String", # A unique identifier within the source type generated by the server.
311 },
312 ],
313 "deleted": True or False, # True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
314 "objectType": "A String", # The type of the person object.
315 },
316 "interests": [ # The person's interests.
317 { # One of the person's interests.
318 "value": "A String", # The interest; for example, `stargazing`.
319 "metadata": { # Metadata about a field. # Metadata about the interest.
320 "source": { # The source of a field. # The source of the field.
321 "type": "A String", # The source type.
322 "id": "A String", # A unique identifier within the source type generated by the server.
323 },
324 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
325 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
326 },
327 },
328 ],
329 "photos": [ # The person's photos.
330 { # A person's photo. A picture shown next to the person's name to help others recognize the person.
331 "url": "A String", # The URL of the photo.
332 "metadata": { # Metadata about a field. # Metadata about the photo.
333 "source": { # The source of a field. # The source of the field.
334 "type": "A String", # The source type.
335 "id": "A String", # A unique identifier within the source type generated by the server.
336 },
337 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
338 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
339 },
340 },
341 ],
342 "residences": [ # The person's residences.
343 { # A person's past or current residence.
344 "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
345 "value": "A String", # The address of the residence.
346 "metadata": { # Metadata about a field. # Metadata about the residence.
347 "source": { # The source of a field. # The source of the field.
348 "type": "A String", # The source type.
349 "id": "A String", # A unique identifier within the source type generated by the server.
350 },
351 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
352 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
353 },
354 },
355 ],
356 "relationshipInterests": [ # The kind of relationship the person is looking for.
357 { # The kind of relationship the person is looking for.
358 "formattedValue": "A String", # The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
359 "value": "A String", # The kind of relationship the person is looking for. The value can be custom or predefined. Possible values include, but are not limited to, the following values: * `friend` * `date` * `relationship` * `networking`
360 "metadata": { # Metadata about a field. # Metadata about the relationship interest.
361 "source": { # The source of a field. # The source of the field.
362 "type": "A String", # The source type.
363 "id": "A String", # A unique identifier within the source type generated by the server.
364 },
365 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
366 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
367 },
368 },
369 ],
370 "coverPhotos": [ # The person's cover photos.
371 { # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
372 "url": "A String", # The URL of the cover photo.
373 "default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
374 "metadata": { # Metadata about a field. # Metadata about the cover photo.
375 "source": { # The source of a field. # The source of the field.
376 "type": "A String", # The source type.
377 "id": "A String", # A unique identifier within the source type generated by the server.
378 },
379 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
380 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
381 },
382 },
383 ],
384 "locales": [ # The person's locale preferences.
385 { # A person's locale preference.
386 "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
387 "metadata": { # Metadata about a field. # Metadata about the locale.
388 "source": { # The source of a field. # The source of the field.
389 "type": "A String", # The source type.
390 "id": "A String", # A unique identifier within the source type generated by the server.
391 },
392 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
393 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
394 },
395 },
396 ],
397 "organizations": [ # The person's past or current organizations.
398 { # A person's past or current organization. Overlapping date ranges are permitted.
399 "formattedType": "A String", # The read-only type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
400 "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
401 "endDate": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The end date when the person left the organization.
402 "month": 42, # Month of year. Must be from 1 to 12.
403 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
404 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
405 },
406 "name": "A String", # The name of the organization.
407 "startDate": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The start date when the person joined the organization.
408 "month": 42, # Month of year. Must be from 1 to 12.
409 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
410 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
411 },
412 "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
413 "title": "A String", # The person's job title at the organization.
414 "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
415 "jobDescription": "A String", # The person's job description at the organization.
416 "location": "A String", # The location of the organization office the person works at.
417 "department": "A String", # The person's department at the organization.
418 "type": "A String", # The type of the organization. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `work` * `school`
419 "phoneticName": "A String", # The phonetic name of the organization.
420 "metadata": { # Metadata about a field. # Metadata about the organization.
421 "source": { # The source of a field. # The source of the field.
422 "type": "A String", # The source type.
423 "id": "A String", # A unique identifier within the source type generated by the server.
424 },
425 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
426 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
427 },
428 },
429 ],
430 "biographies": [ # The person's biographies.
431 { # A person's short biography.
432 "value": "A String", # The short biography.
433 "metadata": { # Metadata about a field. # Metadata about the biography.
434 "source": { # The source of a field. # The source of the field.
435 "type": "A String", # The source type.
436 "id": "A String", # A unique identifier within the source type generated by the server.
437 },
438 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
439 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
440 },
441 },
442 ],
443 "memberships": [ # The person's group memberships.
444 { # A person's membership in a group.
445 "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
446 "contactGroupId": "A String", # The contact group ID for the contact group membership. The contact group ID can be custom or predefined. Possible values include, but are not limited to, the following: * `myContacts` * `starred` * A numerical ID for user-created groups.
447 },
448 "domainMembership": { # A Google Apps Domain membership. # The domain membership.
449 "inViewerDomain": True or False, # True if the person is in the viewer's Google Apps domain.
450 },
451 "metadata": { # Metadata about a field. # Metadata about the membership.
452 "source": { # The source of a field. # The source of the field.
453 "type": "A String", # The source type.
454 "id": "A String", # A unique identifier within the source type generated by the server.
455 },
456 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
457 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
458 },
459 },
460 ],
461 "taglines": [ # The person's taglines.
462 { # A brief one-line description of the person.
463 "value": "A String", # The tagline.
464 "metadata": { # Metadata about a field. # Metadata about the tagline.
465 "source": { # The source of a field. # The source of the field.
466 "type": "A String", # The source type.
467 "id": "A String", # A unique identifier within the source type generated by the server.
468 },
469 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
470 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
471 },
472 },
473 ],
474 "urls": [ # The person's associated URLs.
475 { # A person's associated URLs.
476 "formattedType": "A String", # The read-only type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
477 "type": "A String", # The type of the URL. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Google+ application. * `other`
478 "value": "A String", # The URL.
479 "metadata": { # Metadata about a field. # Metadata about the URL.
480 "source": { # The source of a field. # The source of the field.
481 "type": "A String", # The source type.
482 "id": "A String", # A unique identifier within the source type generated by the server.
483 },
484 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
485 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
486 },
487 },
488 ],
489 "ageRange": "A String", # The person's age range.
490 "genders": [ # The person's genders.
491 { # A person's gender.
492 "formattedValue": "A String", # The read-only value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
493 "value": "A String", # The gender for the person. The gender can be custom or predefined. Possible values include, but are not limited to, the following: * `male` * `female` * `other` * `unknown`
494 "metadata": { # Metadata about a field. # Metadata about the gender.
495 "source": { # The source of a field. # The source of the field.
496 "type": "A String", # The source type.
497 "id": "A String", # A unique identifier within the source type generated by the server.
498 },
499 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
500 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
501 },
502 },
503 ],
504 "emailAddresses": [ # The person's email addresses.
505 { # A person's email address.
506 "formattedType": "A String", # The read-only type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
507 "type": "A String", # The type of the email address. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
508 "value": "A String", # The email address.
509 "metadata": { # Metadata about a field. # Metadata about the email address.
510 "source": { # The source of a field. # The source of the field.
511 "type": "A String", # The source type.
512 "id": "A String", # A unique identifier within the source type generated by the server.
513 },
514 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
515 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
516 },
517 },
518 ],
519 },
520 ],
521 "nextPageToken": "A String", # The token that can be used to retrieve the next page of results.
522 "nextSyncToken": "A String", # The token that can be used to retrieve changes since the last request.
523 }</pre>
524</div>
525
526<div class="method">
527 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
528 <pre>Retrieves the next page of results.
529
530Args:
531 previous_request: The request for the previous page. (required)
532 previous_response: The response from the request for the previous page. (required)
533
534Returns:
535 A request object that you can call 'execute()' on to request the next
536 page. Returns None if there are no more items in the collection.
537 </pre>
538</div>
539
540</body></html>