L'API
Google Business Performance propose une
NOUVELLE méthode qui permet d'extraire plusieurs `DailyMetrics` avec une seule requête API.
Consultez le
planning d'abandon et les instructions pour migrer de la méthode API reportInsights v4 à l'API Google Business Profile Performance.
Method: accounts.invitations.list
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Répertorie les invitations en attente pour le compte spécifié.
Requête HTTP
GET https://mybusinessaccountmanagement.googleapis.com/v1/{parent=accounts/*}/invitations
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
| Paramètres |
parent |
string
Obligatoire. Nom du compte à partir duquel la liste d'invitations est extraite. accounts/{account_id}/invitations
|
Paramètres de requête
| Paramètres |
filter |
string
Facultatif. Le filtrage de la réponse est possible via le champ Invitation.target_type.
|
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Message de réponse pour AccessControl.ListInvitations.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
| Représentation JSON |
{
"invitations": [
{
object (Invitation)
}
]
} |
| Champs |
invitations[] |
object (Invitation)
Ensemble d'invitations en attente pour le compte. Le nombre d'invitations répertoriées ici ne peut pas dépasser 1 000.
|
Champs d'application des autorisations
Requiert le niveau d'accès OAuth suivant :
https://www.googleapis.com/auth/business.manage
Pour en savoir plus, consultez la Présentation d'OAuth 2.0.
Invitation
Représente une invitation en attente.
| Représentation 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.
} |
| Champs |
name |
string
Obligatoire. Nom de ressource de l'invitation. accounts/{account_id}/invitations/{invitation_id}.
|
role |
enum (AdminRole)
Uniquement en sortie. Rôle invité sur le compte.
|
targetType |
enum (TargetType)
Uniquement en sortie. Spécifie les types de cibles à afficher dans la réponse.
|
Champ d'union target. Indique la cible de cette invitation. target ne peut être qu'un des éléments suivants : |
targetAccount |
object (Account)
Compte partiellement rempli auquel cette invitation est destinée.
|
targetLocation |
object (TargetLocation)
Emplacement cible auquel cette invitation est destinée.
|
TargetLocation
Représente une zone géographique cible pour une invitation en attente.
| Représentation JSON |
{
"locationName": string,
"address": string
} |
| Champs |
locationName |
string
Nom de l'établissement auquel l'utilisateur est invité.
|
address |
string
Adresse de l'établissement auquel l'utilisateur est invité.
|
TargetType
Type de cible auquel une invitation est destinée.
| Enums |
TARGET_TYPE_UNSPECIFIED |
Défini lorsque le type de cible n'est pas spécifié. |
ACCOUNTS_ONLY |
Afficher les invitations uniquement pour les cibles de type Compte. |
LOCATIONS_ONLY |
Afficher les invitations uniquement pour les cibles de type "Zone géographique". |
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 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. |"]]
