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