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