google_api_people v0.4.0 GoogleApi.People.V1.Api.ContactGroups View Source
API calls for all endpoints tagged ContactGroups
.
Link to this section Summary
Functions
Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.
Create a new contact group owned by the authenticated user.
Delete an existing contact group owned by the authenticated user by specifying a contact group resource name.
Get a specific contact group owned by the authenticated user by specifying a contact group resource name.
List all contact groups owned by the authenticated user. Members of the contact groups are not populated.
Modify the members of a contact group owned by the authenticated user. <br> The only system contact groups that can have members added are `contactGroups/myContacts` and `contactGroups/starred`. Other system contact groups are deprecated and can only have contacts removed.
Update the name of an existing contact group owned by the authenticated user.
Link to this section Functions
people_contact_groups_batch_get(connection, optional_params \\ [], opts \\ []) View Source
Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.
Parameters
- connection (GoogleApi.People.V1.Connection): Connection to server
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :maxMembers (integer()): Specifies the maximum number of members to return for each group.
- :resourceNames ([String.t]): The resource names of the contact groups to get.
Returns
{:ok, %GoogleApi.People.V1.Model.BatchGetContactGroupsResponse{}} on success {:error, info} on failure
people_contact_groups_create(connection, optional_params \\ [], opts \\ []) View Source
Create a new contact group owned by the authenticated user.
Parameters
- connection (GoogleApi.People.V1.Connection): Connection to server
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :body (CreateContactGroupRequest):
Returns
{:ok, %GoogleApi.People.V1.Model.ContactGroup{}} on success {:error, info} on failure
people_contact_groups_delete(connection, contact_groups_id, optional_params \\ [], opts \\ []) View Source
Delete an existing contact group owned by the authenticated user by specifying a contact group resource name.
Parameters
- connection (GoogleApi.People.V1.Connection): Connection to server
- contact_groups_id (String.t): Part of `resourceName`. The resource name of the contact group to delete.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :deleteContacts (boolean()): Set to true to also delete the contacts in the specified group.
Returns
{:ok, %GoogleApi.People.V1.Model.Empty{}} on success {:error, info} on failure
people_contact_groups_get(connection, contact_groups_id, optional_params \\ [], opts \\ []) View Source
Get a specific contact group owned by the authenticated user by specifying a contact group resource name.
Parameters
- connection (GoogleApi.People.V1.Connection): Connection to server
- contact_groups_id (String.t): Part of `resourceName`. The resource name of the contact group to get.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :maxMembers (integer()): Specifies the maximum number of members to return.
Returns
{:ok, %GoogleApi.People.V1.Model.ContactGroup{}} on success {:error, info} on failure
people_contact_groups_list(connection, optional_params \\ [], opts \\ []) View Source
List all contact groups owned by the authenticated user. Members of the contact groups are not populated.
Parameters
- connection (GoogleApi.People.V1.Connection): Connection to server
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :pageSize (integer()): The maximum number of resources to return.
- :pageToken (String.t): The next_page_token value returned from a previous call to ListContactGroups. Requests the next page of resources.
- :syncToken (String.t): A sync token, returned by a previous call to `contactgroups.list`. Only resources changed since the sync token was created will be returned.
Returns
{:ok, %GoogleApi.People.V1.Model.ListContactGroupsResponse{}} on success {:error, info} on failure
people_contact_groups_members_modify(connection, contact_groups_id, optional_params \\ [], opts \\ []) View Source
Modify the members of a contact group owned by the authenticated user. <br> The only system contact groups that can have members added are `contactGroups/myContacts` and `contactGroups/starred`. Other system contact groups are deprecated and can only have contacts removed.
Parameters
- connection (GoogleApi.People.V1.Connection): Connection to server
- contact_groups_id (String.t): Part of `resourceName`. The resource name of the contact group to modify.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :body (ModifyContactGroupMembersRequest):
Returns
{:ok, %GoogleApi.People.V1.Model.ModifyContactGroupMembersResponse{}} on success {:error, info} on failure
people_contact_groups_update(connection, contact_groups_id, optional_params \\ [], opts \\ []) View Source
Update the name of an existing contact group owned by the authenticated user.
Parameters
- connection (GoogleApi.People.V1.Connection): Connection to server
- contact_groups_id (String.t): Part of `contactGroup.resourceName`. The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/`<var>contact_group_id</var>.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :body (UpdateContactGroupRequest):
Returns
{:ok, %GoogleApi.People.V1.Model.ContactGroup{}} on success {:error, info} on failure