- Solicitud HTTP
- Parámetros de ruta de acceso
- Parámetros de consulta
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- Invitación
- TargetLocation
- TargetType
Enumera las invitaciones pendientes para la cuenta especificada.
Solicitud HTTP
GET https://mybusinessaccountmanagement.googleapis.com/v1/{parent=accounts/*}/invitations
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros | |
---|---|
parent |
Obligatorio. El nombre de la cuenta de la que se recupera la lista de invitaciones. |
Parámetros de consulta
Parámetros | |
---|---|
filter |
Opcional. Se admite el filtrado de la respuesta a través del campo Invitation.target_type. |
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Mensaje de respuesta para AccessControl.ListInvitations.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Representación JSON |
---|
{
"invitations": [
{
object ( |
Campos | |
---|---|
invitations[] |
Un conjunto de invitaciones que están pendientes para la cuenta La cantidad de invitaciones indicadas aquí no puede ser mayor que 1,000. |
Permisos de autorización
Requiere el siguiente alcance de OAuth:
https://www.googleapis.com/auth/business.manage
Para obtener más información, consulta la Descripción general de OAuth 2.0.
Invitación
Representa una invitación pendiente.
Representación JSON |
---|
{ "name": string, "role": enum ( |
Campos | |
---|---|
name |
Obligatorio. El nombre del recurso para la invitación. |
role |
Solo salida. El rol invitado en la cuenta. |
targetType |
Solo salida. Especifica qué tipos de destino deben aparecer en la respuesta. |
Campo de unión target . Indica el destino de esta invitación. Las direcciones (target ) solo pueden ser una de las siguientes opciones: |
|
targetAccount |
La cuenta poco propagada a la que corresponde esta invitación. |
targetLocation |
La ubicación de segmentación para la que se creó esta invitación. |
TargetLocation
Representa una ubicación de segmentación para una invitación pendiente.
Representación JSON |
---|
{ "locationName": string, "address": string } |
Campos | |
---|---|
locationName |
El nombre de la ubicación a la que está invitado el usuario. |
address |
La dirección de la ubicación a la que está invitado al usuario. |
TargetType
Es el tipo de segmentación para una invitación.
Enumeradores | |
---|---|
TARGET_TYPE_UNSPECIFIED |
Se establece cuando no se especifica el tipo de objetivo. |
ACCOUNTS_ONLY |
Enumera las invitaciones solo para destinos del tipo Cuenta. |
LOCATIONS_ONLY |
Enumera invitaciones solo para objetivos de tipo Ubicación. |