| 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></h1> |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="people_v1.people.connections.html">connections()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the connections Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 83 | <code><a href="#createContact">createContact(body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 84 | <p class="firstline">Create a new contact and return the person resource for that contact.</p> |
| 85 | <p class="toc_element"> |
| 86 | <code><a href="#deleteContact">deleteContact(resourceName, x__xgafv=None)</a></code></p> |
| 87 | <p class="firstline">Delete a contact person. Any non-contact data will not be deleted.</p> |
| 88 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 89 | <code><a href="#deleteContactPhoto">deleteContactPhoto(resourceName, personFields=None, x__xgafv=None)</a></code></p> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 90 | <p class="firstline">Delete a contact's photo.</p> |
| 91 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 92 | <code><a href="#get">get(resourceName, requestMask_includeField=None, personFields=None, x__xgafv=None)</a></code></p> |
| Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 93 | <p class="firstline">Provides information about a person by specifying a resource name. Use</p> |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 94 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 95 | <code><a href="#getBatchGet">getBatchGet(personFields=None, resourceNames=None, requestMask_includeField=None, x__xgafv=None)</a></code></p> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 96 | <p class="firstline">Provides information about a list of specific people by specifying a list</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 97 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 98 | <code><a href="#updateContact">updateContact(resourceName, body=None, updatePersonFields=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 99 | <p class="firstline">Update contact data for an existing contact person. Any non-contact data</p> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 100 | <p class="toc_element"> |
| 101 | <code><a href="#updateContactPhoto">updateContactPhoto(resourceName, body=None, x__xgafv=None)</a></code></p> |
| 102 | <p class="firstline">Update a contact's photo.</p> |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 103 | <h3>Method Details</h3> |
| 104 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 105 | <code class="details" id="createContact">createContact(body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 106 | <pre>Create a new contact and return the person resource for that contact. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 107 | |
| 108 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 109 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 110 | The object takes the form of: |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 111 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 112 | { # Information about a person merged from various data sources such as the |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 113 | # authenticated user's contacts and profile data. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 114 | # |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 115 | # Most fields can have multiple items. The items in a field have no guaranteed |
| 116 | # order, but each non-empty field is guaranteed to have exactly one field with |
| 117 | # `metadata.primary` set to true. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 118 | "interests": [ # The person's interests. |
| 119 | { # One of the person's interests. |
| 120 | "value": "A String", # The interest; for example, `stargazing`. |
| 121 | "metadata": { # Metadata about a field. # Metadata about the interest. |
| 122 | "source": { # The source of a field. # The source of the field. |
| 123 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 124 | # |
| 125 | # Last update timestamp of this source. |
| 126 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 127 | # |
| 128 | # Metadata about a source of type PROFILE. |
| 129 | "userTypes": [ # Output only. The user types. |
| 130 | "A String", |
| 131 | ], |
| 132 | "objectType": "A String", # Output only. The profile object type. |
| 133 | }, |
| 134 | "type": "A String", # The source type. |
| 135 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 136 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 137 | # |
| 138 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 139 | # source. Used for web cache validation. |
| 140 | }, |
| 141 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 142 | # verified field is typically a name, email address, phone number, or |
| 143 | # website that has been confirmed to be owned by the person. |
| 144 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 145 | # field. |
| 146 | }, |
| 147 | }, |
| 148 | ], |
| 149 | "userDefined": [ # The person's user defined data. |
| 150 | { # Arbitrary user data that is populated by the end users. |
| 151 | "metadata": { # Metadata about a field. # Metadata about the user defined data. |
| 152 | "source": { # The source of a field. # The source of the field. |
| 153 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 154 | # |
| 155 | # Last update timestamp of this source. |
| 156 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 157 | # |
| 158 | # Metadata about a source of type PROFILE. |
| 159 | "userTypes": [ # Output only. The user types. |
| 160 | "A String", |
| 161 | ], |
| 162 | "objectType": "A String", # Output only. The profile object type. |
| 163 | }, |
| 164 | "type": "A String", # The source type. |
| 165 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 166 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 167 | # |
| 168 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 169 | # source. Used for web cache validation. |
| 170 | }, |
| 171 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 172 | # verified field is typically a name, email address, phone number, or |
| 173 | # website that has been confirmed to be owned by the person. |
| 174 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 175 | # field. |
| 176 | }, |
| 177 | "key": "A String", # The end user specified key of the user defined data. |
| 178 | "value": "A String", # The end user specified value of the user defined data. |
| 179 | }, |
| 180 | ], |
| 181 | "sipAddresses": [ # The person's SIP addresses. |
| 182 | { # A person's SIP address. Session Initial Protocol addresses are used for VoIP |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 183 | # communications to make voice or video calls over the internet. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 184 | "value": "A String", # The SIP address in the |
| 185 | # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI |
| 186 | # format. |
| 187 | "type": "A String", # The type of the SIP address. The type can be custom or or one of these |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 188 | # predefined values: |
| 189 | # |
| 190 | # * `home` |
| 191 | # * `work` |
| 192 | # * `mobile` |
| 193 | # * `other` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 194 | "metadata": { # Metadata about a field. # Metadata about the SIP address. |
| 195 | "source": { # The source of a field. # The source of the field. |
| 196 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 197 | # |
| 198 | # Last update timestamp of this source. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 199 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 200 | # |
| 201 | # Metadata about a source of type PROFILE. |
| 202 | "userTypes": [ # Output only. The user types. |
| 203 | "A String", |
| 204 | ], |
| 205 | "objectType": "A String", # Output only. The profile object type. |
| 206 | }, |
| 207 | "type": "A String", # The source type. |
| 208 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 209 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 210 | # |
| 211 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 212 | # source. Used for web cache validation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 213 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 214 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 215 | # verified field is typically a name, email address, phone number, or |
| 216 | # website that has been confirmed to be owned by the person. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 217 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 218 | # field. |
| 219 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 220 | "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the |
| 221 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 222 | }, |
| 223 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 224 | "phoneNumbers": [ # The person's phone numbers. |
| 225 | { # A person's phone number. |
| 226 | "type": "A String", # The type of the phone number. The type can be custom or one of these |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 227 | # predefined values: |
| 228 | # |
| 229 | # * `home` |
| 230 | # * `work` |
| 231 | # * `mobile` |
| 232 | # * `homeFax` |
| 233 | # * `workFax` |
| 234 | # * `otherFax` |
| 235 | # * `pager` |
| 236 | # * `workMobile` |
| 237 | # * `workPager` |
| 238 | # * `main` |
| 239 | # * `googleVoice` |
| 240 | # * `other` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 241 | "value": "A String", # The phone number. |
| 242 | "canonicalForm": "A String", # Output only. The canonicalized [ITU-T |
| 243 | # E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) |
| 244 | # form of the phone number. |
| 245 | "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the |
| 246 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 247 | "metadata": { # Metadata about a field. # Metadata about the phone number. |
| 248 | "source": { # The source of a field. # The source of the field. |
| 249 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 250 | # |
| 251 | # Last update timestamp of this source. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 252 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 253 | # |
| 254 | # Metadata about a source of type PROFILE. |
| 255 | "userTypes": [ # Output only. The user types. |
| 256 | "A String", |
| 257 | ], |
| 258 | "objectType": "A String", # Output only. The profile object type. |
| 259 | }, |
| 260 | "type": "A String", # The source type. |
| 261 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 262 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 263 | # |
| 264 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 265 | # source. Used for web cache validation. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 266 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 267 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 268 | # verified field is typically a name, email address, phone number, or |
| 269 | # website that has been confirmed to be owned by the person. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 270 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 271 | # field. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 272 | }, |
| 273 | }, |
| 274 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 275 | "occupations": [ # The person's occupations. |
| 276 | { # A person's occupation. |
| 277 | "value": "A String", # The occupation; for example, `carpenter`. |
| 278 | "metadata": { # Metadata about a field. # Metadata about the occupation. |
| 279 | "source": { # The source of a field. # The source of the field. |
| 280 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 281 | # |
| 282 | # Last update timestamp of this source. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 283 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 284 | # |
| 285 | # Metadata about a source of type PROFILE. |
| 286 | "userTypes": [ # Output only. The user types. |
| 287 | "A String", |
| 288 | ], |
| 289 | "objectType": "A String", # Output only. The profile object type. |
| 290 | }, |
| 291 | "type": "A String", # The source type. |
| 292 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 293 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 294 | # |
| 295 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 296 | # source. Used for web cache validation. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 297 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 298 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 299 | # verified field is typically a name, email address, phone number, or |
| 300 | # website that has been confirmed to be owned by the person. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 301 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 302 | # field. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 303 | }, |
| 304 | }, |
| 305 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 306 | "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) |
| 307 | # |
| 308 | # The person's age range. |
| 309 | "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 310 | # resource. Used for web cache validation. |
| 311 | "biographies": [ # The person's biographies. |
| 312 | { # A person's short biography. |
| 313 | "metadata": { # Metadata about a field. # Metadata about the biography. |
| 314 | "source": { # The source of a field. # The source of the field. |
| 315 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 316 | # |
| 317 | # Last update timestamp of this source. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 318 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 319 | # |
| 320 | # Metadata about a source of type PROFILE. |
| 321 | "userTypes": [ # Output only. The user types. |
| 322 | "A String", |
| 323 | ], |
| 324 | "objectType": "A String", # Output only. The profile object type. |
| 325 | }, |
| 326 | "type": "A String", # The source type. |
| 327 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 328 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 329 | # |
| 330 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 331 | # source. Used for web cache validation. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 332 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 333 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 334 | # verified field is typically a name, email address, phone number, or |
| 335 | # website that has been confirmed to be owned by the person. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 336 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 337 | # field. |
| 338 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 339 | "contentType": "A String", # The content type of the biography. |
| 340 | "value": "A String", # The short biography. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 341 | }, |
| 342 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 343 | "locales": [ # The person's locale preferences. |
| 344 | { # A person's locale preference. |
| 345 | "metadata": { # Metadata about a field. # Metadata about the locale. |
| 346 | "source": { # The source of a field. # The source of the field. |
| 347 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 348 | # |
| 349 | # Last update timestamp of this source. |
| 350 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 351 | # |
| 352 | # Metadata about a source of type PROFILE. |
| 353 | "userTypes": [ # Output only. The user types. |
| 354 | "A String", |
| 355 | ], |
| 356 | "objectType": "A String", # Output only. The profile object type. |
| 357 | }, |
| 358 | "type": "A String", # The source type. |
| 359 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 360 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 361 | # |
| 362 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 363 | # source. Used for web cache validation. |
| 364 | }, |
| 365 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 366 | # verified field is typically a name, email address, phone number, or |
| 367 | # website that has been confirmed to be owned by the person. |
| 368 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 369 | # field. |
| 370 | }, |
| 371 | "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) |
| 372 | # language tag representing the locale. |
| 373 | }, |
| 374 | ], |
| 375 | "taglines": [ # Output only. **DEPRECATED**: No data will be returned |
| 376 | # The person's taglines. |
| 377 | { # **DEPRECATED**: No data will be returned |
| 378 | # A brief one-line description of the person. |
| 379 | "metadata": { # Metadata about a field. # Metadata about the tagline. |
| 380 | "source": { # The source of a field. # The source of the field. |
| 381 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 382 | # |
| 383 | # Last update timestamp of this source. |
| 384 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 385 | # |
| 386 | # Metadata about a source of type PROFILE. |
| 387 | "userTypes": [ # Output only. The user types. |
| 388 | "A String", |
| 389 | ], |
| 390 | "objectType": "A String", # Output only. The profile object type. |
| 391 | }, |
| 392 | "type": "A String", # The source type. |
| 393 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 394 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 395 | # |
| 396 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 397 | # source. Used for web cache validation. |
| 398 | }, |
| 399 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 400 | # verified field is typically a name, email address, phone number, or |
| 401 | # website that has been confirmed to be owned by the person. |
| 402 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 403 | # field. |
| 404 | }, |
| 405 | "value": "A String", # The tagline. |
| 406 | }, |
| 407 | ], |
| 408 | "organizations": [ # The person's past or current organizations. |
| 409 | { # A person's past or current organization. Overlapping date ranges are |
| 410 | # permitted. |
| 411 | "title": "A String", # The person's job title at the organization. |
| 412 | "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker |
| 413 | # symbol, abbreviation, or acronym. |
| 414 | "name": "A String", # The name of the organization. |
| 415 | "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The start date when the person joined the organization. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 416 | # and time zone are either specified elsewhere or are not significant. The date |
| 417 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 418 | # |
| 419 | # * A full date, with non-zero year, month and day values |
| 420 | # * A month and day value, with a zero year, e.g. an anniversary |
| 421 | # * A year on its own, with zero month and day values |
| 422 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 423 | # |
| 424 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 425 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 426 | # a year. |
| 427 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 428 | # month and day. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 429 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 430 | # if specifying a year by itself or a year and month where the day is not |
| 431 | # significant. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 432 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 433 | "department": "A String", # The person's department at the organization. |
| 434 | "current": True or False, # True if the organization is the person's current organization; |
| 435 | # false if the organization is a past organization. |
| 436 | "location": "A String", # The location of the organization office the person works at. |
| 437 | "domain": "A String", # The domain name associated with the organization; for example, |
| 438 | # `google.com`. |
| 439 | "metadata": { # Metadata about a field. # Metadata about the organization. |
| 440 | "source": { # The source of a field. # The source of the field. |
| 441 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 442 | # |
| 443 | # Last update timestamp of this source. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 444 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 445 | # |
| 446 | # Metadata about a source of type PROFILE. |
| 447 | "userTypes": [ # Output only. The user types. |
| 448 | "A String", |
| 449 | ], |
| 450 | "objectType": "A String", # Output only. The profile object type. |
| 451 | }, |
| 452 | "type": "A String", # The source type. |
| 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`.** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 455 | # |
| 456 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 457 | # source. Used for web cache validation. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 458 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 459 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 460 | # verified field is typically a name, email address, phone number, or |
| 461 | # website that has been confirmed to be owned by the person. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 462 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 463 | # field. |
| 464 | }, |
| 465 | "jobDescription": "A String", # The person's job description at the organization. |
| 466 | "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The end date when the person left the organization. |
| 467 | # and time zone are either specified elsewhere or are not significant. The date |
| 468 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 469 | # |
| 470 | # * A full date, with non-zero year, month and day values |
| 471 | # * A month and day value, with a zero year, e.g. an anniversary |
| 472 | # * A year on its own, with zero month and day values |
| 473 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 474 | # |
| 475 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 476 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 477 | # a year. |
| 478 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 479 | # month and day. |
| 480 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 481 | # if specifying a year by itself or a year and month where the day is not |
| 482 | # significant. |
| 483 | }, |
| 484 | "phoneticName": "A String", # The phonetic name of the organization. |
| 485 | "formattedType": "A String", # Output only. The type of the organization translated and formatted in the |
| 486 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 487 | "type": "A String", # The type of the organization. The type can be custom or one of these |
| 488 | # predefined values: |
| 489 | # |
| 490 | # * `work` |
| 491 | # * `school` |
| 492 | }, |
| 493 | ], |
| 494 | "residences": [ # The person's residences. |
| 495 | { # A person's past or current residence. |
| 496 | "metadata": { # Metadata about a field. # Metadata about the residence. |
| 497 | "source": { # The source of a field. # The source of the field. |
| 498 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 499 | # |
| 500 | # Last update timestamp of this source. |
| 501 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 502 | # |
| 503 | # Metadata about a source of type PROFILE. |
| 504 | "userTypes": [ # Output only. The user types. |
| 505 | "A String", |
| 506 | ], |
| 507 | "objectType": "A String", # Output only. The profile object type. |
| 508 | }, |
| 509 | "type": "A String", # The source type. |
| 510 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 511 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 512 | # |
| 513 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 514 | # source. Used for web cache validation. |
| 515 | }, |
| 516 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 517 | # verified field is typically a name, email address, phone number, or |
| 518 | # website that has been confirmed to be owned by the person. |
| 519 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 520 | # field. |
| 521 | }, |
| 522 | "current": True or False, # True if the residence is the person's current residence; |
| 523 | # false if the residence is a past residence. |
| 524 | "value": "A String", # The address of the residence. |
| 525 | }, |
| 526 | ], |
| 527 | "genders": [ # The person's genders. |
| 528 | { # A person's gender. |
| 529 | "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account |
| 530 | # locale or the `Accept-Language` HTTP header locale. Unspecified or custom |
| 531 | # value are not localized. |
| 532 | "metadata": { # Metadata about a field. # Metadata about the gender. |
| 533 | "source": { # The source of a field. # The source of the field. |
| 534 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 535 | # |
| 536 | # Last update timestamp of this source. |
| 537 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 538 | # |
| 539 | # Metadata about a source of type PROFILE. |
| 540 | "userTypes": [ # Output only. The user types. |
| 541 | "A String", |
| 542 | ], |
| 543 | "objectType": "A String", # Output only. The profile object type. |
| 544 | }, |
| 545 | "type": "A String", # The source type. |
| 546 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 547 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 548 | # |
| 549 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 550 | # source. Used for web cache validation. |
| 551 | }, |
| 552 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 553 | # verified field is typically a name, email address, phone number, or |
| 554 | # website that has been confirmed to be owned by the person. |
| 555 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 556 | # field. |
| 557 | }, |
| 558 | "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value |
| 559 | # can be custom or one of these predefined values: |
| 560 | # |
| 561 | # * `male` |
| 562 | # * `female` |
| 563 | # * `other` |
| 564 | "value": "A String", # The gender for the person. The gender can be custom or one of these |
| 565 | # predefined values: |
| 566 | # |
| 567 | # * `male` |
| 568 | # * `female` |
| 569 | # * `unspecified` |
| 570 | }, |
| 571 | ], |
| 572 | "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned |
| 573 | # The person's relationship interests. |
| 574 | { # **DEPRECATED**: No data will be returned |
| 575 | # A person's relationship interest . |
| 576 | "formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted |
| 577 | # in the viewer's account locale or the locale specified in the |
| 578 | # Accept-Language HTTP header. |
| 579 | "metadata": { # Metadata about a field. # Metadata about the relationship interest. |
| 580 | "source": { # The source of a field. # The source of the field. |
| 581 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 582 | # |
| 583 | # Last update timestamp of this source. |
| 584 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 585 | # |
| 586 | # Metadata about a source of type PROFILE. |
| 587 | "userTypes": [ # Output only. The user types. |
| 588 | "A String", |
| 589 | ], |
| 590 | "objectType": "A String", # Output only. The profile object type. |
| 591 | }, |
| 592 | "type": "A String", # The source type. |
| 593 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 594 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 595 | # |
| 596 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 597 | # source. Used for web cache validation. |
| 598 | }, |
| 599 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 600 | # verified field is typically a name, email address, phone number, or |
| 601 | # website that has been confirmed to be owned by the person. |
| 602 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 603 | # field. |
| 604 | }, |
| 605 | "value": "A String", # The kind of relationship the person is looking for. The value can be custom |
| 606 | # or one of these predefined values: |
| 607 | # |
| 608 | # * `friend` |
| 609 | # * `date` |
| 610 | # * `relationship` |
| 611 | # * `networking` |
| 612 | }, |
| 613 | ], |
| 614 | "metadata": { # The metadata about a person. # Output only. Metadata about the person. |
| 615 | "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for |
| 616 | # [`connections.list`](/people/api/rest/v1/people.connections/list) requests |
| 617 | # that include a sync token. |
| 618 | # |
| 619 | # The resource name may change when adding or removing fields that link a |
| 620 | # contact and profile such as a verified email, verified phone number, or |
| 621 | # profile URL. |
| 622 | "A String", |
| 623 | ], |
| 624 | "sources": [ # The sources of data for the person. |
| 625 | { # The source of a field. |
| 626 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 627 | # |
| 628 | # Last update timestamp of this source. |
| 629 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 630 | # |
| 631 | # Metadata about a source of type PROFILE. |
| 632 | "userTypes": [ # Output only. The user types. |
| 633 | "A String", |
| 634 | ], |
| 635 | "objectType": "A String", # Output only. The profile object type. |
| 636 | }, |
| 637 | "type": "A String", # The source type. |
| 638 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 639 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 640 | # |
| 641 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 642 | # source. Used for web cache validation. |
| 643 | }, |
| 644 | ], |
| 645 | "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource. |
| 646 | "A String", |
| 647 | ], |
| 648 | "objectType": "A String", # Output only. **DEPRECATED** (Please use |
| 649 | # `person.metadata.sources.profileMetadata.objectType` instead) |
| 650 | # |
| 651 | # The type of the person object. |
| 652 | "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for |
| 653 | # [`connections.list`](/people/api/rest/v1/people.connections/list) requests |
| 654 | # that include a sync token. |
| 655 | }, |
| 656 | "memberships": [ # The person's group memberships. |
| 657 | { # A person's membership in a group. Only contact group memberships can be |
| 658 | # modified. |
| 659 | "metadata": { # Metadata about a field. # Metadata about the membership. |
| 660 | "source": { # The source of a field. # The source of the field. |
| 661 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 662 | # |
| 663 | # Last update timestamp of this source. |
| 664 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 665 | # |
| 666 | # Metadata about a source of type PROFILE. |
| 667 | "userTypes": [ # Output only. The user types. |
| 668 | "A String", |
| 669 | ], |
| 670 | "objectType": "A String", # Output only. The profile object type. |
| 671 | }, |
| 672 | "type": "A String", # The source type. |
| 673 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 674 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 675 | # |
| 676 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 677 | # source. Used for web cache validation. |
| 678 | }, |
| 679 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 680 | # verified field is typically a name, email address, phone number, or |
| 681 | # website that has been confirmed to be owned by the person. |
| 682 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 683 | # field. |
| 684 | }, |
| 685 | "contactGroupMembership": { # A Google contact group membership. # The contact group membership. |
| 686 | "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership. |
| 687 | "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII |
| 688 | # string, in the form of `contactGroups/{contact_group_id}`. |
| 689 | # Only contact_group_resource_name can be used for modifying memberships. |
| 690 | # Any contact group membership can be removed, but only user group or |
| 691 | # "myContacts" or "starred" system groups memberships can be added. A |
| 692 | # contact must always have at least one contact group membership. |
| 693 | }, |
| 694 | "domainMembership": { # A G Suite Domain membership. # Output only. The domain membership. |
| 695 | "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain. |
| 696 | }, |
| 697 | }, |
| 698 | ], |
| 699 | "birthdays": [ # The person's birthdays. |
| 700 | { # A person's birthday. At least one of the `date` and `text` fields are |
| 701 | # specified. The `date` and `text` fields typically represent the same |
| 702 | # date, but are not guaranteed to. |
| 703 | "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the birthday. |
| 704 | # and time zone are either specified elsewhere or are not significant. The date |
| 705 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 706 | # |
| 707 | # * A full date, with non-zero year, month and day values |
| 708 | # * A month and day value, with a zero year, e.g. an anniversary |
| 709 | # * A year on its own, with zero month and day values |
| 710 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 711 | # |
| 712 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 713 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 714 | # a year. |
| 715 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 716 | # month and day. |
| 717 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 718 | # if specifying a year by itself or a year and month where the day is not |
| 719 | # significant. |
| 720 | }, |
| 721 | "metadata": { # Metadata about a field. # Metadata about the birthday. |
| 722 | "source": { # The source of a field. # The source of the field. |
| 723 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 724 | # |
| 725 | # Last update timestamp of this source. |
| 726 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 727 | # |
| 728 | # Metadata about a source of type PROFILE. |
| 729 | "userTypes": [ # Output only. The user types. |
| 730 | "A String", |
| 731 | ], |
| 732 | "objectType": "A String", # Output only. The profile object type. |
| 733 | }, |
| 734 | "type": "A String", # The source type. |
| 735 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 736 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 737 | # |
| 738 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 739 | # source. Used for web cache validation. |
| 740 | }, |
| 741 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 742 | # verified field is typically a name, email address, phone number, or |
| 743 | # website that has been confirmed to be owned by the person. |
| 744 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 745 | # field. |
| 746 | }, |
| 747 | "text": "A String", # A free-form string representing the user's birthday. |
| 748 | }, |
| 749 | ], |
| 750 | "imClients": [ # The person's instant messaging clients. |
| 751 | { # A person's instant messaging client. |
| 752 | "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the |
| 753 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 754 | "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these |
| 755 | # predefined values: |
| 756 | # |
| 757 | # * `aim` |
| 758 | # * `msn` |
| 759 | # * `yahoo` |
| 760 | # * `skype` |
| 761 | # * `qq` |
| 762 | # * `googleTalk` |
| 763 | # * `icq` |
| 764 | # * `jabber` |
| 765 | # * `netMeeting` |
| 766 | "username": "A String", # The user name used in the IM client. |
| 767 | "type": "A String", # The type of the IM client. The type can be custom or one of these |
| 768 | # predefined values: |
| 769 | # |
| 770 | # * `home` |
| 771 | # * `work` |
| 772 | # * `other` |
| 773 | "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account |
| 774 | # locale or the `Accept-Language` HTTP header locale. |
| 775 | "metadata": { # Metadata about a field. # Metadata about the IM client. |
| 776 | "source": { # The source of a field. # The source of the field. |
| 777 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 778 | # |
| 779 | # Last update timestamp of this source. |
| 780 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 781 | # |
| 782 | # Metadata about a source of type PROFILE. |
| 783 | "userTypes": [ # Output only. The user types. |
| 784 | "A String", |
| 785 | ], |
| 786 | "objectType": "A String", # Output only. The profile object type. |
| 787 | }, |
| 788 | "type": "A String", # The source type. |
| 789 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 790 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 791 | # |
| 792 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 793 | # source. Used for web cache validation. |
| 794 | }, |
| 795 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 796 | # verified field is typically a name, email address, phone number, or |
| 797 | # website that has been confirmed to be owned by the person. |
| 798 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 799 | # field. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 800 | }, |
| 801 | }, |
| 802 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 803 | "skills": [ # The person's skills. |
| 804 | { # A skill that the person has. |
| 805 | "metadata": { # Metadata about a field. # Metadata about the skill. |
| 806 | "source": { # The source of a field. # The source of the field. |
| 807 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 808 | # |
| 809 | # Last update timestamp of this source. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 810 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 811 | # |
| 812 | # Metadata about a source of type PROFILE. |
| 813 | "userTypes": [ # Output only. The user types. |
| 814 | "A String", |
| 815 | ], |
| 816 | "objectType": "A String", # Output only. The profile object type. |
| 817 | }, |
| 818 | "type": "A String", # The source type. |
| 819 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 820 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 821 | # |
| 822 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 823 | # source. Used for web cache validation. |
| Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 824 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 825 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 826 | # verified field is typically a name, email address, phone number, or |
| 827 | # website that has been confirmed to be owned by the person. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 828 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 829 | # field. |
| 830 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 831 | "value": "A String", # The skill; for example, `underwater basket weaving`. |
| 832 | }, |
| 833 | ], |
| 834 | "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned |
| 835 | # The person's relationship statuses. |
| 836 | { # **DEPRECATED**: No data will be returned |
| 837 | # A person's relationship status. |
| 838 | "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in |
| 839 | # the viewer's account locale or the `Accept-Language` HTTP header locale. |
| 840 | "metadata": { # Metadata about a field. # Metadata about the relationship status. |
| 841 | "source": { # The source of a field. # The source of the field. |
| 842 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 843 | # |
| 844 | # Last update timestamp of this source. |
| 845 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 846 | # |
| 847 | # Metadata about a source of type PROFILE. |
| 848 | "userTypes": [ # Output only. The user types. |
| 849 | "A String", |
| 850 | ], |
| 851 | "objectType": "A String", # Output only. The profile object type. |
| 852 | }, |
| 853 | "type": "A String", # The source type. |
| 854 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 855 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 856 | # |
| 857 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 858 | # source. Used for web cache validation. |
| 859 | }, |
| 860 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 861 | # verified field is typically a name, email address, phone number, or |
| 862 | # website that has been confirmed to be owned by the person. |
| 863 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 864 | # field. |
| 865 | }, |
| 866 | "value": "A String", # The relationship status. The value can be custom or one of these |
| 867 | # predefined values: |
| 868 | # |
| 869 | # * `single` |
| 870 | # * `inARelationship` |
| 871 | # * `engaged` |
| 872 | # * `married` |
| 873 | # * `itsComplicated` |
| 874 | # * `openRelationship` |
| 875 | # * `widowed` |
| 876 | # * `inDomesticPartnership` |
| 877 | # * `inCivilUnion` |
| 878 | }, |
| 879 | ], |
| 880 | "coverPhotos": [ # Output only. The person's cover photos. |
| 881 | { # A person's cover photo. A large image shown on the person's |
| 882 | # profile page that represents who they are or what they care about. |
| 883 | "url": "A String", # The URL of the cover photo. |
| 884 | "default": True or False, # True if the cover photo is the default cover photo; |
| 885 | # false if the cover photo is a user-provided cover photo. |
| 886 | "metadata": { # Metadata about a field. # Metadata about the cover photo. |
| 887 | "source": { # The source of a field. # The source of the field. |
| 888 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 889 | # |
| 890 | # Last update timestamp of this source. |
| 891 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 892 | # |
| 893 | # Metadata about a source of type PROFILE. |
| 894 | "userTypes": [ # Output only. The user types. |
| 895 | "A String", |
| 896 | ], |
| 897 | "objectType": "A String", # Output only. The profile object type. |
| 898 | }, |
| 899 | "type": "A String", # The source type. |
| 900 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 901 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 902 | # |
| 903 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 904 | # source. Used for web cache validation. |
| 905 | }, |
| 906 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 907 | # verified field is typically a name, email address, phone number, or |
| 908 | # website that has been confirmed to be owned by the person. |
| 909 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 910 | # field. |
| 911 | }, |
| 912 | }, |
| 913 | ], |
| 914 | "names": [ # The person's names. |
| 915 | { # A person's name. If the name is a mononym, the family name is empty. |
| 916 | "middleName": "A String", # The middle name(s). |
| 917 | "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound. |
| 918 | "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to |
| 919 | # the locale specified by the viewer's account or the |
| 920 | # `Accept-Language` HTTP header. |
| 921 | "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.` |
| 922 | "familyName": "A String", # The family name. |
| 923 | "phoneticGivenName": "A String", # The given name spelled as it sounds. |
| 924 | "metadata": { # Metadata about a field. # Metadata about the name. |
| 925 | "source": { # The source of a field. # The source of the field. |
| 926 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 927 | # |
| 928 | # Last update timestamp of this source. |
| 929 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 930 | # |
| 931 | # Metadata about a source of type PROFILE. |
| 932 | "userTypes": [ # Output only. The user types. |
| 933 | "A String", |
| 934 | ], |
| 935 | "objectType": "A String", # Output only. The profile object type. |
| 936 | }, |
| 937 | "type": "A String", # The source type. |
| 938 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 939 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 940 | # |
| 941 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 942 | # source. Used for web cache validation. |
| 943 | }, |
| 944 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 945 | # verified field is typically a name, email address, phone number, or |
| 946 | # website that has been confirmed to be owned by the person. |
| 947 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 948 | # field. |
| 949 | }, |
| 950 | "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound. |
| 951 | "displayName": "A String", # Output only. The display name formatted according to the locale specified by |
| 952 | # the viewer's account or the `Accept-Language` HTTP header. |
| 953 | "phoneticFamilyName": "A String", # The family name spelled as it sounds. |
| 954 | "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.` |
| 955 | "givenName": "A String", # The given name. |
| 956 | "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound. |
| 957 | "phoneticFullName": "A String", # The full name spelled as it sounds. |
| 958 | }, |
| 959 | ], |
| 960 | "relations": [ # The person's relations. |
| 961 | { # A person's relation to another person. |
| 962 | "type": "A String", # The person's relation to the other person. The type can be custom or one of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 963 | # these predefined values: |
| Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 964 | # |
| 965 | # * `spouse` |
| 966 | # * `child` |
| 967 | # * `mother` |
| 968 | # * `father` |
| 969 | # * `parent` |
| 970 | # * `brother` |
| 971 | # * `sister` |
| 972 | # * `friend` |
| 973 | # * `relative` |
| 974 | # * `domesticPartner` |
| 975 | # * `manager` |
| 976 | # * `assistant` |
| 977 | # * `referredBy` |
| 978 | # * `partner` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 979 | "metadata": { # Metadata about a field. # Metadata about the relation. |
| 980 | "source": { # The source of a field. # The source of the field. |
| 981 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 982 | # |
| 983 | # Last update timestamp of this source. |
| 984 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 985 | # |
| 986 | # Metadata about a source of type PROFILE. |
| 987 | "userTypes": [ # Output only. The user types. |
| 988 | "A String", |
| 989 | ], |
| 990 | "objectType": "A String", # Output only. The profile object type. |
| 991 | }, |
| 992 | "type": "A String", # The source type. |
| 993 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 994 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 995 | # |
| 996 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 997 | # source. Used for web cache validation. |
| 998 | }, |
| 999 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 1000 | # verified field is typically a name, email address, phone number, or |
| 1001 | # website that has been confirmed to be owned by the person. |
| 1002 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 1003 | # field. |
| 1004 | }, |
| 1005 | "person": "A String", # The name of the other person this relation refers to. |
| 1006 | "formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's |
| 1007 | # account locale or the locale specified in the Accept-Language HTTP header. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 1008 | }, |
| 1009 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1010 | "ageRanges": [ # Output only. The person's age ranges. |
| 1011 | { # A person's age range. |
| 1012 | "metadata": { # Metadata about a field. # Metadata about the age range. |
| 1013 | "source": { # The source of a field. # The source of the field. |
| 1014 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 1015 | # |
| 1016 | # Last update timestamp of this source. |
| 1017 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 1018 | # |
| 1019 | # Metadata about a source of type PROFILE. |
| 1020 | "userTypes": [ # Output only. The user types. |
| 1021 | "A String", |
| 1022 | ], |
| 1023 | "objectType": "A String", # Output only. The profile object type. |
| 1024 | }, |
| 1025 | "type": "A String", # The source type. |
| 1026 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 1027 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 1028 | # |
| 1029 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 1030 | # source. Used for web cache validation. |
| 1031 | }, |
| 1032 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 1033 | # verified field is typically a name, email address, phone number, or |
| 1034 | # website that has been confirmed to be owned by the person. |
| 1035 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 1036 | # field. |
| 1037 | }, |
| 1038 | "ageRange": "A String", # The age range. |
| 1039 | }, |
| 1040 | ], |
| 1041 | "braggingRights": [ # **DEPRECATED**: No data will be returned |
| 1042 | # The person's bragging rights. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1043 | { # **DEPRECATED**: No data will be returned |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1044 | # A person's bragging rights. |
| 1045 | "value": "A String", # The bragging rights; for example, `climbed mount everest`. |
| 1046 | "metadata": { # Metadata about a field. # Metadata about the bragging rights. |
| 1047 | "source": { # The source of a field. # The source of the field. |
| 1048 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1049 | # |
| 1050 | # Last update timestamp of this source. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1051 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 1052 | # |
| 1053 | # Metadata about a source of type PROFILE. |
| 1054 | "userTypes": [ # Output only. The user types. |
| 1055 | "A String", |
| 1056 | ], |
| 1057 | "objectType": "A String", # Output only. The profile object type. |
| 1058 | }, |
| 1059 | "type": "A String", # The source type. |
| 1060 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 1061 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1062 | # |
| 1063 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 1064 | # source. Used for web cache validation. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 1065 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1066 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1067 | # verified field is typically a name, email address, phone number, or |
| 1068 | # website that has been confirmed to be owned by the person. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1069 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1070 | # field. |
| 1071 | }, |
| 1072 | }, |
| 1073 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1074 | "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string |
| 1075 | # with a max length of 27 characters, in the form of |
| 1076 | # `people/{person_id}`. |
| 1077 | "photos": [ # Output only. The person's photos. |
| 1078 | { # A person's photo. A picture shown next to the person's name to |
| 1079 | # help others recognize the person. |
| 1080 | "url": "A String", # The URL of the photo. You can change the desired size by appending a query |
| 1081 | # parameter `sz={size}` at the end of the url, where {size} is the size in |
| 1082 | # pixels. Example: |
| 1083 | # https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50 |
| 1084 | "default": True or False, # True if the photo is a default photo; |
| 1085 | # false if the photo is a user-provided photo. |
| 1086 | "metadata": { # Metadata about a field. # Metadata about the photo. |
| 1087 | "source": { # The source of a field. # The source of the field. |
| 1088 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1089 | # |
| 1090 | # Last update timestamp of this source. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1091 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 1092 | # |
| 1093 | # Metadata about a source of type PROFILE. |
| 1094 | "userTypes": [ # Output only. The user types. |
| 1095 | "A String", |
| 1096 | ], |
| 1097 | "objectType": "A String", # Output only. The profile object type. |
| 1098 | }, |
| 1099 | "type": "A String", # The source type. |
| 1100 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 1101 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1102 | # |
| 1103 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 1104 | # source. Used for web cache validation. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1105 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1106 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1107 | # verified field is typically a name, email address, phone number, or |
| 1108 | # website that has been confirmed to be owned by the person. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1109 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1110 | # field. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 1111 | }, |
| 1112 | }, |
| 1113 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1114 | "addresses": [ # The person's street addresses. |
| 1115 | { # A person's physical address. May be a P.O. box or street address. All fields |
| 1116 | # are optional. |
| 1117 | "streetAddress": "A String", # The street address. |
| 1118 | "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it |
| 1119 | # will be automatically constructed from structured values. |
| 1120 | "country": "A String", # The country of the address. |
| 1121 | "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's |
| 1122 | # account locale or the `Accept-Language` HTTP header locale. |
| 1123 | "city": "A String", # The city of the address. |
| 1124 | "postalCode": "A String", # The postal code of the address. |
| 1125 | "extendedAddress": "A String", # The extended address of the address; for example, the apartment number. |
| 1126 | "type": "A String", # The type of the address. The type can be custom or one of these predefined |
| 1127 | # values: |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1128 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1129 | # * `home` |
| 1130 | # * `work` |
| 1131 | # * `other` |
| 1132 | "region": "A String", # The region of the address; for example, the state or province. |
| 1133 | "poBox": "A String", # The P.O. box of the address. |
| 1134 | "metadata": { # Metadata about a field. # Metadata about the address. |
| 1135 | "source": { # The source of a field. # The source of the field. |
| 1136 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 1137 | # |
| 1138 | # Last update timestamp of this source. |
| 1139 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 1140 | # |
| 1141 | # Metadata about a source of type PROFILE. |
| 1142 | "userTypes": [ # Output only. The user types. |
| 1143 | "A String", |
| 1144 | ], |
| 1145 | "objectType": "A String", # Output only. The profile object type. |
| 1146 | }, |
| 1147 | "type": "A String", # The source type. |
| 1148 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 1149 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 1150 | # |
| 1151 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 1152 | # source. Used for web cache validation. |
| 1153 | }, |
| 1154 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 1155 | # verified field is typically a name, email address, phone number, or |
| 1156 | # website that has been confirmed to be owned by the person. |
| 1157 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 1158 | # field. |
| 1159 | }, |
| 1160 | "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country |
| 1161 | # code of the address. |
| 1162 | }, |
| 1163 | ], |
| 1164 | "emailAddresses": [ # The person's email addresses. |
| 1165 | { # A person's email address. |
| 1166 | "formattedType": "A String", # Output only. The type of the email address translated and formatted in the |
| 1167 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 1168 | "metadata": { # Metadata about a field. # Metadata about the email address. |
| 1169 | "source": { # The source of a field. # The source of the field. |
| 1170 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 1171 | # |
| 1172 | # Last update timestamp of this source. |
| 1173 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 1174 | # |
| 1175 | # Metadata about a source of type PROFILE. |
| 1176 | "userTypes": [ # Output only. The user types. |
| 1177 | "A String", |
| 1178 | ], |
| 1179 | "objectType": "A String", # Output only. The profile object type. |
| 1180 | }, |
| 1181 | "type": "A String", # The source type. |
| 1182 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 1183 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 1184 | # |
| 1185 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 1186 | # source. Used for web cache validation. |
| 1187 | }, |
| 1188 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 1189 | # verified field is typically a name, email address, phone number, or |
| 1190 | # website that has been confirmed to be owned by the person. |
| 1191 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 1192 | # field. |
| 1193 | }, |
| 1194 | "value": "A String", # The email address. |
| 1195 | "displayName": "A String", # The display name of the email. |
| 1196 | "type": "A String", # The type of the email address. The type can be custom or one of these |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1197 | # predefined values: |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1198 | # |
| 1199 | # * `home` |
| 1200 | # * `work` |
| 1201 | # * `other` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1202 | }, |
| 1203 | ], |
| 1204 | "nicknames": [ # The person's nicknames. |
| 1205 | { # A person's nickname. |
| 1206 | "metadata": { # Metadata about a field. # Metadata about the nickname. |
| 1207 | "source": { # The source of a field. # The source of the field. |
| 1208 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1209 | # |
| 1210 | # Last update timestamp of this source. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1211 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 1212 | # |
| 1213 | # Metadata about a source of type PROFILE. |
| 1214 | "userTypes": [ # Output only. The user types. |
| 1215 | "A String", |
| 1216 | ], |
| 1217 | "objectType": "A String", # Output only. The profile object type. |
| 1218 | }, |
| 1219 | "type": "A String", # The source type. |
| 1220 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 1221 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1222 | # |
| 1223 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 1224 | # source. Used for web cache validation. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 1225 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1226 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1227 | # verified field is typically a name, email address, phone number, or |
| 1228 | # website that has been confirmed to be owned by the person. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1229 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1230 | # field. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 1231 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1232 | "type": "A String", # The type of the nickname. |
| 1233 | "value": "A String", # The nickname. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 1234 | }, |
| 1235 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1236 | "events": [ # The person's events. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 1237 | { # An event related to the person. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1238 | "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the event. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1239 | # and time zone are either specified elsewhere or are not significant. The date |
| 1240 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 1241 | # |
| 1242 | # * A full date, with non-zero year, month and day values |
| 1243 | # * A month and day value, with a zero year, e.g. an anniversary |
| 1244 | # * A year on its own, with zero month and day values |
| 1245 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 1246 | # |
| 1247 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1248 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 1249 | # a year. |
| 1250 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1251 | # month and day. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1252 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1253 | # if specifying a year by itself or a year and month where the day is not |
| 1254 | # significant. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 1255 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1256 | "formattedType": "A String", # Output only. The type of the event translated and formatted in the |
| 1257 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 1258 | "metadata": { # Metadata about a field. # Metadata about the event. |
| 1259 | "source": { # The source of a field. # The source of the field. |
| 1260 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 1261 | # |
| 1262 | # Last update timestamp of this source. |
| 1263 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 1264 | # |
| 1265 | # Metadata about a source of type PROFILE. |
| 1266 | "userTypes": [ # Output only. The user types. |
| 1267 | "A String", |
| 1268 | ], |
| 1269 | "objectType": "A String", # Output only. The profile object type. |
| 1270 | }, |
| 1271 | "type": "A String", # The source type. |
| 1272 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 1273 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 1274 | # |
| 1275 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 1276 | # source. Used for web cache validation. |
| 1277 | }, |
| 1278 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 1279 | # verified field is typically a name, email address, phone number, or |
| 1280 | # website that has been confirmed to be owned by the person. |
| 1281 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 1282 | # field. |
| 1283 | }, |
| 1284 | "type": "A String", # The type of the event. The type can be custom or one of these predefined |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1285 | # values: |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1286 | # |
| 1287 | # * `anniversary` |
| 1288 | # * `other` |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 1289 | }, |
| 1290 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1291 | "urls": [ # The person's associated URLs. |
| 1292 | { # A person's associated URLs. |
| 1293 | "type": "A String", # The type of the URL. The type can be custom or one of these predefined |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1294 | # values: |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1295 | # |
| 1296 | # * `home` |
| 1297 | # * `work` |
| 1298 | # * `blog` |
| 1299 | # * `profile` |
| 1300 | # * `homePage` |
| 1301 | # * `ftp` |
| 1302 | # * `reservations` |
| 1303 | # * `appInstallPage`: website for a Google+ application. |
| 1304 | # * `other` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1305 | "metadata": { # Metadata about a field. # Metadata about the URL. |
| 1306 | "source": { # The source of a field. # The source of the field. |
| 1307 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1308 | # |
| 1309 | # Last update timestamp of this source. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1310 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 1311 | # |
| 1312 | # Metadata about a source of type PROFILE. |
| 1313 | "userTypes": [ # Output only. The user types. |
| 1314 | "A String", |
| 1315 | ], |
| 1316 | "objectType": "A String", # Output only. The profile object type. |
| 1317 | }, |
| 1318 | "type": "A String", # The source type. |
| 1319 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 1320 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1321 | # |
| 1322 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 1323 | # source. Used for web cache validation. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 1324 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1325 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1326 | # verified field is typically a name, email address, phone number, or |
| 1327 | # website that has been confirmed to be owned by the person. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1328 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1329 | # field. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 1330 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1331 | "formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's |
| 1332 | # account locale or the `Accept-Language` HTTP header locale. |
| 1333 | "value": "A String", # The URL. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 1334 | }, |
| 1335 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1336 | } |
| 1337 | |
| 1338 | x__xgafv: string, V1 error format. |
| 1339 | Allowed values |
| 1340 | 1 - v1 error format |
| 1341 | 2 - v2 error format |
| 1342 | |
| 1343 | Returns: |
| 1344 | An object of the form: |
| 1345 | |
| 1346 | { # Information about a person merged from various data sources such as the |
| 1347 | # authenticated user's contacts and profile data. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1348 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1349 | # Most fields can have multiple items. The items in a field have no guaranteed |
| 1350 | # order, but each non-empty field is guaranteed to have exactly one field with |
| 1351 | # `metadata.primary` set to true. |
| 1352 | "interests": [ # The person's interests. |
| 1353 | { # One of the person's interests. |
| 1354 | "value": "A String", # The interest; for example, `stargazing`. |
| 1355 | "metadata": { # Metadata about a field. # Metadata about the interest. |
| 1356 | "source": { # The source of a field. # The source of the field. |
| 1357 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 1358 | # |
| 1359 | # Last update timestamp of this source. |
| 1360 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 1361 | # |
| 1362 | # Metadata about a source of type PROFILE. |
| 1363 | "userTypes": [ # Output only. The user types. |
| 1364 | "A String", |
| 1365 | ], |
| 1366 | "objectType": "A String", # Output only. The profile object type. |
| 1367 | }, |
| 1368 | "type": "A String", # The source type. |
| 1369 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 1370 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 1371 | # |
| 1372 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 1373 | # source. Used for web cache validation. |
| 1374 | }, |
| 1375 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 1376 | # verified field is typically a name, email address, phone number, or |
| 1377 | # website that has been confirmed to be owned by the person. |
| 1378 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 1379 | # field. |
| 1380 | }, |
| 1381 | }, |
| 1382 | ], |
| 1383 | "userDefined": [ # The person's user defined data. |
| 1384 | { # Arbitrary user data that is populated by the end users. |
| 1385 | "metadata": { # Metadata about a field. # Metadata about the user defined data. |
| 1386 | "source": { # The source of a field. # The source of the field. |
| 1387 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 1388 | # |
| 1389 | # Last update timestamp of this source. |
| 1390 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 1391 | # |
| 1392 | # Metadata about a source of type PROFILE. |
| 1393 | "userTypes": [ # Output only. The user types. |
| 1394 | "A String", |
| 1395 | ], |
| 1396 | "objectType": "A String", # Output only. The profile object type. |
| 1397 | }, |
| 1398 | "type": "A String", # The source type. |
| 1399 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 1400 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 1401 | # |
| 1402 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 1403 | # source. Used for web cache validation. |
| 1404 | }, |
| 1405 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 1406 | # verified field is typically a name, email address, phone number, or |
| 1407 | # website that has been confirmed to be owned by the person. |
| 1408 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 1409 | # field. |
| 1410 | }, |
| 1411 | "key": "A String", # The end user specified key of the user defined data. |
| 1412 | "value": "A String", # The end user specified value of the user defined data. |
| 1413 | }, |
| 1414 | ], |
| 1415 | "sipAddresses": [ # The person's SIP addresses. |
| 1416 | { # A person's SIP address. Session Initial Protocol addresses are used for VoIP |
| 1417 | # communications to make voice or video calls over the internet. |
| 1418 | "value": "A String", # The SIP address in the |
| 1419 | # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI |
| 1420 | # format. |
| 1421 | "type": "A String", # The type of the SIP address. The type can be custom or or one of these |
| 1422 | # predefined values: |
| 1423 | # |
| 1424 | # * `home` |
| 1425 | # * `work` |
| 1426 | # * `mobile` |
| 1427 | # * `other` |
| 1428 | "metadata": { # Metadata about a field. # Metadata about the SIP address. |
| 1429 | "source": { # The source of a field. # The source of the field. |
| 1430 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 1431 | # |
| 1432 | # Last update timestamp of this source. |
| 1433 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 1434 | # |
| 1435 | # Metadata about a source of type PROFILE. |
| 1436 | "userTypes": [ # Output only. The user types. |
| 1437 | "A String", |
| 1438 | ], |
| 1439 | "objectType": "A String", # Output only. The profile object type. |
| 1440 | }, |
| 1441 | "type": "A String", # The source type. |
| 1442 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 1443 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 1444 | # |
| 1445 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 1446 | # source. Used for web cache validation. |
| 1447 | }, |
| 1448 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 1449 | # verified field is typically a name, email address, phone number, or |
| 1450 | # website that has been confirmed to be owned by the person. |
| 1451 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 1452 | # field. |
| 1453 | }, |
| 1454 | "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the |
| 1455 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 1456 | }, |
| 1457 | ], |
| 1458 | "phoneNumbers": [ # The person's phone numbers. |
| 1459 | { # A person's phone number. |
| 1460 | "type": "A String", # The type of the phone number. The type can be custom or one of these |
| 1461 | # predefined values: |
| 1462 | # |
| 1463 | # * `home` |
| 1464 | # * `work` |
| 1465 | # * `mobile` |
| 1466 | # * `homeFax` |
| 1467 | # * `workFax` |
| 1468 | # * `otherFax` |
| 1469 | # * `pager` |
| 1470 | # * `workMobile` |
| 1471 | # * `workPager` |
| 1472 | # * `main` |
| 1473 | # * `googleVoice` |
| 1474 | # * `other` |
| 1475 | "value": "A String", # The phone number. |
| 1476 | "canonicalForm": "A String", # Output only. The canonicalized [ITU-T |
| 1477 | # E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) |
| 1478 | # form of the phone number. |
| 1479 | "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the |
| 1480 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 1481 | "metadata": { # Metadata about a field. # Metadata about the phone number. |
| 1482 | "source": { # The source of a field. # The source of the field. |
| 1483 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 1484 | # |
| 1485 | # Last update timestamp of this source. |
| 1486 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 1487 | # |
| 1488 | # Metadata about a source of type PROFILE. |
| 1489 | "userTypes": [ # Output only. The user types. |
| 1490 | "A String", |
| 1491 | ], |
| 1492 | "objectType": "A String", # Output only. The profile object type. |
| 1493 | }, |
| 1494 | "type": "A String", # The source type. |
| 1495 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 1496 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 1497 | # |
| 1498 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 1499 | # source. Used for web cache validation. |
| 1500 | }, |
| 1501 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 1502 | # verified field is typically a name, email address, phone number, or |
| 1503 | # website that has been confirmed to be owned by the person. |
| 1504 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 1505 | # field. |
| 1506 | }, |
| 1507 | }, |
| 1508 | ], |
| 1509 | "occupations": [ # The person's occupations. |
| 1510 | { # A person's occupation. |
| 1511 | "value": "A String", # The occupation; for example, `carpenter`. |
| 1512 | "metadata": { # Metadata about a field. # Metadata about the occupation. |
| 1513 | "source": { # The source of a field. # The source of the field. |
| 1514 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 1515 | # |
| 1516 | # Last update timestamp of this source. |
| 1517 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 1518 | # |
| 1519 | # Metadata about a source of type PROFILE. |
| 1520 | "userTypes": [ # Output only. The user types. |
| 1521 | "A String", |
| 1522 | ], |
| 1523 | "objectType": "A String", # Output only. The profile object type. |
| 1524 | }, |
| 1525 | "type": "A String", # The source type. |
| 1526 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 1527 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 1528 | # |
| 1529 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 1530 | # source. Used for web cache validation. |
| 1531 | }, |
| 1532 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 1533 | # verified field is typically a name, email address, phone number, or |
| 1534 | # website that has been confirmed to be owned by the person. |
| 1535 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 1536 | # field. |
| 1537 | }, |
| 1538 | }, |
| 1539 | ], |
| 1540 | "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) |
| 1541 | # |
| 1542 | # The person's age range. |
| 1543 | "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 1544 | # resource. Used for web cache validation. |
| 1545 | "biographies": [ # The person's biographies. |
| 1546 | { # A person's short biography. |
| 1547 | "metadata": { # Metadata about a field. # Metadata about the biography. |
| 1548 | "source": { # The source of a field. # The source of the field. |
| 1549 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 1550 | # |
| 1551 | # Last update timestamp of this source. |
| 1552 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 1553 | # |
| 1554 | # Metadata about a source of type PROFILE. |
| 1555 | "userTypes": [ # Output only. The user types. |
| 1556 | "A String", |
| 1557 | ], |
| 1558 | "objectType": "A String", # Output only. The profile object type. |
| 1559 | }, |
| 1560 | "type": "A String", # The source type. |
| 1561 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 1562 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 1563 | # |
| 1564 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 1565 | # source. Used for web cache validation. |
| 1566 | }, |
| 1567 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 1568 | # verified field is typically a name, email address, phone number, or |
| 1569 | # website that has been confirmed to be owned by the person. |
| 1570 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 1571 | # field. |
| 1572 | }, |
| 1573 | "contentType": "A String", # The content type of the biography. |
| 1574 | "value": "A String", # The short biography. |
| 1575 | }, |
| 1576 | ], |
| 1577 | "locales": [ # The person's locale preferences. |
| 1578 | { # A person's locale preference. |
| 1579 | "metadata": { # Metadata about a field. # Metadata about the locale. |
| 1580 | "source": { # The source of a field. # The source of the field. |
| 1581 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 1582 | # |
| 1583 | # Last update timestamp of this source. |
| 1584 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 1585 | # |
| 1586 | # Metadata about a source of type PROFILE. |
| 1587 | "userTypes": [ # Output only. The user types. |
| 1588 | "A String", |
| 1589 | ], |
| 1590 | "objectType": "A String", # Output only. The profile object type. |
| 1591 | }, |
| 1592 | "type": "A String", # The source type. |
| 1593 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 1594 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 1595 | # |
| 1596 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 1597 | # source. Used for web cache validation. |
| 1598 | }, |
| 1599 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 1600 | # verified field is typically a name, email address, phone number, or |
| 1601 | # website that has been confirmed to be owned by the person. |
| 1602 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 1603 | # field. |
| 1604 | }, |
| 1605 | "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) |
| 1606 | # language tag representing the locale. |
| 1607 | }, |
| 1608 | ], |
| 1609 | "taglines": [ # Output only. **DEPRECATED**: No data will be returned |
| 1610 | # The person's taglines. |
| 1611 | { # **DEPRECATED**: No data will be returned |
| 1612 | # A brief one-line description of the person. |
| 1613 | "metadata": { # Metadata about a field. # Metadata about the tagline. |
| 1614 | "source": { # The source of a field. # The source of the field. |
| 1615 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 1616 | # |
| 1617 | # Last update timestamp of this source. |
| 1618 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 1619 | # |
| 1620 | # Metadata about a source of type PROFILE. |
| 1621 | "userTypes": [ # Output only. The user types. |
| 1622 | "A String", |
| 1623 | ], |
| 1624 | "objectType": "A String", # Output only. The profile object type. |
| 1625 | }, |
| 1626 | "type": "A String", # The source type. |
| 1627 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 1628 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 1629 | # |
| 1630 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 1631 | # source. Used for web cache validation. |
| 1632 | }, |
| 1633 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 1634 | # verified field is typically a name, email address, phone number, or |
| 1635 | # website that has been confirmed to be owned by the person. |
| 1636 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 1637 | # field. |
| 1638 | }, |
| 1639 | "value": "A String", # The tagline. |
| 1640 | }, |
| 1641 | ], |
| 1642 | "organizations": [ # The person's past or current organizations. |
| 1643 | { # A person's past or current organization. Overlapping date ranges are |
| 1644 | # permitted. |
| 1645 | "title": "A String", # The person's job title at the organization. |
| 1646 | "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker |
| 1647 | # symbol, abbreviation, or acronym. |
| 1648 | "name": "A String", # The name of the organization. |
| 1649 | "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The start date when the person joined the organization. |
| 1650 | # and time zone are either specified elsewhere or are not significant. The date |
| 1651 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 1652 | # |
| 1653 | # * A full date, with non-zero year, month and day values |
| 1654 | # * A month and day value, with a zero year, e.g. an anniversary |
| 1655 | # * A year on its own, with zero month and day values |
| 1656 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 1657 | # |
| 1658 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 1659 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 1660 | # a year. |
| 1661 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 1662 | # month and day. |
| 1663 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 1664 | # if specifying a year by itself or a year and month where the day is not |
| 1665 | # significant. |
| 1666 | }, |
| 1667 | "department": "A String", # The person's department at the organization. |
| 1668 | "current": True or False, # True if the organization is the person's current organization; |
| 1669 | # false if the organization is a past organization. |
| 1670 | "location": "A String", # The location of the organization office the person works at. |
| 1671 | "domain": "A String", # The domain name associated with the organization; for example, |
| 1672 | # `google.com`. |
| 1673 | "metadata": { # Metadata about a field. # Metadata about the organization. |
| 1674 | "source": { # The source of a field. # The source of the field. |
| 1675 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 1676 | # |
| 1677 | # Last update timestamp of this source. |
| 1678 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 1679 | # |
| 1680 | # Metadata about a source of type PROFILE. |
| 1681 | "userTypes": [ # Output only. The user types. |
| 1682 | "A String", |
| 1683 | ], |
| 1684 | "objectType": "A String", # Output only. The profile object type. |
| 1685 | }, |
| 1686 | "type": "A String", # The source type. |
| 1687 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 1688 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 1689 | # |
| 1690 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 1691 | # source. Used for web cache validation. |
| 1692 | }, |
| 1693 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 1694 | # verified field is typically a name, email address, phone number, or |
| 1695 | # website that has been confirmed to be owned by the person. |
| 1696 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 1697 | # field. |
| 1698 | }, |
| 1699 | "jobDescription": "A String", # The person's job description at the organization. |
| 1700 | "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The end date when the person left the organization. |
| 1701 | # and time zone are either specified elsewhere or are not significant. The date |
| 1702 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 1703 | # |
| 1704 | # * A full date, with non-zero year, month and day values |
| 1705 | # * A month and day value, with a zero year, e.g. an anniversary |
| 1706 | # * A year on its own, with zero month and day values |
| 1707 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 1708 | # |
| 1709 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 1710 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 1711 | # a year. |
| 1712 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 1713 | # month and day. |
| 1714 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 1715 | # if specifying a year by itself or a year and month where the day is not |
| 1716 | # significant. |
| 1717 | }, |
| 1718 | "phoneticName": "A String", # The phonetic name of the organization. |
| 1719 | "formattedType": "A String", # Output only. The type of the organization translated and formatted in the |
| 1720 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 1721 | "type": "A String", # The type of the organization. The type can be custom or one of these |
| 1722 | # predefined values: |
| 1723 | # |
| 1724 | # * `work` |
| 1725 | # * `school` |
| 1726 | }, |
| 1727 | ], |
| 1728 | "residences": [ # The person's residences. |
| 1729 | { # A person's past or current residence. |
| 1730 | "metadata": { # Metadata about a field. # Metadata about the residence. |
| 1731 | "source": { # The source of a field. # The source of the field. |
| 1732 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 1733 | # |
| 1734 | # Last update timestamp of this source. |
| 1735 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 1736 | # |
| 1737 | # Metadata about a source of type PROFILE. |
| 1738 | "userTypes": [ # Output only. The user types. |
| 1739 | "A String", |
| 1740 | ], |
| 1741 | "objectType": "A String", # Output only. The profile object type. |
| 1742 | }, |
| 1743 | "type": "A String", # The source type. |
| 1744 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 1745 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 1746 | # |
| 1747 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 1748 | # source. Used for web cache validation. |
| 1749 | }, |
| 1750 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 1751 | # verified field is typically a name, email address, phone number, or |
| 1752 | # website that has been confirmed to be owned by the person. |
| 1753 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 1754 | # field. |
| 1755 | }, |
| 1756 | "current": True or False, # True if the residence is the person's current residence; |
| 1757 | # false if the residence is a past residence. |
| 1758 | "value": "A String", # The address of the residence. |
| 1759 | }, |
| 1760 | ], |
| 1761 | "genders": [ # The person's genders. |
| 1762 | { # A person's gender. |
| 1763 | "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account |
| 1764 | # locale or the `Accept-Language` HTTP header locale. Unspecified or custom |
| 1765 | # value are not localized. |
| 1766 | "metadata": { # Metadata about a field. # Metadata about the gender. |
| 1767 | "source": { # The source of a field. # The source of the field. |
| 1768 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 1769 | # |
| 1770 | # Last update timestamp of this source. |
| 1771 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 1772 | # |
| 1773 | # Metadata about a source of type PROFILE. |
| 1774 | "userTypes": [ # Output only. The user types. |
| 1775 | "A String", |
| 1776 | ], |
| 1777 | "objectType": "A String", # Output only. The profile object type. |
| 1778 | }, |
| 1779 | "type": "A String", # The source type. |
| 1780 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 1781 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 1782 | # |
| 1783 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 1784 | # source. Used for web cache validation. |
| 1785 | }, |
| 1786 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 1787 | # verified field is typically a name, email address, phone number, or |
| 1788 | # website that has been confirmed to be owned by the person. |
| 1789 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 1790 | # field. |
| 1791 | }, |
| 1792 | "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value |
| 1793 | # can be custom or one of these predefined values: |
| 1794 | # |
| 1795 | # * `male` |
| 1796 | # * `female` |
| 1797 | # * `other` |
| 1798 | "value": "A String", # The gender for the person. The gender can be custom or one of these |
| 1799 | # predefined values: |
| 1800 | # |
| 1801 | # * `male` |
| 1802 | # * `female` |
| 1803 | # * `unspecified` |
| 1804 | }, |
| 1805 | ], |
| 1806 | "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned |
| 1807 | # The person's relationship interests. |
| 1808 | { # **DEPRECATED**: No data will be returned |
| 1809 | # A person's relationship interest . |
| 1810 | "formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted |
| 1811 | # in the viewer's account locale or the locale specified in the |
| 1812 | # Accept-Language HTTP header. |
| 1813 | "metadata": { # Metadata about a field. # Metadata about the relationship interest. |
| 1814 | "source": { # The source of a field. # The source of the field. |
| 1815 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 1816 | # |
| 1817 | # Last update timestamp of this source. |
| 1818 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 1819 | # |
| 1820 | # Metadata about a source of type PROFILE. |
| 1821 | "userTypes": [ # Output only. The user types. |
| 1822 | "A String", |
| 1823 | ], |
| 1824 | "objectType": "A String", # Output only. The profile object type. |
| 1825 | }, |
| 1826 | "type": "A String", # The source type. |
| 1827 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 1828 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 1829 | # |
| 1830 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 1831 | # source. Used for web cache validation. |
| 1832 | }, |
| 1833 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 1834 | # verified field is typically a name, email address, phone number, or |
| 1835 | # website that has been confirmed to be owned by the person. |
| 1836 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 1837 | # field. |
| 1838 | }, |
| 1839 | "value": "A String", # The kind of relationship the person is looking for. The value can be custom |
| 1840 | # or one of these predefined values: |
| 1841 | # |
| 1842 | # * `friend` |
| 1843 | # * `date` |
| 1844 | # * `relationship` |
| 1845 | # * `networking` |
| 1846 | }, |
| 1847 | ], |
| 1848 | "metadata": { # The metadata about a person. # Output only. Metadata about the person. |
| 1849 | "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for |
| 1850 | # [`connections.list`](/people/api/rest/v1/people.connections/list) requests |
| 1851 | # that include a sync token. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1852 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1853 | # The resource name may change when adding or removing fields that link a |
| 1854 | # contact and profile such as a verified email, verified phone number, or |
| 1855 | # profile URL. |
| 1856 | "A String", |
| 1857 | ], |
| 1858 | "sources": [ # The sources of data for the person. |
| 1859 | { # The source of a field. |
| 1860 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1861 | # |
| 1862 | # Last update timestamp of this source. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1863 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 1864 | # |
| 1865 | # Metadata about a source of type PROFILE. |
| 1866 | "userTypes": [ # Output only. The user types. |
| 1867 | "A String", |
| 1868 | ], |
| 1869 | "objectType": "A String", # Output only. The profile object type. |
| 1870 | }, |
| 1871 | "type": "A String", # The source type. |
| 1872 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 1873 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1874 | # |
| 1875 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 1876 | # source. Used for web cache validation. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 1877 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1878 | ], |
| 1879 | "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource. |
| 1880 | "A String", |
| 1881 | ], |
| 1882 | "objectType": "A String", # Output only. **DEPRECATED** (Please use |
| 1883 | # `person.metadata.sources.profileMetadata.objectType` instead) |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1884 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1885 | # The type of the person object. |
| 1886 | "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for |
| 1887 | # [`connections.list`](/people/api/rest/v1/people.connections/list) requests |
| 1888 | # that include a sync token. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 1889 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1890 | "memberships": [ # The person's group memberships. |
| 1891 | { # A person's membership in a group. Only contact group memberships can be |
| 1892 | # modified. |
| 1893 | "metadata": { # Metadata about a field. # Metadata about the membership. |
| 1894 | "source": { # The source of a field. # The source of the field. |
| 1895 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 1896 | # |
| 1897 | # Last update timestamp of this source. |
| 1898 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 1899 | # |
| 1900 | # Metadata about a source of type PROFILE. |
| 1901 | "userTypes": [ # Output only. The user types. |
| 1902 | "A String", |
| 1903 | ], |
| 1904 | "objectType": "A String", # Output only. The profile object type. |
| 1905 | }, |
| 1906 | "type": "A String", # The source type. |
| 1907 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 1908 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 1909 | # |
| 1910 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 1911 | # source. Used for web cache validation. |
| 1912 | }, |
| 1913 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 1914 | # verified field is typically a name, email address, phone number, or |
| 1915 | # website that has been confirmed to be owned by the person. |
| 1916 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 1917 | # field. |
| 1918 | }, |
| 1919 | "contactGroupMembership": { # A Google contact group membership. # The contact group membership. |
| 1920 | "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership. |
| 1921 | "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII |
| 1922 | # string, in the form of `contactGroups/{contact_group_id}`. |
| 1923 | # Only contact_group_resource_name can be used for modifying memberships. |
| 1924 | # Any contact group membership can be removed, but only user group or |
| 1925 | # "myContacts" or "starred" system groups memberships can be added. A |
| 1926 | # contact must always have at least one contact group membership. |
| 1927 | }, |
| 1928 | "domainMembership": { # A G Suite Domain membership. # Output only. The domain membership. |
| 1929 | "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain. |
| 1930 | }, |
| 1931 | }, |
| 1932 | ], |
| 1933 | "birthdays": [ # The person's birthdays. |
| 1934 | { # A person's birthday. At least one of the `date` and `text` fields are |
| 1935 | # specified. The `date` and `text` fields typically represent the same |
| 1936 | # date, but are not guaranteed to. |
| 1937 | "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the birthday. |
| 1938 | # and time zone are either specified elsewhere or are not significant. The date |
| 1939 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 1940 | # |
| 1941 | # * A full date, with non-zero year, month and day values |
| 1942 | # * A month and day value, with a zero year, e.g. an anniversary |
| 1943 | # * A year on its own, with zero month and day values |
| 1944 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 1945 | # |
| 1946 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 1947 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 1948 | # a year. |
| 1949 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 1950 | # month and day. |
| 1951 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 1952 | # if specifying a year by itself or a year and month where the day is not |
| 1953 | # significant. |
| 1954 | }, |
| 1955 | "metadata": { # Metadata about a field. # Metadata about the birthday. |
| 1956 | "source": { # The source of a field. # The source of the field. |
| 1957 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 1958 | # |
| 1959 | # Last update timestamp of this source. |
| 1960 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 1961 | # |
| 1962 | # Metadata about a source of type PROFILE. |
| 1963 | "userTypes": [ # Output only. The user types. |
| 1964 | "A String", |
| 1965 | ], |
| 1966 | "objectType": "A String", # Output only. The profile object type. |
| 1967 | }, |
| 1968 | "type": "A String", # The source type. |
| 1969 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 1970 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 1971 | # |
| 1972 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 1973 | # source. Used for web cache validation. |
| 1974 | }, |
| 1975 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 1976 | # verified field is typically a name, email address, phone number, or |
| 1977 | # website that has been confirmed to be owned by the person. |
| 1978 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 1979 | # field. |
| 1980 | }, |
| 1981 | "text": "A String", # A free-form string representing the user's birthday. |
| 1982 | }, |
| 1983 | ], |
| 1984 | "imClients": [ # The person's instant messaging clients. |
| 1985 | { # A person's instant messaging client. |
| 1986 | "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the |
| 1987 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 1988 | "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these |
| 1989 | # predefined values: |
| 1990 | # |
| 1991 | # * `aim` |
| 1992 | # * `msn` |
| 1993 | # * `yahoo` |
| 1994 | # * `skype` |
| 1995 | # * `qq` |
| 1996 | # * `googleTalk` |
| 1997 | # * `icq` |
| 1998 | # * `jabber` |
| 1999 | # * `netMeeting` |
| 2000 | "username": "A String", # The user name used in the IM client. |
| 2001 | "type": "A String", # The type of the IM client. The type can be custom or one of these |
| 2002 | # predefined values: |
| 2003 | # |
| 2004 | # * `home` |
| 2005 | # * `work` |
| 2006 | # * `other` |
| 2007 | "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account |
| 2008 | # locale or the `Accept-Language` HTTP header locale. |
| 2009 | "metadata": { # Metadata about a field. # Metadata about the IM client. |
| 2010 | "source": { # The source of a field. # The source of the field. |
| 2011 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 2012 | # |
| 2013 | # Last update timestamp of this source. |
| 2014 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 2015 | # |
| 2016 | # Metadata about a source of type PROFILE. |
| 2017 | "userTypes": [ # Output only. The user types. |
| 2018 | "A String", |
| 2019 | ], |
| 2020 | "objectType": "A String", # Output only. The profile object type. |
| 2021 | }, |
| 2022 | "type": "A String", # The source type. |
| 2023 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 2024 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 2025 | # |
| 2026 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 2027 | # source. Used for web cache validation. |
| 2028 | }, |
| 2029 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 2030 | # verified field is typically a name, email address, phone number, or |
| 2031 | # website that has been confirmed to be owned by the person. |
| 2032 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 2033 | # field. |
| 2034 | }, |
| 2035 | }, |
| 2036 | ], |
| 2037 | "skills": [ # The person's skills. |
| 2038 | { # A skill that the person has. |
| 2039 | "metadata": { # Metadata about a field. # Metadata about the skill. |
| 2040 | "source": { # The source of a field. # The source of the field. |
| 2041 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 2042 | # |
| 2043 | # Last update timestamp of this source. |
| 2044 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 2045 | # |
| 2046 | # Metadata about a source of type PROFILE. |
| 2047 | "userTypes": [ # Output only. The user types. |
| 2048 | "A String", |
| 2049 | ], |
| 2050 | "objectType": "A String", # Output only. The profile object type. |
| 2051 | }, |
| 2052 | "type": "A String", # The source type. |
| 2053 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 2054 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 2055 | # |
| 2056 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 2057 | # source. Used for web cache validation. |
| 2058 | }, |
| 2059 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 2060 | # verified field is typically a name, email address, phone number, or |
| 2061 | # website that has been confirmed to be owned by the person. |
| 2062 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 2063 | # field. |
| 2064 | }, |
| 2065 | "value": "A String", # The skill; for example, `underwater basket weaving`. |
| 2066 | }, |
| 2067 | ], |
| 2068 | "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned |
| 2069 | # The person's relationship statuses. |
| 2070 | { # **DEPRECATED**: No data will be returned |
| 2071 | # A person's relationship status. |
| 2072 | "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in |
| 2073 | # the viewer's account locale or the `Accept-Language` HTTP header locale. |
| 2074 | "metadata": { # Metadata about a field. # Metadata about the relationship status. |
| 2075 | "source": { # The source of a field. # The source of the field. |
| 2076 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 2077 | # |
| 2078 | # Last update timestamp of this source. |
| 2079 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 2080 | # |
| 2081 | # Metadata about a source of type PROFILE. |
| 2082 | "userTypes": [ # Output only. The user types. |
| 2083 | "A String", |
| 2084 | ], |
| 2085 | "objectType": "A String", # Output only. The profile object type. |
| 2086 | }, |
| 2087 | "type": "A String", # The source type. |
| 2088 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 2089 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 2090 | # |
| 2091 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 2092 | # source. Used for web cache validation. |
| 2093 | }, |
| 2094 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 2095 | # verified field is typically a name, email address, phone number, or |
| 2096 | # website that has been confirmed to be owned by the person. |
| 2097 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 2098 | # field. |
| 2099 | }, |
| 2100 | "value": "A String", # The relationship status. The value can be custom or one of these |
| 2101 | # predefined values: |
| 2102 | # |
| 2103 | # * `single` |
| 2104 | # * `inARelationship` |
| 2105 | # * `engaged` |
| 2106 | # * `married` |
| 2107 | # * `itsComplicated` |
| 2108 | # * `openRelationship` |
| 2109 | # * `widowed` |
| 2110 | # * `inDomesticPartnership` |
| 2111 | # * `inCivilUnion` |
| 2112 | }, |
| 2113 | ], |
| 2114 | "coverPhotos": [ # Output only. The person's cover photos. |
| 2115 | { # A person's cover photo. A large image shown on the person's |
| 2116 | # profile page that represents who they are or what they care about. |
| 2117 | "url": "A String", # The URL of the cover photo. |
| 2118 | "default": True or False, # True if the cover photo is the default cover photo; |
| 2119 | # false if the cover photo is a user-provided cover photo. |
| 2120 | "metadata": { # Metadata about a field. # Metadata about the cover photo. |
| 2121 | "source": { # The source of a field. # The source of the field. |
| 2122 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 2123 | # |
| 2124 | # Last update timestamp of this source. |
| 2125 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 2126 | # |
| 2127 | # Metadata about a source of type PROFILE. |
| 2128 | "userTypes": [ # Output only. The user types. |
| 2129 | "A String", |
| 2130 | ], |
| 2131 | "objectType": "A String", # Output only. The profile object type. |
| 2132 | }, |
| 2133 | "type": "A String", # The source type. |
| 2134 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 2135 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 2136 | # |
| 2137 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 2138 | # source. Used for web cache validation. |
| 2139 | }, |
| 2140 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 2141 | # verified field is typically a name, email address, phone number, or |
| 2142 | # website that has been confirmed to be owned by the person. |
| 2143 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 2144 | # field. |
| 2145 | }, |
| 2146 | }, |
| 2147 | ], |
| 2148 | "names": [ # The person's names. |
| 2149 | { # A person's name. If the name is a mononym, the family name is empty. |
| 2150 | "middleName": "A String", # The middle name(s). |
| 2151 | "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound. |
| 2152 | "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to |
| 2153 | # the locale specified by the viewer's account or the |
| 2154 | # `Accept-Language` HTTP header. |
| 2155 | "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.` |
| 2156 | "familyName": "A String", # The family name. |
| 2157 | "phoneticGivenName": "A String", # The given name spelled as it sounds. |
| 2158 | "metadata": { # Metadata about a field. # Metadata about the name. |
| 2159 | "source": { # The source of a field. # The source of the field. |
| 2160 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 2161 | # |
| 2162 | # Last update timestamp of this source. |
| 2163 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 2164 | # |
| 2165 | # Metadata about a source of type PROFILE. |
| 2166 | "userTypes": [ # Output only. The user types. |
| 2167 | "A String", |
| 2168 | ], |
| 2169 | "objectType": "A String", # Output only. The profile object type. |
| 2170 | }, |
| 2171 | "type": "A String", # The source type. |
| 2172 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 2173 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 2174 | # |
| 2175 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 2176 | # source. Used for web cache validation. |
| 2177 | }, |
| 2178 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 2179 | # verified field is typically a name, email address, phone number, or |
| 2180 | # website that has been confirmed to be owned by the person. |
| 2181 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 2182 | # field. |
| 2183 | }, |
| 2184 | "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound. |
| 2185 | "displayName": "A String", # Output only. The display name formatted according to the locale specified by |
| 2186 | # the viewer's account or the `Accept-Language` HTTP header. |
| 2187 | "phoneticFamilyName": "A String", # The family name spelled as it sounds. |
| 2188 | "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.` |
| 2189 | "givenName": "A String", # The given name. |
| 2190 | "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound. |
| 2191 | "phoneticFullName": "A String", # The full name spelled as it sounds. |
| 2192 | }, |
| 2193 | ], |
| 2194 | "relations": [ # The person's relations. |
| 2195 | { # A person's relation to another person. |
| 2196 | "type": "A String", # The person's relation to the other person. The type can be custom or one of |
| 2197 | # these predefined values: |
| 2198 | # |
| 2199 | # * `spouse` |
| 2200 | # * `child` |
| 2201 | # * `mother` |
| 2202 | # * `father` |
| 2203 | # * `parent` |
| 2204 | # * `brother` |
| 2205 | # * `sister` |
| 2206 | # * `friend` |
| 2207 | # * `relative` |
| 2208 | # * `domesticPartner` |
| 2209 | # * `manager` |
| 2210 | # * `assistant` |
| 2211 | # * `referredBy` |
| 2212 | # * `partner` |
| 2213 | "metadata": { # Metadata about a field. # Metadata about the relation. |
| 2214 | "source": { # The source of a field. # The source of the field. |
| 2215 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 2216 | # |
| 2217 | # Last update timestamp of this source. |
| 2218 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 2219 | # |
| 2220 | # Metadata about a source of type PROFILE. |
| 2221 | "userTypes": [ # Output only. The user types. |
| 2222 | "A String", |
| 2223 | ], |
| 2224 | "objectType": "A String", # Output only. The profile object type. |
| 2225 | }, |
| 2226 | "type": "A String", # The source type. |
| 2227 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 2228 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 2229 | # |
| 2230 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 2231 | # source. Used for web cache validation. |
| 2232 | }, |
| 2233 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 2234 | # verified field is typically a name, email address, phone number, or |
| 2235 | # website that has been confirmed to be owned by the person. |
| 2236 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 2237 | # field. |
| 2238 | }, |
| 2239 | "person": "A String", # The name of the other person this relation refers to. |
| 2240 | "formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's |
| 2241 | # account locale or the locale specified in the Accept-Language HTTP header. |
| 2242 | }, |
| 2243 | ], |
| 2244 | "ageRanges": [ # Output only. The person's age ranges. |
| 2245 | { # A person's age range. |
| 2246 | "metadata": { # Metadata about a field. # Metadata about the age range. |
| 2247 | "source": { # The source of a field. # The source of the field. |
| 2248 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 2249 | # |
| 2250 | # Last update timestamp of this source. |
| 2251 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 2252 | # |
| 2253 | # Metadata about a source of type PROFILE. |
| 2254 | "userTypes": [ # Output only. The user types. |
| 2255 | "A String", |
| 2256 | ], |
| 2257 | "objectType": "A String", # Output only. The profile object type. |
| 2258 | }, |
| 2259 | "type": "A String", # The source type. |
| 2260 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 2261 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 2262 | # |
| 2263 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 2264 | # source. Used for web cache validation. |
| 2265 | }, |
| 2266 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 2267 | # verified field is typically a name, email address, phone number, or |
| 2268 | # website that has been confirmed to be owned by the person. |
| 2269 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 2270 | # field. |
| 2271 | }, |
| 2272 | "ageRange": "A String", # The age range. |
| 2273 | }, |
| 2274 | ], |
| 2275 | "braggingRights": [ # **DEPRECATED**: No data will be returned |
| 2276 | # The person's bragging rights. |
| 2277 | { # **DEPRECATED**: No data will be returned |
| 2278 | # A person's bragging rights. |
| 2279 | "value": "A String", # The bragging rights; for example, `climbed mount everest`. |
| 2280 | "metadata": { # Metadata about a field. # Metadata about the bragging rights. |
| 2281 | "source": { # The source of a field. # The source of the field. |
| 2282 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 2283 | # |
| 2284 | # Last update timestamp of this source. |
| 2285 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 2286 | # |
| 2287 | # Metadata about a source of type PROFILE. |
| 2288 | "userTypes": [ # Output only. The user types. |
| 2289 | "A String", |
| 2290 | ], |
| 2291 | "objectType": "A String", # Output only. The profile object type. |
| 2292 | }, |
| 2293 | "type": "A String", # The source type. |
| 2294 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 2295 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 2296 | # |
| 2297 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 2298 | # source. Used for web cache validation. |
| 2299 | }, |
| 2300 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 2301 | # verified field is typically a name, email address, phone number, or |
| 2302 | # website that has been confirmed to be owned by the person. |
| 2303 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 2304 | # field. |
| 2305 | }, |
| 2306 | }, |
| 2307 | ], |
| 2308 | "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string |
| 2309 | # with a max length of 27 characters, in the form of |
| 2310 | # `people/{person_id}`. |
| 2311 | "photos": [ # Output only. The person's photos. |
| 2312 | { # A person's photo. A picture shown next to the person's name to |
| 2313 | # help others recognize the person. |
| 2314 | "url": "A String", # The URL of the photo. You can change the desired size by appending a query |
| 2315 | # parameter `sz={size}` at the end of the url, where {size} is the size in |
| 2316 | # pixels. Example: |
| 2317 | # https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50 |
| 2318 | "default": True or False, # True if the photo is a default photo; |
| 2319 | # false if the photo is a user-provided photo. |
| 2320 | "metadata": { # Metadata about a field. # Metadata about the photo. |
| 2321 | "source": { # The source of a field. # The source of the field. |
| 2322 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 2323 | # |
| 2324 | # Last update timestamp of this source. |
| 2325 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 2326 | # |
| 2327 | # Metadata about a source of type PROFILE. |
| 2328 | "userTypes": [ # Output only. The user types. |
| 2329 | "A String", |
| 2330 | ], |
| 2331 | "objectType": "A String", # Output only. The profile object type. |
| 2332 | }, |
| 2333 | "type": "A String", # The source type. |
| 2334 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 2335 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 2336 | # |
| 2337 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 2338 | # source. Used for web cache validation. |
| 2339 | }, |
| 2340 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 2341 | # verified field is typically a name, email address, phone number, or |
| 2342 | # website that has been confirmed to be owned by the person. |
| 2343 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 2344 | # field. |
| 2345 | }, |
| 2346 | }, |
| 2347 | ], |
| 2348 | "addresses": [ # The person's street addresses. |
| 2349 | { # A person's physical address. May be a P.O. box or street address. All fields |
| 2350 | # are optional. |
| 2351 | "streetAddress": "A String", # The street address. |
| 2352 | "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it |
| 2353 | # will be automatically constructed from structured values. |
| 2354 | "country": "A String", # The country of the address. |
| 2355 | "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's |
| 2356 | # account locale or the `Accept-Language` HTTP header locale. |
| 2357 | "city": "A String", # The city of the address. |
| 2358 | "postalCode": "A String", # The postal code of the address. |
| 2359 | "extendedAddress": "A String", # The extended address of the address; for example, the apartment number. |
| 2360 | "type": "A String", # The type of the address. The type can be custom or one of these predefined |
| 2361 | # values: |
| 2362 | # |
| 2363 | # * `home` |
| 2364 | # * `work` |
| 2365 | # * `other` |
| 2366 | "region": "A String", # The region of the address; for example, the state or province. |
| 2367 | "poBox": "A String", # The P.O. box of the address. |
| 2368 | "metadata": { # Metadata about a field. # Metadata about the address. |
| 2369 | "source": { # The source of a field. # The source of the field. |
| 2370 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 2371 | # |
| 2372 | # Last update timestamp of this source. |
| 2373 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 2374 | # |
| 2375 | # Metadata about a source of type PROFILE. |
| 2376 | "userTypes": [ # Output only. The user types. |
| 2377 | "A String", |
| 2378 | ], |
| 2379 | "objectType": "A String", # Output only. The profile object type. |
| 2380 | }, |
| 2381 | "type": "A String", # The source type. |
| 2382 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 2383 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 2384 | # |
| 2385 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 2386 | # source. Used for web cache validation. |
| 2387 | }, |
| 2388 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 2389 | # verified field is typically a name, email address, phone number, or |
| 2390 | # website that has been confirmed to be owned by the person. |
| 2391 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 2392 | # field. |
| 2393 | }, |
| 2394 | "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country |
| 2395 | # code of the address. |
| 2396 | }, |
| 2397 | ], |
| 2398 | "emailAddresses": [ # The person's email addresses. |
| 2399 | { # A person's email address. |
| 2400 | "formattedType": "A String", # Output only. The type of the email address translated and formatted in the |
| 2401 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 2402 | "metadata": { # Metadata about a field. # Metadata about the email address. |
| 2403 | "source": { # The source of a field. # The source of the field. |
| 2404 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 2405 | # |
| 2406 | # Last update timestamp of this source. |
| 2407 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 2408 | # |
| 2409 | # Metadata about a source of type PROFILE. |
| 2410 | "userTypes": [ # Output only. The user types. |
| 2411 | "A String", |
| 2412 | ], |
| 2413 | "objectType": "A String", # Output only. The profile object type. |
| 2414 | }, |
| 2415 | "type": "A String", # The source type. |
| 2416 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 2417 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 2418 | # |
| 2419 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 2420 | # source. Used for web cache validation. |
| 2421 | }, |
| 2422 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 2423 | # verified field is typically a name, email address, phone number, or |
| 2424 | # website that has been confirmed to be owned by the person. |
| 2425 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 2426 | # field. |
| 2427 | }, |
| 2428 | "value": "A String", # The email address. |
| 2429 | "displayName": "A String", # The display name of the email. |
| 2430 | "type": "A String", # The type of the email address. The type can be custom or one of these |
| 2431 | # predefined values: |
| 2432 | # |
| 2433 | # * `home` |
| 2434 | # * `work` |
| 2435 | # * `other` |
| 2436 | }, |
| 2437 | ], |
| 2438 | "nicknames": [ # The person's nicknames. |
| 2439 | { # A person's nickname. |
| 2440 | "metadata": { # Metadata about a field. # Metadata about the nickname. |
| 2441 | "source": { # The source of a field. # The source of the field. |
| 2442 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 2443 | # |
| 2444 | # Last update timestamp of this source. |
| 2445 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 2446 | # |
| 2447 | # Metadata about a source of type PROFILE. |
| 2448 | "userTypes": [ # Output only. The user types. |
| 2449 | "A String", |
| 2450 | ], |
| 2451 | "objectType": "A String", # Output only. The profile object type. |
| 2452 | }, |
| 2453 | "type": "A String", # The source type. |
| 2454 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 2455 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 2456 | # |
| 2457 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 2458 | # source. Used for web cache validation. |
| 2459 | }, |
| 2460 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 2461 | # verified field is typically a name, email address, phone number, or |
| 2462 | # website that has been confirmed to be owned by the person. |
| 2463 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 2464 | # field. |
| 2465 | }, |
| 2466 | "type": "A String", # The type of the nickname. |
| 2467 | "value": "A String", # The nickname. |
| 2468 | }, |
| 2469 | ], |
| 2470 | "events": [ # The person's events. |
| 2471 | { # An event related to the person. |
| 2472 | "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the event. |
| 2473 | # and time zone are either specified elsewhere or are not significant. The date |
| 2474 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 2475 | # |
| 2476 | # * A full date, with non-zero year, month and day values |
| 2477 | # * A month and day value, with a zero year, e.g. an anniversary |
| 2478 | # * A year on its own, with zero month and day values |
| 2479 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 2480 | # |
| 2481 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 2482 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 2483 | # a year. |
| 2484 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 2485 | # month and day. |
| 2486 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 2487 | # if specifying a year by itself or a year and month where the day is not |
| 2488 | # significant. |
| 2489 | }, |
| 2490 | "formattedType": "A String", # Output only. The type of the event translated and formatted in the |
| 2491 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 2492 | "metadata": { # Metadata about a field. # Metadata about the event. |
| 2493 | "source": { # The source of a field. # The source of the field. |
| 2494 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 2495 | # |
| 2496 | # Last update timestamp of this source. |
| 2497 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 2498 | # |
| 2499 | # Metadata about a source of type PROFILE. |
| 2500 | "userTypes": [ # Output only. The user types. |
| 2501 | "A String", |
| 2502 | ], |
| 2503 | "objectType": "A String", # Output only. The profile object type. |
| 2504 | }, |
| 2505 | "type": "A String", # The source type. |
| 2506 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 2507 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 2508 | # |
| 2509 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 2510 | # source. Used for web cache validation. |
| 2511 | }, |
| 2512 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 2513 | # verified field is typically a name, email address, phone number, or |
| 2514 | # website that has been confirmed to be owned by the person. |
| 2515 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 2516 | # field. |
| 2517 | }, |
| 2518 | "type": "A String", # The type of the event. The type can be custom or one of these predefined |
| 2519 | # values: |
| 2520 | # |
| 2521 | # * `anniversary` |
| 2522 | # * `other` |
| 2523 | }, |
| 2524 | ], |
| 2525 | "urls": [ # The person's associated URLs. |
| 2526 | { # A person's associated URLs. |
| 2527 | "type": "A String", # The type of the URL. The type can be custom or one of these predefined |
| 2528 | # values: |
| 2529 | # |
| 2530 | # * `home` |
| 2531 | # * `work` |
| 2532 | # * `blog` |
| 2533 | # * `profile` |
| 2534 | # * `homePage` |
| 2535 | # * `ftp` |
| 2536 | # * `reservations` |
| 2537 | # * `appInstallPage`: website for a Google+ application. |
| 2538 | # * `other` |
| 2539 | "metadata": { # Metadata about a field. # Metadata about the URL. |
| 2540 | "source": { # The source of a field. # The source of the field. |
| 2541 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 2542 | # |
| 2543 | # Last update timestamp of this source. |
| 2544 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 2545 | # |
| 2546 | # Metadata about a source of type PROFILE. |
| 2547 | "userTypes": [ # Output only. The user types. |
| 2548 | "A String", |
| 2549 | ], |
| 2550 | "objectType": "A String", # Output only. The profile object type. |
| 2551 | }, |
| 2552 | "type": "A String", # The source type. |
| 2553 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 2554 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 2555 | # |
| 2556 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 2557 | # source. Used for web cache validation. |
| 2558 | }, |
| 2559 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 2560 | # verified field is typically a name, email address, phone number, or |
| 2561 | # website that has been confirmed to be owned by the person. |
| 2562 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 2563 | # field. |
| 2564 | }, |
| 2565 | "formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's |
| 2566 | # account locale or the `Accept-Language` HTTP header locale. |
| 2567 | "value": "A String", # The URL. |
| 2568 | }, |
| 2569 | ], |
| 2570 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2571 | </div> |
| 2572 | |
| 2573 | <div class="method"> |
| 2574 | <code class="details" id="deleteContact">deleteContact(resourceName, x__xgafv=None)</code> |
| 2575 | <pre>Delete a contact person. Any non-contact data will not be deleted. |
| 2576 | |
| 2577 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2578 | resourceName: string, Required. The resource name of the contact to delete. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2579 | x__xgafv: string, V1 error format. |
| 2580 | Allowed values |
| 2581 | 1 - v1 error format |
| 2582 | 2 - v2 error format |
| 2583 | |
| 2584 | Returns: |
| 2585 | An object of the form: |
| 2586 | |
| 2587 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 2588 | # empty messages in your APIs. A typical example is to use it as the request |
| 2589 | # or the response type of an API method. For instance: |
| 2590 | # |
| 2591 | # service Foo { |
| 2592 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 2593 | # } |
| 2594 | # |
| 2595 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 2596 | }</pre> |
| 2597 | </div> |
| 2598 | |
| 2599 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2600 | <code class="details" id="deleteContactPhoto">deleteContactPhoto(resourceName, personFields=None, x__xgafv=None)</code> |
| 2601 | <pre>Delete a contact's photo. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2602 | |
| 2603 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2604 | resourceName: string, Required. The resource name of the contact whose photo will be deleted. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2605 | personFields: string, Optional. A field mask to restrict which fields on the person are returned. Multiple |
| 2606 | fields can be specified by separating them with commas. Defaults to empty |
| 2607 | if not set, which will skip the post mutate get. Valid values are: |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2608 | |
| 2609 | * addresses |
| 2610 | * ageRanges |
| 2611 | * biographies |
| 2612 | * birthdays |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2613 | * coverPhotos |
| 2614 | * emailAddresses |
| 2615 | * events |
| 2616 | * genders |
| 2617 | * imClients |
| 2618 | * interests |
| 2619 | * locales |
| 2620 | * memberships |
| 2621 | * metadata |
| 2622 | * names |
| 2623 | * nicknames |
| 2624 | * occupations |
| 2625 | * organizations |
| 2626 | * phoneNumbers |
| 2627 | * photos |
| 2628 | * relations |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2629 | * residences |
| 2630 | * sipAddresses |
| 2631 | * skills |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2632 | * urls |
| 2633 | * userDefined |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2634 | x__xgafv: string, V1 error format. |
| 2635 | Allowed values |
| 2636 | 1 - v1 error format |
| 2637 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2638 | |
| 2639 | Returns: |
| 2640 | An object of the form: |
| 2641 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2642 | { # The response for deleteing a contact's photo. |
| 2643 | "person": { # Information about a person merged from various data sources such as the # The updated person, if person_fields is set in the |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2644 | # DeleteContactPhotoRequest; otherwise this will be unset. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2645 | # authenticated user's contacts and profile data. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2646 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2647 | # Most fields can have multiple items. The items in a field have no guaranteed |
| 2648 | # order, but each non-empty field is guaranteed to have exactly one field with |
| 2649 | # `metadata.primary` set to true. |
| 2650 | "interests": [ # The person's interests. |
| 2651 | { # One of the person's interests. |
| 2652 | "value": "A String", # The interest; for example, `stargazing`. |
| 2653 | "metadata": { # Metadata about a field. # Metadata about the interest. |
| 2654 | "source": { # The source of a field. # The source of the field. |
| 2655 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 2656 | # |
| 2657 | # Last update timestamp of this source. |
| 2658 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 2659 | # |
| 2660 | # Metadata about a source of type PROFILE. |
| 2661 | "userTypes": [ # Output only. The user types. |
| 2662 | "A String", |
| 2663 | ], |
| 2664 | "objectType": "A String", # Output only. The profile object type. |
| 2665 | }, |
| 2666 | "type": "A String", # The source type. |
| 2667 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 2668 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 2669 | # |
| 2670 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 2671 | # source. Used for web cache validation. |
| 2672 | }, |
| 2673 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 2674 | # verified field is typically a name, email address, phone number, or |
| 2675 | # website that has been confirmed to be owned by the person. |
| 2676 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 2677 | # field. |
| 2678 | }, |
| 2679 | }, |
| 2680 | ], |
| 2681 | "userDefined": [ # The person's user defined data. |
| 2682 | { # Arbitrary user data that is populated by the end users. |
| 2683 | "metadata": { # Metadata about a field. # Metadata about the user defined data. |
| 2684 | "source": { # The source of a field. # The source of the field. |
| 2685 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 2686 | # |
| 2687 | # Last update timestamp of this source. |
| 2688 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 2689 | # |
| 2690 | # Metadata about a source of type PROFILE. |
| 2691 | "userTypes": [ # Output only. The user types. |
| 2692 | "A String", |
| 2693 | ], |
| 2694 | "objectType": "A String", # Output only. The profile object type. |
| 2695 | }, |
| 2696 | "type": "A String", # The source type. |
| 2697 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 2698 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 2699 | # |
| 2700 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 2701 | # source. Used for web cache validation. |
| 2702 | }, |
| 2703 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 2704 | # verified field is typically a name, email address, phone number, or |
| 2705 | # website that has been confirmed to be owned by the person. |
| 2706 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 2707 | # field. |
| 2708 | }, |
| 2709 | "key": "A String", # The end user specified key of the user defined data. |
| 2710 | "value": "A String", # The end user specified value of the user defined data. |
| 2711 | }, |
| 2712 | ], |
| 2713 | "sipAddresses": [ # The person's SIP addresses. |
| 2714 | { # A person's SIP address. Session Initial Protocol addresses are used for VoIP |
| 2715 | # communications to make voice or video calls over the internet. |
| 2716 | "value": "A String", # The SIP address in the |
| 2717 | # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI |
| 2718 | # format. |
| 2719 | "type": "A String", # The type of the SIP address. The type can be custom or or one of these |
| 2720 | # predefined values: |
| 2721 | # |
| 2722 | # * `home` |
| 2723 | # * `work` |
| 2724 | # * `mobile` |
| 2725 | # * `other` |
| 2726 | "metadata": { # Metadata about a field. # Metadata about the SIP address. |
| 2727 | "source": { # The source of a field. # The source of the field. |
| 2728 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 2729 | # |
| 2730 | # Last update timestamp of this source. |
| 2731 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 2732 | # |
| 2733 | # Metadata about a source of type PROFILE. |
| 2734 | "userTypes": [ # Output only. The user types. |
| 2735 | "A String", |
| 2736 | ], |
| 2737 | "objectType": "A String", # Output only. The profile object type. |
| 2738 | }, |
| 2739 | "type": "A String", # The source type. |
| 2740 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 2741 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 2742 | # |
| 2743 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 2744 | # source. Used for web cache validation. |
| 2745 | }, |
| 2746 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 2747 | # verified field is typically a name, email address, phone number, or |
| 2748 | # website that has been confirmed to be owned by the person. |
| 2749 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 2750 | # field. |
| 2751 | }, |
| 2752 | "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the |
| 2753 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 2754 | }, |
| 2755 | ], |
| 2756 | "phoneNumbers": [ # The person's phone numbers. |
| 2757 | { # A person's phone number. |
| 2758 | "type": "A String", # The type of the phone number. The type can be custom or one of these |
| 2759 | # predefined values: |
| 2760 | # |
| 2761 | # * `home` |
| 2762 | # * `work` |
| 2763 | # * `mobile` |
| 2764 | # * `homeFax` |
| 2765 | # * `workFax` |
| 2766 | # * `otherFax` |
| 2767 | # * `pager` |
| 2768 | # * `workMobile` |
| 2769 | # * `workPager` |
| 2770 | # * `main` |
| 2771 | # * `googleVoice` |
| 2772 | # * `other` |
| 2773 | "value": "A String", # The phone number. |
| 2774 | "canonicalForm": "A String", # Output only. The canonicalized [ITU-T |
| 2775 | # E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) |
| 2776 | # form of the phone number. |
| 2777 | "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the |
| 2778 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 2779 | "metadata": { # Metadata about a field. # Metadata about the phone number. |
| 2780 | "source": { # The source of a field. # The source of the field. |
| 2781 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 2782 | # |
| 2783 | # Last update timestamp of this source. |
| 2784 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 2785 | # |
| 2786 | # Metadata about a source of type PROFILE. |
| 2787 | "userTypes": [ # Output only. The user types. |
| 2788 | "A String", |
| 2789 | ], |
| 2790 | "objectType": "A String", # Output only. The profile object type. |
| 2791 | }, |
| 2792 | "type": "A String", # The source type. |
| 2793 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 2794 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 2795 | # |
| 2796 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 2797 | # source. Used for web cache validation. |
| 2798 | }, |
| 2799 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 2800 | # verified field is typically a name, email address, phone number, or |
| 2801 | # website that has been confirmed to be owned by the person. |
| 2802 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 2803 | # field. |
| 2804 | }, |
| 2805 | }, |
| 2806 | ], |
| 2807 | "occupations": [ # The person's occupations. |
| 2808 | { # A person's occupation. |
| 2809 | "value": "A String", # The occupation; for example, `carpenter`. |
| 2810 | "metadata": { # Metadata about a field. # Metadata about the occupation. |
| 2811 | "source": { # The source of a field. # The source of the field. |
| 2812 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 2813 | # |
| 2814 | # Last update timestamp of this source. |
| 2815 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 2816 | # |
| 2817 | # Metadata about a source of type PROFILE. |
| 2818 | "userTypes": [ # Output only. The user types. |
| 2819 | "A String", |
| 2820 | ], |
| 2821 | "objectType": "A String", # Output only. The profile object type. |
| 2822 | }, |
| 2823 | "type": "A String", # The source type. |
| 2824 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 2825 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 2826 | # |
| 2827 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 2828 | # source. Used for web cache validation. |
| 2829 | }, |
| 2830 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 2831 | # verified field is typically a name, email address, phone number, or |
| 2832 | # website that has been confirmed to be owned by the person. |
| 2833 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 2834 | # field. |
| 2835 | }, |
| 2836 | }, |
| 2837 | ], |
| 2838 | "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) |
| 2839 | # |
| 2840 | # The person's age range. |
| 2841 | "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 2842 | # resource. Used for web cache validation. |
| 2843 | "biographies": [ # The person's biographies. |
| 2844 | { # A person's short biography. |
| 2845 | "metadata": { # Metadata about a field. # Metadata about the biography. |
| 2846 | "source": { # The source of a field. # The source of the field. |
| 2847 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 2848 | # |
| 2849 | # Last update timestamp of this source. |
| 2850 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 2851 | # |
| 2852 | # Metadata about a source of type PROFILE. |
| 2853 | "userTypes": [ # Output only. The user types. |
| 2854 | "A String", |
| 2855 | ], |
| 2856 | "objectType": "A String", # Output only. The profile object type. |
| 2857 | }, |
| 2858 | "type": "A String", # The source type. |
| 2859 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 2860 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 2861 | # |
| 2862 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 2863 | # source. Used for web cache validation. |
| 2864 | }, |
| 2865 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 2866 | # verified field is typically a name, email address, phone number, or |
| 2867 | # website that has been confirmed to be owned by the person. |
| 2868 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 2869 | # field. |
| 2870 | }, |
| 2871 | "contentType": "A String", # The content type of the biography. |
| 2872 | "value": "A String", # The short biography. |
| 2873 | }, |
| 2874 | ], |
| 2875 | "locales": [ # The person's locale preferences. |
| 2876 | { # A person's locale preference. |
| 2877 | "metadata": { # Metadata about a field. # Metadata about the locale. |
| 2878 | "source": { # The source of a field. # The source of the field. |
| 2879 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 2880 | # |
| 2881 | # Last update timestamp of this source. |
| 2882 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 2883 | # |
| 2884 | # Metadata about a source of type PROFILE. |
| 2885 | "userTypes": [ # Output only. The user types. |
| 2886 | "A String", |
| 2887 | ], |
| 2888 | "objectType": "A String", # Output only. The profile object type. |
| 2889 | }, |
| 2890 | "type": "A String", # The source type. |
| 2891 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 2892 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 2893 | # |
| 2894 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 2895 | # source. Used for web cache validation. |
| 2896 | }, |
| 2897 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 2898 | # verified field is typically a name, email address, phone number, or |
| 2899 | # website that has been confirmed to be owned by the person. |
| 2900 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 2901 | # field. |
| 2902 | }, |
| 2903 | "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) |
| 2904 | # language tag representing the locale. |
| 2905 | }, |
| 2906 | ], |
| 2907 | "taglines": [ # Output only. **DEPRECATED**: No data will be returned |
| 2908 | # The person's taglines. |
| 2909 | { # **DEPRECATED**: No data will be returned |
| 2910 | # A brief one-line description of the person. |
| 2911 | "metadata": { # Metadata about a field. # Metadata about the tagline. |
| 2912 | "source": { # The source of a field. # The source of the field. |
| 2913 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 2914 | # |
| 2915 | # Last update timestamp of this source. |
| 2916 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 2917 | # |
| 2918 | # Metadata about a source of type PROFILE. |
| 2919 | "userTypes": [ # Output only. The user types. |
| 2920 | "A String", |
| 2921 | ], |
| 2922 | "objectType": "A String", # Output only. The profile object type. |
| 2923 | }, |
| 2924 | "type": "A String", # The source type. |
| 2925 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 2926 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 2927 | # |
| 2928 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 2929 | # source. Used for web cache validation. |
| 2930 | }, |
| 2931 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 2932 | # verified field is typically a name, email address, phone number, or |
| 2933 | # website that has been confirmed to be owned by the person. |
| 2934 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 2935 | # field. |
| 2936 | }, |
| 2937 | "value": "A String", # The tagline. |
| 2938 | }, |
| 2939 | ], |
| 2940 | "organizations": [ # The person's past or current organizations. |
| 2941 | { # A person's past or current organization. Overlapping date ranges are |
| 2942 | # permitted. |
| 2943 | "title": "A String", # The person's job title at the organization. |
| 2944 | "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker |
| 2945 | # symbol, abbreviation, or acronym. |
| 2946 | "name": "A String", # The name of the organization. |
| 2947 | "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The start date when the person joined the organization. |
| 2948 | # and time zone are either specified elsewhere or are not significant. The date |
| 2949 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 2950 | # |
| 2951 | # * A full date, with non-zero year, month and day values |
| 2952 | # * A month and day value, with a zero year, e.g. an anniversary |
| 2953 | # * A year on its own, with zero month and day values |
| 2954 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 2955 | # |
| 2956 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 2957 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 2958 | # a year. |
| 2959 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 2960 | # month and day. |
| 2961 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 2962 | # if specifying a year by itself or a year and month where the day is not |
| 2963 | # significant. |
| 2964 | }, |
| 2965 | "department": "A String", # The person's department at the organization. |
| 2966 | "current": True or False, # True if the organization is the person's current organization; |
| 2967 | # false if the organization is a past organization. |
| 2968 | "location": "A String", # The location of the organization office the person works at. |
| 2969 | "domain": "A String", # The domain name associated with the organization; for example, |
| 2970 | # `google.com`. |
| 2971 | "metadata": { # Metadata about a field. # Metadata about the organization. |
| 2972 | "source": { # The source of a field. # The source of the field. |
| 2973 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 2974 | # |
| 2975 | # Last update timestamp of this source. |
| 2976 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 2977 | # |
| 2978 | # Metadata about a source of type PROFILE. |
| 2979 | "userTypes": [ # Output only. The user types. |
| 2980 | "A String", |
| 2981 | ], |
| 2982 | "objectType": "A String", # Output only. The profile object type. |
| 2983 | }, |
| 2984 | "type": "A String", # The source type. |
| 2985 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 2986 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 2987 | # |
| 2988 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 2989 | # source. Used for web cache validation. |
| 2990 | }, |
| 2991 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 2992 | # verified field is typically a name, email address, phone number, or |
| 2993 | # website that has been confirmed to be owned by the person. |
| 2994 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 2995 | # field. |
| 2996 | }, |
| 2997 | "jobDescription": "A String", # The person's job description at the organization. |
| 2998 | "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The end date when the person left the organization. |
| 2999 | # and time zone are either specified elsewhere or are not significant. The date |
| 3000 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 3001 | # |
| 3002 | # * A full date, with non-zero year, month and day values |
| 3003 | # * A month and day value, with a zero year, e.g. an anniversary |
| 3004 | # * A year on its own, with zero month and day values |
| 3005 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 3006 | # |
| 3007 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 3008 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 3009 | # a year. |
| 3010 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 3011 | # month and day. |
| 3012 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 3013 | # if specifying a year by itself or a year and month where the day is not |
| 3014 | # significant. |
| 3015 | }, |
| 3016 | "phoneticName": "A String", # The phonetic name of the organization. |
| 3017 | "formattedType": "A String", # Output only. The type of the organization translated and formatted in the |
| 3018 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 3019 | "type": "A String", # The type of the organization. The type can be custom or one of these |
| 3020 | # predefined values: |
| 3021 | # |
| 3022 | # * `work` |
| 3023 | # * `school` |
| 3024 | }, |
| 3025 | ], |
| 3026 | "residences": [ # The person's residences. |
| 3027 | { # A person's past or current residence. |
| 3028 | "metadata": { # Metadata about a field. # Metadata about the residence. |
| 3029 | "source": { # The source of a field. # The source of the field. |
| 3030 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 3031 | # |
| 3032 | # Last update timestamp of this source. |
| 3033 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 3034 | # |
| 3035 | # Metadata about a source of type PROFILE. |
| 3036 | "userTypes": [ # Output only. The user types. |
| 3037 | "A String", |
| 3038 | ], |
| 3039 | "objectType": "A String", # Output only. The profile object type. |
| 3040 | }, |
| 3041 | "type": "A String", # The source type. |
| 3042 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 3043 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 3044 | # |
| 3045 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 3046 | # source. Used for web cache validation. |
| 3047 | }, |
| 3048 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 3049 | # verified field is typically a name, email address, phone number, or |
| 3050 | # website that has been confirmed to be owned by the person. |
| 3051 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 3052 | # field. |
| 3053 | }, |
| 3054 | "current": True or False, # True if the residence is the person's current residence; |
| 3055 | # false if the residence is a past residence. |
| 3056 | "value": "A String", # The address of the residence. |
| 3057 | }, |
| 3058 | ], |
| 3059 | "genders": [ # The person's genders. |
| 3060 | { # A person's gender. |
| 3061 | "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account |
| 3062 | # locale or the `Accept-Language` HTTP header locale. Unspecified or custom |
| 3063 | # value are not localized. |
| 3064 | "metadata": { # Metadata about a field. # Metadata about the gender. |
| 3065 | "source": { # The source of a field. # The source of the field. |
| 3066 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 3067 | # |
| 3068 | # Last update timestamp of this source. |
| 3069 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 3070 | # |
| 3071 | # Metadata about a source of type PROFILE. |
| 3072 | "userTypes": [ # Output only. The user types. |
| 3073 | "A String", |
| 3074 | ], |
| 3075 | "objectType": "A String", # Output only. The profile object type. |
| 3076 | }, |
| 3077 | "type": "A String", # The source type. |
| 3078 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 3079 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 3080 | # |
| 3081 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 3082 | # source. Used for web cache validation. |
| 3083 | }, |
| 3084 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 3085 | # verified field is typically a name, email address, phone number, or |
| 3086 | # website that has been confirmed to be owned by the person. |
| 3087 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 3088 | # field. |
| 3089 | }, |
| 3090 | "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value |
| 3091 | # can be custom or one of these predefined values: |
| 3092 | # |
| 3093 | # * `male` |
| 3094 | # * `female` |
| 3095 | # * `other` |
| 3096 | "value": "A String", # The gender for the person. The gender can be custom or one of these |
| 3097 | # predefined values: |
| 3098 | # |
| 3099 | # * `male` |
| 3100 | # * `female` |
| 3101 | # * `unspecified` |
| 3102 | }, |
| 3103 | ], |
| 3104 | "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned |
| 3105 | # The person's relationship interests. |
| 3106 | { # **DEPRECATED**: No data will be returned |
| 3107 | # A person's relationship interest . |
| 3108 | "formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted |
| 3109 | # in the viewer's account locale or the locale specified in the |
| 3110 | # Accept-Language HTTP header. |
| 3111 | "metadata": { # Metadata about a field. # Metadata about the relationship interest. |
| 3112 | "source": { # The source of a field. # The source of the field. |
| 3113 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 3114 | # |
| 3115 | # Last update timestamp of this source. |
| 3116 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 3117 | # |
| 3118 | # Metadata about a source of type PROFILE. |
| 3119 | "userTypes": [ # Output only. The user types. |
| 3120 | "A String", |
| 3121 | ], |
| 3122 | "objectType": "A String", # Output only. The profile object type. |
| 3123 | }, |
| 3124 | "type": "A String", # The source type. |
| 3125 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 3126 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 3127 | # |
| 3128 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 3129 | # source. Used for web cache validation. |
| 3130 | }, |
| 3131 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 3132 | # verified field is typically a name, email address, phone number, or |
| 3133 | # website that has been confirmed to be owned by the person. |
| 3134 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 3135 | # field. |
| 3136 | }, |
| 3137 | "value": "A String", # The kind of relationship the person is looking for. The value can be custom |
| 3138 | # or one of these predefined values: |
| 3139 | # |
| 3140 | # * `friend` |
| 3141 | # * `date` |
| 3142 | # * `relationship` |
| 3143 | # * `networking` |
| 3144 | }, |
| 3145 | ], |
| 3146 | "metadata": { # The metadata about a person. # Output only. Metadata about the person. |
| 3147 | "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for |
| 3148 | # [`connections.list`](/people/api/rest/v1/people.connections/list) requests |
| 3149 | # that include a sync token. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3150 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3151 | # The resource name may change when adding or removing fields that link a |
| 3152 | # contact and profile such as a verified email, verified phone number, or |
| 3153 | # profile URL. |
| 3154 | "A String", |
| 3155 | ], |
| 3156 | "sources": [ # The sources of data for the person. |
| 3157 | { # The source of a field. |
| 3158 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3159 | # |
| 3160 | # Last update timestamp of this source. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3161 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 3162 | # |
| 3163 | # Metadata about a source of type PROFILE. |
| 3164 | "userTypes": [ # Output only. The user types. |
| 3165 | "A String", |
| 3166 | ], |
| 3167 | "objectType": "A String", # Output only. The profile object type. |
| 3168 | }, |
| 3169 | "type": "A String", # The source type. |
| 3170 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 3171 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3172 | # |
| 3173 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 3174 | # source. Used for web cache validation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3175 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3176 | ], |
| 3177 | "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource. |
| 3178 | "A String", |
| 3179 | ], |
| 3180 | "objectType": "A String", # Output only. **DEPRECATED** (Please use |
| 3181 | # `person.metadata.sources.profileMetadata.objectType` instead) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3182 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3183 | # The type of the person object. |
| 3184 | "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for |
| 3185 | # [`connections.list`](/people/api/rest/v1/people.connections/list) requests |
| 3186 | # that include a sync token. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3187 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3188 | "memberships": [ # The person's group memberships. |
| 3189 | { # A person's membership in a group. Only contact group memberships can be |
| 3190 | # modified. |
| 3191 | "metadata": { # Metadata about a field. # Metadata about the membership. |
| 3192 | "source": { # The source of a field. # The source of the field. |
| 3193 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 3194 | # |
| 3195 | # Last update timestamp of this source. |
| 3196 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 3197 | # |
| 3198 | # Metadata about a source of type PROFILE. |
| 3199 | "userTypes": [ # Output only. The user types. |
| 3200 | "A String", |
| 3201 | ], |
| 3202 | "objectType": "A String", # Output only. The profile object type. |
| 3203 | }, |
| 3204 | "type": "A String", # The source type. |
| 3205 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 3206 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 3207 | # |
| 3208 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 3209 | # source. Used for web cache validation. |
| 3210 | }, |
| 3211 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 3212 | # verified field is typically a name, email address, phone number, or |
| 3213 | # website that has been confirmed to be owned by the person. |
| 3214 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 3215 | # field. |
| 3216 | }, |
| 3217 | "contactGroupMembership": { # A Google contact group membership. # The contact group membership. |
| 3218 | "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership. |
| 3219 | "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII |
| 3220 | # string, in the form of `contactGroups/{contact_group_id}`. |
| 3221 | # Only contact_group_resource_name can be used for modifying memberships. |
| 3222 | # Any contact group membership can be removed, but only user group or |
| 3223 | # "myContacts" or "starred" system groups memberships can be added. A |
| 3224 | # contact must always have at least one contact group membership. |
| 3225 | }, |
| 3226 | "domainMembership": { # A G Suite Domain membership. # Output only. The domain membership. |
| 3227 | "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain. |
| 3228 | }, |
| 3229 | }, |
| 3230 | ], |
| 3231 | "birthdays": [ # The person's birthdays. |
| 3232 | { # A person's birthday. At least one of the `date` and `text` fields are |
| 3233 | # specified. The `date` and `text` fields typically represent the same |
| 3234 | # date, but are not guaranteed to. |
| 3235 | "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the birthday. |
| 3236 | # and time zone are either specified elsewhere or are not significant. The date |
| 3237 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 3238 | # |
| 3239 | # * A full date, with non-zero year, month and day values |
| 3240 | # * A month and day value, with a zero year, e.g. an anniversary |
| 3241 | # * A year on its own, with zero month and day values |
| 3242 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 3243 | # |
| 3244 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 3245 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 3246 | # a year. |
| 3247 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 3248 | # month and day. |
| 3249 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 3250 | # if specifying a year by itself or a year and month where the day is not |
| 3251 | # significant. |
| 3252 | }, |
| 3253 | "metadata": { # Metadata about a field. # Metadata about the birthday. |
| 3254 | "source": { # The source of a field. # The source of the field. |
| 3255 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 3256 | # |
| 3257 | # Last update timestamp of this source. |
| 3258 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 3259 | # |
| 3260 | # Metadata about a source of type PROFILE. |
| 3261 | "userTypes": [ # Output only. The user types. |
| 3262 | "A String", |
| 3263 | ], |
| 3264 | "objectType": "A String", # Output only. The profile object type. |
| 3265 | }, |
| 3266 | "type": "A String", # The source type. |
| 3267 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 3268 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 3269 | # |
| 3270 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 3271 | # source. Used for web cache validation. |
| 3272 | }, |
| 3273 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 3274 | # verified field is typically a name, email address, phone number, or |
| 3275 | # website that has been confirmed to be owned by the person. |
| 3276 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 3277 | # field. |
| 3278 | }, |
| 3279 | "text": "A String", # A free-form string representing the user's birthday. |
| 3280 | }, |
| 3281 | ], |
| 3282 | "imClients": [ # The person's instant messaging clients. |
| 3283 | { # A person's instant messaging client. |
| 3284 | "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the |
| 3285 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 3286 | "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these |
| 3287 | # predefined values: |
| 3288 | # |
| 3289 | # * `aim` |
| 3290 | # * `msn` |
| 3291 | # * `yahoo` |
| 3292 | # * `skype` |
| 3293 | # * `qq` |
| 3294 | # * `googleTalk` |
| 3295 | # * `icq` |
| 3296 | # * `jabber` |
| 3297 | # * `netMeeting` |
| 3298 | "username": "A String", # The user name used in the IM client. |
| 3299 | "type": "A String", # The type of the IM client. The type can be custom or one of these |
| 3300 | # predefined values: |
| 3301 | # |
| 3302 | # * `home` |
| 3303 | # * `work` |
| 3304 | # * `other` |
| 3305 | "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account |
| 3306 | # locale or the `Accept-Language` HTTP header locale. |
| 3307 | "metadata": { # Metadata about a field. # Metadata about the IM client. |
| 3308 | "source": { # The source of a field. # The source of the field. |
| 3309 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 3310 | # |
| 3311 | # Last update timestamp of this source. |
| 3312 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 3313 | # |
| 3314 | # Metadata about a source of type PROFILE. |
| 3315 | "userTypes": [ # Output only. The user types. |
| 3316 | "A String", |
| 3317 | ], |
| 3318 | "objectType": "A String", # Output only. The profile object type. |
| 3319 | }, |
| 3320 | "type": "A String", # The source type. |
| 3321 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 3322 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 3323 | # |
| 3324 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 3325 | # source. Used for web cache validation. |
| 3326 | }, |
| 3327 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 3328 | # verified field is typically a name, email address, phone number, or |
| 3329 | # website that has been confirmed to be owned by the person. |
| 3330 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 3331 | # field. |
| 3332 | }, |
| 3333 | }, |
| 3334 | ], |
| 3335 | "skills": [ # The person's skills. |
| 3336 | { # A skill that the person has. |
| 3337 | "metadata": { # Metadata about a field. # Metadata about the skill. |
| 3338 | "source": { # The source of a field. # The source of the field. |
| 3339 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 3340 | # |
| 3341 | # Last update timestamp of this source. |
| 3342 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 3343 | # |
| 3344 | # Metadata about a source of type PROFILE. |
| 3345 | "userTypes": [ # Output only. The user types. |
| 3346 | "A String", |
| 3347 | ], |
| 3348 | "objectType": "A String", # Output only. The profile object type. |
| 3349 | }, |
| 3350 | "type": "A String", # The source type. |
| 3351 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 3352 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 3353 | # |
| 3354 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 3355 | # source. Used for web cache validation. |
| 3356 | }, |
| 3357 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 3358 | # verified field is typically a name, email address, phone number, or |
| 3359 | # website that has been confirmed to be owned by the person. |
| 3360 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 3361 | # field. |
| 3362 | }, |
| 3363 | "value": "A String", # The skill; for example, `underwater basket weaving`. |
| 3364 | }, |
| 3365 | ], |
| 3366 | "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned |
| 3367 | # The person's relationship statuses. |
| 3368 | { # **DEPRECATED**: No data will be returned |
| 3369 | # A person's relationship status. |
| 3370 | "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in |
| 3371 | # the viewer's account locale or the `Accept-Language` HTTP header locale. |
| 3372 | "metadata": { # Metadata about a field. # Metadata about the relationship status. |
| 3373 | "source": { # The source of a field. # The source of the field. |
| 3374 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 3375 | # |
| 3376 | # Last update timestamp of this source. |
| 3377 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 3378 | # |
| 3379 | # Metadata about a source of type PROFILE. |
| 3380 | "userTypes": [ # Output only. The user types. |
| 3381 | "A String", |
| 3382 | ], |
| 3383 | "objectType": "A String", # Output only. The profile object type. |
| 3384 | }, |
| 3385 | "type": "A String", # The source type. |
| 3386 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 3387 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 3388 | # |
| 3389 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 3390 | # source. Used for web cache validation. |
| 3391 | }, |
| 3392 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 3393 | # verified field is typically a name, email address, phone number, or |
| 3394 | # website that has been confirmed to be owned by the person. |
| 3395 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 3396 | # field. |
| 3397 | }, |
| 3398 | "value": "A String", # The relationship status. The value can be custom or one of these |
| 3399 | # predefined values: |
| 3400 | # |
| 3401 | # * `single` |
| 3402 | # * `inARelationship` |
| 3403 | # * `engaged` |
| 3404 | # * `married` |
| 3405 | # * `itsComplicated` |
| 3406 | # * `openRelationship` |
| 3407 | # * `widowed` |
| 3408 | # * `inDomesticPartnership` |
| 3409 | # * `inCivilUnion` |
| 3410 | }, |
| 3411 | ], |
| 3412 | "coverPhotos": [ # Output only. The person's cover photos. |
| 3413 | { # A person's cover photo. A large image shown on the person's |
| 3414 | # profile page that represents who they are or what they care about. |
| 3415 | "url": "A String", # The URL of the cover photo. |
| 3416 | "default": True or False, # True if the cover photo is the default cover photo; |
| 3417 | # false if the cover photo is a user-provided cover photo. |
| 3418 | "metadata": { # Metadata about a field. # Metadata about the cover photo. |
| 3419 | "source": { # The source of a field. # The source of the field. |
| 3420 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 3421 | # |
| 3422 | # Last update timestamp of this source. |
| 3423 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 3424 | # |
| 3425 | # Metadata about a source of type PROFILE. |
| 3426 | "userTypes": [ # Output only. The user types. |
| 3427 | "A String", |
| 3428 | ], |
| 3429 | "objectType": "A String", # Output only. The profile object type. |
| 3430 | }, |
| 3431 | "type": "A String", # The source type. |
| 3432 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 3433 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 3434 | # |
| 3435 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 3436 | # source. Used for web cache validation. |
| 3437 | }, |
| 3438 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 3439 | # verified field is typically a name, email address, phone number, or |
| 3440 | # website that has been confirmed to be owned by the person. |
| 3441 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 3442 | # field. |
| 3443 | }, |
| 3444 | }, |
| 3445 | ], |
| 3446 | "names": [ # The person's names. |
| 3447 | { # A person's name. If the name is a mononym, the family name is empty. |
| 3448 | "middleName": "A String", # The middle name(s). |
| 3449 | "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound. |
| 3450 | "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to |
| 3451 | # the locale specified by the viewer's account or the |
| 3452 | # `Accept-Language` HTTP header. |
| 3453 | "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.` |
| 3454 | "familyName": "A String", # The family name. |
| 3455 | "phoneticGivenName": "A String", # The given name spelled as it sounds. |
| 3456 | "metadata": { # Metadata about a field. # Metadata about the name. |
| 3457 | "source": { # The source of a field. # The source of the field. |
| 3458 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 3459 | # |
| 3460 | # Last update timestamp of this source. |
| 3461 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 3462 | # |
| 3463 | # Metadata about a source of type PROFILE. |
| 3464 | "userTypes": [ # Output only. The user types. |
| 3465 | "A String", |
| 3466 | ], |
| 3467 | "objectType": "A String", # Output only. The profile object type. |
| 3468 | }, |
| 3469 | "type": "A String", # The source type. |
| 3470 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 3471 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 3472 | # |
| 3473 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 3474 | # source. Used for web cache validation. |
| 3475 | }, |
| 3476 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 3477 | # verified field is typically a name, email address, phone number, or |
| 3478 | # website that has been confirmed to be owned by the person. |
| 3479 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 3480 | # field. |
| 3481 | }, |
| 3482 | "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound. |
| 3483 | "displayName": "A String", # Output only. The display name formatted according to the locale specified by |
| 3484 | # the viewer's account or the `Accept-Language` HTTP header. |
| 3485 | "phoneticFamilyName": "A String", # The family name spelled as it sounds. |
| 3486 | "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.` |
| 3487 | "givenName": "A String", # The given name. |
| 3488 | "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound. |
| 3489 | "phoneticFullName": "A String", # The full name spelled as it sounds. |
| 3490 | }, |
| 3491 | ], |
| 3492 | "relations": [ # The person's relations. |
| 3493 | { # A person's relation to another person. |
| 3494 | "type": "A String", # The person's relation to the other person. The type can be custom or one of |
| 3495 | # these predefined values: |
| 3496 | # |
| 3497 | # * `spouse` |
| 3498 | # * `child` |
| 3499 | # * `mother` |
| 3500 | # * `father` |
| 3501 | # * `parent` |
| 3502 | # * `brother` |
| 3503 | # * `sister` |
| 3504 | # * `friend` |
| 3505 | # * `relative` |
| 3506 | # * `domesticPartner` |
| 3507 | # * `manager` |
| 3508 | # * `assistant` |
| 3509 | # * `referredBy` |
| 3510 | # * `partner` |
| 3511 | "metadata": { # Metadata about a field. # Metadata about the relation. |
| 3512 | "source": { # The source of a field. # The source of the field. |
| 3513 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 3514 | # |
| 3515 | # Last update timestamp of this source. |
| 3516 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 3517 | # |
| 3518 | # Metadata about a source of type PROFILE. |
| 3519 | "userTypes": [ # Output only. The user types. |
| 3520 | "A String", |
| 3521 | ], |
| 3522 | "objectType": "A String", # Output only. The profile object type. |
| 3523 | }, |
| 3524 | "type": "A String", # The source type. |
| 3525 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 3526 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 3527 | # |
| 3528 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 3529 | # source. Used for web cache validation. |
| 3530 | }, |
| 3531 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 3532 | # verified field is typically a name, email address, phone number, or |
| 3533 | # website that has been confirmed to be owned by the person. |
| 3534 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 3535 | # field. |
| 3536 | }, |
| 3537 | "person": "A String", # The name of the other person this relation refers to. |
| 3538 | "formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's |
| 3539 | # account locale or the locale specified in the Accept-Language HTTP header. |
| 3540 | }, |
| 3541 | ], |
| 3542 | "ageRanges": [ # Output only. The person's age ranges. |
| 3543 | { # A person's age range. |
| 3544 | "metadata": { # Metadata about a field. # Metadata about the age range. |
| 3545 | "source": { # The source of a field. # The source of the field. |
| 3546 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 3547 | # |
| 3548 | # Last update timestamp of this source. |
| 3549 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 3550 | # |
| 3551 | # Metadata about a source of type PROFILE. |
| 3552 | "userTypes": [ # Output only. The user types. |
| 3553 | "A String", |
| 3554 | ], |
| 3555 | "objectType": "A String", # Output only. The profile object type. |
| 3556 | }, |
| 3557 | "type": "A String", # The source type. |
| 3558 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 3559 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 3560 | # |
| 3561 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 3562 | # source. Used for web cache validation. |
| 3563 | }, |
| 3564 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 3565 | # verified field is typically a name, email address, phone number, or |
| 3566 | # website that has been confirmed to be owned by the person. |
| 3567 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 3568 | # field. |
| 3569 | }, |
| 3570 | "ageRange": "A String", # The age range. |
| 3571 | }, |
| 3572 | ], |
| 3573 | "braggingRights": [ # **DEPRECATED**: No data will be returned |
| 3574 | # The person's bragging rights. |
| 3575 | { # **DEPRECATED**: No data will be returned |
| 3576 | # A person's bragging rights. |
| 3577 | "value": "A String", # The bragging rights; for example, `climbed mount everest`. |
| 3578 | "metadata": { # Metadata about a field. # Metadata about the bragging rights. |
| 3579 | "source": { # The source of a field. # The source of the field. |
| 3580 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 3581 | # |
| 3582 | # Last update timestamp of this source. |
| 3583 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 3584 | # |
| 3585 | # Metadata about a source of type PROFILE. |
| 3586 | "userTypes": [ # Output only. The user types. |
| 3587 | "A String", |
| 3588 | ], |
| 3589 | "objectType": "A String", # Output only. The profile object type. |
| 3590 | }, |
| 3591 | "type": "A String", # The source type. |
| 3592 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 3593 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 3594 | # |
| 3595 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 3596 | # source. Used for web cache validation. |
| 3597 | }, |
| 3598 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 3599 | # verified field is typically a name, email address, phone number, or |
| 3600 | # website that has been confirmed to be owned by the person. |
| 3601 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 3602 | # field. |
| 3603 | }, |
| 3604 | }, |
| 3605 | ], |
| 3606 | "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string |
| 3607 | # with a max length of 27 characters, in the form of |
| 3608 | # `people/{person_id}`. |
| 3609 | "photos": [ # Output only. The person's photos. |
| 3610 | { # A person's photo. A picture shown next to the person's name to |
| 3611 | # help others recognize the person. |
| 3612 | "url": "A String", # The URL of the photo. You can change the desired size by appending a query |
| 3613 | # parameter `sz={size}` at the end of the url, where {size} is the size in |
| 3614 | # pixels. Example: |
| 3615 | # https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50 |
| 3616 | "default": True or False, # True if the photo is a default photo; |
| 3617 | # false if the photo is a user-provided photo. |
| 3618 | "metadata": { # Metadata about a field. # Metadata about the photo. |
| 3619 | "source": { # The source of a field. # The source of the field. |
| 3620 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 3621 | # |
| 3622 | # Last update timestamp of this source. |
| 3623 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 3624 | # |
| 3625 | # Metadata about a source of type PROFILE. |
| 3626 | "userTypes": [ # Output only. The user types. |
| 3627 | "A String", |
| 3628 | ], |
| 3629 | "objectType": "A String", # Output only. The profile object type. |
| 3630 | }, |
| 3631 | "type": "A String", # The source type. |
| 3632 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 3633 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 3634 | # |
| 3635 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 3636 | # source. Used for web cache validation. |
| 3637 | }, |
| 3638 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 3639 | # verified field is typically a name, email address, phone number, or |
| 3640 | # website that has been confirmed to be owned by the person. |
| 3641 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 3642 | # field. |
| 3643 | }, |
| 3644 | }, |
| 3645 | ], |
| 3646 | "addresses": [ # The person's street addresses. |
| 3647 | { # A person's physical address. May be a P.O. box or street address. All fields |
| 3648 | # are optional. |
| 3649 | "streetAddress": "A String", # The street address. |
| 3650 | "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it |
| 3651 | # will be automatically constructed from structured values. |
| 3652 | "country": "A String", # The country of the address. |
| 3653 | "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's |
| 3654 | # account locale or the `Accept-Language` HTTP header locale. |
| 3655 | "city": "A String", # The city of the address. |
| 3656 | "postalCode": "A String", # The postal code of the address. |
| 3657 | "extendedAddress": "A String", # The extended address of the address; for example, the apartment number. |
| 3658 | "type": "A String", # The type of the address. The type can be custom or one of these predefined |
| 3659 | # values: |
| 3660 | # |
| 3661 | # * `home` |
| 3662 | # * `work` |
| 3663 | # * `other` |
| 3664 | "region": "A String", # The region of the address; for example, the state or province. |
| 3665 | "poBox": "A String", # The P.O. box of the address. |
| 3666 | "metadata": { # Metadata about a field. # Metadata about the address. |
| 3667 | "source": { # The source of a field. # The source of the field. |
| 3668 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 3669 | # |
| 3670 | # Last update timestamp of this source. |
| 3671 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 3672 | # |
| 3673 | # Metadata about a source of type PROFILE. |
| 3674 | "userTypes": [ # Output only. The user types. |
| 3675 | "A String", |
| 3676 | ], |
| 3677 | "objectType": "A String", # Output only. The profile object type. |
| 3678 | }, |
| 3679 | "type": "A String", # The source type. |
| 3680 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 3681 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 3682 | # |
| 3683 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 3684 | # source. Used for web cache validation. |
| 3685 | }, |
| 3686 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 3687 | # verified field is typically a name, email address, phone number, or |
| 3688 | # website that has been confirmed to be owned by the person. |
| 3689 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 3690 | # field. |
| 3691 | }, |
| 3692 | "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country |
| 3693 | # code of the address. |
| 3694 | }, |
| 3695 | ], |
| 3696 | "emailAddresses": [ # The person's email addresses. |
| 3697 | { # A person's email address. |
| 3698 | "formattedType": "A String", # Output only. The type of the email address translated and formatted in the |
| 3699 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 3700 | "metadata": { # Metadata about a field. # Metadata about the email address. |
| 3701 | "source": { # The source of a field. # The source of the field. |
| 3702 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 3703 | # |
| 3704 | # Last update timestamp of this source. |
| 3705 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 3706 | # |
| 3707 | # Metadata about a source of type PROFILE. |
| 3708 | "userTypes": [ # Output only. The user types. |
| 3709 | "A String", |
| 3710 | ], |
| 3711 | "objectType": "A String", # Output only. The profile object type. |
| 3712 | }, |
| 3713 | "type": "A String", # The source type. |
| 3714 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 3715 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 3716 | # |
| 3717 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 3718 | # source. Used for web cache validation. |
| 3719 | }, |
| 3720 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 3721 | # verified field is typically a name, email address, phone number, or |
| 3722 | # website that has been confirmed to be owned by the person. |
| 3723 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 3724 | # field. |
| 3725 | }, |
| 3726 | "value": "A String", # The email address. |
| 3727 | "displayName": "A String", # The display name of the email. |
| 3728 | "type": "A String", # The type of the email address. The type can be custom or one of these |
| 3729 | # predefined values: |
| 3730 | # |
| 3731 | # * `home` |
| 3732 | # * `work` |
| 3733 | # * `other` |
| 3734 | }, |
| 3735 | ], |
| 3736 | "nicknames": [ # The person's nicknames. |
| 3737 | { # A person's nickname. |
| 3738 | "metadata": { # Metadata about a field. # Metadata about the nickname. |
| 3739 | "source": { # The source of a field. # The source of the field. |
| 3740 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 3741 | # |
| 3742 | # Last update timestamp of this source. |
| 3743 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 3744 | # |
| 3745 | # Metadata about a source of type PROFILE. |
| 3746 | "userTypes": [ # Output only. The user types. |
| 3747 | "A String", |
| 3748 | ], |
| 3749 | "objectType": "A String", # Output only. The profile object type. |
| 3750 | }, |
| 3751 | "type": "A String", # The source type. |
| 3752 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 3753 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 3754 | # |
| 3755 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 3756 | # source. Used for web cache validation. |
| 3757 | }, |
| 3758 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 3759 | # verified field is typically a name, email address, phone number, or |
| 3760 | # website that has been confirmed to be owned by the person. |
| 3761 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 3762 | # field. |
| 3763 | }, |
| 3764 | "type": "A String", # The type of the nickname. |
| 3765 | "value": "A String", # The nickname. |
| 3766 | }, |
| 3767 | ], |
| 3768 | "events": [ # The person's events. |
| 3769 | { # An event related to the person. |
| 3770 | "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the event. |
| 3771 | # and time zone are either specified elsewhere or are not significant. The date |
| 3772 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 3773 | # |
| 3774 | # * A full date, with non-zero year, month and day values |
| 3775 | # * A month and day value, with a zero year, e.g. an anniversary |
| 3776 | # * A year on its own, with zero month and day values |
| 3777 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 3778 | # |
| 3779 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 3780 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 3781 | # a year. |
| 3782 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 3783 | # month and day. |
| 3784 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 3785 | # if specifying a year by itself or a year and month where the day is not |
| 3786 | # significant. |
| 3787 | }, |
| 3788 | "formattedType": "A String", # Output only. The type of the event translated and formatted in the |
| 3789 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 3790 | "metadata": { # Metadata about a field. # Metadata about the event. |
| 3791 | "source": { # The source of a field. # The source of the field. |
| 3792 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 3793 | # |
| 3794 | # Last update timestamp of this source. |
| 3795 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 3796 | # |
| 3797 | # Metadata about a source of type PROFILE. |
| 3798 | "userTypes": [ # Output only. The user types. |
| 3799 | "A String", |
| 3800 | ], |
| 3801 | "objectType": "A String", # Output only. The profile object type. |
| 3802 | }, |
| 3803 | "type": "A String", # The source type. |
| 3804 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 3805 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 3806 | # |
| 3807 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 3808 | # source. Used for web cache validation. |
| 3809 | }, |
| 3810 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 3811 | # verified field is typically a name, email address, phone number, or |
| 3812 | # website that has been confirmed to be owned by the person. |
| 3813 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 3814 | # field. |
| 3815 | }, |
| 3816 | "type": "A String", # The type of the event. The type can be custom or one of these predefined |
| 3817 | # values: |
| 3818 | # |
| 3819 | # * `anniversary` |
| 3820 | # * `other` |
| 3821 | }, |
| 3822 | ], |
| 3823 | "urls": [ # The person's associated URLs. |
| 3824 | { # A person's associated URLs. |
| 3825 | "type": "A String", # The type of the URL. The type can be custom or one of these predefined |
| 3826 | # values: |
| 3827 | # |
| 3828 | # * `home` |
| 3829 | # * `work` |
| 3830 | # * `blog` |
| 3831 | # * `profile` |
| 3832 | # * `homePage` |
| 3833 | # * `ftp` |
| 3834 | # * `reservations` |
| 3835 | # * `appInstallPage`: website for a Google+ application. |
| 3836 | # * `other` |
| 3837 | "metadata": { # Metadata about a field. # Metadata about the URL. |
| 3838 | "source": { # The source of a field. # The source of the field. |
| 3839 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 3840 | # |
| 3841 | # Last update timestamp of this source. |
| 3842 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 3843 | # |
| 3844 | # Metadata about a source of type PROFILE. |
| 3845 | "userTypes": [ # Output only. The user types. |
| 3846 | "A String", |
| 3847 | ], |
| 3848 | "objectType": "A String", # Output only. The profile object type. |
| 3849 | }, |
| 3850 | "type": "A String", # The source type. |
| 3851 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 3852 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 3853 | # |
| 3854 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 3855 | # source. Used for web cache validation. |
| 3856 | }, |
| 3857 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 3858 | # verified field is typically a name, email address, phone number, or |
| 3859 | # website that has been confirmed to be owned by the person. |
| 3860 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 3861 | # field. |
| 3862 | }, |
| 3863 | "formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's |
| 3864 | # account locale or the `Accept-Language` HTTP header locale. |
| 3865 | "value": "A String", # The URL. |
| 3866 | }, |
| 3867 | ], |
| 3868 | }, |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3869 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3870 | </div> |
| 3871 | |
| 3872 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3873 | <code class="details" id="get">get(resourceName, requestMask_includeField=None, personFields=None, x__xgafv=None)</code> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3874 | <pre>Provides information about a person by specifying a resource name. Use |
| 3875 | `people/me` to indicate the authenticated user. |
| 3876 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3877 | The request throws a 400 error if 'personFields' is not specified. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3878 | |
| 3879 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3880 | resourceName: string, Required. The resource name of the person to provide information about. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3881 | |
| 3882 | - To get information about the authenticated user, specify `people/me`. |
| 3883 | - To get information about a google account, specify |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3884 | `people/{account_id}`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3885 | - To get information about a contact, specify the resource name that |
| 3886 | identifies the contact as returned by |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3887 | [`people.connections.list`](/people/api/rest/v1/people.connections/list). (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3888 | requestMask_includeField: string, Required. Comma-separated list of person fields to be included in the response. Each |
| 3889 | path should start with `person.`: for example, `person.names` or |
| 3890 | `person.photos`. |
| 3891 | personFields: string, Required. A field mask to restrict which fields on the person are returned. Multiple |
| 3892 | fields can be specified by separating them with commas. Valid values are: |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3893 | |
| 3894 | * addresses |
| 3895 | * ageRanges |
| 3896 | * biographies |
| 3897 | * birthdays |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3898 | * coverPhotos |
| 3899 | * emailAddresses |
| 3900 | * events |
| 3901 | * genders |
| 3902 | * imClients |
| 3903 | * interests |
| 3904 | * locales |
| 3905 | * memberships |
| 3906 | * metadata |
| 3907 | * names |
| 3908 | * nicknames |
| 3909 | * occupations |
| 3910 | * organizations |
| 3911 | * phoneNumbers |
| 3912 | * photos |
| 3913 | * relations |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3914 | * residences |
| 3915 | * sipAddresses |
| 3916 | * skills |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3917 | * urls |
| 3918 | * userDefined |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3919 | x__xgafv: string, V1 error format. |
| 3920 | Allowed values |
| 3921 | 1 - v1 error format |
| 3922 | 2 - v2 error format |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 3923 | |
| 3924 | Returns: |
| 3925 | An object of the form: |
| 3926 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3927 | { # Information about a person merged from various data sources such as the |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3928 | # authenticated user's contacts and profile data. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3929 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3930 | # Most fields can have multiple items. The items in a field have no guaranteed |
| 3931 | # order, but each non-empty field is guaranteed to have exactly one field with |
| 3932 | # `metadata.primary` set to true. |
| 3933 | "interests": [ # The person's interests. |
| 3934 | { # One of the person's interests. |
| 3935 | "value": "A String", # The interest; for example, `stargazing`. |
| 3936 | "metadata": { # Metadata about a field. # Metadata about the interest. |
| 3937 | "source": { # The source of a field. # The source of the field. |
| 3938 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 3939 | # |
| 3940 | # Last update timestamp of this source. |
| 3941 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 3942 | # |
| 3943 | # Metadata about a source of type PROFILE. |
| 3944 | "userTypes": [ # Output only. The user types. |
| 3945 | "A String", |
| 3946 | ], |
| 3947 | "objectType": "A String", # Output only. The profile object type. |
| 3948 | }, |
| 3949 | "type": "A String", # The source type. |
| 3950 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 3951 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 3952 | # |
| 3953 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 3954 | # source. Used for web cache validation. |
| 3955 | }, |
| 3956 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 3957 | # verified field is typically a name, email address, phone number, or |
| 3958 | # website that has been confirmed to be owned by the person. |
| 3959 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 3960 | # field. |
| 3961 | }, |
| 3962 | }, |
| 3963 | ], |
| 3964 | "userDefined": [ # The person's user defined data. |
| 3965 | { # Arbitrary user data that is populated by the end users. |
| 3966 | "metadata": { # Metadata about a field. # Metadata about the user defined data. |
| 3967 | "source": { # The source of a field. # The source of the field. |
| 3968 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 3969 | # |
| 3970 | # Last update timestamp of this source. |
| 3971 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 3972 | # |
| 3973 | # Metadata about a source of type PROFILE. |
| 3974 | "userTypes": [ # Output only. The user types. |
| 3975 | "A String", |
| 3976 | ], |
| 3977 | "objectType": "A String", # Output only. The profile object type. |
| 3978 | }, |
| 3979 | "type": "A String", # The source type. |
| 3980 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 3981 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 3982 | # |
| 3983 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 3984 | # source. Used for web cache validation. |
| 3985 | }, |
| 3986 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 3987 | # verified field is typically a name, email address, phone number, or |
| 3988 | # website that has been confirmed to be owned by the person. |
| 3989 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 3990 | # field. |
| 3991 | }, |
| 3992 | "key": "A String", # The end user specified key of the user defined data. |
| 3993 | "value": "A String", # The end user specified value of the user defined data. |
| 3994 | }, |
| 3995 | ], |
| 3996 | "sipAddresses": [ # The person's SIP addresses. |
| 3997 | { # A person's SIP address. Session Initial Protocol addresses are used for VoIP |
| 3998 | # communications to make voice or video calls over the internet. |
| 3999 | "value": "A String", # The SIP address in the |
| 4000 | # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI |
| 4001 | # format. |
| 4002 | "type": "A String", # The type of the SIP address. The type can be custom or or one of these |
| 4003 | # predefined values: |
| 4004 | # |
| 4005 | # * `home` |
| 4006 | # * `work` |
| 4007 | # * `mobile` |
| 4008 | # * `other` |
| 4009 | "metadata": { # Metadata about a field. # Metadata about the SIP address. |
| 4010 | "source": { # The source of a field. # The source of the field. |
| 4011 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 4012 | # |
| 4013 | # Last update timestamp of this source. |
| 4014 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 4015 | # |
| 4016 | # Metadata about a source of type PROFILE. |
| 4017 | "userTypes": [ # Output only. The user types. |
| 4018 | "A String", |
| 4019 | ], |
| 4020 | "objectType": "A String", # Output only. The profile object type. |
| 4021 | }, |
| 4022 | "type": "A String", # The source type. |
| 4023 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 4024 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 4025 | # |
| 4026 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 4027 | # source. Used for web cache validation. |
| 4028 | }, |
| 4029 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 4030 | # verified field is typically a name, email address, phone number, or |
| 4031 | # website that has been confirmed to be owned by the person. |
| 4032 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 4033 | # field. |
| 4034 | }, |
| 4035 | "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the |
| 4036 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 4037 | }, |
| 4038 | ], |
| 4039 | "phoneNumbers": [ # The person's phone numbers. |
| 4040 | { # A person's phone number. |
| 4041 | "type": "A String", # The type of the phone number. The type can be custom or one of these |
| 4042 | # predefined values: |
| 4043 | # |
| 4044 | # * `home` |
| 4045 | # * `work` |
| 4046 | # * `mobile` |
| 4047 | # * `homeFax` |
| 4048 | # * `workFax` |
| 4049 | # * `otherFax` |
| 4050 | # * `pager` |
| 4051 | # * `workMobile` |
| 4052 | # * `workPager` |
| 4053 | # * `main` |
| 4054 | # * `googleVoice` |
| 4055 | # * `other` |
| 4056 | "value": "A String", # The phone number. |
| 4057 | "canonicalForm": "A String", # Output only. The canonicalized [ITU-T |
| 4058 | # E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) |
| 4059 | # form of the phone number. |
| 4060 | "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the |
| 4061 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 4062 | "metadata": { # Metadata about a field. # Metadata about the phone number. |
| 4063 | "source": { # The source of a field. # The source of the field. |
| 4064 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 4065 | # |
| 4066 | # Last update timestamp of this source. |
| 4067 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 4068 | # |
| 4069 | # Metadata about a source of type PROFILE. |
| 4070 | "userTypes": [ # Output only. The user types. |
| 4071 | "A String", |
| 4072 | ], |
| 4073 | "objectType": "A String", # Output only. The profile object type. |
| 4074 | }, |
| 4075 | "type": "A String", # The source type. |
| 4076 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 4077 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 4078 | # |
| 4079 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 4080 | # source. Used for web cache validation. |
| 4081 | }, |
| 4082 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 4083 | # verified field is typically a name, email address, phone number, or |
| 4084 | # website that has been confirmed to be owned by the person. |
| 4085 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 4086 | # field. |
| 4087 | }, |
| 4088 | }, |
| 4089 | ], |
| 4090 | "occupations": [ # The person's occupations. |
| 4091 | { # A person's occupation. |
| 4092 | "value": "A String", # The occupation; for example, `carpenter`. |
| 4093 | "metadata": { # Metadata about a field. # Metadata about the occupation. |
| 4094 | "source": { # The source of a field. # The source of the field. |
| 4095 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 4096 | # |
| 4097 | # Last update timestamp of this source. |
| 4098 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 4099 | # |
| 4100 | # Metadata about a source of type PROFILE. |
| 4101 | "userTypes": [ # Output only. The user types. |
| 4102 | "A String", |
| 4103 | ], |
| 4104 | "objectType": "A String", # Output only. The profile object type. |
| 4105 | }, |
| 4106 | "type": "A String", # The source type. |
| 4107 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 4108 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 4109 | # |
| 4110 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 4111 | # source. Used for web cache validation. |
| 4112 | }, |
| 4113 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 4114 | # verified field is typically a name, email address, phone number, or |
| 4115 | # website that has been confirmed to be owned by the person. |
| 4116 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 4117 | # field. |
| 4118 | }, |
| 4119 | }, |
| 4120 | ], |
| 4121 | "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) |
| 4122 | # |
| 4123 | # The person's age range. |
| 4124 | "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 4125 | # resource. Used for web cache validation. |
| 4126 | "biographies": [ # The person's biographies. |
| 4127 | { # A person's short biography. |
| 4128 | "metadata": { # Metadata about a field. # Metadata about the biography. |
| 4129 | "source": { # The source of a field. # The source of the field. |
| 4130 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 4131 | # |
| 4132 | # Last update timestamp of this source. |
| 4133 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 4134 | # |
| 4135 | # Metadata about a source of type PROFILE. |
| 4136 | "userTypes": [ # Output only. The user types. |
| 4137 | "A String", |
| 4138 | ], |
| 4139 | "objectType": "A String", # Output only. The profile object type. |
| 4140 | }, |
| 4141 | "type": "A String", # The source type. |
| 4142 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 4143 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 4144 | # |
| 4145 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 4146 | # source. Used for web cache validation. |
| 4147 | }, |
| 4148 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 4149 | # verified field is typically a name, email address, phone number, or |
| 4150 | # website that has been confirmed to be owned by the person. |
| 4151 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 4152 | # field. |
| 4153 | }, |
| 4154 | "contentType": "A String", # The content type of the biography. |
| 4155 | "value": "A String", # The short biography. |
| 4156 | }, |
| 4157 | ], |
| 4158 | "locales": [ # The person's locale preferences. |
| 4159 | { # A person's locale preference. |
| 4160 | "metadata": { # Metadata about a field. # Metadata about the locale. |
| 4161 | "source": { # The source of a field. # The source of the field. |
| 4162 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 4163 | # |
| 4164 | # Last update timestamp of this source. |
| 4165 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 4166 | # |
| 4167 | # Metadata about a source of type PROFILE. |
| 4168 | "userTypes": [ # Output only. The user types. |
| 4169 | "A String", |
| 4170 | ], |
| 4171 | "objectType": "A String", # Output only. The profile object type. |
| 4172 | }, |
| 4173 | "type": "A String", # The source type. |
| 4174 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 4175 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 4176 | # |
| 4177 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 4178 | # source. Used for web cache validation. |
| 4179 | }, |
| 4180 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 4181 | # verified field is typically a name, email address, phone number, or |
| 4182 | # website that has been confirmed to be owned by the person. |
| 4183 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 4184 | # field. |
| 4185 | }, |
| 4186 | "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) |
| 4187 | # language tag representing the locale. |
| 4188 | }, |
| 4189 | ], |
| 4190 | "taglines": [ # Output only. **DEPRECATED**: No data will be returned |
| 4191 | # The person's taglines. |
| 4192 | { # **DEPRECATED**: No data will be returned |
| 4193 | # A brief one-line description of the person. |
| 4194 | "metadata": { # Metadata about a field. # Metadata about the tagline. |
| 4195 | "source": { # The source of a field. # The source of the field. |
| 4196 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 4197 | # |
| 4198 | # Last update timestamp of this source. |
| 4199 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 4200 | # |
| 4201 | # Metadata about a source of type PROFILE. |
| 4202 | "userTypes": [ # Output only. The user types. |
| 4203 | "A String", |
| 4204 | ], |
| 4205 | "objectType": "A String", # Output only. The profile object type. |
| 4206 | }, |
| 4207 | "type": "A String", # The source type. |
| 4208 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 4209 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 4210 | # |
| 4211 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 4212 | # source. Used for web cache validation. |
| 4213 | }, |
| 4214 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 4215 | # verified field is typically a name, email address, phone number, or |
| 4216 | # website that has been confirmed to be owned by the person. |
| 4217 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 4218 | # field. |
| 4219 | }, |
| 4220 | "value": "A String", # The tagline. |
| 4221 | }, |
| 4222 | ], |
| 4223 | "organizations": [ # The person's past or current organizations. |
| 4224 | { # A person's past or current organization. Overlapping date ranges are |
| 4225 | # permitted. |
| 4226 | "title": "A String", # The person's job title at the organization. |
| 4227 | "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker |
| 4228 | # symbol, abbreviation, or acronym. |
| 4229 | "name": "A String", # The name of the organization. |
| 4230 | "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The start date when the person joined the organization. |
| 4231 | # and time zone are either specified elsewhere or are not significant. The date |
| 4232 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 4233 | # |
| 4234 | # * A full date, with non-zero year, month and day values |
| 4235 | # * A month and day value, with a zero year, e.g. an anniversary |
| 4236 | # * A year on its own, with zero month and day values |
| 4237 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 4238 | # |
| 4239 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 4240 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 4241 | # a year. |
| 4242 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 4243 | # month and day. |
| 4244 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 4245 | # if specifying a year by itself or a year and month where the day is not |
| 4246 | # significant. |
| 4247 | }, |
| 4248 | "department": "A String", # The person's department at the organization. |
| 4249 | "current": True or False, # True if the organization is the person's current organization; |
| 4250 | # false if the organization is a past organization. |
| 4251 | "location": "A String", # The location of the organization office the person works at. |
| 4252 | "domain": "A String", # The domain name associated with the organization; for example, |
| 4253 | # `google.com`. |
| 4254 | "metadata": { # Metadata about a field. # Metadata about the organization. |
| 4255 | "source": { # The source of a field. # The source of the field. |
| 4256 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 4257 | # |
| 4258 | # Last update timestamp of this source. |
| 4259 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 4260 | # |
| 4261 | # Metadata about a source of type PROFILE. |
| 4262 | "userTypes": [ # Output only. The user types. |
| 4263 | "A String", |
| 4264 | ], |
| 4265 | "objectType": "A String", # Output only. The profile object type. |
| 4266 | }, |
| 4267 | "type": "A String", # The source type. |
| 4268 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 4269 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 4270 | # |
| 4271 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 4272 | # source. Used for web cache validation. |
| 4273 | }, |
| 4274 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 4275 | # verified field is typically a name, email address, phone number, or |
| 4276 | # website that has been confirmed to be owned by the person. |
| 4277 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 4278 | # field. |
| 4279 | }, |
| 4280 | "jobDescription": "A String", # The person's job description at the organization. |
| 4281 | "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The end date when the person left the organization. |
| 4282 | # and time zone are either specified elsewhere or are not significant. The date |
| 4283 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 4284 | # |
| 4285 | # * A full date, with non-zero year, month and day values |
| 4286 | # * A month and day value, with a zero year, e.g. an anniversary |
| 4287 | # * A year on its own, with zero month and day values |
| 4288 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 4289 | # |
| 4290 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 4291 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 4292 | # a year. |
| 4293 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 4294 | # month and day. |
| 4295 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 4296 | # if specifying a year by itself or a year and month where the day is not |
| 4297 | # significant. |
| 4298 | }, |
| 4299 | "phoneticName": "A String", # The phonetic name of the organization. |
| 4300 | "formattedType": "A String", # Output only. The type of the organization translated and formatted in the |
| 4301 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 4302 | "type": "A String", # The type of the organization. The type can be custom or one of these |
| 4303 | # predefined values: |
| 4304 | # |
| 4305 | # * `work` |
| 4306 | # * `school` |
| 4307 | }, |
| 4308 | ], |
| 4309 | "residences": [ # The person's residences. |
| 4310 | { # A person's past or current residence. |
| 4311 | "metadata": { # Metadata about a field. # Metadata about the residence. |
| 4312 | "source": { # The source of a field. # The source of the field. |
| 4313 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 4314 | # |
| 4315 | # Last update timestamp of this source. |
| 4316 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 4317 | # |
| 4318 | # Metadata about a source of type PROFILE. |
| 4319 | "userTypes": [ # Output only. The user types. |
| 4320 | "A String", |
| 4321 | ], |
| 4322 | "objectType": "A String", # Output only. The profile object type. |
| 4323 | }, |
| 4324 | "type": "A String", # The source type. |
| 4325 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 4326 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 4327 | # |
| 4328 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 4329 | # source. Used for web cache validation. |
| 4330 | }, |
| 4331 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 4332 | # verified field is typically a name, email address, phone number, or |
| 4333 | # website that has been confirmed to be owned by the person. |
| 4334 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 4335 | # field. |
| 4336 | }, |
| 4337 | "current": True or False, # True if the residence is the person's current residence; |
| 4338 | # false if the residence is a past residence. |
| 4339 | "value": "A String", # The address of the residence. |
| 4340 | }, |
| 4341 | ], |
| 4342 | "genders": [ # The person's genders. |
| 4343 | { # A person's gender. |
| 4344 | "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account |
| 4345 | # locale or the `Accept-Language` HTTP header locale. Unspecified or custom |
| 4346 | # value are not localized. |
| 4347 | "metadata": { # Metadata about a field. # Metadata about the gender. |
| 4348 | "source": { # The source of a field. # The source of the field. |
| 4349 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 4350 | # |
| 4351 | # Last update timestamp of this source. |
| 4352 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 4353 | # |
| 4354 | # Metadata about a source of type PROFILE. |
| 4355 | "userTypes": [ # Output only. The user types. |
| 4356 | "A String", |
| 4357 | ], |
| 4358 | "objectType": "A String", # Output only. The profile object type. |
| 4359 | }, |
| 4360 | "type": "A String", # The source type. |
| 4361 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 4362 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 4363 | # |
| 4364 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 4365 | # source. Used for web cache validation. |
| 4366 | }, |
| 4367 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 4368 | # verified field is typically a name, email address, phone number, or |
| 4369 | # website that has been confirmed to be owned by the person. |
| 4370 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 4371 | # field. |
| 4372 | }, |
| 4373 | "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value |
| 4374 | # can be custom or one of these predefined values: |
| 4375 | # |
| 4376 | # * `male` |
| 4377 | # * `female` |
| 4378 | # * `other` |
| 4379 | "value": "A String", # The gender for the person. The gender can be custom or one of these |
| 4380 | # predefined values: |
| 4381 | # |
| 4382 | # * `male` |
| 4383 | # * `female` |
| 4384 | # * `unspecified` |
| 4385 | }, |
| 4386 | ], |
| 4387 | "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned |
| 4388 | # The person's relationship interests. |
| 4389 | { # **DEPRECATED**: No data will be returned |
| 4390 | # A person's relationship interest . |
| 4391 | "formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted |
| 4392 | # in the viewer's account locale or the locale specified in the |
| 4393 | # Accept-Language HTTP header. |
| 4394 | "metadata": { # Metadata about a field. # Metadata about the relationship interest. |
| 4395 | "source": { # The source of a field. # The source of the field. |
| 4396 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 4397 | # |
| 4398 | # Last update timestamp of this source. |
| 4399 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 4400 | # |
| 4401 | # Metadata about a source of type PROFILE. |
| 4402 | "userTypes": [ # Output only. The user types. |
| 4403 | "A String", |
| 4404 | ], |
| 4405 | "objectType": "A String", # Output only. The profile object type. |
| 4406 | }, |
| 4407 | "type": "A String", # The source type. |
| 4408 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 4409 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 4410 | # |
| 4411 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 4412 | # source. Used for web cache validation. |
| 4413 | }, |
| 4414 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 4415 | # verified field is typically a name, email address, phone number, or |
| 4416 | # website that has been confirmed to be owned by the person. |
| 4417 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 4418 | # field. |
| 4419 | }, |
| 4420 | "value": "A String", # The kind of relationship the person is looking for. The value can be custom |
| 4421 | # or one of these predefined values: |
| 4422 | # |
| 4423 | # * `friend` |
| 4424 | # * `date` |
| 4425 | # * `relationship` |
| 4426 | # * `networking` |
| 4427 | }, |
| 4428 | ], |
| 4429 | "metadata": { # The metadata about a person. # Output only. Metadata about the person. |
| 4430 | "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for |
| 4431 | # [`connections.list`](/people/api/rest/v1/people.connections/list) requests |
| 4432 | # that include a sync token. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4433 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4434 | # The resource name may change when adding or removing fields that link a |
| 4435 | # contact and profile such as a verified email, verified phone number, or |
| 4436 | # profile URL. |
| 4437 | "A String", |
| 4438 | ], |
| 4439 | "sources": [ # The sources of data for the person. |
| 4440 | { # The source of a field. |
| 4441 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4442 | # |
| 4443 | # Last update timestamp of this source. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4444 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 4445 | # |
| 4446 | # Metadata about a source of type PROFILE. |
| 4447 | "userTypes": [ # Output only. The user types. |
| 4448 | "A String", |
| 4449 | ], |
| 4450 | "objectType": "A String", # Output only. The profile object type. |
| 4451 | }, |
| 4452 | "type": "A String", # The source type. |
| 4453 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 4454 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4455 | # |
| 4456 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 4457 | # source. Used for web cache validation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4458 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4459 | ], |
| 4460 | "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource. |
| 4461 | "A String", |
| 4462 | ], |
| 4463 | "objectType": "A String", # Output only. **DEPRECATED** (Please use |
| 4464 | # `person.metadata.sources.profileMetadata.objectType` instead) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4465 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4466 | # The type of the person object. |
| 4467 | "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for |
| 4468 | # [`connections.list`](/people/api/rest/v1/people.connections/list) requests |
| 4469 | # that include a sync token. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4470 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4471 | "memberships": [ # The person's group memberships. |
| 4472 | { # A person's membership in a group. Only contact group memberships can be |
| 4473 | # modified. |
| 4474 | "metadata": { # Metadata about a field. # Metadata about the membership. |
| 4475 | "source": { # The source of a field. # The source of the field. |
| 4476 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 4477 | # |
| 4478 | # Last update timestamp of this source. |
| 4479 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 4480 | # |
| 4481 | # Metadata about a source of type PROFILE. |
| 4482 | "userTypes": [ # Output only. The user types. |
| 4483 | "A String", |
| 4484 | ], |
| 4485 | "objectType": "A String", # Output only. The profile object type. |
| 4486 | }, |
| 4487 | "type": "A String", # The source type. |
| 4488 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 4489 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 4490 | # |
| 4491 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 4492 | # source. Used for web cache validation. |
| 4493 | }, |
| 4494 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 4495 | # verified field is typically a name, email address, phone number, or |
| 4496 | # website that has been confirmed to be owned by the person. |
| 4497 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 4498 | # field. |
| 4499 | }, |
| 4500 | "contactGroupMembership": { # A Google contact group membership. # The contact group membership. |
| 4501 | "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership. |
| 4502 | "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII |
| 4503 | # string, in the form of `contactGroups/{contact_group_id}`. |
| 4504 | # Only contact_group_resource_name can be used for modifying memberships. |
| 4505 | # Any contact group membership can be removed, but only user group or |
| 4506 | # "myContacts" or "starred" system groups memberships can be added. A |
| 4507 | # contact must always have at least one contact group membership. |
| 4508 | }, |
| 4509 | "domainMembership": { # A G Suite Domain membership. # Output only. The domain membership. |
| 4510 | "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain. |
| 4511 | }, |
| 4512 | }, |
| 4513 | ], |
| 4514 | "birthdays": [ # The person's birthdays. |
| 4515 | { # A person's birthday. At least one of the `date` and `text` fields are |
| 4516 | # specified. The `date` and `text` fields typically represent the same |
| 4517 | # date, but are not guaranteed to. |
| 4518 | "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the birthday. |
| 4519 | # and time zone are either specified elsewhere or are not significant. The date |
| 4520 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 4521 | # |
| 4522 | # * A full date, with non-zero year, month and day values |
| 4523 | # * A month and day value, with a zero year, e.g. an anniversary |
| 4524 | # * A year on its own, with zero month and day values |
| 4525 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 4526 | # |
| 4527 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 4528 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 4529 | # a year. |
| 4530 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 4531 | # month and day. |
| 4532 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 4533 | # if specifying a year by itself or a year and month where the day is not |
| 4534 | # significant. |
| 4535 | }, |
| 4536 | "metadata": { # Metadata about a field. # Metadata about the birthday. |
| 4537 | "source": { # The source of a field. # The source of the field. |
| 4538 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 4539 | # |
| 4540 | # Last update timestamp of this source. |
| 4541 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 4542 | # |
| 4543 | # Metadata about a source of type PROFILE. |
| 4544 | "userTypes": [ # Output only. The user types. |
| 4545 | "A String", |
| 4546 | ], |
| 4547 | "objectType": "A String", # Output only. The profile object type. |
| 4548 | }, |
| 4549 | "type": "A String", # The source type. |
| 4550 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 4551 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 4552 | # |
| 4553 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 4554 | # source. Used for web cache validation. |
| 4555 | }, |
| 4556 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 4557 | # verified field is typically a name, email address, phone number, or |
| 4558 | # website that has been confirmed to be owned by the person. |
| 4559 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 4560 | # field. |
| 4561 | }, |
| 4562 | "text": "A String", # A free-form string representing the user's birthday. |
| 4563 | }, |
| 4564 | ], |
| 4565 | "imClients": [ # The person's instant messaging clients. |
| 4566 | { # A person's instant messaging client. |
| 4567 | "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the |
| 4568 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 4569 | "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these |
| 4570 | # predefined values: |
| 4571 | # |
| 4572 | # * `aim` |
| 4573 | # * `msn` |
| 4574 | # * `yahoo` |
| 4575 | # * `skype` |
| 4576 | # * `qq` |
| 4577 | # * `googleTalk` |
| 4578 | # * `icq` |
| 4579 | # * `jabber` |
| 4580 | # * `netMeeting` |
| 4581 | "username": "A String", # The user name used in the IM client. |
| 4582 | "type": "A String", # The type of the IM client. The type can be custom or one of these |
| 4583 | # predefined values: |
| 4584 | # |
| 4585 | # * `home` |
| 4586 | # * `work` |
| 4587 | # * `other` |
| 4588 | "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account |
| 4589 | # locale or the `Accept-Language` HTTP header locale. |
| 4590 | "metadata": { # Metadata about a field. # Metadata about the IM client. |
| 4591 | "source": { # The source of a field. # The source of the field. |
| 4592 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 4593 | # |
| 4594 | # Last update timestamp of this source. |
| 4595 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 4596 | # |
| 4597 | # Metadata about a source of type PROFILE. |
| 4598 | "userTypes": [ # Output only. The user types. |
| 4599 | "A String", |
| 4600 | ], |
| 4601 | "objectType": "A String", # Output only. The profile object type. |
| 4602 | }, |
| 4603 | "type": "A String", # The source type. |
| 4604 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 4605 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 4606 | # |
| 4607 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 4608 | # source. Used for web cache validation. |
| 4609 | }, |
| 4610 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 4611 | # verified field is typically a name, email address, phone number, or |
| 4612 | # website that has been confirmed to be owned by the person. |
| 4613 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 4614 | # field. |
| 4615 | }, |
| 4616 | }, |
| 4617 | ], |
| 4618 | "skills": [ # The person's skills. |
| 4619 | { # A skill that the person has. |
| 4620 | "metadata": { # Metadata about a field. # Metadata about the skill. |
| 4621 | "source": { # The source of a field. # The source of the field. |
| 4622 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 4623 | # |
| 4624 | # Last update timestamp of this source. |
| 4625 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 4626 | # |
| 4627 | # Metadata about a source of type PROFILE. |
| 4628 | "userTypes": [ # Output only. The user types. |
| 4629 | "A String", |
| 4630 | ], |
| 4631 | "objectType": "A String", # Output only. The profile object type. |
| 4632 | }, |
| 4633 | "type": "A String", # The source type. |
| 4634 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 4635 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 4636 | # |
| 4637 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 4638 | # source. Used for web cache validation. |
| 4639 | }, |
| 4640 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 4641 | # verified field is typically a name, email address, phone number, or |
| 4642 | # website that has been confirmed to be owned by the person. |
| 4643 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 4644 | # field. |
| 4645 | }, |
| 4646 | "value": "A String", # The skill; for example, `underwater basket weaving`. |
| 4647 | }, |
| 4648 | ], |
| 4649 | "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned |
| 4650 | # The person's relationship statuses. |
| 4651 | { # **DEPRECATED**: No data will be returned |
| 4652 | # A person's relationship status. |
| 4653 | "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in |
| 4654 | # the viewer's account locale or the `Accept-Language` HTTP header locale. |
| 4655 | "metadata": { # Metadata about a field. # Metadata about the relationship status. |
| 4656 | "source": { # The source of a field. # The source of the field. |
| 4657 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 4658 | # |
| 4659 | # Last update timestamp of this source. |
| 4660 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 4661 | # |
| 4662 | # Metadata about a source of type PROFILE. |
| 4663 | "userTypes": [ # Output only. The user types. |
| 4664 | "A String", |
| 4665 | ], |
| 4666 | "objectType": "A String", # Output only. The profile object type. |
| 4667 | }, |
| 4668 | "type": "A String", # The source type. |
| 4669 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 4670 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 4671 | # |
| 4672 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 4673 | # source. Used for web cache validation. |
| 4674 | }, |
| 4675 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 4676 | # verified field is typically a name, email address, phone number, or |
| 4677 | # website that has been confirmed to be owned by the person. |
| 4678 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 4679 | # field. |
| 4680 | }, |
| 4681 | "value": "A String", # The relationship status. The value can be custom or one of these |
| 4682 | # predefined values: |
| 4683 | # |
| 4684 | # * `single` |
| 4685 | # * `inARelationship` |
| 4686 | # * `engaged` |
| 4687 | # * `married` |
| 4688 | # * `itsComplicated` |
| 4689 | # * `openRelationship` |
| 4690 | # * `widowed` |
| 4691 | # * `inDomesticPartnership` |
| 4692 | # * `inCivilUnion` |
| 4693 | }, |
| 4694 | ], |
| 4695 | "coverPhotos": [ # Output only. The person's cover photos. |
| 4696 | { # A person's cover photo. A large image shown on the person's |
| 4697 | # profile page that represents who they are or what they care about. |
| 4698 | "url": "A String", # The URL of the cover photo. |
| 4699 | "default": True or False, # True if the cover photo is the default cover photo; |
| 4700 | # false if the cover photo is a user-provided cover photo. |
| 4701 | "metadata": { # Metadata about a field. # Metadata about the cover photo. |
| 4702 | "source": { # The source of a field. # The source of the field. |
| 4703 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 4704 | # |
| 4705 | # Last update timestamp of this source. |
| 4706 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 4707 | # |
| 4708 | # Metadata about a source of type PROFILE. |
| 4709 | "userTypes": [ # Output only. The user types. |
| 4710 | "A String", |
| 4711 | ], |
| 4712 | "objectType": "A String", # Output only. The profile object type. |
| 4713 | }, |
| 4714 | "type": "A String", # The source type. |
| 4715 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 4716 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 4717 | # |
| 4718 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 4719 | # source. Used for web cache validation. |
| 4720 | }, |
| 4721 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 4722 | # verified field is typically a name, email address, phone number, or |
| 4723 | # website that has been confirmed to be owned by the person. |
| 4724 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 4725 | # field. |
| 4726 | }, |
| 4727 | }, |
| 4728 | ], |
| 4729 | "names": [ # The person's names. |
| 4730 | { # A person's name. If the name is a mononym, the family name is empty. |
| 4731 | "middleName": "A String", # The middle name(s). |
| 4732 | "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound. |
| 4733 | "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to |
| 4734 | # the locale specified by the viewer's account or the |
| 4735 | # `Accept-Language` HTTP header. |
| 4736 | "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.` |
| 4737 | "familyName": "A String", # The family name. |
| 4738 | "phoneticGivenName": "A String", # The given name spelled as it sounds. |
| 4739 | "metadata": { # Metadata about a field. # Metadata about the name. |
| 4740 | "source": { # The source of a field. # The source of the field. |
| 4741 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 4742 | # |
| 4743 | # Last update timestamp of this source. |
| 4744 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 4745 | # |
| 4746 | # Metadata about a source of type PROFILE. |
| 4747 | "userTypes": [ # Output only. The user types. |
| 4748 | "A String", |
| 4749 | ], |
| 4750 | "objectType": "A String", # Output only. The profile object type. |
| 4751 | }, |
| 4752 | "type": "A String", # The source type. |
| 4753 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 4754 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 4755 | # |
| 4756 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 4757 | # source. Used for web cache validation. |
| 4758 | }, |
| 4759 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 4760 | # verified field is typically a name, email address, phone number, or |
| 4761 | # website that has been confirmed to be owned by the person. |
| 4762 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 4763 | # field. |
| 4764 | }, |
| 4765 | "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound. |
| 4766 | "displayName": "A String", # Output only. The display name formatted according to the locale specified by |
| 4767 | # the viewer's account or the `Accept-Language` HTTP header. |
| 4768 | "phoneticFamilyName": "A String", # The family name spelled as it sounds. |
| 4769 | "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.` |
| 4770 | "givenName": "A String", # The given name. |
| 4771 | "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound. |
| 4772 | "phoneticFullName": "A String", # The full name spelled as it sounds. |
| 4773 | }, |
| 4774 | ], |
| 4775 | "relations": [ # The person's relations. |
| 4776 | { # A person's relation to another person. |
| 4777 | "type": "A String", # The person's relation to the other person. The type can be custom or one of |
| 4778 | # these predefined values: |
| 4779 | # |
| 4780 | # * `spouse` |
| 4781 | # * `child` |
| 4782 | # * `mother` |
| 4783 | # * `father` |
| 4784 | # * `parent` |
| 4785 | # * `brother` |
| 4786 | # * `sister` |
| 4787 | # * `friend` |
| 4788 | # * `relative` |
| 4789 | # * `domesticPartner` |
| 4790 | # * `manager` |
| 4791 | # * `assistant` |
| 4792 | # * `referredBy` |
| 4793 | # * `partner` |
| 4794 | "metadata": { # Metadata about a field. # Metadata about the relation. |
| 4795 | "source": { # The source of a field. # The source of the field. |
| 4796 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 4797 | # |
| 4798 | # Last update timestamp of this source. |
| 4799 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 4800 | # |
| 4801 | # Metadata about a source of type PROFILE. |
| 4802 | "userTypes": [ # Output only. The user types. |
| 4803 | "A String", |
| 4804 | ], |
| 4805 | "objectType": "A String", # Output only. The profile object type. |
| 4806 | }, |
| 4807 | "type": "A String", # The source type. |
| 4808 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 4809 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 4810 | # |
| 4811 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 4812 | # source. Used for web cache validation. |
| 4813 | }, |
| 4814 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 4815 | # verified field is typically a name, email address, phone number, or |
| 4816 | # website that has been confirmed to be owned by the person. |
| 4817 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 4818 | # field. |
| 4819 | }, |
| 4820 | "person": "A String", # The name of the other person this relation refers to. |
| 4821 | "formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's |
| 4822 | # account locale or the locale specified in the Accept-Language HTTP header. |
| 4823 | }, |
| 4824 | ], |
| 4825 | "ageRanges": [ # Output only. The person's age ranges. |
| 4826 | { # A person's age range. |
| 4827 | "metadata": { # Metadata about a field. # Metadata about the age range. |
| 4828 | "source": { # The source of a field. # The source of the field. |
| 4829 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 4830 | # |
| 4831 | # Last update timestamp of this source. |
| 4832 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 4833 | # |
| 4834 | # Metadata about a source of type PROFILE. |
| 4835 | "userTypes": [ # Output only. The user types. |
| 4836 | "A String", |
| 4837 | ], |
| 4838 | "objectType": "A String", # Output only. The profile object type. |
| 4839 | }, |
| 4840 | "type": "A String", # The source type. |
| 4841 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 4842 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 4843 | # |
| 4844 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 4845 | # source. Used for web cache validation. |
| 4846 | }, |
| 4847 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 4848 | # verified field is typically a name, email address, phone number, or |
| 4849 | # website that has been confirmed to be owned by the person. |
| 4850 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 4851 | # field. |
| 4852 | }, |
| 4853 | "ageRange": "A String", # The age range. |
| 4854 | }, |
| 4855 | ], |
| 4856 | "braggingRights": [ # **DEPRECATED**: No data will be returned |
| 4857 | # The person's bragging rights. |
| 4858 | { # **DEPRECATED**: No data will be returned |
| 4859 | # A person's bragging rights. |
| 4860 | "value": "A String", # The bragging rights; for example, `climbed mount everest`. |
| 4861 | "metadata": { # Metadata about a field. # Metadata about the bragging rights. |
| 4862 | "source": { # The source of a field. # The source of the field. |
| 4863 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 4864 | # |
| 4865 | # Last update timestamp of this source. |
| 4866 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 4867 | # |
| 4868 | # Metadata about a source of type PROFILE. |
| 4869 | "userTypes": [ # Output only. The user types. |
| 4870 | "A String", |
| 4871 | ], |
| 4872 | "objectType": "A String", # Output only. The profile object type. |
| 4873 | }, |
| 4874 | "type": "A String", # The source type. |
| 4875 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 4876 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 4877 | # |
| 4878 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 4879 | # source. Used for web cache validation. |
| 4880 | }, |
| 4881 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 4882 | # verified field is typically a name, email address, phone number, or |
| 4883 | # website that has been confirmed to be owned by the person. |
| 4884 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 4885 | # field. |
| 4886 | }, |
| 4887 | }, |
| 4888 | ], |
| 4889 | "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string |
| 4890 | # with a max length of 27 characters, in the form of |
| 4891 | # `people/{person_id}`. |
| 4892 | "photos": [ # Output only. The person's photos. |
| 4893 | { # A person's photo. A picture shown next to the person's name to |
| 4894 | # help others recognize the person. |
| 4895 | "url": "A String", # The URL of the photo. You can change the desired size by appending a query |
| 4896 | # parameter `sz={size}` at the end of the url, where {size} is the size in |
| 4897 | # pixels. Example: |
| 4898 | # https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50 |
| 4899 | "default": True or False, # True if the photo is a default photo; |
| 4900 | # false if the photo is a user-provided photo. |
| 4901 | "metadata": { # Metadata about a field. # Metadata about the photo. |
| 4902 | "source": { # The source of a field. # The source of the field. |
| 4903 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 4904 | # |
| 4905 | # Last update timestamp of this source. |
| 4906 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 4907 | # |
| 4908 | # Metadata about a source of type PROFILE. |
| 4909 | "userTypes": [ # Output only. The user types. |
| 4910 | "A String", |
| 4911 | ], |
| 4912 | "objectType": "A String", # Output only. The profile object type. |
| 4913 | }, |
| 4914 | "type": "A String", # The source type. |
| 4915 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 4916 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 4917 | # |
| 4918 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 4919 | # source. Used for web cache validation. |
| 4920 | }, |
| 4921 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 4922 | # verified field is typically a name, email address, phone number, or |
| 4923 | # website that has been confirmed to be owned by the person. |
| 4924 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 4925 | # field. |
| 4926 | }, |
| 4927 | }, |
| 4928 | ], |
| 4929 | "addresses": [ # The person's street addresses. |
| 4930 | { # A person's physical address. May be a P.O. box or street address. All fields |
| 4931 | # are optional. |
| 4932 | "streetAddress": "A String", # The street address. |
| 4933 | "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it |
| 4934 | # will be automatically constructed from structured values. |
| 4935 | "country": "A String", # The country of the address. |
| 4936 | "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's |
| 4937 | # account locale or the `Accept-Language` HTTP header locale. |
| 4938 | "city": "A String", # The city of the address. |
| 4939 | "postalCode": "A String", # The postal code of the address. |
| 4940 | "extendedAddress": "A String", # The extended address of the address; for example, the apartment number. |
| 4941 | "type": "A String", # The type of the address. The type can be custom or one of these predefined |
| 4942 | # values: |
| 4943 | # |
| 4944 | # * `home` |
| 4945 | # * `work` |
| 4946 | # * `other` |
| 4947 | "region": "A String", # The region of the address; for example, the state or province. |
| 4948 | "poBox": "A String", # The P.O. box of the address. |
| 4949 | "metadata": { # Metadata about a field. # Metadata about the address. |
| 4950 | "source": { # The source of a field. # The source of the field. |
| 4951 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 4952 | # |
| 4953 | # Last update timestamp of this source. |
| 4954 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 4955 | # |
| 4956 | # Metadata about a source of type PROFILE. |
| 4957 | "userTypes": [ # Output only. The user types. |
| 4958 | "A String", |
| 4959 | ], |
| 4960 | "objectType": "A String", # Output only. The profile object type. |
| 4961 | }, |
| 4962 | "type": "A String", # The source type. |
| 4963 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 4964 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 4965 | # |
| 4966 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 4967 | # source. Used for web cache validation. |
| 4968 | }, |
| 4969 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 4970 | # verified field is typically a name, email address, phone number, or |
| 4971 | # website that has been confirmed to be owned by the person. |
| 4972 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 4973 | # field. |
| 4974 | }, |
| 4975 | "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country |
| 4976 | # code of the address. |
| 4977 | }, |
| 4978 | ], |
| 4979 | "emailAddresses": [ # The person's email addresses. |
| 4980 | { # A person's email address. |
| 4981 | "formattedType": "A String", # Output only. The type of the email address translated and formatted in the |
| 4982 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 4983 | "metadata": { # Metadata about a field. # Metadata about the email address. |
| 4984 | "source": { # The source of a field. # The source of the field. |
| 4985 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 4986 | # |
| 4987 | # Last update timestamp of this source. |
| 4988 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 4989 | # |
| 4990 | # Metadata about a source of type PROFILE. |
| 4991 | "userTypes": [ # Output only. The user types. |
| 4992 | "A String", |
| 4993 | ], |
| 4994 | "objectType": "A String", # Output only. The profile object type. |
| 4995 | }, |
| 4996 | "type": "A String", # The source type. |
| 4997 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 4998 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 4999 | # |
| 5000 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 5001 | # source. Used for web cache validation. |
| 5002 | }, |
| 5003 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 5004 | # verified field is typically a name, email address, phone number, or |
| 5005 | # website that has been confirmed to be owned by the person. |
| 5006 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 5007 | # field. |
| 5008 | }, |
| 5009 | "value": "A String", # The email address. |
| 5010 | "displayName": "A String", # The display name of the email. |
| 5011 | "type": "A String", # The type of the email address. The type can be custom or one of these |
| 5012 | # predefined values: |
| 5013 | # |
| 5014 | # * `home` |
| 5015 | # * `work` |
| 5016 | # * `other` |
| 5017 | }, |
| 5018 | ], |
| 5019 | "nicknames": [ # The person's nicknames. |
| 5020 | { # A person's nickname. |
| 5021 | "metadata": { # Metadata about a field. # Metadata about the nickname. |
| 5022 | "source": { # The source of a field. # The source of the field. |
| 5023 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 5024 | # |
| 5025 | # Last update timestamp of this source. |
| 5026 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 5027 | # |
| 5028 | # Metadata about a source of type PROFILE. |
| 5029 | "userTypes": [ # Output only. The user types. |
| 5030 | "A String", |
| 5031 | ], |
| 5032 | "objectType": "A String", # Output only. The profile object type. |
| 5033 | }, |
| 5034 | "type": "A String", # The source type. |
| 5035 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 5036 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 5037 | # |
| 5038 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 5039 | # source. Used for web cache validation. |
| 5040 | }, |
| 5041 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 5042 | # verified field is typically a name, email address, phone number, or |
| 5043 | # website that has been confirmed to be owned by the person. |
| 5044 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 5045 | # field. |
| 5046 | }, |
| 5047 | "type": "A String", # The type of the nickname. |
| 5048 | "value": "A String", # The nickname. |
| 5049 | }, |
| 5050 | ], |
| 5051 | "events": [ # The person's events. |
| 5052 | { # An event related to the person. |
| 5053 | "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the event. |
| 5054 | # and time zone are either specified elsewhere or are not significant. The date |
| 5055 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 5056 | # |
| 5057 | # * A full date, with non-zero year, month and day values |
| 5058 | # * A month and day value, with a zero year, e.g. an anniversary |
| 5059 | # * A year on its own, with zero month and day values |
| 5060 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 5061 | # |
| 5062 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 5063 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 5064 | # a year. |
| 5065 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 5066 | # month and day. |
| 5067 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 5068 | # if specifying a year by itself or a year and month where the day is not |
| 5069 | # significant. |
| 5070 | }, |
| 5071 | "formattedType": "A String", # Output only. The type of the event translated and formatted in the |
| 5072 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 5073 | "metadata": { # Metadata about a field. # Metadata about the event. |
| 5074 | "source": { # The source of a field. # The source of the field. |
| 5075 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 5076 | # |
| 5077 | # Last update timestamp of this source. |
| 5078 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 5079 | # |
| 5080 | # Metadata about a source of type PROFILE. |
| 5081 | "userTypes": [ # Output only. The user types. |
| 5082 | "A String", |
| 5083 | ], |
| 5084 | "objectType": "A String", # Output only. The profile object type. |
| 5085 | }, |
| 5086 | "type": "A String", # The source type. |
| 5087 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 5088 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 5089 | # |
| 5090 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 5091 | # source. Used for web cache validation. |
| 5092 | }, |
| 5093 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 5094 | # verified field is typically a name, email address, phone number, or |
| 5095 | # website that has been confirmed to be owned by the person. |
| 5096 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 5097 | # field. |
| 5098 | }, |
| 5099 | "type": "A String", # The type of the event. The type can be custom or one of these predefined |
| 5100 | # values: |
| 5101 | # |
| 5102 | # * `anniversary` |
| 5103 | # * `other` |
| 5104 | }, |
| 5105 | ], |
| 5106 | "urls": [ # The person's associated URLs. |
| 5107 | { # A person's associated URLs. |
| 5108 | "type": "A String", # The type of the URL. The type can be custom or one of these predefined |
| 5109 | # values: |
| 5110 | # |
| 5111 | # * `home` |
| 5112 | # * `work` |
| 5113 | # * `blog` |
| 5114 | # * `profile` |
| 5115 | # * `homePage` |
| 5116 | # * `ftp` |
| 5117 | # * `reservations` |
| 5118 | # * `appInstallPage`: website for a Google+ application. |
| 5119 | # * `other` |
| 5120 | "metadata": { # Metadata about a field. # Metadata about the URL. |
| 5121 | "source": { # The source of a field. # The source of the field. |
| 5122 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 5123 | # |
| 5124 | # Last update timestamp of this source. |
| 5125 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 5126 | # |
| 5127 | # Metadata about a source of type PROFILE. |
| 5128 | "userTypes": [ # Output only. The user types. |
| 5129 | "A String", |
| 5130 | ], |
| 5131 | "objectType": "A String", # Output only. The profile object type. |
| 5132 | }, |
| 5133 | "type": "A String", # The source type. |
| 5134 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 5135 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 5136 | # |
| 5137 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 5138 | # source. Used for web cache validation. |
| 5139 | }, |
| 5140 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 5141 | # verified field is typically a name, email address, phone number, or |
| 5142 | # website that has been confirmed to be owned by the person. |
| 5143 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 5144 | # field. |
| 5145 | }, |
| 5146 | "formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's |
| 5147 | # account locale or the `Accept-Language` HTTP header locale. |
| 5148 | "value": "A String", # The URL. |
| 5149 | }, |
| 5150 | ], |
| 5151 | }</pre> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5152 | </div> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5153 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5154 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5155 | <code class="details" id="getBatchGet">getBatchGet(personFields=None, resourceNames=None, requestMask_includeField=None, x__xgafv=None)</code> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5156 | <pre>Provides information about a list of specific people by specifying a list |
| 5157 | of requested resource names. Use `people/me` to indicate the authenticated |
| 5158 | user. |
| 5159 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5160 | The request throws a 400 error if 'personFields' is not specified. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5161 | |
| 5162 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5163 | personFields: string, Required. A field mask to restrict which fields on each person are returned. Multiple |
| 5164 | fields can be specified by separating them with commas. Valid values are: |
| 5165 | |
| 5166 | * addresses |
| 5167 | * ageRanges |
| 5168 | * biographies |
| 5169 | * birthdays |
| 5170 | * coverPhotos |
| 5171 | * emailAddresses |
| 5172 | * events |
| 5173 | * genders |
| 5174 | * imClients |
| 5175 | * interests |
| 5176 | * locales |
| 5177 | * memberships |
| 5178 | * metadata |
| 5179 | * names |
| 5180 | * nicknames |
| 5181 | * occupations |
| 5182 | * organizations |
| 5183 | * phoneNumbers |
| 5184 | * photos |
| 5185 | * relations |
| 5186 | * residences |
| 5187 | * sipAddresses |
| 5188 | * skills |
| 5189 | * urls |
| 5190 | * userDefined |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5191 | resourceNames: string, Required. The resource names of the people to provide information about. |
| 5192 | |
| 5193 | - To get information about the authenticated user, specify `people/me`. |
| 5194 | - To get information about a google account, specify |
| 5195 | `people/{account_id}`. |
| 5196 | - To get information about a contact, specify the resource name that |
| 5197 | identifies the contact as returned by |
| 5198 | [`people.connections.list`](/people/api/rest/v1/people.connections/list). |
| 5199 | |
| 5200 | You can include up to 50 resource names in one request. (repeated) |
| 5201 | requestMask_includeField: string, Required. Comma-separated list of person fields to be included in the response. Each |
| 5202 | path should start with `person.`: for example, `person.names` or |
| 5203 | `person.photos`. |
| 5204 | x__xgafv: string, V1 error format. |
| 5205 | Allowed values |
| 5206 | 1 - v1 error format |
| 5207 | 2 - v2 error format |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5208 | |
| 5209 | Returns: |
| 5210 | An object of the form: |
| 5211 | |
| 5212 | { # The response to a get request for a list of people by resource name. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5213 | "responses": [ # The response for each requested resource name. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5214 | { # The response for a single person |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5215 | "person": { # Information about a person merged from various data sources such as the # The person. |
| 5216 | # authenticated user's contacts and profile data. |
| 5217 | # |
| 5218 | # Most fields can have multiple items. The items in a field have no guaranteed |
| 5219 | # order, but each non-empty field is guaranteed to have exactly one field with |
| 5220 | # `metadata.primary` set to true. |
| 5221 | "interests": [ # The person's interests. |
| 5222 | { # One of the person's interests. |
| 5223 | "value": "A String", # The interest; for example, `stargazing`. |
| 5224 | "metadata": { # Metadata about a field. # Metadata about the interest. |
| 5225 | "source": { # The source of a field. # The source of the field. |
| 5226 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 5227 | # |
| 5228 | # Last update timestamp of this source. |
| 5229 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 5230 | # |
| 5231 | # Metadata about a source of type PROFILE. |
| 5232 | "userTypes": [ # Output only. The user types. |
| 5233 | "A String", |
| 5234 | ], |
| 5235 | "objectType": "A String", # Output only. The profile object type. |
| 5236 | }, |
| 5237 | "type": "A String", # The source type. |
| 5238 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 5239 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 5240 | # |
| 5241 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 5242 | # source. Used for web cache validation. |
| 5243 | }, |
| 5244 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 5245 | # verified field is typically a name, email address, phone number, or |
| 5246 | # website that has been confirmed to be owned by the person. |
| 5247 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 5248 | # field. |
| 5249 | }, |
| 5250 | }, |
| 5251 | ], |
| 5252 | "userDefined": [ # The person's user defined data. |
| 5253 | { # Arbitrary user data that is populated by the end users. |
| 5254 | "metadata": { # Metadata about a field. # Metadata about the user defined data. |
| 5255 | "source": { # The source of a field. # The source of the field. |
| 5256 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 5257 | # |
| 5258 | # Last update timestamp of this source. |
| 5259 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 5260 | # |
| 5261 | # Metadata about a source of type PROFILE. |
| 5262 | "userTypes": [ # Output only. The user types. |
| 5263 | "A String", |
| 5264 | ], |
| 5265 | "objectType": "A String", # Output only. The profile object type. |
| 5266 | }, |
| 5267 | "type": "A String", # The source type. |
| 5268 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 5269 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 5270 | # |
| 5271 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 5272 | # source. Used for web cache validation. |
| 5273 | }, |
| 5274 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 5275 | # verified field is typically a name, email address, phone number, or |
| 5276 | # website that has been confirmed to be owned by the person. |
| 5277 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 5278 | # field. |
| 5279 | }, |
| 5280 | "key": "A String", # The end user specified key of the user defined data. |
| 5281 | "value": "A String", # The end user specified value of the user defined data. |
| 5282 | }, |
| 5283 | ], |
| 5284 | "sipAddresses": [ # The person's SIP addresses. |
| 5285 | { # A person's SIP address. Session Initial Protocol addresses are used for VoIP |
| 5286 | # communications to make voice or video calls over the internet. |
| 5287 | "value": "A String", # The SIP address in the |
| 5288 | # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI |
| 5289 | # format. |
| 5290 | "type": "A String", # The type of the SIP address. The type can be custom or or one of these |
| 5291 | # predefined values: |
| 5292 | # |
| 5293 | # * `home` |
| 5294 | # * `work` |
| 5295 | # * `mobile` |
| 5296 | # * `other` |
| 5297 | "metadata": { # Metadata about a field. # Metadata about the SIP address. |
| 5298 | "source": { # The source of a field. # The source of the field. |
| 5299 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 5300 | # |
| 5301 | # Last update timestamp of this source. |
| 5302 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 5303 | # |
| 5304 | # Metadata about a source of type PROFILE. |
| 5305 | "userTypes": [ # Output only. The user types. |
| 5306 | "A String", |
| 5307 | ], |
| 5308 | "objectType": "A String", # Output only. The profile object type. |
| 5309 | }, |
| 5310 | "type": "A String", # The source type. |
| 5311 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 5312 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 5313 | # |
| 5314 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 5315 | # source. Used for web cache validation. |
| 5316 | }, |
| 5317 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 5318 | # verified field is typically a name, email address, phone number, or |
| 5319 | # website that has been confirmed to be owned by the person. |
| 5320 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 5321 | # field. |
| 5322 | }, |
| 5323 | "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the |
| 5324 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 5325 | }, |
| 5326 | ], |
| 5327 | "phoneNumbers": [ # The person's phone numbers. |
| 5328 | { # A person's phone number. |
| 5329 | "type": "A String", # The type of the phone number. The type can be custom or one of these |
| 5330 | # predefined values: |
| 5331 | # |
| 5332 | # * `home` |
| 5333 | # * `work` |
| 5334 | # * `mobile` |
| 5335 | # * `homeFax` |
| 5336 | # * `workFax` |
| 5337 | # * `otherFax` |
| 5338 | # * `pager` |
| 5339 | # * `workMobile` |
| 5340 | # * `workPager` |
| 5341 | # * `main` |
| 5342 | # * `googleVoice` |
| 5343 | # * `other` |
| 5344 | "value": "A String", # The phone number. |
| 5345 | "canonicalForm": "A String", # Output only. The canonicalized [ITU-T |
| 5346 | # E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) |
| 5347 | # form of the phone number. |
| 5348 | "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the |
| 5349 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 5350 | "metadata": { # Metadata about a field. # Metadata about the phone number. |
| 5351 | "source": { # The source of a field. # The source of the field. |
| 5352 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 5353 | # |
| 5354 | # Last update timestamp of this source. |
| 5355 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 5356 | # |
| 5357 | # Metadata about a source of type PROFILE. |
| 5358 | "userTypes": [ # Output only. The user types. |
| 5359 | "A String", |
| 5360 | ], |
| 5361 | "objectType": "A String", # Output only. The profile object type. |
| 5362 | }, |
| 5363 | "type": "A String", # The source type. |
| 5364 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 5365 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 5366 | # |
| 5367 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 5368 | # source. Used for web cache validation. |
| 5369 | }, |
| 5370 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 5371 | # verified field is typically a name, email address, phone number, or |
| 5372 | # website that has been confirmed to be owned by the person. |
| 5373 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 5374 | # field. |
| 5375 | }, |
| 5376 | }, |
| 5377 | ], |
| 5378 | "occupations": [ # The person's occupations. |
| 5379 | { # A person's occupation. |
| 5380 | "value": "A String", # The occupation; for example, `carpenter`. |
| 5381 | "metadata": { # Metadata about a field. # Metadata about the occupation. |
| 5382 | "source": { # The source of a field. # The source of the field. |
| 5383 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 5384 | # |
| 5385 | # Last update timestamp of this source. |
| 5386 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 5387 | # |
| 5388 | # Metadata about a source of type PROFILE. |
| 5389 | "userTypes": [ # Output only. The user types. |
| 5390 | "A String", |
| 5391 | ], |
| 5392 | "objectType": "A String", # Output only. The profile object type. |
| 5393 | }, |
| 5394 | "type": "A String", # The source type. |
| 5395 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 5396 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 5397 | # |
| 5398 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 5399 | # source. Used for web cache validation. |
| 5400 | }, |
| 5401 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 5402 | # verified field is typically a name, email address, phone number, or |
| 5403 | # website that has been confirmed to be owned by the person. |
| 5404 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 5405 | # field. |
| 5406 | }, |
| 5407 | }, |
| 5408 | ], |
| 5409 | "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) |
| 5410 | # |
| 5411 | # The person's age range. |
| 5412 | "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 5413 | # resource. Used for web cache validation. |
| 5414 | "biographies": [ # The person's biographies. |
| 5415 | { # A person's short biography. |
| 5416 | "metadata": { # Metadata about a field. # Metadata about the biography. |
| 5417 | "source": { # The source of a field. # The source of the field. |
| 5418 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 5419 | # |
| 5420 | # Last update timestamp of this source. |
| 5421 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 5422 | # |
| 5423 | # Metadata about a source of type PROFILE. |
| 5424 | "userTypes": [ # Output only. The user types. |
| 5425 | "A String", |
| 5426 | ], |
| 5427 | "objectType": "A String", # Output only. The profile object type. |
| 5428 | }, |
| 5429 | "type": "A String", # The source type. |
| 5430 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 5431 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 5432 | # |
| 5433 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 5434 | # source. Used for web cache validation. |
| 5435 | }, |
| 5436 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 5437 | # verified field is typically a name, email address, phone number, or |
| 5438 | # website that has been confirmed to be owned by the person. |
| 5439 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 5440 | # field. |
| 5441 | }, |
| 5442 | "contentType": "A String", # The content type of the biography. |
| 5443 | "value": "A String", # The short biography. |
| 5444 | }, |
| 5445 | ], |
| 5446 | "locales": [ # The person's locale preferences. |
| 5447 | { # A person's locale preference. |
| 5448 | "metadata": { # Metadata about a field. # Metadata about the locale. |
| 5449 | "source": { # The source of a field. # The source of the field. |
| 5450 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 5451 | # |
| 5452 | # Last update timestamp of this source. |
| 5453 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 5454 | # |
| 5455 | # Metadata about a source of type PROFILE. |
| 5456 | "userTypes": [ # Output only. The user types. |
| 5457 | "A String", |
| 5458 | ], |
| 5459 | "objectType": "A String", # Output only. The profile object type. |
| 5460 | }, |
| 5461 | "type": "A String", # The source type. |
| 5462 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 5463 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 5464 | # |
| 5465 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 5466 | # source. Used for web cache validation. |
| 5467 | }, |
| 5468 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 5469 | # verified field is typically a name, email address, phone number, or |
| 5470 | # website that has been confirmed to be owned by the person. |
| 5471 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 5472 | # field. |
| 5473 | }, |
| 5474 | "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) |
| 5475 | # language tag representing the locale. |
| 5476 | }, |
| 5477 | ], |
| 5478 | "taglines": [ # Output only. **DEPRECATED**: No data will be returned |
| 5479 | # The person's taglines. |
| 5480 | { # **DEPRECATED**: No data will be returned |
| 5481 | # A brief one-line description of the person. |
| 5482 | "metadata": { # Metadata about a field. # Metadata about the tagline. |
| 5483 | "source": { # The source of a field. # The source of the field. |
| 5484 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 5485 | # |
| 5486 | # Last update timestamp of this source. |
| 5487 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 5488 | # |
| 5489 | # Metadata about a source of type PROFILE. |
| 5490 | "userTypes": [ # Output only. The user types. |
| 5491 | "A String", |
| 5492 | ], |
| 5493 | "objectType": "A String", # Output only. The profile object type. |
| 5494 | }, |
| 5495 | "type": "A String", # The source type. |
| 5496 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 5497 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 5498 | # |
| 5499 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 5500 | # source. Used for web cache validation. |
| 5501 | }, |
| 5502 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 5503 | # verified field is typically a name, email address, phone number, or |
| 5504 | # website that has been confirmed to be owned by the person. |
| 5505 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 5506 | # field. |
| 5507 | }, |
| 5508 | "value": "A String", # The tagline. |
| 5509 | }, |
| 5510 | ], |
| 5511 | "organizations": [ # The person's past or current organizations. |
| 5512 | { # A person's past or current organization. Overlapping date ranges are |
| 5513 | # permitted. |
| 5514 | "title": "A String", # The person's job title at the organization. |
| 5515 | "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker |
| 5516 | # symbol, abbreviation, or acronym. |
| 5517 | "name": "A String", # The name of the organization. |
| 5518 | "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The start date when the person joined the organization. |
| 5519 | # and time zone are either specified elsewhere or are not significant. The date |
| 5520 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 5521 | # |
| 5522 | # * A full date, with non-zero year, month and day values |
| 5523 | # * A month and day value, with a zero year, e.g. an anniversary |
| 5524 | # * A year on its own, with zero month and day values |
| 5525 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 5526 | # |
| 5527 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 5528 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 5529 | # a year. |
| 5530 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 5531 | # month and day. |
| 5532 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 5533 | # if specifying a year by itself or a year and month where the day is not |
| 5534 | # significant. |
| 5535 | }, |
| 5536 | "department": "A String", # The person's department at the organization. |
| 5537 | "current": True or False, # True if the organization is the person's current organization; |
| 5538 | # false if the organization is a past organization. |
| 5539 | "location": "A String", # The location of the organization office the person works at. |
| 5540 | "domain": "A String", # The domain name associated with the organization; for example, |
| 5541 | # `google.com`. |
| 5542 | "metadata": { # Metadata about a field. # Metadata about the organization. |
| 5543 | "source": { # The source of a field. # The source of the field. |
| 5544 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 5545 | # |
| 5546 | # Last update timestamp of this source. |
| 5547 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 5548 | # |
| 5549 | # Metadata about a source of type PROFILE. |
| 5550 | "userTypes": [ # Output only. The user types. |
| 5551 | "A String", |
| 5552 | ], |
| 5553 | "objectType": "A String", # Output only. The profile object type. |
| 5554 | }, |
| 5555 | "type": "A String", # The source type. |
| 5556 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 5557 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 5558 | # |
| 5559 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 5560 | # source. Used for web cache validation. |
| 5561 | }, |
| 5562 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 5563 | # verified field is typically a name, email address, phone number, or |
| 5564 | # website that has been confirmed to be owned by the person. |
| 5565 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 5566 | # field. |
| 5567 | }, |
| 5568 | "jobDescription": "A String", # The person's job description at the organization. |
| 5569 | "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The end date when the person left the organization. |
| 5570 | # and time zone are either specified elsewhere or are not significant. The date |
| 5571 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 5572 | # |
| 5573 | # * A full date, with non-zero year, month and day values |
| 5574 | # * A month and day value, with a zero year, e.g. an anniversary |
| 5575 | # * A year on its own, with zero month and day values |
| 5576 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 5577 | # |
| 5578 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 5579 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 5580 | # a year. |
| 5581 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 5582 | # month and day. |
| 5583 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 5584 | # if specifying a year by itself or a year and month where the day is not |
| 5585 | # significant. |
| 5586 | }, |
| 5587 | "phoneticName": "A String", # The phonetic name of the organization. |
| 5588 | "formattedType": "A String", # Output only. The type of the organization translated and formatted in the |
| 5589 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 5590 | "type": "A String", # The type of the organization. The type can be custom or one of these |
| 5591 | # predefined values: |
| 5592 | # |
| 5593 | # * `work` |
| 5594 | # * `school` |
| 5595 | }, |
| 5596 | ], |
| 5597 | "residences": [ # The person's residences. |
| 5598 | { # A person's past or current residence. |
| 5599 | "metadata": { # Metadata about a field. # Metadata about the residence. |
| 5600 | "source": { # The source of a field. # The source of the field. |
| 5601 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 5602 | # |
| 5603 | # Last update timestamp of this source. |
| 5604 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 5605 | # |
| 5606 | # Metadata about a source of type PROFILE. |
| 5607 | "userTypes": [ # Output only. The user types. |
| 5608 | "A String", |
| 5609 | ], |
| 5610 | "objectType": "A String", # Output only. The profile object type. |
| 5611 | }, |
| 5612 | "type": "A String", # The source type. |
| 5613 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 5614 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 5615 | # |
| 5616 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 5617 | # source. Used for web cache validation. |
| 5618 | }, |
| 5619 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 5620 | # verified field is typically a name, email address, phone number, or |
| 5621 | # website that has been confirmed to be owned by the person. |
| 5622 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 5623 | # field. |
| 5624 | }, |
| 5625 | "current": True or False, # True if the residence is the person's current residence; |
| 5626 | # false if the residence is a past residence. |
| 5627 | "value": "A String", # The address of the residence. |
| 5628 | }, |
| 5629 | ], |
| 5630 | "genders": [ # The person's genders. |
| 5631 | { # A person's gender. |
| 5632 | "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account |
| 5633 | # locale or the `Accept-Language` HTTP header locale. Unspecified or custom |
| 5634 | # value are not localized. |
| 5635 | "metadata": { # Metadata about a field. # Metadata about the gender. |
| 5636 | "source": { # The source of a field. # The source of the field. |
| 5637 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 5638 | # |
| 5639 | # Last update timestamp of this source. |
| 5640 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 5641 | # |
| 5642 | # Metadata about a source of type PROFILE. |
| 5643 | "userTypes": [ # Output only. The user types. |
| 5644 | "A String", |
| 5645 | ], |
| 5646 | "objectType": "A String", # Output only. The profile object type. |
| 5647 | }, |
| 5648 | "type": "A String", # The source type. |
| 5649 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 5650 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 5651 | # |
| 5652 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 5653 | # source. Used for web cache validation. |
| 5654 | }, |
| 5655 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 5656 | # verified field is typically a name, email address, phone number, or |
| 5657 | # website that has been confirmed to be owned by the person. |
| 5658 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 5659 | # field. |
| 5660 | }, |
| 5661 | "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value |
| 5662 | # can be custom or one of these predefined values: |
| 5663 | # |
| 5664 | # * `male` |
| 5665 | # * `female` |
| 5666 | # * `other` |
| 5667 | "value": "A String", # The gender for the person. The gender can be custom or one of these |
| 5668 | # predefined values: |
| 5669 | # |
| 5670 | # * `male` |
| 5671 | # * `female` |
| 5672 | # * `unspecified` |
| 5673 | }, |
| 5674 | ], |
| 5675 | "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned |
| 5676 | # The person's relationship interests. |
| 5677 | { # **DEPRECATED**: No data will be returned |
| 5678 | # A person's relationship interest . |
| 5679 | "formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted |
| 5680 | # in the viewer's account locale or the locale specified in the |
| 5681 | # Accept-Language HTTP header. |
| 5682 | "metadata": { # Metadata about a field. # Metadata about the relationship interest. |
| 5683 | "source": { # The source of a field. # The source of the field. |
| 5684 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 5685 | # |
| 5686 | # Last update timestamp of this source. |
| 5687 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 5688 | # |
| 5689 | # Metadata about a source of type PROFILE. |
| 5690 | "userTypes": [ # Output only. The user types. |
| 5691 | "A String", |
| 5692 | ], |
| 5693 | "objectType": "A String", # Output only. The profile object type. |
| 5694 | }, |
| 5695 | "type": "A String", # The source type. |
| 5696 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 5697 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 5698 | # |
| 5699 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 5700 | # source. Used for web cache validation. |
| 5701 | }, |
| 5702 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 5703 | # verified field is typically a name, email address, phone number, or |
| 5704 | # website that has been confirmed to be owned by the person. |
| 5705 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 5706 | # field. |
| 5707 | }, |
| 5708 | "value": "A String", # The kind of relationship the person is looking for. The value can be custom |
| 5709 | # or one of these predefined values: |
| 5710 | # |
| 5711 | # * `friend` |
| 5712 | # * `date` |
| 5713 | # * `relationship` |
| 5714 | # * `networking` |
| 5715 | }, |
| 5716 | ], |
| 5717 | "metadata": { # The metadata about a person. # Output only. Metadata about the person. |
| 5718 | "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for |
| 5719 | # [`connections.list`](/people/api/rest/v1/people.connections/list) requests |
| 5720 | # that include a sync token. |
| 5721 | # |
| 5722 | # The resource name may change when adding or removing fields that link a |
| 5723 | # contact and profile such as a verified email, verified phone number, or |
| 5724 | # profile URL. |
| 5725 | "A String", |
| 5726 | ], |
| 5727 | "sources": [ # The sources of data for the person. |
| 5728 | { # The source of a field. |
| 5729 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 5730 | # |
| 5731 | # Last update timestamp of this source. |
| 5732 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 5733 | # |
| 5734 | # Metadata about a source of type PROFILE. |
| 5735 | "userTypes": [ # Output only. The user types. |
| 5736 | "A String", |
| 5737 | ], |
| 5738 | "objectType": "A String", # Output only. The profile object type. |
| 5739 | }, |
| 5740 | "type": "A String", # The source type. |
| 5741 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 5742 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 5743 | # |
| 5744 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 5745 | # source. Used for web cache validation. |
| 5746 | }, |
| 5747 | ], |
| 5748 | "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource. |
| 5749 | "A String", |
| 5750 | ], |
| 5751 | "objectType": "A String", # Output only. **DEPRECATED** (Please use |
| 5752 | # `person.metadata.sources.profileMetadata.objectType` instead) |
| 5753 | # |
| 5754 | # The type of the person object. |
| 5755 | "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for |
| 5756 | # [`connections.list`](/people/api/rest/v1/people.connections/list) requests |
| 5757 | # that include a sync token. |
| 5758 | }, |
| 5759 | "memberships": [ # The person's group memberships. |
| 5760 | { # A person's membership in a group. Only contact group memberships can be |
| 5761 | # modified. |
| 5762 | "metadata": { # Metadata about a field. # Metadata about the membership. |
| 5763 | "source": { # The source of a field. # The source of the field. |
| 5764 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 5765 | # |
| 5766 | # Last update timestamp of this source. |
| 5767 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 5768 | # |
| 5769 | # Metadata about a source of type PROFILE. |
| 5770 | "userTypes": [ # Output only. The user types. |
| 5771 | "A String", |
| 5772 | ], |
| 5773 | "objectType": "A String", # Output only. The profile object type. |
| 5774 | }, |
| 5775 | "type": "A String", # The source type. |
| 5776 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 5777 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 5778 | # |
| 5779 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 5780 | # source. Used for web cache validation. |
| 5781 | }, |
| 5782 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 5783 | # verified field is typically a name, email address, phone number, or |
| 5784 | # website that has been confirmed to be owned by the person. |
| 5785 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 5786 | # field. |
| 5787 | }, |
| 5788 | "contactGroupMembership": { # A Google contact group membership. # The contact group membership. |
| 5789 | "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership. |
| 5790 | "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII |
| 5791 | # string, in the form of `contactGroups/{contact_group_id}`. |
| 5792 | # Only contact_group_resource_name can be used for modifying memberships. |
| 5793 | # Any contact group membership can be removed, but only user group or |
| 5794 | # "myContacts" or "starred" system groups memberships can be added. A |
| 5795 | # contact must always have at least one contact group membership. |
| 5796 | }, |
| 5797 | "domainMembership": { # A G Suite Domain membership. # Output only. The domain membership. |
| 5798 | "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain. |
| 5799 | }, |
| 5800 | }, |
| 5801 | ], |
| 5802 | "birthdays": [ # The person's birthdays. |
| 5803 | { # A person's birthday. At least one of the `date` and `text` fields are |
| 5804 | # specified. The `date` and `text` fields typically represent the same |
| 5805 | # date, but are not guaranteed to. |
| 5806 | "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the birthday. |
| 5807 | # and time zone are either specified elsewhere or are not significant. The date |
| 5808 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 5809 | # |
| 5810 | # * A full date, with non-zero year, month and day values |
| 5811 | # * A month and day value, with a zero year, e.g. an anniversary |
| 5812 | # * A year on its own, with zero month and day values |
| 5813 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 5814 | # |
| 5815 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 5816 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 5817 | # a year. |
| 5818 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 5819 | # month and day. |
| 5820 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 5821 | # if specifying a year by itself or a year and month where the day is not |
| 5822 | # significant. |
| 5823 | }, |
| 5824 | "metadata": { # Metadata about a field. # Metadata about the birthday. |
| 5825 | "source": { # The source of a field. # The source of the field. |
| 5826 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 5827 | # |
| 5828 | # Last update timestamp of this source. |
| 5829 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 5830 | # |
| 5831 | # Metadata about a source of type PROFILE. |
| 5832 | "userTypes": [ # Output only. The user types. |
| 5833 | "A String", |
| 5834 | ], |
| 5835 | "objectType": "A String", # Output only. The profile object type. |
| 5836 | }, |
| 5837 | "type": "A String", # The source type. |
| 5838 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 5839 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 5840 | # |
| 5841 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 5842 | # source. Used for web cache validation. |
| 5843 | }, |
| 5844 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 5845 | # verified field is typically a name, email address, phone number, or |
| 5846 | # website that has been confirmed to be owned by the person. |
| 5847 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 5848 | # field. |
| 5849 | }, |
| 5850 | "text": "A String", # A free-form string representing the user's birthday. |
| 5851 | }, |
| 5852 | ], |
| 5853 | "imClients": [ # The person's instant messaging clients. |
| 5854 | { # A person's instant messaging client. |
| 5855 | "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the |
| 5856 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 5857 | "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these |
| 5858 | # predefined values: |
| 5859 | # |
| 5860 | # * `aim` |
| 5861 | # * `msn` |
| 5862 | # * `yahoo` |
| 5863 | # * `skype` |
| 5864 | # * `qq` |
| 5865 | # * `googleTalk` |
| 5866 | # * `icq` |
| 5867 | # * `jabber` |
| 5868 | # * `netMeeting` |
| 5869 | "username": "A String", # The user name used in the IM client. |
| 5870 | "type": "A String", # The type of the IM client. The type can be custom or one of these |
| 5871 | # predefined values: |
| 5872 | # |
| 5873 | # * `home` |
| 5874 | # * `work` |
| 5875 | # * `other` |
| 5876 | "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account |
| 5877 | # locale or the `Accept-Language` HTTP header locale. |
| 5878 | "metadata": { # Metadata about a field. # Metadata about the IM client. |
| 5879 | "source": { # The source of a field. # The source of the field. |
| 5880 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 5881 | # |
| 5882 | # Last update timestamp of this source. |
| 5883 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 5884 | # |
| 5885 | # Metadata about a source of type PROFILE. |
| 5886 | "userTypes": [ # Output only. The user types. |
| 5887 | "A String", |
| 5888 | ], |
| 5889 | "objectType": "A String", # Output only. The profile object type. |
| 5890 | }, |
| 5891 | "type": "A String", # The source type. |
| 5892 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 5893 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 5894 | # |
| 5895 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 5896 | # source. Used for web cache validation. |
| 5897 | }, |
| 5898 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 5899 | # verified field is typically a name, email address, phone number, or |
| 5900 | # website that has been confirmed to be owned by the person. |
| 5901 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 5902 | # field. |
| 5903 | }, |
| 5904 | }, |
| 5905 | ], |
| 5906 | "skills": [ # The person's skills. |
| 5907 | { # A skill that the person has. |
| 5908 | "metadata": { # Metadata about a field. # Metadata about the skill. |
| 5909 | "source": { # The source of a field. # The source of the field. |
| 5910 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 5911 | # |
| 5912 | # Last update timestamp of this source. |
| 5913 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 5914 | # |
| 5915 | # Metadata about a source of type PROFILE. |
| 5916 | "userTypes": [ # Output only. The user types. |
| 5917 | "A String", |
| 5918 | ], |
| 5919 | "objectType": "A String", # Output only. The profile object type. |
| 5920 | }, |
| 5921 | "type": "A String", # The source type. |
| 5922 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 5923 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 5924 | # |
| 5925 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 5926 | # source. Used for web cache validation. |
| 5927 | }, |
| 5928 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 5929 | # verified field is typically a name, email address, phone number, or |
| 5930 | # website that has been confirmed to be owned by the person. |
| 5931 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 5932 | # field. |
| 5933 | }, |
| 5934 | "value": "A String", # The skill; for example, `underwater basket weaving`. |
| 5935 | }, |
| 5936 | ], |
| 5937 | "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned |
| 5938 | # The person's relationship statuses. |
| 5939 | { # **DEPRECATED**: No data will be returned |
| 5940 | # A person's relationship status. |
| 5941 | "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in |
| 5942 | # the viewer's account locale or the `Accept-Language` HTTP header locale. |
| 5943 | "metadata": { # Metadata about a field. # Metadata about the relationship status. |
| 5944 | "source": { # The source of a field. # The source of the field. |
| 5945 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 5946 | # |
| 5947 | # Last update timestamp of this source. |
| 5948 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 5949 | # |
| 5950 | # Metadata about a source of type PROFILE. |
| 5951 | "userTypes": [ # Output only. The user types. |
| 5952 | "A String", |
| 5953 | ], |
| 5954 | "objectType": "A String", # Output only. The profile object type. |
| 5955 | }, |
| 5956 | "type": "A String", # The source type. |
| 5957 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 5958 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 5959 | # |
| 5960 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 5961 | # source. Used for web cache validation. |
| 5962 | }, |
| 5963 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 5964 | # verified field is typically a name, email address, phone number, or |
| 5965 | # website that has been confirmed to be owned by the person. |
| 5966 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 5967 | # field. |
| 5968 | }, |
| 5969 | "value": "A String", # The relationship status. The value can be custom or one of these |
| 5970 | # predefined values: |
| 5971 | # |
| 5972 | # * `single` |
| 5973 | # * `inARelationship` |
| 5974 | # * `engaged` |
| 5975 | # * `married` |
| 5976 | # * `itsComplicated` |
| 5977 | # * `openRelationship` |
| 5978 | # * `widowed` |
| 5979 | # * `inDomesticPartnership` |
| 5980 | # * `inCivilUnion` |
| 5981 | }, |
| 5982 | ], |
| 5983 | "coverPhotos": [ # Output only. The person's cover photos. |
| 5984 | { # A person's cover photo. A large image shown on the person's |
| 5985 | # profile page that represents who they are or what they care about. |
| 5986 | "url": "A String", # The URL of the cover photo. |
| 5987 | "default": True or False, # True if the cover photo is the default cover photo; |
| 5988 | # false if the cover photo is a user-provided cover photo. |
| 5989 | "metadata": { # Metadata about a field. # Metadata about the cover photo. |
| 5990 | "source": { # The source of a field. # The source of the field. |
| 5991 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 5992 | # |
| 5993 | # Last update timestamp of this source. |
| 5994 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 5995 | # |
| 5996 | # Metadata about a source of type PROFILE. |
| 5997 | "userTypes": [ # Output only. The user types. |
| 5998 | "A String", |
| 5999 | ], |
| 6000 | "objectType": "A String", # Output only. The profile object type. |
| 6001 | }, |
| 6002 | "type": "A String", # The source type. |
| 6003 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 6004 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 6005 | # |
| 6006 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 6007 | # source. Used for web cache validation. |
| 6008 | }, |
| 6009 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 6010 | # verified field is typically a name, email address, phone number, or |
| 6011 | # website that has been confirmed to be owned by the person. |
| 6012 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 6013 | # field. |
| 6014 | }, |
| 6015 | }, |
| 6016 | ], |
| 6017 | "names": [ # The person's names. |
| 6018 | { # A person's name. If the name is a mononym, the family name is empty. |
| 6019 | "middleName": "A String", # The middle name(s). |
| 6020 | "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound. |
| 6021 | "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to |
| 6022 | # the locale specified by the viewer's account or the |
| 6023 | # `Accept-Language` HTTP header. |
| 6024 | "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.` |
| 6025 | "familyName": "A String", # The family name. |
| 6026 | "phoneticGivenName": "A String", # The given name spelled as it sounds. |
| 6027 | "metadata": { # Metadata about a field. # Metadata about the name. |
| 6028 | "source": { # The source of a field. # The source of the field. |
| 6029 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 6030 | # |
| 6031 | # Last update timestamp of this source. |
| 6032 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 6033 | # |
| 6034 | # Metadata about a source of type PROFILE. |
| 6035 | "userTypes": [ # Output only. The user types. |
| 6036 | "A String", |
| 6037 | ], |
| 6038 | "objectType": "A String", # Output only. The profile object type. |
| 6039 | }, |
| 6040 | "type": "A String", # The source type. |
| 6041 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 6042 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 6043 | # |
| 6044 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 6045 | # source. Used for web cache validation. |
| 6046 | }, |
| 6047 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 6048 | # verified field is typically a name, email address, phone number, or |
| 6049 | # website that has been confirmed to be owned by the person. |
| 6050 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 6051 | # field. |
| 6052 | }, |
| 6053 | "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound. |
| 6054 | "displayName": "A String", # Output only. The display name formatted according to the locale specified by |
| 6055 | # the viewer's account or the `Accept-Language` HTTP header. |
| 6056 | "phoneticFamilyName": "A String", # The family name spelled as it sounds. |
| 6057 | "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.` |
| 6058 | "givenName": "A String", # The given name. |
| 6059 | "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound. |
| 6060 | "phoneticFullName": "A String", # The full name spelled as it sounds. |
| 6061 | }, |
| 6062 | ], |
| 6063 | "relations": [ # The person's relations. |
| 6064 | { # A person's relation to another person. |
| 6065 | "type": "A String", # The person's relation to the other person. The type can be custom or one of |
| 6066 | # these predefined values: |
| 6067 | # |
| 6068 | # * `spouse` |
| 6069 | # * `child` |
| 6070 | # * `mother` |
| 6071 | # * `father` |
| 6072 | # * `parent` |
| 6073 | # * `brother` |
| 6074 | # * `sister` |
| 6075 | # * `friend` |
| 6076 | # * `relative` |
| 6077 | # * `domesticPartner` |
| 6078 | # * `manager` |
| 6079 | # * `assistant` |
| 6080 | # * `referredBy` |
| 6081 | # * `partner` |
| 6082 | "metadata": { # Metadata about a field. # Metadata about the relation. |
| 6083 | "source": { # The source of a field. # The source of the field. |
| 6084 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 6085 | # |
| 6086 | # Last update timestamp of this source. |
| 6087 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 6088 | # |
| 6089 | # Metadata about a source of type PROFILE. |
| 6090 | "userTypes": [ # Output only. The user types. |
| 6091 | "A String", |
| 6092 | ], |
| 6093 | "objectType": "A String", # Output only. The profile object type. |
| 6094 | }, |
| 6095 | "type": "A String", # The source type. |
| 6096 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 6097 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 6098 | # |
| 6099 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 6100 | # source. Used for web cache validation. |
| 6101 | }, |
| 6102 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 6103 | # verified field is typically a name, email address, phone number, or |
| 6104 | # website that has been confirmed to be owned by the person. |
| 6105 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 6106 | # field. |
| 6107 | }, |
| 6108 | "person": "A String", # The name of the other person this relation refers to. |
| 6109 | "formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's |
| 6110 | # account locale or the locale specified in the Accept-Language HTTP header. |
| 6111 | }, |
| 6112 | ], |
| 6113 | "ageRanges": [ # Output only. The person's age ranges. |
| 6114 | { # A person's age range. |
| 6115 | "metadata": { # Metadata about a field. # Metadata about the age range. |
| 6116 | "source": { # The source of a field. # The source of the field. |
| 6117 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 6118 | # |
| 6119 | # Last update timestamp of this source. |
| 6120 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 6121 | # |
| 6122 | # Metadata about a source of type PROFILE. |
| 6123 | "userTypes": [ # Output only. The user types. |
| 6124 | "A String", |
| 6125 | ], |
| 6126 | "objectType": "A String", # Output only. The profile object type. |
| 6127 | }, |
| 6128 | "type": "A String", # The source type. |
| 6129 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 6130 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 6131 | # |
| 6132 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 6133 | # source. Used for web cache validation. |
| 6134 | }, |
| 6135 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 6136 | # verified field is typically a name, email address, phone number, or |
| 6137 | # website that has been confirmed to be owned by the person. |
| 6138 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 6139 | # field. |
| 6140 | }, |
| 6141 | "ageRange": "A String", # The age range. |
| 6142 | }, |
| 6143 | ], |
| 6144 | "braggingRights": [ # **DEPRECATED**: No data will be returned |
| 6145 | # The person's bragging rights. |
| 6146 | { # **DEPRECATED**: No data will be returned |
| 6147 | # A person's bragging rights. |
| 6148 | "value": "A String", # The bragging rights; for example, `climbed mount everest`. |
| 6149 | "metadata": { # Metadata about a field. # Metadata about the bragging rights. |
| 6150 | "source": { # The source of a field. # The source of the field. |
| 6151 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 6152 | # |
| 6153 | # Last update timestamp of this source. |
| 6154 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 6155 | # |
| 6156 | # Metadata about a source of type PROFILE. |
| 6157 | "userTypes": [ # Output only. The user types. |
| 6158 | "A String", |
| 6159 | ], |
| 6160 | "objectType": "A String", # Output only. The profile object type. |
| 6161 | }, |
| 6162 | "type": "A String", # The source type. |
| 6163 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 6164 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 6165 | # |
| 6166 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 6167 | # source. Used for web cache validation. |
| 6168 | }, |
| 6169 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 6170 | # verified field is typically a name, email address, phone number, or |
| 6171 | # website that has been confirmed to be owned by the person. |
| 6172 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 6173 | # field. |
| 6174 | }, |
| 6175 | }, |
| 6176 | ], |
| 6177 | "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string |
| 6178 | # with a max length of 27 characters, in the form of |
| 6179 | # `people/{person_id}`. |
| 6180 | "photos": [ # Output only. The person's photos. |
| 6181 | { # A person's photo. A picture shown next to the person's name to |
| 6182 | # help others recognize the person. |
| 6183 | "url": "A String", # The URL of the photo. You can change the desired size by appending a query |
| 6184 | # parameter `sz={size}` at the end of the url, where {size} is the size in |
| 6185 | # pixels. Example: |
| 6186 | # https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50 |
| 6187 | "default": True or False, # True if the photo is a default photo; |
| 6188 | # false if the photo is a user-provided photo. |
| 6189 | "metadata": { # Metadata about a field. # Metadata about the photo. |
| 6190 | "source": { # The source of a field. # The source of the field. |
| 6191 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 6192 | # |
| 6193 | # Last update timestamp of this source. |
| 6194 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 6195 | # |
| 6196 | # Metadata about a source of type PROFILE. |
| 6197 | "userTypes": [ # Output only. The user types. |
| 6198 | "A String", |
| 6199 | ], |
| 6200 | "objectType": "A String", # Output only. The profile object type. |
| 6201 | }, |
| 6202 | "type": "A String", # The source type. |
| 6203 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 6204 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 6205 | # |
| 6206 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 6207 | # source. Used for web cache validation. |
| 6208 | }, |
| 6209 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 6210 | # verified field is typically a name, email address, phone number, or |
| 6211 | # website that has been confirmed to be owned by the person. |
| 6212 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 6213 | # field. |
| 6214 | }, |
| 6215 | }, |
| 6216 | ], |
| 6217 | "addresses": [ # The person's street addresses. |
| 6218 | { # A person's physical address. May be a P.O. box or street address. All fields |
| 6219 | # are optional. |
| 6220 | "streetAddress": "A String", # The street address. |
| 6221 | "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it |
| 6222 | # will be automatically constructed from structured values. |
| 6223 | "country": "A String", # The country of the address. |
| 6224 | "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's |
| 6225 | # account locale or the `Accept-Language` HTTP header locale. |
| 6226 | "city": "A String", # The city of the address. |
| 6227 | "postalCode": "A String", # The postal code of the address. |
| 6228 | "extendedAddress": "A String", # The extended address of the address; for example, the apartment number. |
| 6229 | "type": "A String", # The type of the address. The type can be custom or one of these predefined |
| 6230 | # values: |
| 6231 | # |
| 6232 | # * `home` |
| 6233 | # * `work` |
| 6234 | # * `other` |
| 6235 | "region": "A String", # The region of the address; for example, the state or province. |
| 6236 | "poBox": "A String", # The P.O. box of the address. |
| 6237 | "metadata": { # Metadata about a field. # Metadata about the address. |
| 6238 | "source": { # The source of a field. # The source of the field. |
| 6239 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 6240 | # |
| 6241 | # Last update timestamp of this source. |
| 6242 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 6243 | # |
| 6244 | # Metadata about a source of type PROFILE. |
| 6245 | "userTypes": [ # Output only. The user types. |
| 6246 | "A String", |
| 6247 | ], |
| 6248 | "objectType": "A String", # Output only. The profile object type. |
| 6249 | }, |
| 6250 | "type": "A String", # The source type. |
| 6251 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 6252 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 6253 | # |
| 6254 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 6255 | # source. Used for web cache validation. |
| 6256 | }, |
| 6257 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 6258 | # verified field is typically a name, email address, phone number, or |
| 6259 | # website that has been confirmed to be owned by the person. |
| 6260 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 6261 | # field. |
| 6262 | }, |
| 6263 | "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country |
| 6264 | # code of the address. |
| 6265 | }, |
| 6266 | ], |
| 6267 | "emailAddresses": [ # The person's email addresses. |
| 6268 | { # A person's email address. |
| 6269 | "formattedType": "A String", # Output only. The type of the email address translated and formatted in the |
| 6270 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 6271 | "metadata": { # Metadata about a field. # Metadata about the email address. |
| 6272 | "source": { # The source of a field. # The source of the field. |
| 6273 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 6274 | # |
| 6275 | # Last update timestamp of this source. |
| 6276 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 6277 | # |
| 6278 | # Metadata about a source of type PROFILE. |
| 6279 | "userTypes": [ # Output only. The user types. |
| 6280 | "A String", |
| 6281 | ], |
| 6282 | "objectType": "A String", # Output only. The profile object type. |
| 6283 | }, |
| 6284 | "type": "A String", # The source type. |
| 6285 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 6286 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 6287 | # |
| 6288 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 6289 | # source. Used for web cache validation. |
| 6290 | }, |
| 6291 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 6292 | # verified field is typically a name, email address, phone number, or |
| 6293 | # website that has been confirmed to be owned by the person. |
| 6294 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 6295 | # field. |
| 6296 | }, |
| 6297 | "value": "A String", # The email address. |
| 6298 | "displayName": "A String", # The display name of the email. |
| 6299 | "type": "A String", # The type of the email address. The type can be custom or one of these |
| 6300 | # predefined values: |
| 6301 | # |
| 6302 | # * `home` |
| 6303 | # * `work` |
| 6304 | # * `other` |
| 6305 | }, |
| 6306 | ], |
| 6307 | "nicknames": [ # The person's nicknames. |
| 6308 | { # A person's nickname. |
| 6309 | "metadata": { # Metadata about a field. # Metadata about the nickname. |
| 6310 | "source": { # The source of a field. # The source of the field. |
| 6311 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 6312 | # |
| 6313 | # Last update timestamp of this source. |
| 6314 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 6315 | # |
| 6316 | # Metadata about a source of type PROFILE. |
| 6317 | "userTypes": [ # Output only. The user types. |
| 6318 | "A String", |
| 6319 | ], |
| 6320 | "objectType": "A String", # Output only. The profile object type. |
| 6321 | }, |
| 6322 | "type": "A String", # The source type. |
| 6323 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 6324 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 6325 | # |
| 6326 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 6327 | # source. Used for web cache validation. |
| 6328 | }, |
| 6329 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 6330 | # verified field is typically a name, email address, phone number, or |
| 6331 | # website that has been confirmed to be owned by the person. |
| 6332 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 6333 | # field. |
| 6334 | }, |
| 6335 | "type": "A String", # The type of the nickname. |
| 6336 | "value": "A String", # The nickname. |
| 6337 | }, |
| 6338 | ], |
| 6339 | "events": [ # The person's events. |
| 6340 | { # An event related to the person. |
| 6341 | "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the event. |
| 6342 | # and time zone are either specified elsewhere or are not significant. The date |
| 6343 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 6344 | # |
| 6345 | # * A full date, with non-zero year, month and day values |
| 6346 | # * A month and day value, with a zero year, e.g. an anniversary |
| 6347 | # * A year on its own, with zero month and day values |
| 6348 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 6349 | # |
| 6350 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 6351 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 6352 | # a year. |
| 6353 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 6354 | # month and day. |
| 6355 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 6356 | # if specifying a year by itself or a year and month where the day is not |
| 6357 | # significant. |
| 6358 | }, |
| 6359 | "formattedType": "A String", # Output only. The type of the event translated and formatted in the |
| 6360 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 6361 | "metadata": { # Metadata about a field. # Metadata about the event. |
| 6362 | "source": { # The source of a field. # The source of the field. |
| 6363 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 6364 | # |
| 6365 | # Last update timestamp of this source. |
| 6366 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 6367 | # |
| 6368 | # Metadata about a source of type PROFILE. |
| 6369 | "userTypes": [ # Output only. The user types. |
| 6370 | "A String", |
| 6371 | ], |
| 6372 | "objectType": "A String", # Output only. The profile object type. |
| 6373 | }, |
| 6374 | "type": "A String", # The source type. |
| 6375 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 6376 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 6377 | # |
| 6378 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 6379 | # source. Used for web cache validation. |
| 6380 | }, |
| 6381 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 6382 | # verified field is typically a name, email address, phone number, or |
| 6383 | # website that has been confirmed to be owned by the person. |
| 6384 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 6385 | # field. |
| 6386 | }, |
| 6387 | "type": "A String", # The type of the event. The type can be custom or one of these predefined |
| 6388 | # values: |
| 6389 | # |
| 6390 | # * `anniversary` |
| 6391 | # * `other` |
| 6392 | }, |
| 6393 | ], |
| 6394 | "urls": [ # The person's associated URLs. |
| 6395 | { # A person's associated URLs. |
| 6396 | "type": "A String", # The type of the URL. The type can be custom or one of these predefined |
| 6397 | # values: |
| 6398 | # |
| 6399 | # * `home` |
| 6400 | # * `work` |
| 6401 | # * `blog` |
| 6402 | # * `profile` |
| 6403 | # * `homePage` |
| 6404 | # * `ftp` |
| 6405 | # * `reservations` |
| 6406 | # * `appInstallPage`: website for a Google+ application. |
| 6407 | # * `other` |
| 6408 | "metadata": { # Metadata about a field. # Metadata about the URL. |
| 6409 | "source": { # The source of a field. # The source of the field. |
| 6410 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 6411 | # |
| 6412 | # Last update timestamp of this source. |
| 6413 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 6414 | # |
| 6415 | # Metadata about a source of type PROFILE. |
| 6416 | "userTypes": [ # Output only. The user types. |
| 6417 | "A String", |
| 6418 | ], |
| 6419 | "objectType": "A String", # Output only. The profile object type. |
| 6420 | }, |
| 6421 | "type": "A String", # The source type. |
| 6422 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 6423 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 6424 | # |
| 6425 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 6426 | # source. Used for web cache validation. |
| 6427 | }, |
| 6428 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 6429 | # verified field is typically a name, email address, phone number, or |
| 6430 | # website that has been confirmed to be owned by the person. |
| 6431 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 6432 | # field. |
| 6433 | }, |
| 6434 | "formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's |
| 6435 | # account locale or the `Accept-Language` HTTP header locale. |
| 6436 | "value": "A String", # The URL. |
| 6437 | }, |
| 6438 | ], |
| 6439 | }, |
| 6440 | "requestedResourceName": "A String", # The original requested resource name. May be different than the resource |
| 6441 | # name on the returned person. |
| 6442 | # |
| 6443 | # The resource name can change when adding or removing fields that link a |
| 6444 | # contact and profile such as a verified email, verified phone number, or a |
| 6445 | # profile URL. |
| 6446 | "httpStatusCode": 42, # **DEPRECATED** (Please use status instead) |
| 6447 | # |
| 6448 | # [HTTP 1.1 status code] |
| 6449 | # (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html). |
| 6450 | "status": { # The `Status` type defines a logical error model that is suitable for # The status of the response. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 6451 | # different programming environments, including REST APIs and RPC APIs. It is |
| 6452 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 6453 | # three pieces of data: error code, error message, and error details. |
| 6454 | # |
| 6455 | # You can find out more about this error model and how to work with it in the |
| 6456 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6457 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 6458 | # user-facing error message should be localized and sent in the |
| 6459 | # google.rpc.Status.details field, or localized by the client. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6460 | "details": [ # A list of messages that carry the error details. There is a common set of |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 6461 | # message types for APIs to use. |
| 6462 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6463 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 6464 | }, |
| 6465 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6466 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 6467 | }, |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 6468 | }, |
| 6469 | ], |
| 6470 | }</pre> |
| 6471 | </div> |
| 6472 | |
| 6473 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6474 | <code class="details" id="updateContact">updateContact(resourceName, body=None, updatePersonFields=None, x__xgafv=None)</code> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 6475 | <pre>Update contact data for an existing contact person. Any non-contact data |
| 6476 | will not be modified. |
| 6477 | |
| 6478 | The request throws a 400 error if `updatePersonFields` is not specified. |
| 6479 | |
| 6480 | The request throws a 400 error if `person.metadata.sources` is not |
| 6481 | specified for the contact to be updated. |
| 6482 | |
| 6483 | The request throws a 400 error with an error with reason |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6484 | `"failedPrecondition"` if `person.metadata.sources.etag` is different than |
| 6485 | the contact's etag, which indicates the contact has changed since its data |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 6486 | was read. Clients should get the latest person and re-apply their updates |
| 6487 | to the latest person. |
| 6488 | |
| 6489 | Args: |
| 6490 | resourceName: string, The resource name for the person, assigned by the server. An ASCII string |
| 6491 | with a max length of 27 characters, in the form of |
| 6492 | `people/{person_id}`. (required) |
| 6493 | body: object, The request body. |
| 6494 | The object takes the form of: |
| 6495 | |
| 6496 | { # Information about a person merged from various data sources such as the |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6497 | # authenticated user's contacts and profile data. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 6498 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6499 | # Most fields can have multiple items. The items in a field have no guaranteed |
| 6500 | # order, but each non-empty field is guaranteed to have exactly one field with |
| 6501 | # `metadata.primary` set to true. |
| 6502 | "interests": [ # The person's interests. |
| 6503 | { # One of the person's interests. |
| 6504 | "value": "A String", # The interest; for example, `stargazing`. |
| 6505 | "metadata": { # Metadata about a field. # Metadata about the interest. |
| 6506 | "source": { # The source of a field. # The source of the field. |
| 6507 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 6508 | # |
| 6509 | # Last update timestamp of this source. |
| 6510 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 6511 | # |
| 6512 | # Metadata about a source of type PROFILE. |
| 6513 | "userTypes": [ # Output only. The user types. |
| 6514 | "A String", |
| 6515 | ], |
| 6516 | "objectType": "A String", # Output only. The profile object type. |
| 6517 | }, |
| 6518 | "type": "A String", # The source type. |
| 6519 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 6520 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 6521 | # |
| 6522 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 6523 | # source. Used for web cache validation. |
| 6524 | }, |
| 6525 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 6526 | # verified field is typically a name, email address, phone number, or |
| 6527 | # website that has been confirmed to be owned by the person. |
| 6528 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 6529 | # field. |
| 6530 | }, |
| 6531 | }, |
| 6532 | ], |
| 6533 | "userDefined": [ # The person's user defined data. |
| 6534 | { # Arbitrary user data that is populated by the end users. |
| 6535 | "metadata": { # Metadata about a field. # Metadata about the user defined data. |
| 6536 | "source": { # The source of a field. # The source of the field. |
| 6537 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 6538 | # |
| 6539 | # Last update timestamp of this source. |
| 6540 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 6541 | # |
| 6542 | # Metadata about a source of type PROFILE. |
| 6543 | "userTypes": [ # Output only. The user types. |
| 6544 | "A String", |
| 6545 | ], |
| 6546 | "objectType": "A String", # Output only. The profile object type. |
| 6547 | }, |
| 6548 | "type": "A String", # The source type. |
| 6549 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 6550 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 6551 | # |
| 6552 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 6553 | # source. Used for web cache validation. |
| 6554 | }, |
| 6555 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 6556 | # verified field is typically a name, email address, phone number, or |
| 6557 | # website that has been confirmed to be owned by the person. |
| 6558 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 6559 | # field. |
| 6560 | }, |
| 6561 | "key": "A String", # The end user specified key of the user defined data. |
| 6562 | "value": "A String", # The end user specified value of the user defined data. |
| 6563 | }, |
| 6564 | ], |
| 6565 | "sipAddresses": [ # The person's SIP addresses. |
| 6566 | { # A person's SIP address. Session Initial Protocol addresses are used for VoIP |
| 6567 | # communications to make voice or video calls over the internet. |
| 6568 | "value": "A String", # The SIP address in the |
| 6569 | # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI |
| 6570 | # format. |
| 6571 | "type": "A String", # The type of the SIP address. The type can be custom or or one of these |
| 6572 | # predefined values: |
| 6573 | # |
| 6574 | # * `home` |
| 6575 | # * `work` |
| 6576 | # * `mobile` |
| 6577 | # * `other` |
| 6578 | "metadata": { # Metadata about a field. # Metadata about the SIP address. |
| 6579 | "source": { # The source of a field. # The source of the field. |
| 6580 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 6581 | # |
| 6582 | # Last update timestamp of this source. |
| 6583 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 6584 | # |
| 6585 | # Metadata about a source of type PROFILE. |
| 6586 | "userTypes": [ # Output only. The user types. |
| 6587 | "A String", |
| 6588 | ], |
| 6589 | "objectType": "A String", # Output only. The profile object type. |
| 6590 | }, |
| 6591 | "type": "A String", # The source type. |
| 6592 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 6593 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 6594 | # |
| 6595 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 6596 | # source. Used for web cache validation. |
| 6597 | }, |
| 6598 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 6599 | # verified field is typically a name, email address, phone number, or |
| 6600 | # website that has been confirmed to be owned by the person. |
| 6601 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 6602 | # field. |
| 6603 | }, |
| 6604 | "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the |
| 6605 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 6606 | }, |
| 6607 | ], |
| 6608 | "phoneNumbers": [ # The person's phone numbers. |
| 6609 | { # A person's phone number. |
| 6610 | "type": "A String", # The type of the phone number. The type can be custom or one of these |
| 6611 | # predefined values: |
| 6612 | # |
| 6613 | # * `home` |
| 6614 | # * `work` |
| 6615 | # * `mobile` |
| 6616 | # * `homeFax` |
| 6617 | # * `workFax` |
| 6618 | # * `otherFax` |
| 6619 | # * `pager` |
| 6620 | # * `workMobile` |
| 6621 | # * `workPager` |
| 6622 | # * `main` |
| 6623 | # * `googleVoice` |
| 6624 | # * `other` |
| 6625 | "value": "A String", # The phone number. |
| 6626 | "canonicalForm": "A String", # Output only. The canonicalized [ITU-T |
| 6627 | # E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) |
| 6628 | # form of the phone number. |
| 6629 | "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the |
| 6630 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 6631 | "metadata": { # Metadata about a field. # Metadata about the phone number. |
| 6632 | "source": { # The source of a field. # The source of the field. |
| 6633 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 6634 | # |
| 6635 | # Last update timestamp of this source. |
| 6636 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 6637 | # |
| 6638 | # Metadata about a source of type PROFILE. |
| 6639 | "userTypes": [ # Output only. The user types. |
| 6640 | "A String", |
| 6641 | ], |
| 6642 | "objectType": "A String", # Output only. The profile object type. |
| 6643 | }, |
| 6644 | "type": "A String", # The source type. |
| 6645 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 6646 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 6647 | # |
| 6648 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 6649 | # source. Used for web cache validation. |
| 6650 | }, |
| 6651 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 6652 | # verified field is typically a name, email address, phone number, or |
| 6653 | # website that has been confirmed to be owned by the person. |
| 6654 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 6655 | # field. |
| 6656 | }, |
| 6657 | }, |
| 6658 | ], |
| 6659 | "occupations": [ # The person's occupations. |
| 6660 | { # A person's occupation. |
| 6661 | "value": "A String", # The occupation; for example, `carpenter`. |
| 6662 | "metadata": { # Metadata about a field. # Metadata about the occupation. |
| 6663 | "source": { # The source of a field. # The source of the field. |
| 6664 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 6665 | # |
| 6666 | # Last update timestamp of this source. |
| 6667 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 6668 | # |
| 6669 | # Metadata about a source of type PROFILE. |
| 6670 | "userTypes": [ # Output only. The user types. |
| 6671 | "A String", |
| 6672 | ], |
| 6673 | "objectType": "A String", # Output only. The profile object type. |
| 6674 | }, |
| 6675 | "type": "A String", # The source type. |
| 6676 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 6677 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 6678 | # |
| 6679 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 6680 | # source. Used for web cache validation. |
| 6681 | }, |
| 6682 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 6683 | # verified field is typically a name, email address, phone number, or |
| 6684 | # website that has been confirmed to be owned by the person. |
| 6685 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 6686 | # field. |
| 6687 | }, |
| 6688 | }, |
| 6689 | ], |
| 6690 | "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) |
| 6691 | # |
| 6692 | # The person's age range. |
| 6693 | "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 6694 | # resource. Used for web cache validation. |
| 6695 | "biographies": [ # The person's biographies. |
| 6696 | { # A person's short biography. |
| 6697 | "metadata": { # Metadata about a field. # Metadata about the biography. |
| 6698 | "source": { # The source of a field. # The source of the field. |
| 6699 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 6700 | # |
| 6701 | # Last update timestamp of this source. |
| 6702 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 6703 | # |
| 6704 | # Metadata about a source of type PROFILE. |
| 6705 | "userTypes": [ # Output only. The user types. |
| 6706 | "A String", |
| 6707 | ], |
| 6708 | "objectType": "A String", # Output only. The profile object type. |
| 6709 | }, |
| 6710 | "type": "A String", # The source type. |
| 6711 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 6712 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 6713 | # |
| 6714 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 6715 | # source. Used for web cache validation. |
| 6716 | }, |
| 6717 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 6718 | # verified field is typically a name, email address, phone number, or |
| 6719 | # website that has been confirmed to be owned by the person. |
| 6720 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 6721 | # field. |
| 6722 | }, |
| 6723 | "contentType": "A String", # The content type of the biography. |
| 6724 | "value": "A String", # The short biography. |
| 6725 | }, |
| 6726 | ], |
| 6727 | "locales": [ # The person's locale preferences. |
| 6728 | { # A person's locale preference. |
| 6729 | "metadata": { # Metadata about a field. # Metadata about the locale. |
| 6730 | "source": { # The source of a field. # The source of the field. |
| 6731 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 6732 | # |
| 6733 | # Last update timestamp of this source. |
| 6734 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 6735 | # |
| 6736 | # Metadata about a source of type PROFILE. |
| 6737 | "userTypes": [ # Output only. The user types. |
| 6738 | "A String", |
| 6739 | ], |
| 6740 | "objectType": "A String", # Output only. The profile object type. |
| 6741 | }, |
| 6742 | "type": "A String", # The source type. |
| 6743 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 6744 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 6745 | # |
| 6746 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 6747 | # source. Used for web cache validation. |
| 6748 | }, |
| 6749 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 6750 | # verified field is typically a name, email address, phone number, or |
| 6751 | # website that has been confirmed to be owned by the person. |
| 6752 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 6753 | # field. |
| 6754 | }, |
| 6755 | "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) |
| 6756 | # language tag representing the locale. |
| 6757 | }, |
| 6758 | ], |
| 6759 | "taglines": [ # Output only. **DEPRECATED**: No data will be returned |
| 6760 | # The person's taglines. |
| 6761 | { # **DEPRECATED**: No data will be returned |
| 6762 | # A brief one-line description of the person. |
| 6763 | "metadata": { # Metadata about a field. # Metadata about the tagline. |
| 6764 | "source": { # The source of a field. # The source of the field. |
| 6765 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 6766 | # |
| 6767 | # Last update timestamp of this source. |
| 6768 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 6769 | # |
| 6770 | # Metadata about a source of type PROFILE. |
| 6771 | "userTypes": [ # Output only. The user types. |
| 6772 | "A String", |
| 6773 | ], |
| 6774 | "objectType": "A String", # Output only. The profile object type. |
| 6775 | }, |
| 6776 | "type": "A String", # The source type. |
| 6777 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 6778 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 6779 | # |
| 6780 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 6781 | # source. Used for web cache validation. |
| 6782 | }, |
| 6783 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 6784 | # verified field is typically a name, email address, phone number, or |
| 6785 | # website that has been confirmed to be owned by the person. |
| 6786 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 6787 | # field. |
| 6788 | }, |
| 6789 | "value": "A String", # The tagline. |
| 6790 | }, |
| 6791 | ], |
| 6792 | "organizations": [ # The person's past or current organizations. |
| 6793 | { # A person's past or current organization. Overlapping date ranges are |
| 6794 | # permitted. |
| 6795 | "title": "A String", # The person's job title at the organization. |
| 6796 | "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker |
| 6797 | # symbol, abbreviation, or acronym. |
| 6798 | "name": "A String", # The name of the organization. |
| 6799 | "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The start date when the person joined the organization. |
| 6800 | # and time zone are either specified elsewhere or are not significant. The date |
| 6801 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 6802 | # |
| 6803 | # * A full date, with non-zero year, month and day values |
| 6804 | # * A month and day value, with a zero year, e.g. an anniversary |
| 6805 | # * A year on its own, with zero month and day values |
| 6806 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 6807 | # |
| 6808 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 6809 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 6810 | # a year. |
| 6811 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 6812 | # month and day. |
| 6813 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 6814 | # if specifying a year by itself or a year and month where the day is not |
| 6815 | # significant. |
| 6816 | }, |
| 6817 | "department": "A String", # The person's department at the organization. |
| 6818 | "current": True or False, # True if the organization is the person's current organization; |
| 6819 | # false if the organization is a past organization. |
| 6820 | "location": "A String", # The location of the organization office the person works at. |
| 6821 | "domain": "A String", # The domain name associated with the organization; for example, |
| 6822 | # `google.com`. |
| 6823 | "metadata": { # Metadata about a field. # Metadata about the organization. |
| 6824 | "source": { # The source of a field. # The source of the field. |
| 6825 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 6826 | # |
| 6827 | # Last update timestamp of this source. |
| 6828 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 6829 | # |
| 6830 | # Metadata about a source of type PROFILE. |
| 6831 | "userTypes": [ # Output only. The user types. |
| 6832 | "A String", |
| 6833 | ], |
| 6834 | "objectType": "A String", # Output only. The profile object type. |
| 6835 | }, |
| 6836 | "type": "A String", # The source type. |
| 6837 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 6838 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 6839 | # |
| 6840 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 6841 | # source. Used for web cache validation. |
| 6842 | }, |
| 6843 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 6844 | # verified field is typically a name, email address, phone number, or |
| 6845 | # website that has been confirmed to be owned by the person. |
| 6846 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 6847 | # field. |
| 6848 | }, |
| 6849 | "jobDescription": "A String", # The person's job description at the organization. |
| 6850 | "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The end date when the person left the organization. |
| 6851 | # and time zone are either specified elsewhere or are not significant. The date |
| 6852 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 6853 | # |
| 6854 | # * A full date, with non-zero year, month and day values |
| 6855 | # * A month and day value, with a zero year, e.g. an anniversary |
| 6856 | # * A year on its own, with zero month and day values |
| 6857 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 6858 | # |
| 6859 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 6860 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 6861 | # a year. |
| 6862 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 6863 | # month and day. |
| 6864 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 6865 | # if specifying a year by itself or a year and month where the day is not |
| 6866 | # significant. |
| 6867 | }, |
| 6868 | "phoneticName": "A String", # The phonetic name of the organization. |
| 6869 | "formattedType": "A String", # Output only. The type of the organization translated and formatted in the |
| 6870 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 6871 | "type": "A String", # The type of the organization. The type can be custom or one of these |
| 6872 | # predefined values: |
| 6873 | # |
| 6874 | # * `work` |
| 6875 | # * `school` |
| 6876 | }, |
| 6877 | ], |
| 6878 | "residences": [ # The person's residences. |
| 6879 | { # A person's past or current residence. |
| 6880 | "metadata": { # Metadata about a field. # Metadata about the residence. |
| 6881 | "source": { # The source of a field. # The source of the field. |
| 6882 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 6883 | # |
| 6884 | # Last update timestamp of this source. |
| 6885 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 6886 | # |
| 6887 | # Metadata about a source of type PROFILE. |
| 6888 | "userTypes": [ # Output only. The user types. |
| 6889 | "A String", |
| 6890 | ], |
| 6891 | "objectType": "A String", # Output only. The profile object type. |
| 6892 | }, |
| 6893 | "type": "A String", # The source type. |
| 6894 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 6895 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 6896 | # |
| 6897 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 6898 | # source. Used for web cache validation. |
| 6899 | }, |
| 6900 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 6901 | # verified field is typically a name, email address, phone number, or |
| 6902 | # website that has been confirmed to be owned by the person. |
| 6903 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 6904 | # field. |
| 6905 | }, |
| 6906 | "current": True or False, # True if the residence is the person's current residence; |
| 6907 | # false if the residence is a past residence. |
| 6908 | "value": "A String", # The address of the residence. |
| 6909 | }, |
| 6910 | ], |
| 6911 | "genders": [ # The person's genders. |
| 6912 | { # A person's gender. |
| 6913 | "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account |
| 6914 | # locale or the `Accept-Language` HTTP header locale. Unspecified or custom |
| 6915 | # value are not localized. |
| 6916 | "metadata": { # Metadata about a field. # Metadata about the gender. |
| 6917 | "source": { # The source of a field. # The source of the field. |
| 6918 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 6919 | # |
| 6920 | # Last update timestamp of this source. |
| 6921 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 6922 | # |
| 6923 | # Metadata about a source of type PROFILE. |
| 6924 | "userTypes": [ # Output only. The user types. |
| 6925 | "A String", |
| 6926 | ], |
| 6927 | "objectType": "A String", # Output only. The profile object type. |
| 6928 | }, |
| 6929 | "type": "A String", # The source type. |
| 6930 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 6931 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 6932 | # |
| 6933 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 6934 | # source. Used for web cache validation. |
| 6935 | }, |
| 6936 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 6937 | # verified field is typically a name, email address, phone number, or |
| 6938 | # website that has been confirmed to be owned by the person. |
| 6939 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 6940 | # field. |
| 6941 | }, |
| 6942 | "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value |
| 6943 | # can be custom or one of these predefined values: |
| 6944 | # |
| 6945 | # * `male` |
| 6946 | # * `female` |
| 6947 | # * `other` |
| 6948 | "value": "A String", # The gender for the person. The gender can be custom or one of these |
| 6949 | # predefined values: |
| 6950 | # |
| 6951 | # * `male` |
| 6952 | # * `female` |
| 6953 | # * `unspecified` |
| 6954 | }, |
| 6955 | ], |
| 6956 | "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned |
| 6957 | # The person's relationship interests. |
| 6958 | { # **DEPRECATED**: No data will be returned |
| 6959 | # A person's relationship interest . |
| 6960 | "formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted |
| 6961 | # in the viewer's account locale or the locale specified in the |
| 6962 | # Accept-Language HTTP header. |
| 6963 | "metadata": { # Metadata about a field. # Metadata about the relationship interest. |
| 6964 | "source": { # The source of a field. # The source of the field. |
| 6965 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 6966 | # |
| 6967 | # Last update timestamp of this source. |
| 6968 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 6969 | # |
| 6970 | # Metadata about a source of type PROFILE. |
| 6971 | "userTypes": [ # Output only. The user types. |
| 6972 | "A String", |
| 6973 | ], |
| 6974 | "objectType": "A String", # Output only. The profile object type. |
| 6975 | }, |
| 6976 | "type": "A String", # The source type. |
| 6977 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 6978 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 6979 | # |
| 6980 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 6981 | # source. Used for web cache validation. |
| 6982 | }, |
| 6983 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 6984 | # verified field is typically a name, email address, phone number, or |
| 6985 | # website that has been confirmed to be owned by the person. |
| 6986 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 6987 | # field. |
| 6988 | }, |
| 6989 | "value": "A String", # The kind of relationship the person is looking for. The value can be custom |
| 6990 | # or one of these predefined values: |
| 6991 | # |
| 6992 | # * `friend` |
| 6993 | # * `date` |
| 6994 | # * `relationship` |
| 6995 | # * `networking` |
| 6996 | }, |
| 6997 | ], |
| 6998 | "metadata": { # The metadata about a person. # Output only. Metadata about the person. |
| 6999 | "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for |
| 7000 | # [`connections.list`](/people/api/rest/v1/people.connections/list) requests |
| 7001 | # that include a sync token. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 7002 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7003 | # The resource name may change when adding or removing fields that link a |
| 7004 | # contact and profile such as a verified email, verified phone number, or |
| 7005 | # profile URL. |
| 7006 | "A String", |
| 7007 | ], |
| 7008 | "sources": [ # The sources of data for the person. |
| 7009 | { # The source of a field. |
| 7010 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 7011 | # |
| 7012 | # Last update timestamp of this source. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7013 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 7014 | # |
| 7015 | # Metadata about a source of type PROFILE. |
| 7016 | "userTypes": [ # Output only. The user types. |
| 7017 | "A String", |
| 7018 | ], |
| 7019 | "objectType": "A String", # Output only. The profile object type. |
| 7020 | }, |
| 7021 | "type": "A String", # The source type. |
| 7022 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 7023 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 7024 | # |
| 7025 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 7026 | # source. Used for web cache validation. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 7027 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7028 | ], |
| 7029 | "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource. |
| 7030 | "A String", |
| 7031 | ], |
| 7032 | "objectType": "A String", # Output only. **DEPRECATED** (Please use |
| 7033 | # `person.metadata.sources.profileMetadata.objectType` instead) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 7034 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7035 | # The type of the person object. |
| 7036 | "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for |
| 7037 | # [`connections.list`](/people/api/rest/v1/people.connections/list) requests |
| 7038 | # that include a sync token. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 7039 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7040 | "memberships": [ # The person's group memberships. |
| 7041 | { # A person's membership in a group. Only contact group memberships can be |
| 7042 | # modified. |
| 7043 | "metadata": { # Metadata about a field. # Metadata about the membership. |
| 7044 | "source": { # The source of a field. # The source of the field. |
| 7045 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 7046 | # |
| 7047 | # Last update timestamp of this source. |
| 7048 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 7049 | # |
| 7050 | # Metadata about a source of type PROFILE. |
| 7051 | "userTypes": [ # Output only. The user types. |
| 7052 | "A String", |
| 7053 | ], |
| 7054 | "objectType": "A String", # Output only. The profile object type. |
| 7055 | }, |
| 7056 | "type": "A String", # The source type. |
| 7057 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 7058 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 7059 | # |
| 7060 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 7061 | # source. Used for web cache validation. |
| 7062 | }, |
| 7063 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 7064 | # verified field is typically a name, email address, phone number, or |
| 7065 | # website that has been confirmed to be owned by the person. |
| 7066 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 7067 | # field. |
| 7068 | }, |
| 7069 | "contactGroupMembership": { # A Google contact group membership. # The contact group membership. |
| 7070 | "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership. |
| 7071 | "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII |
| 7072 | # string, in the form of `contactGroups/{contact_group_id}`. |
| 7073 | # Only contact_group_resource_name can be used for modifying memberships. |
| 7074 | # Any contact group membership can be removed, but only user group or |
| 7075 | # "myContacts" or "starred" system groups memberships can be added. A |
| 7076 | # contact must always have at least one contact group membership. |
| 7077 | }, |
| 7078 | "domainMembership": { # A G Suite Domain membership. # Output only. The domain membership. |
| 7079 | "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain. |
| 7080 | }, |
| 7081 | }, |
| 7082 | ], |
| 7083 | "birthdays": [ # The person's birthdays. |
| 7084 | { # A person's birthday. At least one of the `date` and `text` fields are |
| 7085 | # specified. The `date` and `text` fields typically represent the same |
| 7086 | # date, but are not guaranteed to. |
| 7087 | "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the birthday. |
| 7088 | # and time zone are either specified elsewhere or are not significant. The date |
| 7089 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 7090 | # |
| 7091 | # * A full date, with non-zero year, month and day values |
| 7092 | # * A month and day value, with a zero year, e.g. an anniversary |
| 7093 | # * A year on its own, with zero month and day values |
| 7094 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 7095 | # |
| 7096 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 7097 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 7098 | # a year. |
| 7099 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 7100 | # month and day. |
| 7101 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 7102 | # if specifying a year by itself or a year and month where the day is not |
| 7103 | # significant. |
| 7104 | }, |
| 7105 | "metadata": { # Metadata about a field. # Metadata about the birthday. |
| 7106 | "source": { # The source of a field. # The source of the field. |
| 7107 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 7108 | # |
| 7109 | # Last update timestamp of this source. |
| 7110 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 7111 | # |
| 7112 | # Metadata about a source of type PROFILE. |
| 7113 | "userTypes": [ # Output only. The user types. |
| 7114 | "A String", |
| 7115 | ], |
| 7116 | "objectType": "A String", # Output only. The profile object type. |
| 7117 | }, |
| 7118 | "type": "A String", # The source type. |
| 7119 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 7120 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 7121 | # |
| 7122 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 7123 | # source. Used for web cache validation. |
| 7124 | }, |
| 7125 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 7126 | # verified field is typically a name, email address, phone number, or |
| 7127 | # website that has been confirmed to be owned by the person. |
| 7128 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 7129 | # field. |
| 7130 | }, |
| 7131 | "text": "A String", # A free-form string representing the user's birthday. |
| 7132 | }, |
| 7133 | ], |
| 7134 | "imClients": [ # The person's instant messaging clients. |
| 7135 | { # A person's instant messaging client. |
| 7136 | "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the |
| 7137 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 7138 | "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these |
| 7139 | # predefined values: |
| 7140 | # |
| 7141 | # * `aim` |
| 7142 | # * `msn` |
| 7143 | # * `yahoo` |
| 7144 | # * `skype` |
| 7145 | # * `qq` |
| 7146 | # * `googleTalk` |
| 7147 | # * `icq` |
| 7148 | # * `jabber` |
| 7149 | # * `netMeeting` |
| 7150 | "username": "A String", # The user name used in the IM client. |
| 7151 | "type": "A String", # The type of the IM client. The type can be custom or one of these |
| 7152 | # predefined values: |
| 7153 | # |
| 7154 | # * `home` |
| 7155 | # * `work` |
| 7156 | # * `other` |
| 7157 | "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account |
| 7158 | # locale or the `Accept-Language` HTTP header locale. |
| 7159 | "metadata": { # Metadata about a field. # Metadata about the IM client. |
| 7160 | "source": { # The source of a field. # The source of the field. |
| 7161 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 7162 | # |
| 7163 | # Last update timestamp of this source. |
| 7164 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 7165 | # |
| 7166 | # Metadata about a source of type PROFILE. |
| 7167 | "userTypes": [ # Output only. The user types. |
| 7168 | "A String", |
| 7169 | ], |
| 7170 | "objectType": "A String", # Output only. The profile object type. |
| 7171 | }, |
| 7172 | "type": "A String", # The source type. |
| 7173 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 7174 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 7175 | # |
| 7176 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 7177 | # source. Used for web cache validation. |
| 7178 | }, |
| 7179 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 7180 | # verified field is typically a name, email address, phone number, or |
| 7181 | # website that has been confirmed to be owned by the person. |
| 7182 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 7183 | # field. |
| 7184 | }, |
| 7185 | }, |
| 7186 | ], |
| 7187 | "skills": [ # The person's skills. |
| 7188 | { # A skill that the person has. |
| 7189 | "metadata": { # Metadata about a field. # Metadata about the skill. |
| 7190 | "source": { # The source of a field. # The source of the field. |
| 7191 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 7192 | # |
| 7193 | # Last update timestamp of this source. |
| 7194 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 7195 | # |
| 7196 | # Metadata about a source of type PROFILE. |
| 7197 | "userTypes": [ # Output only. The user types. |
| 7198 | "A String", |
| 7199 | ], |
| 7200 | "objectType": "A String", # Output only. The profile object type. |
| 7201 | }, |
| 7202 | "type": "A String", # The source type. |
| 7203 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 7204 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 7205 | # |
| 7206 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 7207 | # source. Used for web cache validation. |
| 7208 | }, |
| 7209 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 7210 | # verified field is typically a name, email address, phone number, or |
| 7211 | # website that has been confirmed to be owned by the person. |
| 7212 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 7213 | # field. |
| 7214 | }, |
| 7215 | "value": "A String", # The skill; for example, `underwater basket weaving`. |
| 7216 | }, |
| 7217 | ], |
| 7218 | "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned |
| 7219 | # The person's relationship statuses. |
| 7220 | { # **DEPRECATED**: No data will be returned |
| 7221 | # A person's relationship status. |
| 7222 | "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in |
| 7223 | # the viewer's account locale or the `Accept-Language` HTTP header locale. |
| 7224 | "metadata": { # Metadata about a field. # Metadata about the relationship status. |
| 7225 | "source": { # The source of a field. # The source of the field. |
| 7226 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 7227 | # |
| 7228 | # Last update timestamp of this source. |
| 7229 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 7230 | # |
| 7231 | # Metadata about a source of type PROFILE. |
| 7232 | "userTypes": [ # Output only. The user types. |
| 7233 | "A String", |
| 7234 | ], |
| 7235 | "objectType": "A String", # Output only. The profile object type. |
| 7236 | }, |
| 7237 | "type": "A String", # The source type. |
| 7238 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 7239 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 7240 | # |
| 7241 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 7242 | # source. Used for web cache validation. |
| 7243 | }, |
| 7244 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 7245 | # verified field is typically a name, email address, phone number, or |
| 7246 | # website that has been confirmed to be owned by the person. |
| 7247 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 7248 | # field. |
| 7249 | }, |
| 7250 | "value": "A String", # The relationship status. The value can be custom or one of these |
| 7251 | # predefined values: |
| 7252 | # |
| 7253 | # * `single` |
| 7254 | # * `inARelationship` |
| 7255 | # * `engaged` |
| 7256 | # * `married` |
| 7257 | # * `itsComplicated` |
| 7258 | # * `openRelationship` |
| 7259 | # * `widowed` |
| 7260 | # * `inDomesticPartnership` |
| 7261 | # * `inCivilUnion` |
| 7262 | }, |
| 7263 | ], |
| 7264 | "coverPhotos": [ # Output only. The person's cover photos. |
| 7265 | { # A person's cover photo. A large image shown on the person's |
| 7266 | # profile page that represents who they are or what they care about. |
| 7267 | "url": "A String", # The URL of the cover photo. |
| 7268 | "default": True or False, # True if the cover photo is the default cover photo; |
| 7269 | # false if the cover photo is a user-provided cover photo. |
| 7270 | "metadata": { # Metadata about a field. # Metadata about the cover photo. |
| 7271 | "source": { # The source of a field. # The source of the field. |
| 7272 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 7273 | # |
| 7274 | # Last update timestamp of this source. |
| 7275 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 7276 | # |
| 7277 | # Metadata about a source of type PROFILE. |
| 7278 | "userTypes": [ # Output only. The user types. |
| 7279 | "A String", |
| 7280 | ], |
| 7281 | "objectType": "A String", # Output only. The profile object type. |
| 7282 | }, |
| 7283 | "type": "A String", # The source type. |
| 7284 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 7285 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 7286 | # |
| 7287 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 7288 | # source. Used for web cache validation. |
| 7289 | }, |
| 7290 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 7291 | # verified field is typically a name, email address, phone number, or |
| 7292 | # website that has been confirmed to be owned by the person. |
| 7293 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 7294 | # field. |
| 7295 | }, |
| 7296 | }, |
| 7297 | ], |
| 7298 | "names": [ # The person's names. |
| 7299 | { # A person's name. If the name is a mononym, the family name is empty. |
| 7300 | "middleName": "A String", # The middle name(s). |
| 7301 | "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound. |
| 7302 | "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to |
| 7303 | # the locale specified by the viewer's account or the |
| 7304 | # `Accept-Language` HTTP header. |
| 7305 | "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.` |
| 7306 | "familyName": "A String", # The family name. |
| 7307 | "phoneticGivenName": "A String", # The given name spelled as it sounds. |
| 7308 | "metadata": { # Metadata about a field. # Metadata about the name. |
| 7309 | "source": { # The source of a field. # The source of the field. |
| 7310 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 7311 | # |
| 7312 | # Last update timestamp of this source. |
| 7313 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 7314 | # |
| 7315 | # Metadata about a source of type PROFILE. |
| 7316 | "userTypes": [ # Output only. The user types. |
| 7317 | "A String", |
| 7318 | ], |
| 7319 | "objectType": "A String", # Output only. The profile object type. |
| 7320 | }, |
| 7321 | "type": "A String", # The source type. |
| 7322 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 7323 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 7324 | # |
| 7325 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 7326 | # source. Used for web cache validation. |
| 7327 | }, |
| 7328 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 7329 | # verified field is typically a name, email address, phone number, or |
| 7330 | # website that has been confirmed to be owned by the person. |
| 7331 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 7332 | # field. |
| 7333 | }, |
| 7334 | "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound. |
| 7335 | "displayName": "A String", # Output only. The display name formatted according to the locale specified by |
| 7336 | # the viewer's account or the `Accept-Language` HTTP header. |
| 7337 | "phoneticFamilyName": "A String", # The family name spelled as it sounds. |
| 7338 | "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.` |
| 7339 | "givenName": "A String", # The given name. |
| 7340 | "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound. |
| 7341 | "phoneticFullName": "A String", # The full name spelled as it sounds. |
| 7342 | }, |
| 7343 | ], |
| 7344 | "relations": [ # The person's relations. |
| 7345 | { # A person's relation to another person. |
| 7346 | "type": "A String", # The person's relation to the other person. The type can be custom or one of |
| 7347 | # these predefined values: |
| 7348 | # |
| 7349 | # * `spouse` |
| 7350 | # * `child` |
| 7351 | # * `mother` |
| 7352 | # * `father` |
| 7353 | # * `parent` |
| 7354 | # * `brother` |
| 7355 | # * `sister` |
| 7356 | # * `friend` |
| 7357 | # * `relative` |
| 7358 | # * `domesticPartner` |
| 7359 | # * `manager` |
| 7360 | # * `assistant` |
| 7361 | # * `referredBy` |
| 7362 | # * `partner` |
| 7363 | "metadata": { # Metadata about a field. # Metadata about the relation. |
| 7364 | "source": { # The source of a field. # The source of the field. |
| 7365 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 7366 | # |
| 7367 | # Last update timestamp of this source. |
| 7368 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 7369 | # |
| 7370 | # Metadata about a source of type PROFILE. |
| 7371 | "userTypes": [ # Output only. The user types. |
| 7372 | "A String", |
| 7373 | ], |
| 7374 | "objectType": "A String", # Output only. The profile object type. |
| 7375 | }, |
| 7376 | "type": "A String", # The source type. |
| 7377 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 7378 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 7379 | # |
| 7380 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 7381 | # source. Used for web cache validation. |
| 7382 | }, |
| 7383 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 7384 | # verified field is typically a name, email address, phone number, or |
| 7385 | # website that has been confirmed to be owned by the person. |
| 7386 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 7387 | # field. |
| 7388 | }, |
| 7389 | "person": "A String", # The name of the other person this relation refers to. |
| 7390 | "formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's |
| 7391 | # account locale or the locale specified in the Accept-Language HTTP header. |
| 7392 | }, |
| 7393 | ], |
| 7394 | "ageRanges": [ # Output only. The person's age ranges. |
| 7395 | { # A person's age range. |
| 7396 | "metadata": { # Metadata about a field. # Metadata about the age range. |
| 7397 | "source": { # The source of a field. # The source of the field. |
| 7398 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 7399 | # |
| 7400 | # Last update timestamp of this source. |
| 7401 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 7402 | # |
| 7403 | # Metadata about a source of type PROFILE. |
| 7404 | "userTypes": [ # Output only. The user types. |
| 7405 | "A String", |
| 7406 | ], |
| 7407 | "objectType": "A String", # Output only. The profile object type. |
| 7408 | }, |
| 7409 | "type": "A String", # The source type. |
| 7410 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 7411 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 7412 | # |
| 7413 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 7414 | # source. Used for web cache validation. |
| 7415 | }, |
| 7416 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 7417 | # verified field is typically a name, email address, phone number, or |
| 7418 | # website that has been confirmed to be owned by the person. |
| 7419 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 7420 | # field. |
| 7421 | }, |
| 7422 | "ageRange": "A String", # The age range. |
| 7423 | }, |
| 7424 | ], |
| 7425 | "braggingRights": [ # **DEPRECATED**: No data will be returned |
| 7426 | # The person's bragging rights. |
| 7427 | { # **DEPRECATED**: No data will be returned |
| 7428 | # A person's bragging rights. |
| 7429 | "value": "A String", # The bragging rights; for example, `climbed mount everest`. |
| 7430 | "metadata": { # Metadata about a field. # Metadata about the bragging rights. |
| 7431 | "source": { # The source of a field. # The source of the field. |
| 7432 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 7433 | # |
| 7434 | # Last update timestamp of this source. |
| 7435 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 7436 | # |
| 7437 | # Metadata about a source of type PROFILE. |
| 7438 | "userTypes": [ # Output only. The user types. |
| 7439 | "A String", |
| 7440 | ], |
| 7441 | "objectType": "A String", # Output only. The profile object type. |
| 7442 | }, |
| 7443 | "type": "A String", # The source type. |
| 7444 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 7445 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 7446 | # |
| 7447 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 7448 | # source. Used for web cache validation. |
| 7449 | }, |
| 7450 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 7451 | # verified field is typically a name, email address, phone number, or |
| 7452 | # website that has been confirmed to be owned by the person. |
| 7453 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 7454 | # field. |
| 7455 | }, |
| 7456 | }, |
| 7457 | ], |
| 7458 | "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string |
| 7459 | # with a max length of 27 characters, in the form of |
| 7460 | # `people/{person_id}`. |
| 7461 | "photos": [ # Output only. The person's photos. |
| 7462 | { # A person's photo. A picture shown next to the person's name to |
| 7463 | # help others recognize the person. |
| 7464 | "url": "A String", # The URL of the photo. You can change the desired size by appending a query |
| 7465 | # parameter `sz={size}` at the end of the url, where {size} is the size in |
| 7466 | # pixels. Example: |
| 7467 | # https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50 |
| 7468 | "default": True or False, # True if the photo is a default photo; |
| 7469 | # false if the photo is a user-provided photo. |
| 7470 | "metadata": { # Metadata about a field. # Metadata about the photo. |
| 7471 | "source": { # The source of a field. # The source of the field. |
| 7472 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 7473 | # |
| 7474 | # Last update timestamp of this source. |
| 7475 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 7476 | # |
| 7477 | # Metadata about a source of type PROFILE. |
| 7478 | "userTypes": [ # Output only. The user types. |
| 7479 | "A String", |
| 7480 | ], |
| 7481 | "objectType": "A String", # Output only. The profile object type. |
| 7482 | }, |
| 7483 | "type": "A String", # The source type. |
| 7484 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 7485 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 7486 | # |
| 7487 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 7488 | # source. Used for web cache validation. |
| 7489 | }, |
| 7490 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 7491 | # verified field is typically a name, email address, phone number, or |
| 7492 | # website that has been confirmed to be owned by the person. |
| 7493 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 7494 | # field. |
| 7495 | }, |
| 7496 | }, |
| 7497 | ], |
| 7498 | "addresses": [ # The person's street addresses. |
| 7499 | { # A person's physical address. May be a P.O. box or street address. All fields |
| 7500 | # are optional. |
| 7501 | "streetAddress": "A String", # The street address. |
| 7502 | "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it |
| 7503 | # will be automatically constructed from structured values. |
| 7504 | "country": "A String", # The country of the address. |
| 7505 | "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's |
| 7506 | # account locale or the `Accept-Language` HTTP header locale. |
| 7507 | "city": "A String", # The city of the address. |
| 7508 | "postalCode": "A String", # The postal code of the address. |
| 7509 | "extendedAddress": "A String", # The extended address of the address; for example, the apartment number. |
| 7510 | "type": "A String", # The type of the address. The type can be custom or one of these predefined |
| 7511 | # values: |
| 7512 | # |
| 7513 | # * `home` |
| 7514 | # * `work` |
| 7515 | # * `other` |
| 7516 | "region": "A String", # The region of the address; for example, the state or province. |
| 7517 | "poBox": "A String", # The P.O. box of the address. |
| 7518 | "metadata": { # Metadata about a field. # Metadata about the address. |
| 7519 | "source": { # The source of a field. # The source of the field. |
| 7520 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 7521 | # |
| 7522 | # Last update timestamp of this source. |
| 7523 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 7524 | # |
| 7525 | # Metadata about a source of type PROFILE. |
| 7526 | "userTypes": [ # Output only. The user types. |
| 7527 | "A String", |
| 7528 | ], |
| 7529 | "objectType": "A String", # Output only. The profile object type. |
| 7530 | }, |
| 7531 | "type": "A String", # The source type. |
| 7532 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 7533 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 7534 | # |
| 7535 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 7536 | # source. Used for web cache validation. |
| 7537 | }, |
| 7538 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 7539 | # verified field is typically a name, email address, phone number, or |
| 7540 | # website that has been confirmed to be owned by the person. |
| 7541 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 7542 | # field. |
| 7543 | }, |
| 7544 | "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country |
| 7545 | # code of the address. |
| 7546 | }, |
| 7547 | ], |
| 7548 | "emailAddresses": [ # The person's email addresses. |
| 7549 | { # A person's email address. |
| 7550 | "formattedType": "A String", # Output only. The type of the email address translated and formatted in the |
| 7551 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 7552 | "metadata": { # Metadata about a field. # Metadata about the email address. |
| 7553 | "source": { # The source of a field. # The source of the field. |
| 7554 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 7555 | # |
| 7556 | # Last update timestamp of this source. |
| 7557 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 7558 | # |
| 7559 | # Metadata about a source of type PROFILE. |
| 7560 | "userTypes": [ # Output only. The user types. |
| 7561 | "A String", |
| 7562 | ], |
| 7563 | "objectType": "A String", # Output only. The profile object type. |
| 7564 | }, |
| 7565 | "type": "A String", # The source type. |
| 7566 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 7567 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 7568 | # |
| 7569 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 7570 | # source. Used for web cache validation. |
| 7571 | }, |
| 7572 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 7573 | # verified field is typically a name, email address, phone number, or |
| 7574 | # website that has been confirmed to be owned by the person. |
| 7575 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 7576 | # field. |
| 7577 | }, |
| 7578 | "value": "A String", # The email address. |
| 7579 | "displayName": "A String", # The display name of the email. |
| 7580 | "type": "A String", # The type of the email address. The type can be custom or one of these |
| 7581 | # predefined values: |
| 7582 | # |
| 7583 | # * `home` |
| 7584 | # * `work` |
| 7585 | # * `other` |
| 7586 | }, |
| 7587 | ], |
| 7588 | "nicknames": [ # The person's nicknames. |
| 7589 | { # A person's nickname. |
| 7590 | "metadata": { # Metadata about a field. # Metadata about the nickname. |
| 7591 | "source": { # The source of a field. # The source of the field. |
| 7592 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 7593 | # |
| 7594 | # Last update timestamp of this source. |
| 7595 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 7596 | # |
| 7597 | # Metadata about a source of type PROFILE. |
| 7598 | "userTypes": [ # Output only. The user types. |
| 7599 | "A String", |
| 7600 | ], |
| 7601 | "objectType": "A String", # Output only. The profile object type. |
| 7602 | }, |
| 7603 | "type": "A String", # The source type. |
| 7604 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 7605 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 7606 | # |
| 7607 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 7608 | # source. Used for web cache validation. |
| 7609 | }, |
| 7610 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 7611 | # verified field is typically a name, email address, phone number, or |
| 7612 | # website that has been confirmed to be owned by the person. |
| 7613 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 7614 | # field. |
| 7615 | }, |
| 7616 | "type": "A String", # The type of the nickname. |
| 7617 | "value": "A String", # The nickname. |
| 7618 | }, |
| 7619 | ], |
| 7620 | "events": [ # The person's events. |
| 7621 | { # An event related to the person. |
| 7622 | "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the event. |
| 7623 | # and time zone are either specified elsewhere or are not significant. The date |
| 7624 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 7625 | # |
| 7626 | # * A full date, with non-zero year, month and day values |
| 7627 | # * A month and day value, with a zero year, e.g. an anniversary |
| 7628 | # * A year on its own, with zero month and day values |
| 7629 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 7630 | # |
| 7631 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 7632 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 7633 | # a year. |
| 7634 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 7635 | # month and day. |
| 7636 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 7637 | # if specifying a year by itself or a year and month where the day is not |
| 7638 | # significant. |
| 7639 | }, |
| 7640 | "formattedType": "A String", # Output only. The type of the event translated and formatted in the |
| 7641 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 7642 | "metadata": { # Metadata about a field. # Metadata about the event. |
| 7643 | "source": { # The source of a field. # The source of the field. |
| 7644 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 7645 | # |
| 7646 | # Last update timestamp of this source. |
| 7647 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 7648 | # |
| 7649 | # Metadata about a source of type PROFILE. |
| 7650 | "userTypes": [ # Output only. The user types. |
| 7651 | "A String", |
| 7652 | ], |
| 7653 | "objectType": "A String", # Output only. The profile object type. |
| 7654 | }, |
| 7655 | "type": "A String", # The source type. |
| 7656 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 7657 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 7658 | # |
| 7659 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 7660 | # source. Used for web cache validation. |
| 7661 | }, |
| 7662 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 7663 | # verified field is typically a name, email address, phone number, or |
| 7664 | # website that has been confirmed to be owned by the person. |
| 7665 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 7666 | # field. |
| 7667 | }, |
| 7668 | "type": "A String", # The type of the event. The type can be custom or one of these predefined |
| 7669 | # values: |
| 7670 | # |
| 7671 | # * `anniversary` |
| 7672 | # * `other` |
| 7673 | }, |
| 7674 | ], |
| 7675 | "urls": [ # The person's associated URLs. |
| 7676 | { # A person's associated URLs. |
| 7677 | "type": "A String", # The type of the URL. The type can be custom or one of these predefined |
| 7678 | # values: |
| 7679 | # |
| 7680 | # * `home` |
| 7681 | # * `work` |
| 7682 | # * `blog` |
| 7683 | # * `profile` |
| 7684 | # * `homePage` |
| 7685 | # * `ftp` |
| 7686 | # * `reservations` |
| 7687 | # * `appInstallPage`: website for a Google+ application. |
| 7688 | # * `other` |
| 7689 | "metadata": { # Metadata about a field. # Metadata about the URL. |
| 7690 | "source": { # The source of a field. # The source of the field. |
| 7691 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 7692 | # |
| 7693 | # Last update timestamp of this source. |
| 7694 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 7695 | # |
| 7696 | # Metadata about a source of type PROFILE. |
| 7697 | "userTypes": [ # Output only. The user types. |
| 7698 | "A String", |
| 7699 | ], |
| 7700 | "objectType": "A String", # Output only. The profile object type. |
| 7701 | }, |
| 7702 | "type": "A String", # The source type. |
| 7703 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 7704 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 7705 | # |
| 7706 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 7707 | # source. Used for web cache validation. |
| 7708 | }, |
| 7709 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 7710 | # verified field is typically a name, email address, phone number, or |
| 7711 | # website that has been confirmed to be owned by the person. |
| 7712 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 7713 | # field. |
| 7714 | }, |
| 7715 | "formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's |
| 7716 | # account locale or the `Accept-Language` HTTP header locale. |
| 7717 | "value": "A String", # The URL. |
| 7718 | }, |
| 7719 | ], |
| 7720 | } |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 7721 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 7722 | updatePersonFields: string, Required. A field mask to restrict which fields on the person are updated. Multiple |
| 7723 | fields can be specified by separating them with commas. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 7724 | All updated fields will be replaced. Valid values are: |
| 7725 | |
| 7726 | * addresses |
| 7727 | * biographies |
| 7728 | * birthdays |
| 7729 | * emailAddresses |
| 7730 | * events |
| 7731 | * genders |
| 7732 | * imClients |
| 7733 | * interests |
| 7734 | * locales |
| 7735 | * memberships |
| 7736 | * names |
| 7737 | * nicknames |
| 7738 | * occupations |
| 7739 | * organizations |
| 7740 | * phoneNumbers |
| 7741 | * relations |
| 7742 | * residences |
| 7743 | * sipAddresses |
| 7744 | * urls |
| 7745 | * userDefined |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7746 | x__xgafv: string, V1 error format. |
| 7747 | Allowed values |
| 7748 | 1 - v1 error format |
| 7749 | 2 - v2 error format |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 7750 | |
| 7751 | Returns: |
| 7752 | An object of the form: |
| 7753 | |
| 7754 | { # Information about a person merged from various data sources such as the |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7755 | # authenticated user's contacts and profile data. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 7756 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7757 | # Most fields can have multiple items. The items in a field have no guaranteed |
| 7758 | # order, but each non-empty field is guaranteed to have exactly one field with |
| 7759 | # `metadata.primary` set to true. |
| 7760 | "interests": [ # The person's interests. |
| 7761 | { # One of the person's interests. |
| 7762 | "value": "A String", # The interest; for example, `stargazing`. |
| 7763 | "metadata": { # Metadata about a field. # Metadata about the interest. |
| 7764 | "source": { # The source of a field. # The source of the field. |
| 7765 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 7766 | # |
| 7767 | # Last update timestamp of this source. |
| 7768 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 7769 | # |
| 7770 | # Metadata about a source of type PROFILE. |
| 7771 | "userTypes": [ # Output only. The user types. |
| 7772 | "A String", |
| 7773 | ], |
| 7774 | "objectType": "A String", # Output only. The profile object type. |
| 7775 | }, |
| 7776 | "type": "A String", # The source type. |
| 7777 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 7778 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 7779 | # |
| 7780 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 7781 | # source. Used for web cache validation. |
| 7782 | }, |
| 7783 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 7784 | # verified field is typically a name, email address, phone number, or |
| 7785 | # website that has been confirmed to be owned by the person. |
| 7786 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 7787 | # field. |
| 7788 | }, |
| 7789 | }, |
| 7790 | ], |
| 7791 | "userDefined": [ # The person's user defined data. |
| 7792 | { # Arbitrary user data that is populated by the end users. |
| 7793 | "metadata": { # Metadata about a field. # Metadata about the user defined data. |
| 7794 | "source": { # The source of a field. # The source of the field. |
| 7795 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 7796 | # |
| 7797 | # Last update timestamp of this source. |
| 7798 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 7799 | # |
| 7800 | # Metadata about a source of type PROFILE. |
| 7801 | "userTypes": [ # Output only. The user types. |
| 7802 | "A String", |
| 7803 | ], |
| 7804 | "objectType": "A String", # Output only. The profile object type. |
| 7805 | }, |
| 7806 | "type": "A String", # The source type. |
| 7807 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 7808 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 7809 | # |
| 7810 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 7811 | # source. Used for web cache validation. |
| 7812 | }, |
| 7813 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 7814 | # verified field is typically a name, email address, phone number, or |
| 7815 | # website that has been confirmed to be owned by the person. |
| 7816 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 7817 | # field. |
| 7818 | }, |
| 7819 | "key": "A String", # The end user specified key of the user defined data. |
| 7820 | "value": "A String", # The end user specified value of the user defined data. |
| 7821 | }, |
| 7822 | ], |
| 7823 | "sipAddresses": [ # The person's SIP addresses. |
| 7824 | { # A person's SIP address. Session Initial Protocol addresses are used for VoIP |
| 7825 | # communications to make voice or video calls over the internet. |
| 7826 | "value": "A String", # The SIP address in the |
| 7827 | # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI |
| 7828 | # format. |
| 7829 | "type": "A String", # The type of the SIP address. The type can be custom or or one of these |
| 7830 | # predefined values: |
| 7831 | # |
| 7832 | # * `home` |
| 7833 | # * `work` |
| 7834 | # * `mobile` |
| 7835 | # * `other` |
| 7836 | "metadata": { # Metadata about a field. # Metadata about the SIP address. |
| 7837 | "source": { # The source of a field. # The source of the field. |
| 7838 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 7839 | # |
| 7840 | # Last update timestamp of this source. |
| 7841 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 7842 | # |
| 7843 | # Metadata about a source of type PROFILE. |
| 7844 | "userTypes": [ # Output only. The user types. |
| 7845 | "A String", |
| 7846 | ], |
| 7847 | "objectType": "A String", # Output only. The profile object type. |
| 7848 | }, |
| 7849 | "type": "A String", # The source type. |
| 7850 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 7851 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 7852 | # |
| 7853 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 7854 | # source. Used for web cache validation. |
| 7855 | }, |
| 7856 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 7857 | # verified field is typically a name, email address, phone number, or |
| 7858 | # website that has been confirmed to be owned by the person. |
| 7859 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 7860 | # field. |
| 7861 | }, |
| 7862 | "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the |
| 7863 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 7864 | }, |
| 7865 | ], |
| 7866 | "phoneNumbers": [ # The person's phone numbers. |
| 7867 | { # A person's phone number. |
| 7868 | "type": "A String", # The type of the phone number. The type can be custom or one of these |
| 7869 | # predefined values: |
| 7870 | # |
| 7871 | # * `home` |
| 7872 | # * `work` |
| 7873 | # * `mobile` |
| 7874 | # * `homeFax` |
| 7875 | # * `workFax` |
| 7876 | # * `otherFax` |
| 7877 | # * `pager` |
| 7878 | # * `workMobile` |
| 7879 | # * `workPager` |
| 7880 | # * `main` |
| 7881 | # * `googleVoice` |
| 7882 | # * `other` |
| 7883 | "value": "A String", # The phone number. |
| 7884 | "canonicalForm": "A String", # Output only. The canonicalized [ITU-T |
| 7885 | # E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) |
| 7886 | # form of the phone number. |
| 7887 | "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the |
| 7888 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 7889 | "metadata": { # Metadata about a field. # Metadata about the phone number. |
| 7890 | "source": { # The source of a field. # The source of the field. |
| 7891 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 7892 | # |
| 7893 | # Last update timestamp of this source. |
| 7894 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 7895 | # |
| 7896 | # Metadata about a source of type PROFILE. |
| 7897 | "userTypes": [ # Output only. The user types. |
| 7898 | "A String", |
| 7899 | ], |
| 7900 | "objectType": "A String", # Output only. The profile object type. |
| 7901 | }, |
| 7902 | "type": "A String", # The source type. |
| 7903 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 7904 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 7905 | # |
| 7906 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 7907 | # source. Used for web cache validation. |
| 7908 | }, |
| 7909 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 7910 | # verified field is typically a name, email address, phone number, or |
| 7911 | # website that has been confirmed to be owned by the person. |
| 7912 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 7913 | # field. |
| 7914 | }, |
| 7915 | }, |
| 7916 | ], |
| 7917 | "occupations": [ # The person's occupations. |
| 7918 | { # A person's occupation. |
| 7919 | "value": "A String", # The occupation; for example, `carpenter`. |
| 7920 | "metadata": { # Metadata about a field. # Metadata about the occupation. |
| 7921 | "source": { # The source of a field. # The source of the field. |
| 7922 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 7923 | # |
| 7924 | # Last update timestamp of this source. |
| 7925 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 7926 | # |
| 7927 | # Metadata about a source of type PROFILE. |
| 7928 | "userTypes": [ # Output only. The user types. |
| 7929 | "A String", |
| 7930 | ], |
| 7931 | "objectType": "A String", # Output only. The profile object type. |
| 7932 | }, |
| 7933 | "type": "A String", # The source type. |
| 7934 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 7935 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 7936 | # |
| 7937 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 7938 | # source. Used for web cache validation. |
| 7939 | }, |
| 7940 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 7941 | # verified field is typically a name, email address, phone number, or |
| 7942 | # website that has been confirmed to be owned by the person. |
| 7943 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 7944 | # field. |
| 7945 | }, |
| 7946 | }, |
| 7947 | ], |
| 7948 | "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) |
| 7949 | # |
| 7950 | # The person's age range. |
| 7951 | "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 7952 | # resource. Used for web cache validation. |
| 7953 | "biographies": [ # The person's biographies. |
| 7954 | { # A person's short biography. |
| 7955 | "metadata": { # Metadata about a field. # Metadata about the biography. |
| 7956 | "source": { # The source of a field. # The source of the field. |
| 7957 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 7958 | # |
| 7959 | # Last update timestamp of this source. |
| 7960 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 7961 | # |
| 7962 | # Metadata about a source of type PROFILE. |
| 7963 | "userTypes": [ # Output only. The user types. |
| 7964 | "A String", |
| 7965 | ], |
| 7966 | "objectType": "A String", # Output only. The profile object type. |
| 7967 | }, |
| 7968 | "type": "A String", # The source type. |
| 7969 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 7970 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 7971 | # |
| 7972 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 7973 | # source. Used for web cache validation. |
| 7974 | }, |
| 7975 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 7976 | # verified field is typically a name, email address, phone number, or |
| 7977 | # website that has been confirmed to be owned by the person. |
| 7978 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 7979 | # field. |
| 7980 | }, |
| 7981 | "contentType": "A String", # The content type of the biography. |
| 7982 | "value": "A String", # The short biography. |
| 7983 | }, |
| 7984 | ], |
| 7985 | "locales": [ # The person's locale preferences. |
| 7986 | { # A person's locale preference. |
| 7987 | "metadata": { # Metadata about a field. # Metadata about the locale. |
| 7988 | "source": { # The source of a field. # The source of the field. |
| 7989 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 7990 | # |
| 7991 | # Last update timestamp of this source. |
| 7992 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 7993 | # |
| 7994 | # Metadata about a source of type PROFILE. |
| 7995 | "userTypes": [ # Output only. The user types. |
| 7996 | "A String", |
| 7997 | ], |
| 7998 | "objectType": "A String", # Output only. The profile object type. |
| 7999 | }, |
| 8000 | "type": "A String", # The source type. |
| 8001 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 8002 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 8003 | # |
| 8004 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 8005 | # source. Used for web cache validation. |
| 8006 | }, |
| 8007 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 8008 | # verified field is typically a name, email address, phone number, or |
| 8009 | # website that has been confirmed to be owned by the person. |
| 8010 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 8011 | # field. |
| 8012 | }, |
| 8013 | "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) |
| 8014 | # language tag representing the locale. |
| 8015 | }, |
| 8016 | ], |
| 8017 | "taglines": [ # Output only. **DEPRECATED**: No data will be returned |
| 8018 | # The person's taglines. |
| 8019 | { # **DEPRECATED**: No data will be returned |
| 8020 | # A brief one-line description of the person. |
| 8021 | "metadata": { # Metadata about a field. # Metadata about the tagline. |
| 8022 | "source": { # The source of a field. # The source of the field. |
| 8023 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 8024 | # |
| 8025 | # Last update timestamp of this source. |
| 8026 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 8027 | # |
| 8028 | # Metadata about a source of type PROFILE. |
| 8029 | "userTypes": [ # Output only. The user types. |
| 8030 | "A String", |
| 8031 | ], |
| 8032 | "objectType": "A String", # Output only. The profile object type. |
| 8033 | }, |
| 8034 | "type": "A String", # The source type. |
| 8035 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 8036 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 8037 | # |
| 8038 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 8039 | # source. Used for web cache validation. |
| 8040 | }, |
| 8041 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 8042 | # verified field is typically a name, email address, phone number, or |
| 8043 | # website that has been confirmed to be owned by the person. |
| 8044 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 8045 | # field. |
| 8046 | }, |
| 8047 | "value": "A String", # The tagline. |
| 8048 | }, |
| 8049 | ], |
| 8050 | "organizations": [ # The person's past or current organizations. |
| 8051 | { # A person's past or current organization. Overlapping date ranges are |
| 8052 | # permitted. |
| 8053 | "title": "A String", # The person's job title at the organization. |
| 8054 | "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker |
| 8055 | # symbol, abbreviation, or acronym. |
| 8056 | "name": "A String", # The name of the organization. |
| 8057 | "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The start date when the person joined the organization. |
| 8058 | # and time zone are either specified elsewhere or are not significant. The date |
| 8059 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 8060 | # |
| 8061 | # * A full date, with non-zero year, month and day values |
| 8062 | # * A month and day value, with a zero year, e.g. an anniversary |
| 8063 | # * A year on its own, with zero month and day values |
| 8064 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 8065 | # |
| 8066 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 8067 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 8068 | # a year. |
| 8069 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 8070 | # month and day. |
| 8071 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 8072 | # if specifying a year by itself or a year and month where the day is not |
| 8073 | # significant. |
| 8074 | }, |
| 8075 | "department": "A String", # The person's department at the organization. |
| 8076 | "current": True or False, # True if the organization is the person's current organization; |
| 8077 | # false if the organization is a past organization. |
| 8078 | "location": "A String", # The location of the organization office the person works at. |
| 8079 | "domain": "A String", # The domain name associated with the organization; for example, |
| 8080 | # `google.com`. |
| 8081 | "metadata": { # Metadata about a field. # Metadata about the organization. |
| 8082 | "source": { # The source of a field. # The source of the field. |
| 8083 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 8084 | # |
| 8085 | # Last update timestamp of this source. |
| 8086 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 8087 | # |
| 8088 | # Metadata about a source of type PROFILE. |
| 8089 | "userTypes": [ # Output only. The user types. |
| 8090 | "A String", |
| 8091 | ], |
| 8092 | "objectType": "A String", # Output only. The profile object type. |
| 8093 | }, |
| 8094 | "type": "A String", # The source type. |
| 8095 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 8096 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 8097 | # |
| 8098 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 8099 | # source. Used for web cache validation. |
| 8100 | }, |
| 8101 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 8102 | # verified field is typically a name, email address, phone number, or |
| 8103 | # website that has been confirmed to be owned by the person. |
| 8104 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 8105 | # field. |
| 8106 | }, |
| 8107 | "jobDescription": "A String", # The person's job description at the organization. |
| 8108 | "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The end date when the person left the organization. |
| 8109 | # and time zone are either specified elsewhere or are not significant. The date |
| 8110 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 8111 | # |
| 8112 | # * A full date, with non-zero year, month and day values |
| 8113 | # * A month and day value, with a zero year, e.g. an anniversary |
| 8114 | # * A year on its own, with zero month and day values |
| 8115 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 8116 | # |
| 8117 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 8118 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 8119 | # a year. |
| 8120 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 8121 | # month and day. |
| 8122 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 8123 | # if specifying a year by itself or a year and month where the day is not |
| 8124 | # significant. |
| 8125 | }, |
| 8126 | "phoneticName": "A String", # The phonetic name of the organization. |
| 8127 | "formattedType": "A String", # Output only. The type of the organization translated and formatted in the |
| 8128 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 8129 | "type": "A String", # The type of the organization. The type can be custom or one of these |
| 8130 | # predefined values: |
| 8131 | # |
| 8132 | # * `work` |
| 8133 | # * `school` |
| 8134 | }, |
| 8135 | ], |
| 8136 | "residences": [ # The person's residences. |
| 8137 | { # A person's past or current residence. |
| 8138 | "metadata": { # Metadata about a field. # Metadata about the residence. |
| 8139 | "source": { # The source of a field. # The source of the field. |
| 8140 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 8141 | # |
| 8142 | # Last update timestamp of this source. |
| 8143 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 8144 | # |
| 8145 | # Metadata about a source of type PROFILE. |
| 8146 | "userTypes": [ # Output only. The user types. |
| 8147 | "A String", |
| 8148 | ], |
| 8149 | "objectType": "A String", # Output only. The profile object type. |
| 8150 | }, |
| 8151 | "type": "A String", # The source type. |
| 8152 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 8153 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 8154 | # |
| 8155 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 8156 | # source. Used for web cache validation. |
| 8157 | }, |
| 8158 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 8159 | # verified field is typically a name, email address, phone number, or |
| 8160 | # website that has been confirmed to be owned by the person. |
| 8161 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 8162 | # field. |
| 8163 | }, |
| 8164 | "current": True or False, # True if the residence is the person's current residence; |
| 8165 | # false if the residence is a past residence. |
| 8166 | "value": "A String", # The address of the residence. |
| 8167 | }, |
| 8168 | ], |
| 8169 | "genders": [ # The person's genders. |
| 8170 | { # A person's gender. |
| 8171 | "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account |
| 8172 | # locale or the `Accept-Language` HTTP header locale. Unspecified or custom |
| 8173 | # value are not localized. |
| 8174 | "metadata": { # Metadata about a field. # Metadata about the gender. |
| 8175 | "source": { # The source of a field. # The source of the field. |
| 8176 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 8177 | # |
| 8178 | # Last update timestamp of this source. |
| 8179 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 8180 | # |
| 8181 | # Metadata about a source of type PROFILE. |
| 8182 | "userTypes": [ # Output only. The user types. |
| 8183 | "A String", |
| 8184 | ], |
| 8185 | "objectType": "A String", # Output only. The profile object type. |
| 8186 | }, |
| 8187 | "type": "A String", # The source type. |
| 8188 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 8189 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 8190 | # |
| 8191 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 8192 | # source. Used for web cache validation. |
| 8193 | }, |
| 8194 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 8195 | # verified field is typically a name, email address, phone number, or |
| 8196 | # website that has been confirmed to be owned by the person. |
| 8197 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 8198 | # field. |
| 8199 | }, |
| 8200 | "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value |
| 8201 | # can be custom or one of these predefined values: |
| 8202 | # |
| 8203 | # * `male` |
| 8204 | # * `female` |
| 8205 | # * `other` |
| 8206 | "value": "A String", # The gender for the person. The gender can be custom or one of these |
| 8207 | # predefined values: |
| 8208 | # |
| 8209 | # * `male` |
| 8210 | # * `female` |
| 8211 | # * `unspecified` |
| 8212 | }, |
| 8213 | ], |
| 8214 | "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned |
| 8215 | # The person's relationship interests. |
| 8216 | { # **DEPRECATED**: No data will be returned |
| 8217 | # A person's relationship interest . |
| 8218 | "formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted |
| 8219 | # in the viewer's account locale or the locale specified in the |
| 8220 | # Accept-Language HTTP header. |
| 8221 | "metadata": { # Metadata about a field. # Metadata about the relationship interest. |
| 8222 | "source": { # The source of a field. # The source of the field. |
| 8223 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 8224 | # |
| 8225 | # Last update timestamp of this source. |
| 8226 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 8227 | # |
| 8228 | # Metadata about a source of type PROFILE. |
| 8229 | "userTypes": [ # Output only. The user types. |
| 8230 | "A String", |
| 8231 | ], |
| 8232 | "objectType": "A String", # Output only. The profile object type. |
| 8233 | }, |
| 8234 | "type": "A String", # The source type. |
| 8235 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 8236 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 8237 | # |
| 8238 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 8239 | # source. Used for web cache validation. |
| 8240 | }, |
| 8241 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 8242 | # verified field is typically a name, email address, phone number, or |
| 8243 | # website that has been confirmed to be owned by the person. |
| 8244 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 8245 | # field. |
| 8246 | }, |
| 8247 | "value": "A String", # The kind of relationship the person is looking for. The value can be custom |
| 8248 | # or one of these predefined values: |
| 8249 | # |
| 8250 | # * `friend` |
| 8251 | # * `date` |
| 8252 | # * `relationship` |
| 8253 | # * `networking` |
| 8254 | }, |
| 8255 | ], |
| 8256 | "metadata": { # The metadata about a person. # Output only. Metadata about the person. |
| 8257 | "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for |
| 8258 | # [`connections.list`](/people/api/rest/v1/people.connections/list) requests |
| 8259 | # that include a sync token. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 8260 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8261 | # The resource name may change when adding or removing fields that link a |
| 8262 | # contact and profile such as a verified email, verified phone number, or |
| 8263 | # profile URL. |
| 8264 | "A String", |
| 8265 | ], |
| 8266 | "sources": [ # The sources of data for the person. |
| 8267 | { # The source of a field. |
| 8268 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 8269 | # |
| 8270 | # Last update timestamp of this source. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8271 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 8272 | # |
| 8273 | # Metadata about a source of type PROFILE. |
| 8274 | "userTypes": [ # Output only. The user types. |
| 8275 | "A String", |
| 8276 | ], |
| 8277 | "objectType": "A String", # Output only. The profile object type. |
| 8278 | }, |
| 8279 | "type": "A String", # The source type. |
| 8280 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 8281 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 8282 | # |
| 8283 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 8284 | # source. Used for web cache validation. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 8285 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8286 | ], |
| 8287 | "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource. |
| 8288 | "A String", |
| 8289 | ], |
| 8290 | "objectType": "A String", # Output only. **DEPRECATED** (Please use |
| 8291 | # `person.metadata.sources.profileMetadata.objectType` instead) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 8292 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8293 | # The type of the person object. |
| 8294 | "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for |
| 8295 | # [`connections.list`](/people/api/rest/v1/people.connections/list) requests |
| 8296 | # that include a sync token. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 8297 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8298 | "memberships": [ # The person's group memberships. |
| 8299 | { # A person's membership in a group. Only contact group memberships can be |
| 8300 | # modified. |
| 8301 | "metadata": { # Metadata about a field. # Metadata about the membership. |
| 8302 | "source": { # The source of a field. # The source of the field. |
| 8303 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 8304 | # |
| 8305 | # Last update timestamp of this source. |
| 8306 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 8307 | # |
| 8308 | # Metadata about a source of type PROFILE. |
| 8309 | "userTypes": [ # Output only. The user types. |
| 8310 | "A String", |
| 8311 | ], |
| 8312 | "objectType": "A String", # Output only. The profile object type. |
| 8313 | }, |
| 8314 | "type": "A String", # The source type. |
| 8315 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 8316 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 8317 | # |
| 8318 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 8319 | # source. Used for web cache validation. |
| 8320 | }, |
| 8321 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 8322 | # verified field is typically a name, email address, phone number, or |
| 8323 | # website that has been confirmed to be owned by the person. |
| 8324 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 8325 | # field. |
| 8326 | }, |
| 8327 | "contactGroupMembership": { # A Google contact group membership. # The contact group membership. |
| 8328 | "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership. |
| 8329 | "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII |
| 8330 | # string, in the form of `contactGroups/{contact_group_id}`. |
| 8331 | # Only contact_group_resource_name can be used for modifying memberships. |
| 8332 | # Any contact group membership can be removed, but only user group or |
| 8333 | # "myContacts" or "starred" system groups memberships can be added. A |
| 8334 | # contact must always have at least one contact group membership. |
| 8335 | }, |
| 8336 | "domainMembership": { # A G Suite Domain membership. # Output only. The domain membership. |
| 8337 | "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain. |
| 8338 | }, |
| 8339 | }, |
| 8340 | ], |
| 8341 | "birthdays": [ # The person's birthdays. |
| 8342 | { # A person's birthday. At least one of the `date` and `text` fields are |
| 8343 | # specified. The `date` and `text` fields typically represent the same |
| 8344 | # date, but are not guaranteed to. |
| 8345 | "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the birthday. |
| 8346 | # and time zone are either specified elsewhere or are not significant. The date |
| 8347 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 8348 | # |
| 8349 | # * A full date, with non-zero year, month and day values |
| 8350 | # * A month and day value, with a zero year, e.g. an anniversary |
| 8351 | # * A year on its own, with zero month and day values |
| 8352 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 8353 | # |
| 8354 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 8355 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 8356 | # a year. |
| 8357 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 8358 | # month and day. |
| 8359 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 8360 | # if specifying a year by itself or a year and month where the day is not |
| 8361 | # significant. |
| 8362 | }, |
| 8363 | "metadata": { # Metadata about a field. # Metadata about the birthday. |
| 8364 | "source": { # The source of a field. # The source of the field. |
| 8365 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 8366 | # |
| 8367 | # Last update timestamp of this source. |
| 8368 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 8369 | # |
| 8370 | # Metadata about a source of type PROFILE. |
| 8371 | "userTypes": [ # Output only. The user types. |
| 8372 | "A String", |
| 8373 | ], |
| 8374 | "objectType": "A String", # Output only. The profile object type. |
| 8375 | }, |
| 8376 | "type": "A String", # The source type. |
| 8377 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 8378 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 8379 | # |
| 8380 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 8381 | # source. Used for web cache validation. |
| 8382 | }, |
| 8383 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 8384 | # verified field is typically a name, email address, phone number, or |
| 8385 | # website that has been confirmed to be owned by the person. |
| 8386 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 8387 | # field. |
| 8388 | }, |
| 8389 | "text": "A String", # A free-form string representing the user's birthday. |
| 8390 | }, |
| 8391 | ], |
| 8392 | "imClients": [ # The person's instant messaging clients. |
| 8393 | { # A person's instant messaging client. |
| 8394 | "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the |
| 8395 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 8396 | "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these |
| 8397 | # predefined values: |
| 8398 | # |
| 8399 | # * `aim` |
| 8400 | # * `msn` |
| 8401 | # * `yahoo` |
| 8402 | # * `skype` |
| 8403 | # * `qq` |
| 8404 | # * `googleTalk` |
| 8405 | # * `icq` |
| 8406 | # * `jabber` |
| 8407 | # * `netMeeting` |
| 8408 | "username": "A String", # The user name used in the IM client. |
| 8409 | "type": "A String", # The type of the IM client. The type can be custom or one of these |
| 8410 | # predefined values: |
| 8411 | # |
| 8412 | # * `home` |
| 8413 | # * `work` |
| 8414 | # * `other` |
| 8415 | "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account |
| 8416 | # locale or the `Accept-Language` HTTP header locale. |
| 8417 | "metadata": { # Metadata about a field. # Metadata about the IM client. |
| 8418 | "source": { # The source of a field. # The source of the field. |
| 8419 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 8420 | # |
| 8421 | # Last update timestamp of this source. |
| 8422 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 8423 | # |
| 8424 | # Metadata about a source of type PROFILE. |
| 8425 | "userTypes": [ # Output only. The user types. |
| 8426 | "A String", |
| 8427 | ], |
| 8428 | "objectType": "A String", # Output only. The profile object type. |
| 8429 | }, |
| 8430 | "type": "A String", # The source type. |
| 8431 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 8432 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 8433 | # |
| 8434 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 8435 | # source. Used for web cache validation. |
| 8436 | }, |
| 8437 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 8438 | # verified field is typically a name, email address, phone number, or |
| 8439 | # website that has been confirmed to be owned by the person. |
| 8440 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 8441 | # field. |
| 8442 | }, |
| 8443 | }, |
| 8444 | ], |
| 8445 | "skills": [ # The person's skills. |
| 8446 | { # A skill that the person has. |
| 8447 | "metadata": { # Metadata about a field. # Metadata about the skill. |
| 8448 | "source": { # The source of a field. # The source of the field. |
| 8449 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 8450 | # |
| 8451 | # Last update timestamp of this source. |
| 8452 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 8453 | # |
| 8454 | # Metadata about a source of type PROFILE. |
| 8455 | "userTypes": [ # Output only. The user types. |
| 8456 | "A String", |
| 8457 | ], |
| 8458 | "objectType": "A String", # Output only. The profile object type. |
| 8459 | }, |
| 8460 | "type": "A String", # The source type. |
| 8461 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 8462 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 8463 | # |
| 8464 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 8465 | # source. Used for web cache validation. |
| 8466 | }, |
| 8467 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 8468 | # verified field is typically a name, email address, phone number, or |
| 8469 | # website that has been confirmed to be owned by the person. |
| 8470 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 8471 | # field. |
| 8472 | }, |
| 8473 | "value": "A String", # The skill; for example, `underwater basket weaving`. |
| 8474 | }, |
| 8475 | ], |
| 8476 | "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned |
| 8477 | # The person's relationship statuses. |
| 8478 | { # **DEPRECATED**: No data will be returned |
| 8479 | # A person's relationship status. |
| 8480 | "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in |
| 8481 | # the viewer's account locale or the `Accept-Language` HTTP header locale. |
| 8482 | "metadata": { # Metadata about a field. # Metadata about the relationship status. |
| 8483 | "source": { # The source of a field. # The source of the field. |
| 8484 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 8485 | # |
| 8486 | # Last update timestamp of this source. |
| 8487 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 8488 | # |
| 8489 | # Metadata about a source of type PROFILE. |
| 8490 | "userTypes": [ # Output only. The user types. |
| 8491 | "A String", |
| 8492 | ], |
| 8493 | "objectType": "A String", # Output only. The profile object type. |
| 8494 | }, |
| 8495 | "type": "A String", # The source type. |
| 8496 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 8497 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 8498 | # |
| 8499 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 8500 | # source. Used for web cache validation. |
| 8501 | }, |
| 8502 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 8503 | # verified field is typically a name, email address, phone number, or |
| 8504 | # website that has been confirmed to be owned by the person. |
| 8505 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 8506 | # field. |
| 8507 | }, |
| 8508 | "value": "A String", # The relationship status. The value can be custom or one of these |
| 8509 | # predefined values: |
| 8510 | # |
| 8511 | # * `single` |
| 8512 | # * `inARelationship` |
| 8513 | # * `engaged` |
| 8514 | # * `married` |
| 8515 | # * `itsComplicated` |
| 8516 | # * `openRelationship` |
| 8517 | # * `widowed` |
| 8518 | # * `inDomesticPartnership` |
| 8519 | # * `inCivilUnion` |
| 8520 | }, |
| 8521 | ], |
| 8522 | "coverPhotos": [ # Output only. The person's cover photos. |
| 8523 | { # A person's cover photo. A large image shown on the person's |
| 8524 | # profile page that represents who they are or what they care about. |
| 8525 | "url": "A String", # The URL of the cover photo. |
| 8526 | "default": True or False, # True if the cover photo is the default cover photo; |
| 8527 | # false if the cover photo is a user-provided cover photo. |
| 8528 | "metadata": { # Metadata about a field. # Metadata about the cover photo. |
| 8529 | "source": { # The source of a field. # The source of the field. |
| 8530 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 8531 | # |
| 8532 | # Last update timestamp of this source. |
| 8533 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 8534 | # |
| 8535 | # Metadata about a source of type PROFILE. |
| 8536 | "userTypes": [ # Output only. The user types. |
| 8537 | "A String", |
| 8538 | ], |
| 8539 | "objectType": "A String", # Output only. The profile object type. |
| 8540 | }, |
| 8541 | "type": "A String", # The source type. |
| 8542 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 8543 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 8544 | # |
| 8545 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 8546 | # source. Used for web cache validation. |
| 8547 | }, |
| 8548 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 8549 | # verified field is typically a name, email address, phone number, or |
| 8550 | # website that has been confirmed to be owned by the person. |
| 8551 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 8552 | # field. |
| 8553 | }, |
| 8554 | }, |
| 8555 | ], |
| 8556 | "names": [ # The person's names. |
| 8557 | { # A person's name. If the name is a mononym, the family name is empty. |
| 8558 | "middleName": "A String", # The middle name(s). |
| 8559 | "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound. |
| 8560 | "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to |
| 8561 | # the locale specified by the viewer's account or the |
| 8562 | # `Accept-Language` HTTP header. |
| 8563 | "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.` |
| 8564 | "familyName": "A String", # The family name. |
| 8565 | "phoneticGivenName": "A String", # The given name spelled as it sounds. |
| 8566 | "metadata": { # Metadata about a field. # Metadata about the name. |
| 8567 | "source": { # The source of a field. # The source of the field. |
| 8568 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 8569 | # |
| 8570 | # Last update timestamp of this source. |
| 8571 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 8572 | # |
| 8573 | # Metadata about a source of type PROFILE. |
| 8574 | "userTypes": [ # Output only. The user types. |
| 8575 | "A String", |
| 8576 | ], |
| 8577 | "objectType": "A String", # Output only. The profile object type. |
| 8578 | }, |
| 8579 | "type": "A String", # The source type. |
| 8580 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 8581 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 8582 | # |
| 8583 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 8584 | # source. Used for web cache validation. |
| 8585 | }, |
| 8586 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 8587 | # verified field is typically a name, email address, phone number, or |
| 8588 | # website that has been confirmed to be owned by the person. |
| 8589 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 8590 | # field. |
| 8591 | }, |
| 8592 | "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound. |
| 8593 | "displayName": "A String", # Output only. The display name formatted according to the locale specified by |
| 8594 | # the viewer's account or the `Accept-Language` HTTP header. |
| 8595 | "phoneticFamilyName": "A String", # The family name spelled as it sounds. |
| 8596 | "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.` |
| 8597 | "givenName": "A String", # The given name. |
| 8598 | "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound. |
| 8599 | "phoneticFullName": "A String", # The full name spelled as it sounds. |
| 8600 | }, |
| 8601 | ], |
| 8602 | "relations": [ # The person's relations. |
| 8603 | { # A person's relation to another person. |
| 8604 | "type": "A String", # The person's relation to the other person. The type can be custom or one of |
| 8605 | # these predefined values: |
| 8606 | # |
| 8607 | # * `spouse` |
| 8608 | # * `child` |
| 8609 | # * `mother` |
| 8610 | # * `father` |
| 8611 | # * `parent` |
| 8612 | # * `brother` |
| 8613 | # * `sister` |
| 8614 | # * `friend` |
| 8615 | # * `relative` |
| 8616 | # * `domesticPartner` |
| 8617 | # * `manager` |
| 8618 | # * `assistant` |
| 8619 | # * `referredBy` |
| 8620 | # * `partner` |
| 8621 | "metadata": { # Metadata about a field. # Metadata about the relation. |
| 8622 | "source": { # The source of a field. # The source of the field. |
| 8623 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 8624 | # |
| 8625 | # Last update timestamp of this source. |
| 8626 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 8627 | # |
| 8628 | # Metadata about a source of type PROFILE. |
| 8629 | "userTypes": [ # Output only. The user types. |
| 8630 | "A String", |
| 8631 | ], |
| 8632 | "objectType": "A String", # Output only. The profile object type. |
| 8633 | }, |
| 8634 | "type": "A String", # The source type. |
| 8635 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 8636 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 8637 | # |
| 8638 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 8639 | # source. Used for web cache validation. |
| 8640 | }, |
| 8641 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 8642 | # verified field is typically a name, email address, phone number, or |
| 8643 | # website that has been confirmed to be owned by the person. |
| 8644 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 8645 | # field. |
| 8646 | }, |
| 8647 | "person": "A String", # The name of the other person this relation refers to. |
| 8648 | "formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's |
| 8649 | # account locale or the locale specified in the Accept-Language HTTP header. |
| 8650 | }, |
| 8651 | ], |
| 8652 | "ageRanges": [ # Output only. The person's age ranges. |
| 8653 | { # A person's age range. |
| 8654 | "metadata": { # Metadata about a field. # Metadata about the age range. |
| 8655 | "source": { # The source of a field. # The source of the field. |
| 8656 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 8657 | # |
| 8658 | # Last update timestamp of this source. |
| 8659 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 8660 | # |
| 8661 | # Metadata about a source of type PROFILE. |
| 8662 | "userTypes": [ # Output only. The user types. |
| 8663 | "A String", |
| 8664 | ], |
| 8665 | "objectType": "A String", # Output only. The profile object type. |
| 8666 | }, |
| 8667 | "type": "A String", # The source type. |
| 8668 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 8669 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 8670 | # |
| 8671 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 8672 | # source. Used for web cache validation. |
| 8673 | }, |
| 8674 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 8675 | # verified field is typically a name, email address, phone number, or |
| 8676 | # website that has been confirmed to be owned by the person. |
| 8677 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 8678 | # field. |
| 8679 | }, |
| 8680 | "ageRange": "A String", # The age range. |
| 8681 | }, |
| 8682 | ], |
| 8683 | "braggingRights": [ # **DEPRECATED**: No data will be returned |
| 8684 | # The person's bragging rights. |
| 8685 | { # **DEPRECATED**: No data will be returned |
| 8686 | # A person's bragging rights. |
| 8687 | "value": "A String", # The bragging rights; for example, `climbed mount everest`. |
| 8688 | "metadata": { # Metadata about a field. # Metadata about the bragging rights. |
| 8689 | "source": { # The source of a field. # The source of the field. |
| 8690 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 8691 | # |
| 8692 | # Last update timestamp of this source. |
| 8693 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 8694 | # |
| 8695 | # Metadata about a source of type PROFILE. |
| 8696 | "userTypes": [ # Output only. The user types. |
| 8697 | "A String", |
| 8698 | ], |
| 8699 | "objectType": "A String", # Output only. The profile object type. |
| 8700 | }, |
| 8701 | "type": "A String", # The source type. |
| 8702 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 8703 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 8704 | # |
| 8705 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 8706 | # source. Used for web cache validation. |
| 8707 | }, |
| 8708 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 8709 | # verified field is typically a name, email address, phone number, or |
| 8710 | # website that has been confirmed to be owned by the person. |
| 8711 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 8712 | # field. |
| 8713 | }, |
| 8714 | }, |
| 8715 | ], |
| 8716 | "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string |
| 8717 | # with a max length of 27 characters, in the form of |
| 8718 | # `people/{person_id}`. |
| 8719 | "photos": [ # Output only. The person's photos. |
| 8720 | { # A person's photo. A picture shown next to the person's name to |
| 8721 | # help others recognize the person. |
| 8722 | "url": "A String", # The URL of the photo. You can change the desired size by appending a query |
| 8723 | # parameter `sz={size}` at the end of the url, where {size} is the size in |
| 8724 | # pixels. Example: |
| 8725 | # https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50 |
| 8726 | "default": True or False, # True if the photo is a default photo; |
| 8727 | # false if the photo is a user-provided photo. |
| 8728 | "metadata": { # Metadata about a field. # Metadata about the photo. |
| 8729 | "source": { # The source of a field. # The source of the field. |
| 8730 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 8731 | # |
| 8732 | # Last update timestamp of this source. |
| 8733 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 8734 | # |
| 8735 | # Metadata about a source of type PROFILE. |
| 8736 | "userTypes": [ # Output only. The user types. |
| 8737 | "A String", |
| 8738 | ], |
| 8739 | "objectType": "A String", # Output only. The profile object type. |
| 8740 | }, |
| 8741 | "type": "A String", # The source type. |
| 8742 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 8743 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 8744 | # |
| 8745 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 8746 | # source. Used for web cache validation. |
| 8747 | }, |
| 8748 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 8749 | # verified field is typically a name, email address, phone number, or |
| 8750 | # website that has been confirmed to be owned by the person. |
| 8751 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 8752 | # field. |
| 8753 | }, |
| 8754 | }, |
| 8755 | ], |
| 8756 | "addresses": [ # The person's street addresses. |
| 8757 | { # A person's physical address. May be a P.O. box or street address. All fields |
| 8758 | # are optional. |
| 8759 | "streetAddress": "A String", # The street address. |
| 8760 | "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it |
| 8761 | # will be automatically constructed from structured values. |
| 8762 | "country": "A String", # The country of the address. |
| 8763 | "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's |
| 8764 | # account locale or the `Accept-Language` HTTP header locale. |
| 8765 | "city": "A String", # The city of the address. |
| 8766 | "postalCode": "A String", # The postal code of the address. |
| 8767 | "extendedAddress": "A String", # The extended address of the address; for example, the apartment number. |
| 8768 | "type": "A String", # The type of the address. The type can be custom or one of these predefined |
| 8769 | # values: |
| 8770 | # |
| 8771 | # * `home` |
| 8772 | # * `work` |
| 8773 | # * `other` |
| 8774 | "region": "A String", # The region of the address; for example, the state or province. |
| 8775 | "poBox": "A String", # The P.O. box of the address. |
| 8776 | "metadata": { # Metadata about a field. # Metadata about the address. |
| 8777 | "source": { # The source of a field. # The source of the field. |
| 8778 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 8779 | # |
| 8780 | # Last update timestamp of this source. |
| 8781 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 8782 | # |
| 8783 | # Metadata about a source of type PROFILE. |
| 8784 | "userTypes": [ # Output only. The user types. |
| 8785 | "A String", |
| 8786 | ], |
| 8787 | "objectType": "A String", # Output only. The profile object type. |
| 8788 | }, |
| 8789 | "type": "A String", # The source type. |
| 8790 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 8791 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 8792 | # |
| 8793 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 8794 | # source. Used for web cache validation. |
| 8795 | }, |
| 8796 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 8797 | # verified field is typically a name, email address, phone number, or |
| 8798 | # website that has been confirmed to be owned by the person. |
| 8799 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 8800 | # field. |
| 8801 | }, |
| 8802 | "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country |
| 8803 | # code of the address. |
| 8804 | }, |
| 8805 | ], |
| 8806 | "emailAddresses": [ # The person's email addresses. |
| 8807 | { # A person's email address. |
| 8808 | "formattedType": "A String", # Output only. The type of the email address translated and formatted in the |
| 8809 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 8810 | "metadata": { # Metadata about a field. # Metadata about the email address. |
| 8811 | "source": { # The source of a field. # The source of the field. |
| 8812 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 8813 | # |
| 8814 | # Last update timestamp of this source. |
| 8815 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 8816 | # |
| 8817 | # Metadata about a source of type PROFILE. |
| 8818 | "userTypes": [ # Output only. The user types. |
| 8819 | "A String", |
| 8820 | ], |
| 8821 | "objectType": "A String", # Output only. The profile object type. |
| 8822 | }, |
| 8823 | "type": "A String", # The source type. |
| 8824 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 8825 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 8826 | # |
| 8827 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 8828 | # source. Used for web cache validation. |
| 8829 | }, |
| 8830 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 8831 | # verified field is typically a name, email address, phone number, or |
| 8832 | # website that has been confirmed to be owned by the person. |
| 8833 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 8834 | # field. |
| 8835 | }, |
| 8836 | "value": "A String", # The email address. |
| 8837 | "displayName": "A String", # The display name of the email. |
| 8838 | "type": "A String", # The type of the email address. The type can be custom or one of these |
| 8839 | # predefined values: |
| 8840 | # |
| 8841 | # * `home` |
| 8842 | # * `work` |
| 8843 | # * `other` |
| 8844 | }, |
| 8845 | ], |
| 8846 | "nicknames": [ # The person's nicknames. |
| 8847 | { # A person's nickname. |
| 8848 | "metadata": { # Metadata about a field. # Metadata about the nickname. |
| 8849 | "source": { # The source of a field. # The source of the field. |
| 8850 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 8851 | # |
| 8852 | # Last update timestamp of this source. |
| 8853 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 8854 | # |
| 8855 | # Metadata about a source of type PROFILE. |
| 8856 | "userTypes": [ # Output only. The user types. |
| 8857 | "A String", |
| 8858 | ], |
| 8859 | "objectType": "A String", # Output only. The profile object type. |
| 8860 | }, |
| 8861 | "type": "A String", # The source type. |
| 8862 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 8863 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 8864 | # |
| 8865 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 8866 | # source. Used for web cache validation. |
| 8867 | }, |
| 8868 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 8869 | # verified field is typically a name, email address, phone number, or |
| 8870 | # website that has been confirmed to be owned by the person. |
| 8871 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 8872 | # field. |
| 8873 | }, |
| 8874 | "type": "A String", # The type of the nickname. |
| 8875 | "value": "A String", # The nickname. |
| 8876 | }, |
| 8877 | ], |
| 8878 | "events": [ # The person's events. |
| 8879 | { # An event related to the person. |
| 8880 | "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the event. |
| 8881 | # and time zone are either specified elsewhere or are not significant. The date |
| 8882 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 8883 | # |
| 8884 | # * A full date, with non-zero year, month and day values |
| 8885 | # * A month and day value, with a zero year, e.g. an anniversary |
| 8886 | # * A year on its own, with zero month and day values |
| 8887 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 8888 | # |
| 8889 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 8890 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 8891 | # a year. |
| 8892 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 8893 | # month and day. |
| 8894 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 8895 | # if specifying a year by itself or a year and month where the day is not |
| 8896 | # significant. |
| 8897 | }, |
| 8898 | "formattedType": "A String", # Output only. The type of the event translated and formatted in the |
| 8899 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 8900 | "metadata": { # Metadata about a field. # Metadata about the event. |
| 8901 | "source": { # The source of a field. # The source of the field. |
| 8902 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 8903 | # |
| 8904 | # Last update timestamp of this source. |
| 8905 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 8906 | # |
| 8907 | # Metadata about a source of type PROFILE. |
| 8908 | "userTypes": [ # Output only. The user types. |
| 8909 | "A String", |
| 8910 | ], |
| 8911 | "objectType": "A String", # Output only. The profile object type. |
| 8912 | }, |
| 8913 | "type": "A String", # The source type. |
| 8914 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 8915 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 8916 | # |
| 8917 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 8918 | # source. Used for web cache validation. |
| 8919 | }, |
| 8920 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 8921 | # verified field is typically a name, email address, phone number, or |
| 8922 | # website that has been confirmed to be owned by the person. |
| 8923 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 8924 | # field. |
| 8925 | }, |
| 8926 | "type": "A String", # The type of the event. The type can be custom or one of these predefined |
| 8927 | # values: |
| 8928 | # |
| 8929 | # * `anniversary` |
| 8930 | # * `other` |
| 8931 | }, |
| 8932 | ], |
| 8933 | "urls": [ # The person's associated URLs. |
| 8934 | { # A person's associated URLs. |
| 8935 | "type": "A String", # The type of the URL. The type can be custom or one of these predefined |
| 8936 | # values: |
| 8937 | # |
| 8938 | # * `home` |
| 8939 | # * `work` |
| 8940 | # * `blog` |
| 8941 | # * `profile` |
| 8942 | # * `homePage` |
| 8943 | # * `ftp` |
| 8944 | # * `reservations` |
| 8945 | # * `appInstallPage`: website for a Google+ application. |
| 8946 | # * `other` |
| 8947 | "metadata": { # Metadata about a field. # Metadata about the URL. |
| 8948 | "source": { # The source of a field. # The source of the field. |
| 8949 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 8950 | # |
| 8951 | # Last update timestamp of this source. |
| 8952 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 8953 | # |
| 8954 | # Metadata about a source of type PROFILE. |
| 8955 | "userTypes": [ # Output only. The user types. |
| 8956 | "A String", |
| 8957 | ], |
| 8958 | "objectType": "A String", # Output only. The profile object type. |
| 8959 | }, |
| 8960 | "type": "A String", # The source type. |
| 8961 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 8962 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 8963 | # |
| 8964 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 8965 | # source. Used for web cache validation. |
| 8966 | }, |
| 8967 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 8968 | # verified field is typically a name, email address, phone number, or |
| 8969 | # website that has been confirmed to be owned by the person. |
| 8970 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 8971 | # field. |
| 8972 | }, |
| 8973 | "formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's |
| 8974 | # account locale or the `Accept-Language` HTTP header locale. |
| 8975 | "value": "A String", # The URL. |
| 8976 | }, |
| 8977 | ], |
| 8978 | }</pre> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 8979 | </div> |
| 8980 | |
| 8981 | <div class="method"> |
| 8982 | <code class="details" id="updateContactPhoto">updateContactPhoto(resourceName, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8983 | <pre>Update a contact's photo. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 8984 | |
| 8985 | Args: |
| 8986 | resourceName: string, Required. Person resource name (required) |
| 8987 | body: object, The request body. |
| 8988 | The object takes the form of: |
| 8989 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8990 | { # A request to update an existing contact's photo. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 8991 | # All requests must have a valid photo format: JPEG or PNG. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8992 | "photoBytes": "A String", # Required. Raw photo bytes |
| 8993 | "personFields": "A String", # Optional. A field mask to restrict which fields on the person are returned. Multiple |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 8994 | # fields can be specified by separating them with commas. Defaults to empty |
| 8995 | # if not set, which will skip the post mutate get. Valid values are: |
| 8996 | # |
| 8997 | # * addresses |
| 8998 | # * ageRanges |
| 8999 | # * biographies |
| 9000 | # * birthdays |
| 9001 | # * coverPhotos |
| 9002 | # * emailAddresses |
| 9003 | # * events |
| 9004 | # * genders |
| 9005 | # * imClients |
| 9006 | # * interests |
| 9007 | # * locales |
| 9008 | # * memberships |
| 9009 | # * metadata |
| 9010 | # * names |
| 9011 | # * nicknames |
| 9012 | # * occupations |
| 9013 | # * organizations |
| 9014 | # * phoneNumbers |
| 9015 | # * photos |
| 9016 | # * relations |
| 9017 | # * residences |
| 9018 | # * sipAddresses |
| 9019 | # * skills |
| 9020 | # * urls |
| 9021 | # * userDefined |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 9022 | } |
| 9023 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 9024 | x__xgafv: string, V1 error format. |
| 9025 | Allowed values |
| 9026 | 1 - v1 error format |
| 9027 | 2 - v2 error format |
| 9028 | |
| 9029 | Returns: |
| 9030 | An object of the form: |
| 9031 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9032 | { # The response for updating a contact's photo. |
| 9033 | "person": { # Information about a person merged from various data sources such as the # The updated person, if person_fields is set in the |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 9034 | # UpdateContactPhotoRequest; otherwise this will be unset. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9035 | # authenticated user's contacts and profile data. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 9036 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9037 | # Most fields can have multiple items. The items in a field have no guaranteed |
| 9038 | # order, but each non-empty field is guaranteed to have exactly one field with |
| 9039 | # `metadata.primary` set to true. |
| 9040 | "interests": [ # The person's interests. |
| 9041 | { # One of the person's interests. |
| 9042 | "value": "A String", # The interest; for example, `stargazing`. |
| 9043 | "metadata": { # Metadata about a field. # Metadata about the interest. |
| 9044 | "source": { # The source of a field. # The source of the field. |
| 9045 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 9046 | # |
| 9047 | # Last update timestamp of this source. |
| 9048 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 9049 | # |
| 9050 | # Metadata about a source of type PROFILE. |
| 9051 | "userTypes": [ # Output only. The user types. |
| 9052 | "A String", |
| 9053 | ], |
| 9054 | "objectType": "A String", # Output only. The profile object type. |
| 9055 | }, |
| 9056 | "type": "A String", # The source type. |
| 9057 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 9058 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 9059 | # |
| 9060 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 9061 | # source. Used for web cache validation. |
| 9062 | }, |
| 9063 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 9064 | # verified field is typically a name, email address, phone number, or |
| 9065 | # website that has been confirmed to be owned by the person. |
| 9066 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 9067 | # field. |
| 9068 | }, |
| 9069 | }, |
| 9070 | ], |
| 9071 | "userDefined": [ # The person's user defined data. |
| 9072 | { # Arbitrary user data that is populated by the end users. |
| 9073 | "metadata": { # Metadata about a field. # Metadata about the user defined data. |
| 9074 | "source": { # The source of a field. # The source of the field. |
| 9075 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 9076 | # |
| 9077 | # Last update timestamp of this source. |
| 9078 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 9079 | # |
| 9080 | # Metadata about a source of type PROFILE. |
| 9081 | "userTypes": [ # Output only. The user types. |
| 9082 | "A String", |
| 9083 | ], |
| 9084 | "objectType": "A String", # Output only. The profile object type. |
| 9085 | }, |
| 9086 | "type": "A String", # The source type. |
| 9087 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 9088 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 9089 | # |
| 9090 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 9091 | # source. Used for web cache validation. |
| 9092 | }, |
| 9093 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 9094 | # verified field is typically a name, email address, phone number, or |
| 9095 | # website that has been confirmed to be owned by the person. |
| 9096 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 9097 | # field. |
| 9098 | }, |
| 9099 | "key": "A String", # The end user specified key of the user defined data. |
| 9100 | "value": "A String", # The end user specified value of the user defined data. |
| 9101 | }, |
| 9102 | ], |
| 9103 | "sipAddresses": [ # The person's SIP addresses. |
| 9104 | { # A person's SIP address. Session Initial Protocol addresses are used for VoIP |
| 9105 | # communications to make voice or video calls over the internet. |
| 9106 | "value": "A String", # The SIP address in the |
| 9107 | # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI |
| 9108 | # format. |
| 9109 | "type": "A String", # The type of the SIP address. The type can be custom or or one of these |
| 9110 | # predefined values: |
| 9111 | # |
| 9112 | # * `home` |
| 9113 | # * `work` |
| 9114 | # * `mobile` |
| 9115 | # * `other` |
| 9116 | "metadata": { # Metadata about a field. # Metadata about the SIP address. |
| 9117 | "source": { # The source of a field. # The source of the field. |
| 9118 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 9119 | # |
| 9120 | # Last update timestamp of this source. |
| 9121 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 9122 | # |
| 9123 | # Metadata about a source of type PROFILE. |
| 9124 | "userTypes": [ # Output only. The user types. |
| 9125 | "A String", |
| 9126 | ], |
| 9127 | "objectType": "A String", # Output only. The profile object type. |
| 9128 | }, |
| 9129 | "type": "A String", # The source type. |
| 9130 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 9131 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 9132 | # |
| 9133 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 9134 | # source. Used for web cache validation. |
| 9135 | }, |
| 9136 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 9137 | # verified field is typically a name, email address, phone number, or |
| 9138 | # website that has been confirmed to be owned by the person. |
| 9139 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 9140 | # field. |
| 9141 | }, |
| 9142 | "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the |
| 9143 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 9144 | }, |
| 9145 | ], |
| 9146 | "phoneNumbers": [ # The person's phone numbers. |
| 9147 | { # A person's phone number. |
| 9148 | "type": "A String", # The type of the phone number. The type can be custom or one of these |
| 9149 | # predefined values: |
| 9150 | # |
| 9151 | # * `home` |
| 9152 | # * `work` |
| 9153 | # * `mobile` |
| 9154 | # * `homeFax` |
| 9155 | # * `workFax` |
| 9156 | # * `otherFax` |
| 9157 | # * `pager` |
| 9158 | # * `workMobile` |
| 9159 | # * `workPager` |
| 9160 | # * `main` |
| 9161 | # * `googleVoice` |
| 9162 | # * `other` |
| 9163 | "value": "A String", # The phone number. |
| 9164 | "canonicalForm": "A String", # Output only. The canonicalized [ITU-T |
| 9165 | # E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) |
| 9166 | # form of the phone number. |
| 9167 | "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the |
| 9168 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 9169 | "metadata": { # Metadata about a field. # Metadata about the phone number. |
| 9170 | "source": { # The source of a field. # The source of the field. |
| 9171 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 9172 | # |
| 9173 | # Last update timestamp of this source. |
| 9174 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 9175 | # |
| 9176 | # Metadata about a source of type PROFILE. |
| 9177 | "userTypes": [ # Output only. The user types. |
| 9178 | "A String", |
| 9179 | ], |
| 9180 | "objectType": "A String", # Output only. The profile object type. |
| 9181 | }, |
| 9182 | "type": "A String", # The source type. |
| 9183 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 9184 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 9185 | # |
| 9186 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 9187 | # source. Used for web cache validation. |
| 9188 | }, |
| 9189 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 9190 | # verified field is typically a name, email address, phone number, or |
| 9191 | # website that has been confirmed to be owned by the person. |
| 9192 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 9193 | # field. |
| 9194 | }, |
| 9195 | }, |
| 9196 | ], |
| 9197 | "occupations": [ # The person's occupations. |
| 9198 | { # A person's occupation. |
| 9199 | "value": "A String", # The occupation; for example, `carpenter`. |
| 9200 | "metadata": { # Metadata about a field. # Metadata about the occupation. |
| 9201 | "source": { # The source of a field. # The source of the field. |
| 9202 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 9203 | # |
| 9204 | # Last update timestamp of this source. |
| 9205 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 9206 | # |
| 9207 | # Metadata about a source of type PROFILE. |
| 9208 | "userTypes": [ # Output only. The user types. |
| 9209 | "A String", |
| 9210 | ], |
| 9211 | "objectType": "A String", # Output only. The profile object type. |
| 9212 | }, |
| 9213 | "type": "A String", # The source type. |
| 9214 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 9215 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 9216 | # |
| 9217 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 9218 | # source. Used for web cache validation. |
| 9219 | }, |
| 9220 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 9221 | # verified field is typically a name, email address, phone number, or |
| 9222 | # website that has been confirmed to be owned by the person. |
| 9223 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 9224 | # field. |
| 9225 | }, |
| 9226 | }, |
| 9227 | ], |
| 9228 | "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) |
| 9229 | # |
| 9230 | # The person's age range. |
| 9231 | "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 9232 | # resource. Used for web cache validation. |
| 9233 | "biographies": [ # The person's biographies. |
| 9234 | { # A person's short biography. |
| 9235 | "metadata": { # Metadata about a field. # Metadata about the biography. |
| 9236 | "source": { # The source of a field. # The source of the field. |
| 9237 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 9238 | # |
| 9239 | # Last update timestamp of this source. |
| 9240 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 9241 | # |
| 9242 | # Metadata about a source of type PROFILE. |
| 9243 | "userTypes": [ # Output only. The user types. |
| 9244 | "A String", |
| 9245 | ], |
| 9246 | "objectType": "A String", # Output only. The profile object type. |
| 9247 | }, |
| 9248 | "type": "A String", # The source type. |
| 9249 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 9250 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 9251 | # |
| 9252 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 9253 | # source. Used for web cache validation. |
| 9254 | }, |
| 9255 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 9256 | # verified field is typically a name, email address, phone number, or |
| 9257 | # website that has been confirmed to be owned by the person. |
| 9258 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 9259 | # field. |
| 9260 | }, |
| 9261 | "contentType": "A String", # The content type of the biography. |
| 9262 | "value": "A String", # The short biography. |
| 9263 | }, |
| 9264 | ], |
| 9265 | "locales": [ # The person's locale preferences. |
| 9266 | { # A person's locale preference. |
| 9267 | "metadata": { # Metadata about a field. # Metadata about the locale. |
| 9268 | "source": { # The source of a field. # The source of the field. |
| 9269 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 9270 | # |
| 9271 | # Last update timestamp of this source. |
| 9272 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 9273 | # |
| 9274 | # Metadata about a source of type PROFILE. |
| 9275 | "userTypes": [ # Output only. The user types. |
| 9276 | "A String", |
| 9277 | ], |
| 9278 | "objectType": "A String", # Output only. The profile object type. |
| 9279 | }, |
| 9280 | "type": "A String", # The source type. |
| 9281 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 9282 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 9283 | # |
| 9284 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 9285 | # source. Used for web cache validation. |
| 9286 | }, |
| 9287 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 9288 | # verified field is typically a name, email address, phone number, or |
| 9289 | # website that has been confirmed to be owned by the person. |
| 9290 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 9291 | # field. |
| 9292 | }, |
| 9293 | "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) |
| 9294 | # language tag representing the locale. |
| 9295 | }, |
| 9296 | ], |
| 9297 | "taglines": [ # Output only. **DEPRECATED**: No data will be returned |
| 9298 | # The person's taglines. |
| 9299 | { # **DEPRECATED**: No data will be returned |
| 9300 | # A brief one-line description of the person. |
| 9301 | "metadata": { # Metadata about a field. # Metadata about the tagline. |
| 9302 | "source": { # The source of a field. # The source of the field. |
| 9303 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 9304 | # |
| 9305 | # Last update timestamp of this source. |
| 9306 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 9307 | # |
| 9308 | # Metadata about a source of type PROFILE. |
| 9309 | "userTypes": [ # Output only. The user types. |
| 9310 | "A String", |
| 9311 | ], |
| 9312 | "objectType": "A String", # Output only. The profile object type. |
| 9313 | }, |
| 9314 | "type": "A String", # The source type. |
| 9315 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 9316 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 9317 | # |
| 9318 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 9319 | # source. Used for web cache validation. |
| 9320 | }, |
| 9321 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 9322 | # verified field is typically a name, email address, phone number, or |
| 9323 | # website that has been confirmed to be owned by the person. |
| 9324 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 9325 | # field. |
| 9326 | }, |
| 9327 | "value": "A String", # The tagline. |
| 9328 | }, |
| 9329 | ], |
| 9330 | "organizations": [ # The person's past or current organizations. |
| 9331 | { # A person's past or current organization. Overlapping date ranges are |
| 9332 | # permitted. |
| 9333 | "title": "A String", # The person's job title at the organization. |
| 9334 | "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker |
| 9335 | # symbol, abbreviation, or acronym. |
| 9336 | "name": "A String", # The name of the organization. |
| 9337 | "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The start date when the person joined the organization. |
| 9338 | # and time zone are either specified elsewhere or are not significant. The date |
| 9339 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 9340 | # |
| 9341 | # * A full date, with non-zero year, month and day values |
| 9342 | # * A month and day value, with a zero year, e.g. an anniversary |
| 9343 | # * A year on its own, with zero month and day values |
| 9344 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 9345 | # |
| 9346 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 9347 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 9348 | # a year. |
| 9349 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 9350 | # month and day. |
| 9351 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 9352 | # if specifying a year by itself or a year and month where the day is not |
| 9353 | # significant. |
| 9354 | }, |
| 9355 | "department": "A String", # The person's department at the organization. |
| 9356 | "current": True or False, # True if the organization is the person's current organization; |
| 9357 | # false if the organization is a past organization. |
| 9358 | "location": "A String", # The location of the organization office the person works at. |
| 9359 | "domain": "A String", # The domain name associated with the organization; for example, |
| 9360 | # `google.com`. |
| 9361 | "metadata": { # Metadata about a field. # Metadata about the organization. |
| 9362 | "source": { # The source of a field. # The source of the field. |
| 9363 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 9364 | # |
| 9365 | # Last update timestamp of this source. |
| 9366 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 9367 | # |
| 9368 | # Metadata about a source of type PROFILE. |
| 9369 | "userTypes": [ # Output only. The user types. |
| 9370 | "A String", |
| 9371 | ], |
| 9372 | "objectType": "A String", # Output only. The profile object type. |
| 9373 | }, |
| 9374 | "type": "A String", # The source type. |
| 9375 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 9376 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 9377 | # |
| 9378 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 9379 | # source. Used for web cache validation. |
| 9380 | }, |
| 9381 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 9382 | # verified field is typically a name, email address, phone number, or |
| 9383 | # website that has been confirmed to be owned by the person. |
| 9384 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 9385 | # field. |
| 9386 | }, |
| 9387 | "jobDescription": "A String", # The person's job description at the organization. |
| 9388 | "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The end date when the person left the organization. |
| 9389 | # and time zone are either specified elsewhere or are not significant. The date |
| 9390 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 9391 | # |
| 9392 | # * A full date, with non-zero year, month and day values |
| 9393 | # * A month and day value, with a zero year, e.g. an anniversary |
| 9394 | # * A year on its own, with zero month and day values |
| 9395 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 9396 | # |
| 9397 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 9398 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 9399 | # a year. |
| 9400 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 9401 | # month and day. |
| 9402 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 9403 | # if specifying a year by itself or a year and month where the day is not |
| 9404 | # significant. |
| 9405 | }, |
| 9406 | "phoneticName": "A String", # The phonetic name of the organization. |
| 9407 | "formattedType": "A String", # Output only. The type of the organization translated and formatted in the |
| 9408 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 9409 | "type": "A String", # The type of the organization. The type can be custom or one of these |
| 9410 | # predefined values: |
| 9411 | # |
| 9412 | # * `work` |
| 9413 | # * `school` |
| 9414 | }, |
| 9415 | ], |
| 9416 | "residences": [ # The person's residences. |
| 9417 | { # A person's past or current residence. |
| 9418 | "metadata": { # Metadata about a field. # Metadata about the residence. |
| 9419 | "source": { # The source of a field. # The source of the field. |
| 9420 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 9421 | # |
| 9422 | # Last update timestamp of this source. |
| 9423 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 9424 | # |
| 9425 | # Metadata about a source of type PROFILE. |
| 9426 | "userTypes": [ # Output only. The user types. |
| 9427 | "A String", |
| 9428 | ], |
| 9429 | "objectType": "A String", # Output only. The profile object type. |
| 9430 | }, |
| 9431 | "type": "A String", # The source type. |
| 9432 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 9433 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 9434 | # |
| 9435 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 9436 | # source. Used for web cache validation. |
| 9437 | }, |
| 9438 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 9439 | # verified field is typically a name, email address, phone number, or |
| 9440 | # website that has been confirmed to be owned by the person. |
| 9441 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 9442 | # field. |
| 9443 | }, |
| 9444 | "current": True or False, # True if the residence is the person's current residence; |
| 9445 | # false if the residence is a past residence. |
| 9446 | "value": "A String", # The address of the residence. |
| 9447 | }, |
| 9448 | ], |
| 9449 | "genders": [ # The person's genders. |
| 9450 | { # A person's gender. |
| 9451 | "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account |
| 9452 | # locale or the `Accept-Language` HTTP header locale. Unspecified or custom |
| 9453 | # value are not localized. |
| 9454 | "metadata": { # Metadata about a field. # Metadata about the gender. |
| 9455 | "source": { # The source of a field. # The source of the field. |
| 9456 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 9457 | # |
| 9458 | # Last update timestamp of this source. |
| 9459 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 9460 | # |
| 9461 | # Metadata about a source of type PROFILE. |
| 9462 | "userTypes": [ # Output only. The user types. |
| 9463 | "A String", |
| 9464 | ], |
| 9465 | "objectType": "A String", # Output only. The profile object type. |
| 9466 | }, |
| 9467 | "type": "A String", # The source type. |
| 9468 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 9469 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 9470 | # |
| 9471 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 9472 | # source. Used for web cache validation. |
| 9473 | }, |
| 9474 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 9475 | # verified field is typically a name, email address, phone number, or |
| 9476 | # website that has been confirmed to be owned by the person. |
| 9477 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 9478 | # field. |
| 9479 | }, |
| 9480 | "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value |
| 9481 | # can be custom or one of these predefined values: |
| 9482 | # |
| 9483 | # * `male` |
| 9484 | # * `female` |
| 9485 | # * `other` |
| 9486 | "value": "A String", # The gender for the person. The gender can be custom or one of these |
| 9487 | # predefined values: |
| 9488 | # |
| 9489 | # * `male` |
| 9490 | # * `female` |
| 9491 | # * `unspecified` |
| 9492 | }, |
| 9493 | ], |
| 9494 | "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned |
| 9495 | # The person's relationship interests. |
| 9496 | { # **DEPRECATED**: No data will be returned |
| 9497 | # A person's relationship interest . |
| 9498 | "formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted |
| 9499 | # in the viewer's account locale or the locale specified in the |
| 9500 | # Accept-Language HTTP header. |
| 9501 | "metadata": { # Metadata about a field. # Metadata about the relationship interest. |
| 9502 | "source": { # The source of a field. # The source of the field. |
| 9503 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 9504 | # |
| 9505 | # Last update timestamp of this source. |
| 9506 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 9507 | # |
| 9508 | # Metadata about a source of type PROFILE. |
| 9509 | "userTypes": [ # Output only. The user types. |
| 9510 | "A String", |
| 9511 | ], |
| 9512 | "objectType": "A String", # Output only. The profile object type. |
| 9513 | }, |
| 9514 | "type": "A String", # The source type. |
| 9515 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 9516 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 9517 | # |
| 9518 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 9519 | # source. Used for web cache validation. |
| 9520 | }, |
| 9521 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 9522 | # verified field is typically a name, email address, phone number, or |
| 9523 | # website that has been confirmed to be owned by the person. |
| 9524 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 9525 | # field. |
| 9526 | }, |
| 9527 | "value": "A String", # The kind of relationship the person is looking for. The value can be custom |
| 9528 | # or one of these predefined values: |
| 9529 | # |
| 9530 | # * `friend` |
| 9531 | # * `date` |
| 9532 | # * `relationship` |
| 9533 | # * `networking` |
| 9534 | }, |
| 9535 | ], |
| 9536 | "metadata": { # The metadata about a person. # Output only. Metadata about the person. |
| 9537 | "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for |
| 9538 | # [`connections.list`](/people/api/rest/v1/people.connections/list) requests |
| 9539 | # that include a sync token. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 9540 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9541 | # The resource name may change when adding or removing fields that link a |
| 9542 | # contact and profile such as a verified email, verified phone number, or |
| 9543 | # profile URL. |
| 9544 | "A String", |
| 9545 | ], |
| 9546 | "sources": [ # The sources of data for the person. |
| 9547 | { # The source of a field. |
| 9548 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 9549 | # |
| 9550 | # Last update timestamp of this source. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9551 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 9552 | # |
| 9553 | # Metadata about a source of type PROFILE. |
| 9554 | "userTypes": [ # Output only. The user types. |
| 9555 | "A String", |
| 9556 | ], |
| 9557 | "objectType": "A String", # Output only. The profile object type. |
| 9558 | }, |
| 9559 | "type": "A String", # The source type. |
| 9560 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 9561 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 9562 | # |
| 9563 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 9564 | # source. Used for web cache validation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 9565 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9566 | ], |
| 9567 | "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource. |
| 9568 | "A String", |
| 9569 | ], |
| 9570 | "objectType": "A String", # Output only. **DEPRECATED** (Please use |
| 9571 | # `person.metadata.sources.profileMetadata.objectType` instead) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 9572 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9573 | # The type of the person object. |
| 9574 | "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for |
| 9575 | # [`connections.list`](/people/api/rest/v1/people.connections/list) requests |
| 9576 | # that include a sync token. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 9577 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9578 | "memberships": [ # The person's group memberships. |
| 9579 | { # A person's membership in a group. Only contact group memberships can be |
| 9580 | # modified. |
| 9581 | "metadata": { # Metadata about a field. # Metadata about the membership. |
| 9582 | "source": { # The source of a field. # The source of the field. |
| 9583 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 9584 | # |
| 9585 | # Last update timestamp of this source. |
| 9586 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 9587 | # |
| 9588 | # Metadata about a source of type PROFILE. |
| 9589 | "userTypes": [ # Output only. The user types. |
| 9590 | "A String", |
| 9591 | ], |
| 9592 | "objectType": "A String", # Output only. The profile object type. |
| 9593 | }, |
| 9594 | "type": "A String", # The source type. |
| 9595 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 9596 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 9597 | # |
| 9598 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 9599 | # source. Used for web cache validation. |
| 9600 | }, |
| 9601 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 9602 | # verified field is typically a name, email address, phone number, or |
| 9603 | # website that has been confirmed to be owned by the person. |
| 9604 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 9605 | # field. |
| 9606 | }, |
| 9607 | "contactGroupMembership": { # A Google contact group membership. # The contact group membership. |
| 9608 | "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership. |
| 9609 | "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII |
| 9610 | # string, in the form of `contactGroups/{contact_group_id}`. |
| 9611 | # Only contact_group_resource_name can be used for modifying memberships. |
| 9612 | # Any contact group membership can be removed, but only user group or |
| 9613 | # "myContacts" or "starred" system groups memberships can be added. A |
| 9614 | # contact must always have at least one contact group membership. |
| 9615 | }, |
| 9616 | "domainMembership": { # A G Suite Domain membership. # Output only. The domain membership. |
| 9617 | "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain. |
| 9618 | }, |
| 9619 | }, |
| 9620 | ], |
| 9621 | "birthdays": [ # The person's birthdays. |
| 9622 | { # A person's birthday. At least one of the `date` and `text` fields are |
| 9623 | # specified. The `date` and `text` fields typically represent the same |
| 9624 | # date, but are not guaranteed to. |
| 9625 | "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the birthday. |
| 9626 | # and time zone are either specified elsewhere or are not significant. The date |
| 9627 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 9628 | # |
| 9629 | # * A full date, with non-zero year, month and day values |
| 9630 | # * A month and day value, with a zero year, e.g. an anniversary |
| 9631 | # * A year on its own, with zero month and day values |
| 9632 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 9633 | # |
| 9634 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 9635 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 9636 | # a year. |
| 9637 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 9638 | # month and day. |
| 9639 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 9640 | # if specifying a year by itself or a year and month where the day is not |
| 9641 | # significant. |
| 9642 | }, |
| 9643 | "metadata": { # Metadata about a field. # Metadata about the birthday. |
| 9644 | "source": { # The source of a field. # The source of the field. |
| 9645 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 9646 | # |
| 9647 | # Last update timestamp of this source. |
| 9648 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 9649 | # |
| 9650 | # Metadata about a source of type PROFILE. |
| 9651 | "userTypes": [ # Output only. The user types. |
| 9652 | "A String", |
| 9653 | ], |
| 9654 | "objectType": "A String", # Output only. The profile object type. |
| 9655 | }, |
| 9656 | "type": "A String", # The source type. |
| 9657 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 9658 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 9659 | # |
| 9660 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 9661 | # source. Used for web cache validation. |
| 9662 | }, |
| 9663 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 9664 | # verified field is typically a name, email address, phone number, or |
| 9665 | # website that has been confirmed to be owned by the person. |
| 9666 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 9667 | # field. |
| 9668 | }, |
| 9669 | "text": "A String", # A free-form string representing the user's birthday. |
| 9670 | }, |
| 9671 | ], |
| 9672 | "imClients": [ # The person's instant messaging clients. |
| 9673 | { # A person's instant messaging client. |
| 9674 | "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the |
| 9675 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 9676 | "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these |
| 9677 | # predefined values: |
| 9678 | # |
| 9679 | # * `aim` |
| 9680 | # * `msn` |
| 9681 | # * `yahoo` |
| 9682 | # * `skype` |
| 9683 | # * `qq` |
| 9684 | # * `googleTalk` |
| 9685 | # * `icq` |
| 9686 | # * `jabber` |
| 9687 | # * `netMeeting` |
| 9688 | "username": "A String", # The user name used in the IM client. |
| 9689 | "type": "A String", # The type of the IM client. The type can be custom or one of these |
| 9690 | # predefined values: |
| 9691 | # |
| 9692 | # * `home` |
| 9693 | # * `work` |
| 9694 | # * `other` |
| 9695 | "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account |
| 9696 | # locale or the `Accept-Language` HTTP header locale. |
| 9697 | "metadata": { # Metadata about a field. # Metadata about the IM client. |
| 9698 | "source": { # The source of a field. # The source of the field. |
| 9699 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 9700 | # |
| 9701 | # Last update timestamp of this source. |
| 9702 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 9703 | # |
| 9704 | # Metadata about a source of type PROFILE. |
| 9705 | "userTypes": [ # Output only. The user types. |
| 9706 | "A String", |
| 9707 | ], |
| 9708 | "objectType": "A String", # Output only. The profile object type. |
| 9709 | }, |
| 9710 | "type": "A String", # The source type. |
| 9711 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 9712 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 9713 | # |
| 9714 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 9715 | # source. Used for web cache validation. |
| 9716 | }, |
| 9717 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 9718 | # verified field is typically a name, email address, phone number, or |
| 9719 | # website that has been confirmed to be owned by the person. |
| 9720 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 9721 | # field. |
| 9722 | }, |
| 9723 | }, |
| 9724 | ], |
| 9725 | "skills": [ # The person's skills. |
| 9726 | { # A skill that the person has. |
| 9727 | "metadata": { # Metadata about a field. # Metadata about the skill. |
| 9728 | "source": { # The source of a field. # The source of the field. |
| 9729 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 9730 | # |
| 9731 | # Last update timestamp of this source. |
| 9732 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 9733 | # |
| 9734 | # Metadata about a source of type PROFILE. |
| 9735 | "userTypes": [ # Output only. The user types. |
| 9736 | "A String", |
| 9737 | ], |
| 9738 | "objectType": "A String", # Output only. The profile object type. |
| 9739 | }, |
| 9740 | "type": "A String", # The source type. |
| 9741 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 9742 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 9743 | # |
| 9744 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 9745 | # source. Used for web cache validation. |
| 9746 | }, |
| 9747 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 9748 | # verified field is typically a name, email address, phone number, or |
| 9749 | # website that has been confirmed to be owned by the person. |
| 9750 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 9751 | # field. |
| 9752 | }, |
| 9753 | "value": "A String", # The skill; for example, `underwater basket weaving`. |
| 9754 | }, |
| 9755 | ], |
| 9756 | "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned |
| 9757 | # The person's relationship statuses. |
| 9758 | { # **DEPRECATED**: No data will be returned |
| 9759 | # A person's relationship status. |
| 9760 | "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in |
| 9761 | # the viewer's account locale or the `Accept-Language` HTTP header locale. |
| 9762 | "metadata": { # Metadata about a field. # Metadata about the relationship status. |
| 9763 | "source": { # The source of a field. # The source of the field. |
| 9764 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 9765 | # |
| 9766 | # Last update timestamp of this source. |
| 9767 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 9768 | # |
| 9769 | # Metadata about a source of type PROFILE. |
| 9770 | "userTypes": [ # Output only. The user types. |
| 9771 | "A String", |
| 9772 | ], |
| 9773 | "objectType": "A String", # Output only. The profile object type. |
| 9774 | }, |
| 9775 | "type": "A String", # The source type. |
| 9776 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 9777 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 9778 | # |
| 9779 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 9780 | # source. Used for web cache validation. |
| 9781 | }, |
| 9782 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 9783 | # verified field is typically a name, email address, phone number, or |
| 9784 | # website that has been confirmed to be owned by the person. |
| 9785 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 9786 | # field. |
| 9787 | }, |
| 9788 | "value": "A String", # The relationship status. The value can be custom or one of these |
| 9789 | # predefined values: |
| 9790 | # |
| 9791 | # * `single` |
| 9792 | # * `inARelationship` |
| 9793 | # * `engaged` |
| 9794 | # * `married` |
| 9795 | # * `itsComplicated` |
| 9796 | # * `openRelationship` |
| 9797 | # * `widowed` |
| 9798 | # * `inDomesticPartnership` |
| 9799 | # * `inCivilUnion` |
| 9800 | }, |
| 9801 | ], |
| 9802 | "coverPhotos": [ # Output only. The person's cover photos. |
| 9803 | { # A person's cover photo. A large image shown on the person's |
| 9804 | # profile page that represents who they are or what they care about. |
| 9805 | "url": "A String", # The URL of the cover photo. |
| 9806 | "default": True or False, # True if the cover photo is the default cover photo; |
| 9807 | # false if the cover photo is a user-provided cover photo. |
| 9808 | "metadata": { # Metadata about a field. # Metadata about the cover photo. |
| 9809 | "source": { # The source of a field. # The source of the field. |
| 9810 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 9811 | # |
| 9812 | # Last update timestamp of this source. |
| 9813 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 9814 | # |
| 9815 | # Metadata about a source of type PROFILE. |
| 9816 | "userTypes": [ # Output only. The user types. |
| 9817 | "A String", |
| 9818 | ], |
| 9819 | "objectType": "A String", # Output only. The profile object type. |
| 9820 | }, |
| 9821 | "type": "A String", # The source type. |
| 9822 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 9823 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 9824 | # |
| 9825 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 9826 | # source. Used for web cache validation. |
| 9827 | }, |
| 9828 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 9829 | # verified field is typically a name, email address, phone number, or |
| 9830 | # website that has been confirmed to be owned by the person. |
| 9831 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 9832 | # field. |
| 9833 | }, |
| 9834 | }, |
| 9835 | ], |
| 9836 | "names": [ # The person's names. |
| 9837 | { # A person's name. If the name is a mononym, the family name is empty. |
| 9838 | "middleName": "A String", # The middle name(s). |
| 9839 | "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound. |
| 9840 | "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to |
| 9841 | # the locale specified by the viewer's account or the |
| 9842 | # `Accept-Language` HTTP header. |
| 9843 | "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.` |
| 9844 | "familyName": "A String", # The family name. |
| 9845 | "phoneticGivenName": "A String", # The given name spelled as it sounds. |
| 9846 | "metadata": { # Metadata about a field. # Metadata about the name. |
| 9847 | "source": { # The source of a field. # The source of the field. |
| 9848 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 9849 | # |
| 9850 | # Last update timestamp of this source. |
| 9851 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 9852 | # |
| 9853 | # Metadata about a source of type PROFILE. |
| 9854 | "userTypes": [ # Output only. The user types. |
| 9855 | "A String", |
| 9856 | ], |
| 9857 | "objectType": "A String", # Output only. The profile object type. |
| 9858 | }, |
| 9859 | "type": "A String", # The source type. |
| 9860 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 9861 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 9862 | # |
| 9863 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 9864 | # source. Used for web cache validation. |
| 9865 | }, |
| 9866 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 9867 | # verified field is typically a name, email address, phone number, or |
| 9868 | # website that has been confirmed to be owned by the person. |
| 9869 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 9870 | # field. |
| 9871 | }, |
| 9872 | "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound. |
| 9873 | "displayName": "A String", # Output only. The display name formatted according to the locale specified by |
| 9874 | # the viewer's account or the `Accept-Language` HTTP header. |
| 9875 | "phoneticFamilyName": "A String", # The family name spelled as it sounds. |
| 9876 | "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.` |
| 9877 | "givenName": "A String", # The given name. |
| 9878 | "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound. |
| 9879 | "phoneticFullName": "A String", # The full name spelled as it sounds. |
| 9880 | }, |
| 9881 | ], |
| 9882 | "relations": [ # The person's relations. |
| 9883 | { # A person's relation to another person. |
| 9884 | "type": "A String", # The person's relation to the other person. The type can be custom or one of |
| 9885 | # these predefined values: |
| 9886 | # |
| 9887 | # * `spouse` |
| 9888 | # * `child` |
| 9889 | # * `mother` |
| 9890 | # * `father` |
| 9891 | # * `parent` |
| 9892 | # * `brother` |
| 9893 | # * `sister` |
| 9894 | # * `friend` |
| 9895 | # * `relative` |
| 9896 | # * `domesticPartner` |
| 9897 | # * `manager` |
| 9898 | # * `assistant` |
| 9899 | # * `referredBy` |
| 9900 | # * `partner` |
| 9901 | "metadata": { # Metadata about a field. # Metadata about the relation. |
| 9902 | "source": { # The source of a field. # The source of the field. |
| 9903 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 9904 | # |
| 9905 | # Last update timestamp of this source. |
| 9906 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 9907 | # |
| 9908 | # Metadata about a source of type PROFILE. |
| 9909 | "userTypes": [ # Output only. The user types. |
| 9910 | "A String", |
| 9911 | ], |
| 9912 | "objectType": "A String", # Output only. The profile object type. |
| 9913 | }, |
| 9914 | "type": "A String", # The source type. |
| 9915 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 9916 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 9917 | # |
| 9918 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 9919 | # source. Used for web cache validation. |
| 9920 | }, |
| 9921 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 9922 | # verified field is typically a name, email address, phone number, or |
| 9923 | # website that has been confirmed to be owned by the person. |
| 9924 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 9925 | # field. |
| 9926 | }, |
| 9927 | "person": "A String", # The name of the other person this relation refers to. |
| 9928 | "formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's |
| 9929 | # account locale or the locale specified in the Accept-Language HTTP header. |
| 9930 | }, |
| 9931 | ], |
| 9932 | "ageRanges": [ # Output only. The person's age ranges. |
| 9933 | { # A person's age range. |
| 9934 | "metadata": { # Metadata about a field. # Metadata about the age range. |
| 9935 | "source": { # The source of a field. # The source of the field. |
| 9936 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 9937 | # |
| 9938 | # Last update timestamp of this source. |
| 9939 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 9940 | # |
| 9941 | # Metadata about a source of type PROFILE. |
| 9942 | "userTypes": [ # Output only. The user types. |
| 9943 | "A String", |
| 9944 | ], |
| 9945 | "objectType": "A String", # Output only. The profile object type. |
| 9946 | }, |
| 9947 | "type": "A String", # The source type. |
| 9948 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 9949 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 9950 | # |
| 9951 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 9952 | # source. Used for web cache validation. |
| 9953 | }, |
| 9954 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 9955 | # verified field is typically a name, email address, phone number, or |
| 9956 | # website that has been confirmed to be owned by the person. |
| 9957 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 9958 | # field. |
| 9959 | }, |
| 9960 | "ageRange": "A String", # The age range. |
| 9961 | }, |
| 9962 | ], |
| 9963 | "braggingRights": [ # **DEPRECATED**: No data will be returned |
| 9964 | # The person's bragging rights. |
| 9965 | { # **DEPRECATED**: No data will be returned |
| 9966 | # A person's bragging rights. |
| 9967 | "value": "A String", # The bragging rights; for example, `climbed mount everest`. |
| 9968 | "metadata": { # Metadata about a field. # Metadata about the bragging rights. |
| 9969 | "source": { # The source of a field. # The source of the field. |
| 9970 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 9971 | # |
| 9972 | # Last update timestamp of this source. |
| 9973 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 9974 | # |
| 9975 | # Metadata about a source of type PROFILE. |
| 9976 | "userTypes": [ # Output only. The user types. |
| 9977 | "A String", |
| 9978 | ], |
| 9979 | "objectType": "A String", # Output only. The profile object type. |
| 9980 | }, |
| 9981 | "type": "A String", # The source type. |
| 9982 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 9983 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 9984 | # |
| 9985 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 9986 | # source. Used for web cache validation. |
| 9987 | }, |
| 9988 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 9989 | # verified field is typically a name, email address, phone number, or |
| 9990 | # website that has been confirmed to be owned by the person. |
| 9991 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 9992 | # field. |
| 9993 | }, |
| 9994 | }, |
| 9995 | ], |
| 9996 | "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string |
| 9997 | # with a max length of 27 characters, in the form of |
| 9998 | # `people/{person_id}`. |
| 9999 | "photos": [ # Output only. The person's photos. |
| 10000 | { # A person's photo. A picture shown next to the person's name to |
| 10001 | # help others recognize the person. |
| 10002 | "url": "A String", # The URL of the photo. You can change the desired size by appending a query |
| 10003 | # parameter `sz={size}` at the end of the url, where {size} is the size in |
| 10004 | # pixels. Example: |
| 10005 | # https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50 |
| 10006 | "default": True or False, # True if the photo is a default photo; |
| 10007 | # false if the photo is a user-provided photo. |
| 10008 | "metadata": { # Metadata about a field. # Metadata about the photo. |
| 10009 | "source": { # The source of a field. # The source of the field. |
| 10010 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 10011 | # |
| 10012 | # Last update timestamp of this source. |
| 10013 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 10014 | # |
| 10015 | # Metadata about a source of type PROFILE. |
| 10016 | "userTypes": [ # Output only. The user types. |
| 10017 | "A String", |
| 10018 | ], |
| 10019 | "objectType": "A String", # Output only. The profile object type. |
| 10020 | }, |
| 10021 | "type": "A String", # The source type. |
| 10022 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 10023 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 10024 | # |
| 10025 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 10026 | # source. Used for web cache validation. |
| 10027 | }, |
| 10028 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 10029 | # verified field is typically a name, email address, phone number, or |
| 10030 | # website that has been confirmed to be owned by the person. |
| 10031 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 10032 | # field. |
| 10033 | }, |
| 10034 | }, |
| 10035 | ], |
| 10036 | "addresses": [ # The person's street addresses. |
| 10037 | { # A person's physical address. May be a P.O. box or street address. All fields |
| 10038 | # are optional. |
| 10039 | "streetAddress": "A String", # The street address. |
| 10040 | "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it |
| 10041 | # will be automatically constructed from structured values. |
| 10042 | "country": "A String", # The country of the address. |
| 10043 | "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's |
| 10044 | # account locale or the `Accept-Language` HTTP header locale. |
| 10045 | "city": "A String", # The city of the address. |
| 10046 | "postalCode": "A String", # The postal code of the address. |
| 10047 | "extendedAddress": "A String", # The extended address of the address; for example, the apartment number. |
| 10048 | "type": "A String", # The type of the address. The type can be custom or one of these predefined |
| 10049 | # values: |
| 10050 | # |
| 10051 | # * `home` |
| 10052 | # * `work` |
| 10053 | # * `other` |
| 10054 | "region": "A String", # The region of the address; for example, the state or province. |
| 10055 | "poBox": "A String", # The P.O. box of the address. |
| 10056 | "metadata": { # Metadata about a field. # Metadata about the address. |
| 10057 | "source": { # The source of a field. # The source of the field. |
| 10058 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 10059 | # |
| 10060 | # Last update timestamp of this source. |
| 10061 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 10062 | # |
| 10063 | # Metadata about a source of type PROFILE. |
| 10064 | "userTypes": [ # Output only. The user types. |
| 10065 | "A String", |
| 10066 | ], |
| 10067 | "objectType": "A String", # Output only. The profile object type. |
| 10068 | }, |
| 10069 | "type": "A String", # The source type. |
| 10070 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 10071 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 10072 | # |
| 10073 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 10074 | # source. Used for web cache validation. |
| 10075 | }, |
| 10076 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 10077 | # verified field is typically a name, email address, phone number, or |
| 10078 | # website that has been confirmed to be owned by the person. |
| 10079 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 10080 | # field. |
| 10081 | }, |
| 10082 | "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country |
| 10083 | # code of the address. |
| 10084 | }, |
| 10085 | ], |
| 10086 | "emailAddresses": [ # The person's email addresses. |
| 10087 | { # A person's email address. |
| 10088 | "formattedType": "A String", # Output only. The type of the email address translated and formatted in the |
| 10089 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 10090 | "metadata": { # Metadata about a field. # Metadata about the email address. |
| 10091 | "source": { # The source of a field. # The source of the field. |
| 10092 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 10093 | # |
| 10094 | # Last update timestamp of this source. |
| 10095 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 10096 | # |
| 10097 | # Metadata about a source of type PROFILE. |
| 10098 | "userTypes": [ # Output only. The user types. |
| 10099 | "A String", |
| 10100 | ], |
| 10101 | "objectType": "A String", # Output only. The profile object type. |
| 10102 | }, |
| 10103 | "type": "A String", # The source type. |
| 10104 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 10105 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 10106 | # |
| 10107 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 10108 | # source. Used for web cache validation. |
| 10109 | }, |
| 10110 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 10111 | # verified field is typically a name, email address, phone number, or |
| 10112 | # website that has been confirmed to be owned by the person. |
| 10113 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 10114 | # field. |
| 10115 | }, |
| 10116 | "value": "A String", # The email address. |
| 10117 | "displayName": "A String", # The display name of the email. |
| 10118 | "type": "A String", # The type of the email address. The type can be custom or one of these |
| 10119 | # predefined values: |
| 10120 | # |
| 10121 | # * `home` |
| 10122 | # * `work` |
| 10123 | # * `other` |
| 10124 | }, |
| 10125 | ], |
| 10126 | "nicknames": [ # The person's nicknames. |
| 10127 | { # A person's nickname. |
| 10128 | "metadata": { # Metadata about a field. # Metadata about the nickname. |
| 10129 | "source": { # The source of a field. # The source of the field. |
| 10130 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 10131 | # |
| 10132 | # Last update timestamp of this source. |
| 10133 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 10134 | # |
| 10135 | # Metadata about a source of type PROFILE. |
| 10136 | "userTypes": [ # Output only. The user types. |
| 10137 | "A String", |
| 10138 | ], |
| 10139 | "objectType": "A String", # Output only. The profile object type. |
| 10140 | }, |
| 10141 | "type": "A String", # The source type. |
| 10142 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 10143 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 10144 | # |
| 10145 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 10146 | # source. Used for web cache validation. |
| 10147 | }, |
| 10148 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 10149 | # verified field is typically a name, email address, phone number, or |
| 10150 | # website that has been confirmed to be owned by the person. |
| 10151 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 10152 | # field. |
| 10153 | }, |
| 10154 | "type": "A String", # The type of the nickname. |
| 10155 | "value": "A String", # The nickname. |
| 10156 | }, |
| 10157 | ], |
| 10158 | "events": [ # The person's events. |
| 10159 | { # An event related to the person. |
| 10160 | "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the event. |
| 10161 | # and time zone are either specified elsewhere or are not significant. The date |
| 10162 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 10163 | # |
| 10164 | # * A full date, with non-zero year, month and day values |
| 10165 | # * A month and day value, with a zero year, e.g. an anniversary |
| 10166 | # * A year on its own, with zero month and day values |
| 10167 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 10168 | # |
| 10169 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 10170 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 10171 | # a year. |
| 10172 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 10173 | # month and day. |
| 10174 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 10175 | # if specifying a year by itself or a year and month where the day is not |
| 10176 | # significant. |
| 10177 | }, |
| 10178 | "formattedType": "A String", # Output only. The type of the event translated and formatted in the |
| 10179 | # viewer's account locale or the `Accept-Language` HTTP header locale. |
| 10180 | "metadata": { # Metadata about a field. # Metadata about the event. |
| 10181 | "source": { # The source of a field. # The source of the field. |
| 10182 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 10183 | # |
| 10184 | # Last update timestamp of this source. |
| 10185 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 10186 | # |
| 10187 | # Metadata about a source of type PROFILE. |
| 10188 | "userTypes": [ # Output only. The user types. |
| 10189 | "A String", |
| 10190 | ], |
| 10191 | "objectType": "A String", # Output only. The profile object type. |
| 10192 | }, |
| 10193 | "type": "A String", # The source type. |
| 10194 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 10195 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 10196 | # |
| 10197 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 10198 | # source. Used for web cache validation. |
| 10199 | }, |
| 10200 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 10201 | # verified field is typically a name, email address, phone number, or |
| 10202 | # website that has been confirmed to be owned by the person. |
| 10203 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 10204 | # field. |
| 10205 | }, |
| 10206 | "type": "A String", # The type of the event. The type can be custom or one of these predefined |
| 10207 | # values: |
| 10208 | # |
| 10209 | # * `anniversary` |
| 10210 | # * `other` |
| 10211 | }, |
| 10212 | ], |
| 10213 | "urls": [ # The person's associated URLs. |
| 10214 | { # A person's associated URLs. |
| 10215 | "type": "A String", # The type of the URL. The type can be custom or one of these predefined |
| 10216 | # values: |
| 10217 | # |
| 10218 | # * `home` |
| 10219 | # * `work` |
| 10220 | # * `blog` |
| 10221 | # * `profile` |
| 10222 | # * `homePage` |
| 10223 | # * `ftp` |
| 10224 | # * `reservations` |
| 10225 | # * `appInstallPage`: website for a Google+ application. |
| 10226 | # * `other` |
| 10227 | "metadata": { # Metadata about a field. # Metadata about the URL. |
| 10228 | "source": { # The source of a field. # The source of the field. |
| 10229 | "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** |
| 10230 | # |
| 10231 | # Last update timestamp of this source. |
| 10232 | "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** |
| 10233 | # |
| 10234 | # Metadata about a source of type PROFILE. |
| 10235 | "userTypes": [ # Output only. The user types. |
| 10236 | "A String", |
| 10237 | ], |
| 10238 | "objectType": "A String", # Output only. The profile object type. |
| 10239 | }, |
| 10240 | "type": "A String", # The source type. |
| 10241 | "id": "A String", # The unique identifier within the source type generated by the server. |
| 10242 | "etag": "A String", # **Only populated in `person.metadata.sources`.** |
| 10243 | # |
| 10244 | # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the |
| 10245 | # source. Used for web cache validation. |
| 10246 | }, |
| 10247 | "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A |
| 10248 | # verified field is typically a name, email address, phone number, or |
| 10249 | # website that has been confirmed to be owned by the person. |
| 10250 | "primary": True or False, # True if the field is the primary field; false if the field is a secondary |
| 10251 | # field. |
| 10252 | }, |
| 10253 | "formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's |
| 10254 | # account locale or the `Accept-Language` HTTP header locale. |
| 10255 | "value": "A String", # The URL. |
| 10256 | }, |
| 10257 | ], |
| 10258 | }, |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 10259 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 10260 | </div> |
| 10261 | |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 10262 | </body></html> |