batchGet(groupFields=None, maxMembers=None, resourceNames=None, x__xgafv=None)

Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.

Args:
groupFields: string, Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name
maxMembers: integer, Optional. Specifies the maximum number of members to return for each group. Defaults to 0 if not set, which will return zero members.
resourceNames: string, Required. The resource names of the contact groups to get. There is a maximum of 200 resource names. (repeated)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # The response to a batch get contact groups request.
"responses": [ # The list of responses for each requested contact group resource.
{ # The response for a specific contact group.
"contactGroup": { # A contact group. # The contact group.
"clientData": [ # The group's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"value": "A String", # The client specified value of the client data.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale for system groups names. Group names set by the owner are the same as name.
"groupType": "A String", # Output only. The contact group type.
"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.
"A String",
],
"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
"deleted": True or False, # Output only. True if the contact group resource has been deleted. Populated only for [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests that include a sync token.
"updateTime": "A String", # Output only. The time the group was last updated.
},
"name": "A String", # The contact group name set by the group owner or a system provided name for system groups. For [`contactGroups.create`](/people/api/rest/v1/contactGroups/create) or [`contactGroups.update`](/people/api/rest/v1/contactGroups/update) the name must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error.
"resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.
},
"requestedResourceName": "A String", # The original requested resource name.
"status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The status of the response.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
},
],
}

close()

Close httplib2 connections.

create(body=None, x__xgafv=None)

Create a new contact group owned by the authenticated user. Created contact group names must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.

Args:
body: object, The request body.
The object takes the form of:

{ # A request to create a new contact group.
"contactGroup": { # A contact group. # Required. The contact group to create.
"clientData": [ # The group's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"value": "A String", # The client specified value of the client data.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale for system groups names. Group names set by the owner are the same as name.
"groupType": "A String", # Output only. The contact group type.
"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.
"A String",
],
"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
"deleted": True or False, # Output only. True if the contact group resource has been deleted. Populated only for [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests that include a sync token.
"updateTime": "A String", # Output only. The time the group was last updated.
},
"name": "A String", # The contact group name set by the group owner or a system provided name for system groups. For [`contactGroups.create`](/people/api/rest/v1/contactGroups/create) or [`contactGroups.update`](/people/api/rest/v1/contactGroups/update) the name must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error.
"resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.
},
"readGroupFields": "A String", # Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * metadata * name
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # A contact group.
"clientData": [ # The group's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"value": "A String", # The client specified value of the client data.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale for system groups names. Group names set by the owner are the same as name.
"groupType": "A String", # Output only. The contact group type.
"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.
"A String",
],
"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
"deleted": True or False, # Output only. True if the contact group resource has been deleted. Populated only for [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests that include a sync token.
"updateTime": "A String", # Output only. The time the group was last updated.
},
"name": "A String", # The contact group name set by the group owner or a system provided name for system groups. For [`contactGroups.create`](/people/api/rest/v1/contactGroups/create) or [`contactGroups.update`](/people/api/rest/v1/contactGroups/update) the name must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error.
"resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.
}

delete(resourceName, deleteContacts=None, x__xgafv=None)

Delete an existing contact group owned by the authenticated user by specifying a contact group resource name. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.

Args:
  resourceName: string, Required. The resource name of the contact group to delete. (required)
  deleteContacts: boolean, Optional. Set to true to also delete the contacts in the specified group.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(resourceName, groupFields=None, maxMembers=None, x__xgafv=None)

Get a specific contact group owned by the authenticated user by specifying a contact group resource name.

Args:
  resourceName: string, Required. The resource name of the contact group to get. (required)
  groupFields: string, Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name
  maxMembers: integer, Optional. Specifies the maximum number of members to return. Defaults to 0 if not set, which will return zero members.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A contact group.
  "clientData": [ # The group's client data.
    { # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
      "key": "A String", # The client specified key of the client data.
      "value": "A String", # The client specified value of the client data.
    },
  ],
  "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
  "formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale for system groups names. Group names set by the owner are the same as name.
  "groupType": "A String", # Output only. The contact group type.
  "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
  "memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.
    "A String",
  ],
  "metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
    "deleted": True or False, # Output only. True if the contact group resource has been deleted. Populated only for [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests that include a sync token.
    "updateTime": "A String", # Output only. The time the group was last updated.
  },
  "name": "A String", # The contact group name set by the group owner or a system provided name for system groups. For [`contactGroups.create`](/people/api/rest/v1/contactGroups/create) or [`contactGroups.update`](/people/api/rest/v1/contactGroups/update) the name must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error.
  "resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.
}

