A API
Google Business Performance tem um
NOVO método de API que permite buscar várias "DailyMetrics" em uma única solicitação de API.
Confira a
programação de descontinuação e instruções para migrar do método de API reportInsights v4 para a API Google Business Profile Performance.
Method: accounts.invitations.list
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Lista os convites pendentes para a conta especificada.
Solicitação HTTP
GET https://mybusinessaccountmanagement.googleapis.com/v1/{parent=accounts/*}/invitations
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
| Parâmetros |
parent |
string
Obrigatório. O nome da conta da qual a lista de convites está sendo recuperada. accounts/{account_id}/invitations
|
Parâmetros de consulta
| Parâmetros |
filter |
string
Opcional. A filtragem da resposta é suportada pelo campo Invitation.target_type.
|
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Mensagem de resposta para AccessControl.ListInvitations.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
| Representação JSON |
{
"invitations": [
{
object (Invitation)
}
]
} |
| Campos |
invitations[] |
object (Invitation)
Um conjunto de convites pendentes na conta. O número de convites listados aqui não pode exceder 1.000.
|
Escopos de autorização
Requer o seguinte escopo OAuth:
https://www.googleapis.com/auth/business.manage
Para mais informações, consulte a Visão geral do OAuth 2.0.
Convite
Representa um convite pendente.
| Representação 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
Obrigatório. O nome do recurso do convite. accounts/{account_id}/invitations/{invitation_id}.
|
role |
enum (AdminRole)
Apenas saída. A função convidada na conta.
|
targetType |
enum (TargetType)
Apenas saída. Especifica quais tipos de destino devem aparecer na resposta.
|
Campo de união target. Indica o alvo do convite. target pode ser apenas de um dos tipos a seguir: |
targetAccount |
object (Account)
A conta com pouco preenchimento.
|
targetLocation |
object (TargetLocation)
O local de segmentação para o qual este convite se destina.
|
TargetLocation
Representa uma região de segmentação para um convite pendente.
| Representação JSON |
{
"locationName": string,
"address": string
} |
| Campos |
locationName |
string
O nome do local para o qual o usuário é convidado.
|
address |
string
O endereço do local para o qual o usuário foi convidado.
|
Tipo de segmentação
O tipo de destino ao qual um convite se destina.
| Enums |
TARGET_TYPE_UNSPECIFIED |
Definido quando o tipo de destino não é especificado. |
ACCOUNTS_ONLY |
Listar convites apenas para segmentações do tipo "Account". |
LOCATIONS_ONLY |
Listar convites apenas para segmentações do tipo "Local". |
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 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. |"]]
