Skip to content

Commit a646e56

Browse files
feat(people): update the api
#### people:v1 The following keys were added: - resources.otherContacts.methods.list.parameters.sources (Total Keys: 3)
1 parent e7a88ca commit a646e56

File tree

4 files changed

+140
-116
lines changed

4 files changed

+140
-116
lines changed

docs/dyn/people_v1.otherContacts.html

Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@ <h2>Instance Methods</h2>
8181
<code><a href="#copyOtherContactToMyContactsGroup">copyOtherContactToMyContactsGroup(resourceName, body=None, x__xgafv=None)</a></code></p>
8282
<p class="firstline">Copies an "Other contact" to a new contact in the user's "myContacts" group</p>
8383
<p class="toc_element">
84-
<code><a href="#list">list(pageSize=None, pageToken=None, readMask=None, requestSyncToken=None, syncToken=None, x__xgafv=None)</a></code></p>
85-
<p class="firstline">List all "Other contacts", that is contacts that are not in a contact group. "Other contacts" are typically auto created contacts from interactions.</p>
84+
<code><a href="#list">list(pageSize=None, pageToken=None, readMask=None, requestSyncToken=None, sources=None, syncToken=None, x__xgafv=None)</a></code></p>
85+
<p class="firstline">List all "Other contacts", that is contacts that are not in a contact group. "Other contacts" are typically auto created contacts from interactions. Sync tokens expire 7 days after the full sync. A request with an expired sync token will result in a 410 error. In the case of such an error clients should make a full sync request without a `sync_token`. The first page of a full sync request has an additional quota. If the quota is exceeded, a 429 error will be returned. This quota is fixed and can not be increased. When the `sync_token` is specified, resources deleted since the last sync will be returned as a person with `PersonMetadata.deleted` set to true. When the `page_token` or `sync_token` is specified, all other request parameters must match the first call. See example usage at [List the user's other contacts that have changed](/people/v1/other-contacts#list_the_users_other_contacts_that_have_changed).</p>
8686
<p class="toc_element">
8787
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
8888
<p class="firstline">Retrieves the next page of results.</p>
@@ -310,7 +310,7 @@ <h3>Method Details</h3>
310310
&quot;url&quot;: &quot;A String&quot;, # The URL of the cover photo.
311311
},
312312
],
313-
&quot;emailAddresses&quot;: [ # The person&#x27;s email addresses. For [`connections.list`](/people/api/rest/v1/people.connections/list), [`otherContacts.list`](/people/api/rest/v1/otherContacts/list), and [`people.listDirectoryPeople`](/people/api/rest/v1/people/listDirectoryPeople) the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling [&#x27;people.get&#x27;](/people/api/rest/v1/people/get).
313+
&quot;emailAddresses&quot;: [ # The person&#x27;s email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople.
314314
{ # A person&#x27;s email address.
315315
&quot;displayName&quot;: &quot;A String&quot;, # The display name of the email.
316316
&quot;formattedType&quot;: &quot;A String&quot;, # Output only. The type of the email address translated and formatted in the viewer&#x27;s account locale or the `Accept-Language` HTTP header locale.
@@ -551,12 +551,12 @@ <h3>Method Details</h3>
551551
},
552552
],
553553
&quot;metadata&quot;: { # The metadata about a person. # Output only. Metadata about the person.
554-
&quot;deleted&quot;: True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) and [`otherContacts.list`](/people/api/rest/v1/otherContacts/list) requests that include a sync token.
554+
&quot;deleted&quot;: True or False, # Output only. True if the person resource has been deleted. Populated only for `people.connections.list` and `otherContacts.list` sync requests.
555555
&quot;linkedPeopleResourceNames&quot;: [ # Output only. Resource names of people linked to this resource.
556556
&quot;A String&quot;,
557557
],
558558
&quot;objectType&quot;: &quot;A String&quot;, # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
559-
&quot;previousResourceNames&quot;: [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
559+
&quot;previousResourceNames&quot;: [ # Output only. Any former resource names this person has had. Populated only for `people.connections.list` requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
560560
&quot;A String&quot;,
561561
],
562562
&quot;sources&quot;: [ # The sources of data for the person.
@@ -715,7 +715,7 @@ <h3>Method Details</h3>
715715
&quot;type&quot;: &quot;A String&quot;, # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
716716
},
717717
],
718-
&quot;phoneNumbers&quot;: [ # The person&#x27;s phone numbers. For [`connections.list`](/people/api/rest/v1/people.connections/list), [`otherContacts.list`](/people/api/rest/v1/otherContacts/list), and [`people.listDirectoryPeople`](/people/api/rest/v1/people/listDirectoryPeople) the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling [&#x27;people.get&#x27;](/people/api/rest/v1/people/get).
718+
&quot;phoneNumbers&quot;: [ # The person&#x27;s phone numbers. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople.
719719
{ # A person&#x27;s phone number.
720720
&quot;canonicalForm&quot;: &quot;A String&quot;, # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
721721
&quot;formattedType&quot;: &quot;A String&quot;, # Output only. The type of the phone number translated and formatted in the viewer&#x27;s account locale or the `Accept-Language` HTTP header locale.
@@ -965,15 +965,21 @@ <h3>Method Details</h3>
965965
</div>
966966

967967
<div class="method">
968-
<code class="details" id="list">list(pageSize=None, pageToken=None, readMask=None, requestSyncToken=None, syncToken=None, x__xgafv=None)</code>
969-
<pre>List all &quot;Other contacts&quot;, that is contacts that are not in a contact group. &quot;Other contacts&quot; are typically auto created contacts from interactions.
968+
<code class="details" id="list">list(pageSize=None, pageToken=None, readMask=None, requestSyncToken=None, sources=None, syncToken=None, x__xgafv=None)</code>
969+
<pre>List all &quot;Other contacts&quot;, that is contacts that are not in a contact group. &quot;Other contacts&quot; are typically auto created contacts from interactions. Sync tokens expire 7 days after the full sync. A request with an expired sync token will result in a 410 error. In the case of such an error clients should make a full sync request without a `sync_token`. The first page of a full sync request has an additional quota. If the quota is exceeded, a 429 error will be returned. This quota is fixed and can not be increased. When the `sync_token` is specified, resources deleted since the last sync will be returned as a person with `PersonMetadata.deleted` set to true. When the `page_token` or `sync_token` is specified, all other request parameters must match the first call. See example usage at [List the user&#x27;s other contacts that have changed](/people/v1/other-contacts#list_the_users_other_contacts_that_have_changed).
970970

971971
Args:
972972
pageSize: integer, Optional. The number of &quot;Other contacts&quot; to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.
973-
pageToken: string, Optional. A page token, received from a previous `ListOtherContacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListOtherContacts` must match the call that provided the page token.
973+
pageToken: string, Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `otherContacts.list` must match the first call that provided the page token.
974974
readMask: string, Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * emailAddresses * metadata * names * phoneNumbers * photos
975-
requestSyncToken: boolean, Optional. Whether the response should include `next_sync_token`, which can be used to get all changes since the last request. For subsequent sync requests use the `sync_token` param instead. Initial sync requests that specify `request_sync_token` have an additional rate limit.
976-
syncToken: string, Optional. A sync token, received from a previous `ListOtherContacts` call. Provide this to retrieve only the resources changed since the last request. Sync requests that specify `sync_token` have an additional rate limit. When the `syncToken` is specified, resources deleted since the last sync will be returned as a person with [`PersonMetadata.deleted`](/people/api/rest/v1/people#Person.PersonMetadata.FIELDS.deleted) set to true. When the `syncToken` is specified, all other parameters provided to `ListOtherContacts` must match the call that provided the sync token.
975+
requestSyncToken: boolean, Optional. Whether the response should return `next_sync_token` on the last page of results. It can be used to get incremental changes since the last request by setting it on the request `sync_token`. More details about sync behavior at `otherContacts.list`.
976+
sources: string, Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set. (repeated)
977+
Allowed values
978+
READ_SOURCE_TYPE_UNSPECIFIED - Unspecified.
979+
READ_SOURCE_TYPE_PROFILE - Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.
980+
READ_SOURCE_TYPE_CONTACT - Returns SourceType.CONTACT.
981+
READ_SOURCE_TYPE_DOMAIN_CONTACT - Returns SourceType.DOMAIN_CONTACT.
982+
syncToken: string, Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `otherContacts.list` must match the first call that provided the sync token. More details about sync behavior at `otherContacts.list`.
977983
x__xgafv: string, V1 error format.
978984
Allowed values
979985
1 - v1 error format
@@ -1176,7 +1182,7 @@ <h3>Method Details</h3>
11761182
&quot;url&quot;: &quot;A String&quot;, # The URL of the cover photo.
11771183
},
11781184
],
1179-
&quot;emailAddresses&quot;: [ # The person&#x27;s email addresses. For [`connections.list`](/people/api/rest/v1/people.connections/list), [`otherContacts.list`](/people/api/rest/v1/otherContacts/list), and [`people.listDirectoryPeople`](/people/api/rest/v1/people/listDirectoryPeople) the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling [&#x27;people.get&#x27;](/people/api/rest/v1/people/get).
1185+
&quot;emailAddresses&quot;: [ # The person&#x27;s email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople.
11801186
{ # A person&#x27;s email address.
11811187
&quot;displayName&quot;: &quot;A String&quot;, # The display name of the email.
11821188
&quot;formattedType&quot;: &quot;A String&quot;, # Output only. The type of the email address translated and formatted in the viewer&#x27;s account locale or the `Accept-Language` HTTP header locale.
@@ -1417,12 +1423,12 @@ <h3>Method Details</h3>
14171423
},
14181424
],
14191425
&quot;metadata&quot;: { # The metadata about a person. # Output only. Metadata about the person.
1420-
&quot;deleted&quot;: True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) and [`otherContacts.list`](/people/api/rest/v1/otherContacts/list) requests that include a sync token.
1426+
&quot;deleted&quot;: True or False, # Output only. True if the person resource has been deleted. Populated only for `people.connections.list` and `otherContacts.list` sync requests.
14211427
&quot;linkedPeopleResourceNames&quot;: [ # Output only. Resource names of people linked to this resource.
14221428
&quot;A String&quot;,
14231429
],
14241430
&quot;objectType&quot;: &quot;A String&quot;, # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
1425-
&quot;previousResourceNames&quot;: [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
1431+
&quot;previousResourceNames&quot;: [ # Output only. Any former resource names this person has had. Populated only for `people.connections.list` requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
14261432
&quot;A String&quot;,
14271433
],
14281434
&quot;sources&quot;: [ # The sources of data for the person.
@@ -1581,7 +1587,7 @@ <h3>Method Details</h3>
15811587
&quot;type&quot;: &quot;A String&quot;, # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
15821588
},
15831589
],
1584-
&quot;phoneNumbers&quot;: [ # The person&#x27;s phone numbers. For [`connections.list`](/people/api/rest/v1/people.connections/list), [`otherContacts.list`](/people/api/rest/v1/otherContacts/list), and [`people.listDirectoryPeople`](/people/api/rest/v1/people/listDirectoryPeople) the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling [&#x27;people.get&#x27;](/people/api/rest/v1/people/get).
1590+
&quot;phoneNumbers&quot;: [ # The person&#x27;s phone numbers. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople.
15851591
{ # A person&#x27;s phone number.
15861592
&quot;canonicalForm&quot;: &quot;A String&quot;, # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
15871593
&quot;formattedType&quot;: &quot;A String&quot;, # Output only. The type of the phone number translated and formatted in the viewer&#x27;s account locale or the `Accept-Language` HTTP header locale.
@@ -2056,7 +2062,7 @@ <h3>Method Details</h3>
20562062
&quot;url&quot;: &quot;A String&quot;, # The URL of the cover photo.
20572063
},
20582064
],
2059-
&quot;emailAddresses&quot;: [ # The person&#x27;s email addresses. For [`connections.list`](/people/api/rest/v1/people.connections/list), [`otherContacts.list`](/people/api/rest/v1/otherContacts/list), and [`people.listDirectoryPeople`](/people/api/rest/v1/people/listDirectoryPeople) the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling [&#x27;people.get&#x27;](/people/api/rest/v1/people/get).
2065+
&quot;emailAddresses&quot;: [ # The person&#x27;s email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople.
20602066
{ # A person&#x27;s email address.
20612067
&quot;displayName&quot;: &quot;A String&quot;, # The display name of the email.
20622068
&quot;formattedType&quot;: &quot;A String&quot;, # Output only. The type of the email address translated and formatted in the viewer&#x27;s account locale or the `Accept-Language` HTTP header locale.
@@ -2297,12 +2303,12 @@ <h3>Method Details</h3>
22972303
},
22982304
],
22992305
&quot;metadata&quot;: { # The metadata about a person. # Output only. Metadata about the person.
2300-
&quot;deleted&quot;: True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) and [`otherContacts.list`](/people/api/rest/v1/otherContacts/list) requests that include a sync token.
2306+
&quot;deleted&quot;: True or False, # Output only. True if the person resource has been deleted. Populated only for `people.connections.list` and `otherContacts.list` sync requests.
23012307
&quot;linkedPeopleResourceNames&quot;: [ # Output only. Resource names of people linked to this resource.
23022308
&quot;A String&quot;,
23032309
],
23042310
&quot;objectType&quot;: &quot;A String&quot;, # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
2305-
&quot;previousResourceNames&quot;: [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
2311+
&quot;previousResourceNames&quot;: [ # Output only. Any former resource names this person has had. Populated only for `people.connections.list` requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
23062312
&quot;A String&quot;,
23072313
],
23082314
&quot;sources&quot;: [ # The sources of data for the person.
@@ -2461,7 +2467,7 @@ <h3>Method Details</h3>
24612467
&quot;type&quot;: &quot;A String&quot;, # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
24622468
},
24632469
],
2464-
&quot;phoneNumbers&quot;: [ # The person&#x27;s phone numbers. For [`connections.list`](/people/api/rest/v1/people.connections/list), [`otherContacts.list`](/people/api/rest/v1/otherContacts/list), and [`people.listDirectoryPeople`](/people/api/rest/v1/people/listDirectoryPeople) the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling [&#x27;people.get&#x27;](/people/api/rest/v1/people/get).
2470+
&quot;phoneNumbers&quot;: [ # The person&#x27;s phone numbers. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople.
24652471
{ # A person&#x27;s phone number.
24662472
&quot;canonicalForm&quot;: &quot;A String&quot;, # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
24672473
&quot;formattedType&quot;: &quot;A String&quot;, # Output only. The type of the phone number translated and formatted in the viewer&#x27;s account locale or the `Accept-Language` HTTP header locale.

0 commit comments

Comments
 (0)