list(groupFields=None, pageSize=None, pageToken=None, syncToken=None, x__xgafv=None)

List all contact groups owned by the authenticated user. Members of the contact groups are not populated.

Args:
groupFields: string, Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name
pageSize: integer, Optional. The maximum number of resources to return. Valid values are between 1 and 1000, inclusive. Defaults to 30 if not set or set to 0.
pageToken: string, Optional. The next_page_token value returned from a previous call to [ListContactGroups](/people/api/rest/v1/contactgroups/list). Requests the next page of resources.
syncToken: string, Optional. A sync token, returned by a previous call to `contactgroups.list`. Only resources changed since the sync token was created will be returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # The response to a list contact groups request.
"contactGroups": [ # The list of contact groups. Members of the contact groups are not populated.
{ # A contact group.
"clientData": [ # The group's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"value": "A String", # The client specified value of the client data.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale for system groups names. Group names set by the owner are the same as name.
"groupType": "A String", # Output only. The contact group type.
"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.
"A String",
],
"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
"deleted": True or False, # Output only. True if the contact group resource has been deleted. Populated only for [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests that include a sync token.
"updateTime": "A String", # Output only. The time the group was last updated.
},
"name": "A String", # The contact group name set by the group owner or a system provided name for system groups. For [`contactGroups.create`](/people/api/rest/v1/contactGroups/create) or [`contactGroups.update`](/people/api/rest/v1/contactGroups/update) the name must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error.
"resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.
},
],
"nextPageToken": "A String", # The token that can be used to retrieve the next page of results.
"nextSyncToken": "A String", # The token that can be used to retrieve changes since the last request.
"totalItems": 42, # The total number of items in the list without pagination.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

update(resourceName, body=None, x__xgafv=None)

Update the name of an existing contact group owned by the authenticated user. Updated contact group names must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.

Args:
resourceName: string, The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. (required)
body: object, The request body.
The object takes the form of:

{ # A request to update an existing user contact group. All updated fields will be replaced.
"contactGroup": { # A contact group. # Required. The contact group to update.
"clientData": [ # The group's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"value": "A String", # The client specified value of the client data.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale for system groups names. Group names set by the owner are the same as name.
"groupType": "A String", # Output only. The contact group type.
"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.
"A String",
],
"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
"deleted": True or False, # Output only. True if the contact group resource has been deleted. Populated only for [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests that include a sync token.
"updateTime": "A String", # Output only. The time the group was last updated.
},
"name": "A String", # The contact group name set by the group owner or a system provided name for system groups. For [`contactGroups.create`](/people/api/rest/v1/contactGroups/create) or [`contactGroups.update`](/people/api/rest/v1/contactGroups/update) the name must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error.
"resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.
},
"readGroupFields": "A String", # Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name
"updateGroupFields": "A String", # Optional. A field mask to restrict which fields on the group are updated. Multiple fields can be specified by separating them with commas. Defaults to `name` if not set or set to empty. Updated fields are replaced. Valid values are: * clientData * name
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # A contact group.
"clientData": [ # The group's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"value": "A String", # The client specified value of the client data.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale for system groups names. Group names set by the owner are the same as name.
"groupType": "A String", # Output only. The contact group type.
"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.
"A String",
],
"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
"deleted": True or False, # Output only. True if the contact group resource has been deleted. Populated only for [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests that include a sync token.
"updateTime": "A String", # Output only. The time the group was last updated.
},
"name": "A String", # The contact group name set by the group owner or a system provided name for system groups. For [`contactGroups.create`](/people/api/rest/v1/contactGroups/create) or [`contactGroups.update`](/people/api/rest/v1/contactGroups/update) the name must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error.
"resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.
}

People API . contactGroups

Instance Methods

Method Details