La API de
Google Business Performance tiene un método de API
NUEVO que permite recuperar varias métricas "DailyMetrics" en una sola solicitud a la API.
Revise el
programa de baja y las instrucciones para migrar del método de la API de reportInsights versión 4 a la API de rendimiento del Perfil de Negocio de Google.
Method: accounts.invitations.list
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Se muestran las invitaciones pendientes de 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 |
string
Obligatorio. El nombre de la cuenta de la que se recupera la lista de invitaciones. accounts/{account_id}/invitations
|
Parámetros de consulta
| Parámetros |
filter |
string
Opcional. Se puede filtrar 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 (Invitation)
}
]
} |
| Campos |
invitations[] |
object (Invitation)
Es un conjunto de invitaciones pendientes de la cuenta. La cantidad de invitaciones que se incluyen aquí no puede ser superior a 1,000.
|
Alcances 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 (AdminRole),
"targetType": enum (TargetType),
// Union field target can be only one of the following:
"targetAccount": {
object (Account)
},
"targetLocation": {
object (TargetLocation)
}
// End of list of possible types for union field target.
} |
| Campos |
name |
string
Obligatorio. El nombre del recurso para la invitación. accounts/{account_id}/invitations/{invitation_id}.
|
role |
enum (AdminRole)
Solo salida. El rol invitado en la cuenta.
|
targetType |
enum (TargetType)
Solo salida. Especifica qué tipos de objetivos 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 |
object (Account)
La cuenta propagada de manera dispersa a la que corresponde esta invitación.
|
targetLocation |
object (TargetLocation)
La ubicación de destino a la que se dirige esta invitación.
|
TargetLocation
Representa una ubicación de destino para una invitación pendiente.
| Representación JSON |
{
"locationName": string,
"address": string
} |
| Campos |
locationName |
string
El nombre de la ubicación a la que se invita al usuario.
|
address |
string
Es la dirección de la ubicación a la que se invita al usuario.
|
TipoObjetivo
El tipo de destino al que se orienta una invitación.
| Enumeraciones |
TARGET_TYPE_UNSPECIFIED |
Se establece cuando no se especifica el tipo de objetivo. |
ACCOUNTS_ONLY |
Enumerar invitaciones solo para objetivos del tipo Cuenta |
LOCATIONS_ONLY |
Enumera invitaciones solo para destinos del tipo Ubicación. |
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 2025-07-25 (UTC)"],[[["\u003cp\u003eLists pending invitations, up to 1000, for a specified Google My Business account.\u003c/p\u003e\n"],["\u003cp\u003eFilter results by invitation target type (Account or Location).\u003c/p\u003e\n"],["\u003cp\u003eResponse includes invitation details such as name, role, target type, and target information.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/business.manage\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eInvitations can be targeted towards either a Google My Business account or a specific location.\u003c/p\u003e\n"]]],[],null,["# Method: accounts.invitations.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListInvitationsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Invitation](#Invitation)\n - [JSON representation](#Invitation.SCHEMA_REPRESENTATION)\n- [TargetLocation](#TargetLocation)\n - [JSON representation](#TargetLocation.SCHEMA_REPRESENTATION)\n- [TargetType](#TargetType)\n\nLists pending invitations for the specified account.\n\n### HTTP request\n\n`GET https://mybusinessaccountmanagement.googleapis.com/v1/{parent=accounts/*}/invitations`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|---------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The name of the account from which the list of invitations is being retrieved. `accounts/{account_id}/invitations` |\n\n### Query parameters\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------------------|\n| `filter` | `string` Optional. Filtering the response is supported via the Invitation.target_type field. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for AccessControl.ListInvitations.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"invitations\": [ { object (/my-business/reference/accountmanagement/rest/v1/accounts.invitations/list#Invitation) } ] } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `invitations[]` | `object (`[Invitation](/my-business/reference/accountmanagement/rest/v1/accounts.invitations/list#Invitation)`)` A collection of invitations that are pending for the account. The number of invitations listed here cannot exceed 1000. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/business.manage`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2).\n\nInvitation\n----------\n\nRepresents a pending invitation.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"role\": enum (/my-business/reference/accountmanagement/rest/v1/accounts.admins#Admin.AdminRole), \"targetType\": enum (/my-business/reference/accountmanagement/rest/v1/accounts.invitations/list#TargetType), // Union field `target` can be only one of the following: \"targetAccount\": { object (/my-business/reference/accountmanagement/rest/v1/accounts#Account) }, \"targetLocation\": { object (/my-business/reference/accountmanagement/rest/v1/accounts.invitations/list#TargetLocation) } // End of list of possible types for union field `target`. } ``` |\n\n| Fields ||\n|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The resource name for the invitation. `accounts/{account_id}/invitations/{invitation_id}`. |\n| `role` | `enum (`[AdminRole](/my-business/reference/accountmanagement/rest/v1/accounts.admins#Admin.AdminRole)`)` Output only. The invited role on the account. |\n| `targetType` | `enum (`[TargetType](/my-business/reference/accountmanagement/rest/v1/accounts.invitations/list#TargetType)`)` Output only. Specifies which target types should appear in the response. |\n| Union field `target`. Indicates the target this invitation is for. `target` can be only one of the following: ||\n| `targetAccount` | `object (`[Account](/my-business/reference/accountmanagement/rest/v1/accounts#Account)`)` The sparsely populated account this invitation is for. |\n| `targetLocation` | `object (`[TargetLocation](/my-business/reference/accountmanagement/rest/v1/accounts.invitations/list#TargetLocation)`)` The target location this invitation is for. |\n\nTargetLocation\n--------------\n\nRepresents a target location for a pending invitation.\n\n| JSON representation |\n|-------------------------------------------------------|\n| ``` { \"locationName\": string, \"address\": string } ``` |\n\n| Fields ||\n|----------------|--------------------------------------------------------------------|\n| `locationName` | `string` The name of the location to which the user is invited. |\n| `address` | `string` The address of the location to which the user is invited. |\n\nTargetType\n----------\n\nThe type of target an invitation is for.\n\n| Enums ||\n|---------------------------|-----------------------------------------------------|\n| `TARGET_TYPE_UNSPECIFIED` | Set when target type is unspecified. |\n| `ACCOUNTS_ONLY` | List invitations only for targets of type Account. |\n| `LOCATIONS_ONLY` | List invitations only for targets of type Location. |"]]
