Method: contactGroups.get

Obtén un grupo de contactos específico que pertenezca al usuario autenticado especificando un nombre de recurso de grupo de contactos.

Solicitud HTTP

GET https://people.googleapis.com/v1/{resourceName=contactGroups/*}

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
resourceName

string

Obligatorio. El nombre del recurso del grupo de contactos que se obtendrá.

Parámetros de consulta

Parámetros
maxMembers

integer

Opcional. Especifica la cantidad máxima de miembros que se mostrarán. El valor predeterminado es 0 si no está configurado, lo que no mostrará ningún miembro.
groupFields

string (FieldMask format)

Opcional. Una máscara de campo que restringe los campos del grupo que se muestran. La configuración predeterminada es metadata, groupType, memberCount y name si no se configura o se establece como vacío. Los campos válidos son los siguientes:

  • clientData
  • groupType
  • memberCount
  • metadatos
  • name

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de ContactGroup.

Permisos de autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/contacts
  • https://www.googleapis.com/auth/contacts.readonly

Para obtener más información, consulta la guía de autorización.