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">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="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#list">list(resourceName, pageSize=None, pageToken=None, personFields=None, requestMask_includeField=None, requestSyncToken=None, sortOrder=None, sources=None, syncToken=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Provides a list of the authenticated user's contacts. Sync tokens expire 7 days after the full sync. A request with an expired sync token will result in a 410 error. In the case of such an error clients should make a full sync request without a `sync_token`. The first page of a full sync request has an additional quota. If the quota is exceeded, a 429 error will be returned. This quota is fixed and can not be increased. When the `sync_token` is specified, resources deleted since the last sync will be returned as a person with `PersonMetadata.deleted` set to true. When the `page_token` or `sync_token` is specified, all other request parameters must match the first call. Writes may have a propagation delay of several minutes for sync requests. Incremental syncs are not intended for read-after-write use cases. See example usage at [List the user's contacts that have changed](/people/v1/contacts#list_the_users_contacts_that_have_changed).</p> 83<p class="toc_element"> 84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 85<p class="firstline">Retrieves the next page of results.</p> 86<h3>Method Details</h3> 87<div class="method"> 88 <code class="details" id="close">close()</code> 89 <pre>Close httplib2 connections.</pre> 90</div> 91 92<div class="method"> 93 <code class="details" id="list">list(resourceName, pageSize=None, pageToken=None, personFields=None, requestMask_includeField=None, requestSyncToken=None, sortOrder=None, sources=None, syncToken=None, x__xgafv=None)</code> 94 <pre>Provides a list of the authenticated user's contacts. Sync tokens expire 7 days after the full sync. A request with an expired sync token will result in a 410 error. In the case of such an error clients should make a full sync request without a `sync_token`. The first page of a full sync request has an additional quota. If the quota is exceeded, a 429 error will be returned. This quota is fixed and can not be increased. When the `sync_token` is specified, resources deleted since the last sync will be returned as a person with `PersonMetadata.deleted` set to true. When the `page_token` or `sync_token` is specified, all other request parameters must match the first call. Writes may have a propagation delay of several minutes for sync requests. Incremental syncs are not intended for read-after-write use cases. See example usage at [List the user's contacts that have changed](/people/v1/contacts#list_the_users_contacts_that_have_changed). 95 96Args: 97 resourceName: string, Required. The resource name to return connections for. Only `people/me` is valid. (required) 98 pageSize: integer, Optional. The number of connections to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0. 99 pageToken: string, Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `people.connections.list` must match the first call that provided the page token. 100 personFields: string, Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined 101 requestMask_includeField: string, Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`. 102 requestSyncToken: boolean, Optional. Whether the response should return `next_sync_token` on the last page of results. It can be used to get incremental changes since the last request by setting it on the request `sync_token`. More details about sync behavior at `people.connections.list`. 103 sortOrder: string, Optional. The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`. 104 Allowed values 105 LAST_MODIFIED_ASCENDING - Sort people by when they were changed; older entries first. 106 LAST_MODIFIED_DESCENDING - Sort people by when they were changed; newer entries first. 107 FIRST_NAME_ASCENDING - Sort people by first name. 108 LAST_NAME_ASCENDING - Sort people by last name. 109 sources: string, Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set. (repeated) 110 Allowed values 111 READ_SOURCE_TYPE_UNSPECIFIED - Unspecified. 112 READ_SOURCE_TYPE_PROFILE - Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE. 113 READ_SOURCE_TYPE_CONTACT - Returns SourceType.CONTACT. 114 READ_SOURCE_TYPE_DOMAIN_CONTACT - Returns SourceType.DOMAIN_CONTACT. 115 syncToken: string, Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `people.connections.list` must match the first call that provided the sync token. More details about sync behavior at `people.connections.list`. 116 x__xgafv: string, V1 error format. 117 Allowed values 118 1 - v1 error format 119 2 - v2 error format 120 121Returns: 122 An object of the form: 123 124 { # The response to a request for the authenticated user's connections. 125 "connections": [ # The list of people that the requestor is connected to. 126 { # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. 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. 127 "addresses": [ # The person's street addresses. 128 { # A person's physical address. May be a P.O. box or street address. All fields are optional. 129 "city": "A String", # The city of the address. 130 "country": "A String", # The country of the address. 131 "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address. 132 "extendedAddress": "A String", # The extended address of the address; for example, the apartment number. 133 "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. 134 "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values. 135 "metadata": { # Metadata about a field. # Metadata about the address. 136 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 137 "source": { # The source of a field. # The source of the field. 138 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 139 "id": "A String", # The unique identifier within the source type generated by the server. 140 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 141 "objectType": "A String", # Output only. The profile object type. 142 "userTypes": [ # Output only. The user types. 143 "A String", 144 ], 145 }, 146 "type": "A String", # The source type. 147 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 148 }, 149 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 150 "verified": True or False, # Output only. 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. 151 }, 152 "poBox": "A String", # The P.O. box of the address. 153 "postalCode": "A String", # The postal code of the address. 154 "region": "A String", # The region of the address; for example, the state or province. 155 "streetAddress": "A String", # The street address. 156 "type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other` 157 }, 158 ], 159 "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range. 160 "ageRanges": [ # Output only. The person's age ranges. 161 { # A person's age range. 162 "ageRange": "A String", # The age range. 163 "metadata": { # Metadata about a field. # Metadata about the age range. 164 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 165 "source": { # The source of a field. # The source of the field. 166 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 167 "id": "A String", # The unique identifier within the source type generated by the server. 168 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 169 "objectType": "A String", # Output only. The profile object type. 170 "userTypes": [ # Output only. The user types. 171 "A String", 172 ], 173 }, 174 "type": "A String", # The source type. 175 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 176 }, 177 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 178 "verified": True or False, # Output only. 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. 179 }, 180 }, 181 ], 182 "biographies": [ # The person's biographies. This field is a singleton for contact sources. 183 { # A person's short biography. 184 "contentType": "A String", # The content type of the biography. 185 "metadata": { # Metadata about a field. # Metadata about the biography. 186 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 187 "source": { # The source of a field. # The source of the field. 188 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 189 "id": "A String", # The unique identifier within the source type generated by the server. 190 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 191 "objectType": "A String", # Output only. The profile object type. 192 "userTypes": [ # Output only. The user types. 193 "A String", 194 ], 195 }, 196 "type": "A String", # The source type. 197 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 198 }, 199 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 200 "verified": True or False, # Output only. 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 }, 202 "value": "A String", # The short biography. 203 }, 204 ], 205 "birthdays": [ # The person's birthdays. This field is a singleton for contact sources. 206 { # 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. 207 "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the birthday. 208 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 209 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 210 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 211 }, 212 "metadata": { # Metadata about a field. # Metadata about the birthday. 213 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 214 "source": { # The source of a field. # The source of the field. 215 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 216 "id": "A String", # The unique identifier within the source type generated by the server. 217 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 218 "objectType": "A String", # Output only. The profile object type. 219 "userTypes": [ # Output only. The user types. 220 "A String", 221 ], 222 }, 223 "type": "A String", # The source type. 224 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 225 }, 226 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 227 "verified": True or False, # Output only. 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. 228 }, 229 "text": "A String", # A free-form string representing the user's birthday. 230 }, 231 ], 232 "braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights. 233 { # **DEPRECATED**: No data will be returned A person's bragging rights. 234 "metadata": { # Metadata about a field. # Metadata about the bragging rights. 235 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 236 "source": { # The source of a field. # The source of the field. 237 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 238 "id": "A String", # The unique identifier within the source type generated by the server. 239 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 240 "objectType": "A String", # Output only. The profile object type. 241 "userTypes": [ # Output only. The user types. 242 "A String", 243 ], 244 }, 245 "type": "A String", # The source type. 246 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 247 }, 248 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 249 "verified": True or False, # Output only. 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 }, 251 "value": "A String", # The bragging rights; for example, `climbed mount everest`. 252 }, 253 ], 254 "calendarUrls": [ # The person's calendar URLs. 255 { # A person's calendar URL. 256 "formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. 257 "metadata": { # Metadata about a field. # Metadata about the calendar URL. 258 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 259 "source": { # The source of a field. # The source of the field. 260 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 261 "id": "A String", # The unique identifier within the source type generated by the server. 262 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 263 "objectType": "A String", # Output only. The profile object type. 264 "userTypes": [ # Output only. The user types. 265 "A String", 266 ], 267 }, 268 "type": "A String", # The source type. 269 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 270 }, 271 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 272 "verified": True or False, # Output only. 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. 273 }, 274 "type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work` 275 "url": "A String", # The calendar URL. 276 }, 277 ], 278 "clientData": [ # The person's client data. 279 { # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed. 280 "key": "A String", # The client specified key of the client data. 281 "metadata": { # Metadata about a field. # Metadata about the client data. 282 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 283 "source": { # The source of a field. # The source of the field. 284 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 285 "id": "A String", # The unique identifier within the source type generated by the server. 286 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 287 "objectType": "A String", # Output only. The profile object type. 288 "userTypes": [ # Output only. The user types. 289 "A String", 290 ], 291 }, 292 "type": "A String", # The source type. 293 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 294 }, 295 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 296 "verified": True or False, # Output only. 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. 297 }, 298 "value": "A String", # The client specified value of the client data. 299 }, 300 ], 301 "coverPhotos": [ # Output only. The person's cover photos. 302 { # 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. 303 "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. 304 "metadata": { # Metadata about a field. # Metadata about the cover photo. 305 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 306 "source": { # The source of a field. # The source of the field. 307 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 308 "id": "A String", # The unique identifier within the source type generated by the server. 309 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 310 "objectType": "A String", # Output only. The profile object type. 311 "userTypes": [ # Output only. The user types. 312 "A String", 313 ], 314 }, 315 "type": "A String", # The source type. 316 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 317 }, 318 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 319 "verified": True or False, # Output only. 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. 320 }, 321 "url": "A String", # The URL of the cover photo. 322 }, 323 ], 324 "emailAddresses": [ # The person's email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople. 325 { # A person's email address. 326 "displayName": "A String", # The display name of the email. 327 "formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. 328 "metadata": { # Metadata about a field. # Metadata about the email address. 329 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 330 "source": { # The source of a field. # The source of the field. 331 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 332 "id": "A String", # The unique identifier within the source type generated by the server. 333 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 334 "objectType": "A String", # Output only. The profile object type. 335 "userTypes": [ # Output only. The user types. 336 "A String", 337 ], 338 }, 339 "type": "A String", # The source type. 340 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 341 }, 342 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 343 "verified": True or False, # Output only. 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. 344 }, 345 "type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other` 346 "value": "A String", # The email address. 347 }, 348 ], 349 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation. 350 "events": [ # The person's events. 351 { # An event related to the person. 352 "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the event. 353 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 354 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 355 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 356 }, 357 "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. 358 "metadata": { # Metadata about a field. # Metadata about the event. 359 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 360 "source": { # The source of a field. # The source of the field. 361 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 362 "id": "A String", # The unique identifier within the source type generated by the server. 363 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 364 "objectType": "A String", # Output only. The profile object type. 365 "userTypes": [ # Output only. The user types. 366 "A String", 367 ], 368 }, 369 "type": "A String", # The source type. 370 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 371 }, 372 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 373 "verified": True or False, # Output only. 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. 374 }, 375 "type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other` 376 }, 377 ], 378 "externalIds": [ # The person's external IDs. 379 { # An identifier from an external entity related to the person. 380 "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. 381 "metadata": { # Metadata about a field. # Metadata about the external ID. 382 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 383 "source": { # The source of a field. # The source of the field. 384 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 385 "id": "A String", # The unique identifier within the source type generated by the server. 386 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 387 "objectType": "A String", # Output only. The profile object type. 388 "userTypes": [ # Output only. The user types. 389 "A String", 390 ], 391 }, 392 "type": "A String", # The source type. 393 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 394 }, 395 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 396 "verified": True or False, # Output only. 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. 397 }, 398 "type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization` 399 "value": "A String", # The value of the external ID. 400 }, 401 ], 402 "fileAses": [ # The person's file-ases. 403 { # The name that should be used to sort the person in a list. 404 "metadata": { # Metadata about a field. # Metadata about the file-as. 405 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 406 "source": { # The source of a field. # The source of the field. 407 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 408 "id": "A String", # The unique identifier within the source type generated by the server. 409 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 410 "objectType": "A String", # Output only. The profile object type. 411 "userTypes": [ # Output only. The user types. 412 "A String", 413 ], 414 }, 415 "type": "A String", # The source type. 416 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 417 }, 418 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 419 "verified": True or False, # Output only. 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. 420 }, 421 "value": "A String", # The file-as value 422 }, 423 ], 424 "genders": [ # The person's genders. This field is a singleton for contact sources. 425 { # A person's gender. 426 "addressMeAs": "A String", # Free form text field for pronouns that should be used to address the person. Common values are: * `he`/`him` * `she`/`her` * `they`/`them` 427 "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized. 428 "metadata": { # Metadata about a field. # Metadata about the gender. 429 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 430 "source": { # The source of a field. # The source of the field. 431 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 432 "id": "A String", # The unique identifier within the source type generated by the server. 433 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 434 "objectType": "A String", # Output only. The profile object type. 435 "userTypes": [ # Output only. The user types. 436 "A String", 437 ], 438 }, 439 "type": "A String", # The source type. 440 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 441 }, 442 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 443 "verified": True or False, # Output only. 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. 444 }, 445 "value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified` 446 }, 447 ], 448 "imClients": [ # The person's instant messaging clients. 449 { # A person's instant messaging client. 450 "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. 451 "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. 452 "metadata": { # Metadata about a field. # Metadata about the IM client. 453 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 454 "source": { # The source of a field. # The source of the field. 455 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 456 "id": "A String", # The unique identifier within the source type generated by the server. 457 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 458 "objectType": "A String", # Output only. The profile object type. 459 "userTypes": [ # Output only. The user types. 460 "A String", 461 ], 462 }, 463 "type": "A String", # The source type. 464 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 465 }, 466 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 467 "verified": True or False, # Output only. 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. 468 }, 469 "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting` 470 "type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other` 471 "username": "A String", # The user name used in the IM client. 472 }, 473 ], 474 "interests": [ # The person's interests. 475 { # One of the person's interests. 476 "metadata": { # Metadata about a field. # Metadata about the interest. 477 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 478 "source": { # The source of a field. # The source of the field. 479 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 480 "id": "A String", # The unique identifier within the source type generated by the server. 481 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 482 "objectType": "A String", # Output only. The profile object type. 483 "userTypes": [ # Output only. The user types. 484 "A String", 485 ], 486 }, 487 "type": "A String", # The source type. 488 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 489 }, 490 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 491 "verified": True or False, # Output only. 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. 492 }, 493 "value": "A String", # The interest; for example, `stargazing`. 494 }, 495 ], 496 "locales": [ # The person's locale preferences. 497 { # A person's locale preference. 498 "metadata": { # Metadata about a field. # Metadata about the locale. 499 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 500 "source": { # The source of a field. # The source of the field. 501 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 502 "id": "A String", # The unique identifier within the source type generated by the server. 503 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 504 "objectType": "A String", # Output only. The profile object type. 505 "userTypes": [ # Output only. The user types. 506 "A String", 507 ], 508 }, 509 "type": "A String", # The source type. 510 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 511 }, 512 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 513 "verified": True or False, # Output only. 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. 514 }, 515 "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale. 516 }, 517 ], 518 "locations": [ # The person's locations. 519 { # A person's location. 520 "buildingId": "A String", # The building identifier. 521 "current": True or False, # Whether the location is the current location. 522 "deskCode": "A String", # The individual desk location. 523 "floor": "A String", # The floor name or number. 524 "floorSection": "A String", # The floor section in `floor_name`. 525 "metadata": { # Metadata about a field. # Metadata about the location. 526 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 527 "source": { # The source of a field. # The source of the field. 528 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 529 "id": "A String", # The unique identifier within the source type generated by the server. 530 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 531 "objectType": "A String", # Output only. The profile object type. 532 "userTypes": [ # Output only. The user types. 533 "A String", 534 ], 535 }, 536 "type": "A String", # The source type. 537 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 538 }, 539 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 540 "verified": True or False, # Output only. 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. 541 }, 542 "type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp` 543 "value": "A String", # The free-form value of the location. 544 }, 545 ], 546 "memberships": [ # The person's group memberships. 547 { # A person's membership in a group. Only contact group memberships can be modified. 548 "contactGroupMembership": { # A Google contact group membership. # The contact group membership. 549 "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership. 550 "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership. 551 }, 552 "domainMembership": { # A Google Workspace Domain membership. # Output only. The domain membership. 553 "inViewerDomain": True or False, # True if the person is in the viewer's Google Workspace domain. 554 }, 555 "metadata": { # Metadata about a field. # Metadata about the membership. 556 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 557 "source": { # The source of a field. # The source of the field. 558 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 559 "id": "A String", # The unique identifier within the source type generated by the server. 560 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 561 "objectType": "A String", # Output only. The profile object type. 562 "userTypes": [ # Output only. The user types. 563 "A String", 564 ], 565 }, 566 "type": "A String", # The source type. 567 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 568 }, 569 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 570 "verified": True or False, # Output only. 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. 571 }, 572 }, 573 ], 574 "metadata": { # The metadata about a person. # Output only. Metadata about the person. 575 "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for `people.connections.list` and `otherContacts.list` sync requests. 576 "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource. 577 "A String", 578 ], 579 "objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object. 580 "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for `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. 581 "A String", 582 ], 583 "sources": [ # The sources of data for the person. 584 { # The source of a field. 585 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 586 "id": "A String", # The unique identifier within the source type generated by the server. 587 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 588 "objectType": "A String", # Output only. The profile object type. 589 "userTypes": [ # Output only. The user types. 590 "A String", 591 ], 592 }, 593 "type": "A String", # The source type. 594 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 595 }, 596 ], 597 }, 598 "miscKeywords": [ # The person's miscellaneous keywords. 599 { # A person's miscellaneous keyword. 600 "formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. 601 "metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword. 602 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 603 "source": { # The source of a field. # The source of the field. 604 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 605 "id": "A String", # The unique identifier within the source type generated by the server. 606 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 607 "objectType": "A String", # Output only. The profile object type. 608 "userTypes": [ # Output only. The user types. 609 "A String", 610 ], 611 }, 612 "type": "A String", # The source type. 613 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 614 }, 615 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 616 "verified": True or False, # Output only. 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. 617 }, 618 "type": "A String", # The miscellaneous keyword type. 619 "value": "A String", # The value of the miscellaneous keyword. 620 }, 621 ], 622 "names": [ # The person's names. This field is a singleton for contact sources. 623 { # A person's name. If the name is a mononym, the family name is empty. 624 "displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header. 625 "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header. 626 "familyName": "A String", # The family name. 627 "givenName": "A String", # The given name. 628 "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.` 629 "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.` 630 "metadata": { # Metadata about a field. # Metadata about the name. 631 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 632 "source": { # The source of a field. # The source of the field. 633 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 634 "id": "A String", # The unique identifier within the source type generated by the server. 635 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 636 "objectType": "A String", # Output only. The profile object type. 637 "userTypes": [ # Output only. The user types. 638 "A String", 639 ], 640 }, 641 "type": "A String", # The source type. 642 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 643 }, 644 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 645 "verified": True or False, # Output only. 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. 646 }, 647 "middleName": "A String", # The middle name(s). 648 "phoneticFamilyName": "A String", # The family name spelled as it sounds. 649 "phoneticFullName": "A String", # The full name spelled as it sounds. 650 "phoneticGivenName": "A String", # The given name spelled as it sounds. 651 "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound. 652 "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound. 653 "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound. 654 "unstructuredName": "A String", # The free form name value. 655 }, 656 ], 657 "nicknames": [ # The person's nicknames. 658 { # A person's nickname. 659 "metadata": { # Metadata about a field. # Metadata about the nickname. 660 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 661 "source": { # The source of a field. # The source of the field. 662 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 663 "id": "A String", # The unique identifier within the source type generated by the server. 664 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 665 "objectType": "A String", # Output only. The profile object type. 666 "userTypes": [ # Output only. The user types. 667 "A String", 668 ], 669 }, 670 "type": "A String", # The source type. 671 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 672 }, 673 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 674 "verified": True or False, # Output only. 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. 675 }, 676 "type": "A String", # The type of the nickname. 677 "value": "A String", # The nickname. 678 }, 679 ], 680 "occupations": [ # The person's occupations. 681 { # A person's occupation. 682 "metadata": { # Metadata about a field. # Metadata about the occupation. 683 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 684 "source": { # The source of a field. # The source of the field. 685 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 686 "id": "A String", # The unique identifier within the source type generated by the server. 687 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 688 "objectType": "A String", # Output only. The profile object type. 689 "userTypes": [ # Output only. The user types. 690 "A String", 691 ], 692 }, 693 "type": "A String", # The source type. 694 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 695 }, 696 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 697 "verified": True or False, # Output only. 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. 698 }, 699 "value": "A String", # The occupation; for example, `carpenter`. 700 }, 701 ], 702 "organizations": [ # The person's past or current organizations. 703 { # A person's past or current organization. Overlapping date ranges are permitted. 704 "costCenter": "A String", # The person's cost center at the organization. 705 "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization. 706 "department": "A String", # The person's department at the organization. 707 "domain": "A String", # The domain name associated with the organization; for example, `google.com`. 708 "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The end date when the person left the organization. 709 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 710 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 711 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 712 }, 713 "formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. 714 "fullTimeEquivalentMillipercent": 42, # The person's full-time equivalent millipercent within the organization (100000 = 100%). 715 "jobDescription": "A String", # The person's job description at the organization. 716 "location": "A String", # The location of the organization office the person works at. 717 "metadata": { # Metadata about a field. # Metadata about the organization. 718 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 719 "source": { # The source of a field. # The source of the field. 720 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 721 "id": "A String", # The unique identifier within the source type generated by the server. 722 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 723 "objectType": "A String", # Output only. The profile object type. 724 "userTypes": [ # Output only. The user types. 725 "A String", 726 ], 727 }, 728 "type": "A String", # The source type. 729 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 730 }, 731 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 732 "verified": True or False, # Output only. 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. 733 }, 734 "name": "A String", # The name of the organization. 735 "phoneticName": "A String", # The phonetic name of the organization. 736 "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The start date when the person joined the organization. 737 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 738 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 739 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 740 }, 741 "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym. 742 "title": "A String", # The person's job title at the organization. 743 "type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school` 744 }, 745 ], 746 "phoneNumbers": [ # The person's phone numbers. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople. 747 { # A person's phone number. 748 "canonicalForm": "A String", # Output only. The 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. 749 "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. 750 "metadata": { # Metadata about a field. # Metadata about the phone number. 751 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 752 "source": { # The source of a field. # The source of the field. 753 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 754 "id": "A String", # The unique identifier within the source type generated by the server. 755 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 756 "objectType": "A String", # Output only. The profile object type. 757 "userTypes": [ # Output only. The user types. 758 "A String", 759 ], 760 }, 761 "type": "A String", # The source type. 762 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 763 }, 764 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 765 "verified": True or False, # Output only. 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. 766 }, 767 "type": "A String", # The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other` 768 "value": "A String", # The phone number. 769 }, 770 ], 771 "photos": [ # Output only. The person's photos. 772 { # A person's photo. A picture shown next to the person's name to help others recognize the person. 773 "default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo. 774 "metadata": { # Metadata about a field. # Metadata about the photo. 775 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 776 "source": { # The source of a field. # The source of the field. 777 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 778 "id": "A String", # The unique identifier within the source type generated by the server. 779 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 780 "objectType": "A String", # Output only. The profile object type. 781 "userTypes": [ # Output only. The user types. 782 "A String", 783 ], 784 }, 785 "type": "A String", # The source type. 786 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 787 }, 788 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 789 "verified": True or False, # Output only. 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. 790 }, 791 "url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50 792 }, 793 ], 794 "relations": [ # The person's relations. 795 { # A person's relation to another person. 796 "formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header. 797 "metadata": { # Metadata about a field. # Metadata about the relation. 798 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 799 "source": { # The source of a field. # The source of the field. 800 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 801 "id": "A String", # The unique identifier within the source type generated by the server. 802 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 803 "objectType": "A String", # Output only. The profile object type. 804 "userTypes": [ # Output only. The user types. 805 "A String", 806 ], 807 }, 808 "type": "A String", # The source type. 809 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 810 }, 811 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 812 "verified": True or False, # Output only. 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. 813 }, 814 "person": "A String", # The name of the other person this relation refers to. 815 "type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner` 816 }, 817 ], 818 "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests. 819 { # **DEPRECATED**: No data will be returned A person's relationship interest . 820 "formattedValue": "A String", # Output only. 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. 821 "metadata": { # Metadata about a field. # Metadata about the relationship interest. 822 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 823 "source": { # The source of a field. # The source of the field. 824 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 825 "id": "A String", # The unique identifier within the source type generated by the server. 826 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 827 "objectType": "A String", # Output only. The profile object type. 828 "userTypes": [ # Output only. The user types. 829 "A String", 830 ], 831 }, 832 "type": "A String", # The source type. 833 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 834 }, 835 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 836 "verified": True or False, # Output only. 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. 837 }, 838 "value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking` 839 }, 840 ], 841 "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses. 842 { # **DEPRECATED**: No data will be returned A person's relationship status. 843 "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. 844 "metadata": { # Metadata about a field. # Metadata about the relationship status. 845 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 846 "source": { # The source of a field. # The source of the field. 847 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 848 "id": "A String", # The unique identifier within the source type generated by the server. 849 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 850 "objectType": "A String", # Output only. The profile object type. 851 "userTypes": [ # Output only. The user types. 852 "A String", 853 ], 854 }, 855 "type": "A String", # The source type. 856 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 857 }, 858 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 859 "verified": True or False, # Output only. 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. 860 }, 861 "value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion` 862 }, 863 ], 864 "residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences. 865 { # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence. 866 "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence. 867 "metadata": { # Metadata about a field. # Metadata about the residence. 868 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 869 "source": { # The source of a field. # The source of the field. 870 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 871 "id": "A String", # The unique identifier within the source type generated by the server. 872 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 873 "objectType": "A String", # Output only. The profile object type. 874 "userTypes": [ # Output only. The user types. 875 "A String", 876 ], 877 }, 878 "type": "A String", # The source type. 879 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 880 }, 881 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 882 "verified": True or False, # Output only. 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. 883 }, 884 "value": "A String", # The address of the residence. 885 }, 886 ], 887 "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`. 888 "sipAddresses": [ # The person's SIP addresses. 889 { # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet. 890 "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. 891 "metadata": { # Metadata about a field. # Metadata about the SIP address. 892 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 893 "source": { # The source of a field. # The source of the field. 894 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 895 "id": "A String", # The unique identifier within the source type generated by the server. 896 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 897 "objectType": "A String", # Output only. The profile object type. 898 "userTypes": [ # Output only. The user types. 899 "A String", 900 ], 901 }, 902 "type": "A String", # The source type. 903 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 904 }, 905 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 906 "verified": True or False, # Output only. 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. 907 }, 908 "type": "A String", # The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other` 909 "value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format. 910 }, 911 ], 912 "skills": [ # The person's skills. 913 { # A skill that the person has. 914 "metadata": { # Metadata about a field. # Metadata about the skill. 915 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 916 "source": { # The source of a field. # The source of the field. 917 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 918 "id": "A String", # The unique identifier within the source type generated by the server. 919 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 920 "objectType": "A String", # Output only. The profile object type. 921 "userTypes": [ # Output only. The user types. 922 "A String", 923 ], 924 }, 925 "type": "A String", # The source type. 926 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 927 }, 928 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 929 "verified": True or False, # Output only. 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. 930 }, 931 "value": "A String", # The skill; for example, `underwater basket weaving`. 932 }, 933 ], 934 "taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines. 935 { # **DEPRECATED**: No data will be returned A brief one-line description of the person. 936 "metadata": { # Metadata about a field. # Metadata about the tagline. 937 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 938 "source": { # The source of a field. # The source of the field. 939 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 940 "id": "A String", # The unique identifier within the source type generated by the server. 941 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 942 "objectType": "A String", # Output only. The profile object type. 943 "userTypes": [ # Output only. The user types. 944 "A String", 945 ], 946 }, 947 "type": "A String", # The source type. 948 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 949 }, 950 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 951 "verified": True or False, # Output only. 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. 952 }, 953 "value": "A String", # The tagline. 954 }, 955 ], 956 "urls": [ # The person's associated URLs. 957 { # A person's associated URLs. 958 "formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. 959 "metadata": { # Metadata about a field. # Metadata about the URL. 960 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 961 "source": { # The source of a field. # The source of the field. 962 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 963 "id": "A String", # The unique identifier within the source type generated by the server. 964 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 965 "objectType": "A String", # Output only. The profile object type. 966 "userTypes": [ # Output only. The user types. 967 "A String", 968 ], 969 }, 970 "type": "A String", # The source type. 971 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 972 }, 973 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 974 "verified": True or False, # Output only. 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. 975 }, 976 "type": "A String", # The type of the URL. The type can be custom or one of these predefined values: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Currents application. * `other` 977 "value": "A String", # The URL. 978 }, 979 ], 980 "userDefined": [ # The person's user defined data. 981 { # Arbitrary user data that is populated by the end users. 982 "key": "A String", # The end user specified key of the user defined data. 983 "metadata": { # Metadata about a field. # Metadata about the user defined data. 984 "primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true. 985 "source": { # The source of a field. # The source of the field. 986 "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. 987 "id": "A String", # The unique identifier within the source type generated by the server. 988 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. 989 "objectType": "A String", # Output only. The profile object type. 990 "userTypes": [ # Output only. The user types. 991 "A String", 992 ], 993 }, 994 "type": "A String", # The source type. 995 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. 996 }, 997 "sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true. 998 "verified": True or False, # Output only. 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. 999 }, 1000 "value": "A String", # The end user specified value of the user defined data. 1001 }, 1002 ], 1003 }, 1004 ], 1005 "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. 1006 "nextSyncToken": "A String", # A token, which can be sent as `sync_token` to retrieve changes since the last request. Request must set `request_sync_token` to return the sync token. When the response is paginated, only the last page will contain `nextSyncToken`. 1007 "totalItems": 42, # The total number of items in the list without pagination. 1008 "totalPeople": 42, # **DEPRECATED** (Please use totalItems) The total number of people in the list without pagination. 1009}</pre> 1010</div> 1011 1012<div class="method"> 1013 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 1014 <pre>Retrieves the next page of results. 1015 1016Args: 1017 previous_request: The request for the previous page. (required) 1018 previous_response: The response from the request for the previous page. (required) 1019 1020Returns: 1021 A request object that you can call 'execute()' on to request the next 1022 page. Returns None if there are no more items in the collection. 1023 </pre> 1024</div> 1025 1026</body></html>
