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