Interfejs
Google Business Performance API udostępnia
NOWĄ metodę interfejsu API, która umożliwia pobieranie wielu parametrów „DailyMetrics” w jednym żądaniu API.
Zapoznaj się z
harmonogramem wycofywania i instrukcjami, jak przejść z metody raportu API w wersji 4 na interfejs Google Business Profile Performance API.
Method: accounts.invitations.list
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Zawiera listę oczekujących zaproszeń dla określonego konta.
Żądanie HTTP
GET https://mybusinessaccountmanagement.googleapis.com/v1/{parent=accounts/*}/invitations
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
| Parametry |
parent |
string
Wymagane. Nazwa konta, z którego pobierana jest lista zaproszeń. accounts/{account_id}/invitations
|
Parametry zapytania
| Parametry |
filter |
string
Opcjonalnie: Filtrowanie odpowiedzi jest obsługiwane w polu Invitation.target_type.
|
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
Komunikat z odpowiedzią dla AccessControl.ListInvitations.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
| Zapis JSON |
{
"invitations": [
{
object (Invitation)
}
]
} |
| Pola |
invitations[] |
object (Invitation)
Zbiór oczekujących zaproszeń na koncie. Podana tutaj liczba zaproszeń nie może przekraczać 1000.
|
Zakresy autoryzacji
Wymaga następującego zakresu OAuth:
https://www.googleapis.com/auth/business.manage
Więcej informacji znajdziesz w artykule Omówienie protokołu OAuth 2.0.
Zaproszenie
Reprezentuje oczekujące zaproszenie.
| Zapis 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.
} |
| Pola |
name |
string
Wymagane. Nazwa zasobu zaproszenia. accounts/{account_id}/invitations/{invitation_id}.
|
role |
enum (AdminRole)
Tylko dane wyjściowe. Zaproszona rola na koncie.
|
targetType |
enum (TargetType)
Tylko dane wyjściowe. Określa typy celów, które powinny się pojawić w odpowiedzi.
|
Pole sumy target. Wskazuje cel, do którego jest przeznaczone to zaproszenie. target może mieć tylko jedną z tych wartości: |
targetAccount |
object (Account)
Mało zapełnione konto, którego dotyczy to zaproszenie.
|
targetLocation |
object (TargetLocation)
Lokalizacja docelowa, do której jest przeznaczone to zaproszenie.
|
TargetLocation
Reprezentuje lokalizację docelową dla oczekującego zaproszenia.
| Zapis JSON |
{
"locationName": string,
"address": string
} |
| Pola |
locationName |
string
Nazwa lokalizacji, do której użytkownik został zaproszony.
|
address |
string
Adres lokalizacji, do której użytkownik został zaproszony.
|
TargetType
Typ elementu docelowego, do którego jest kierowane zaproszenie.
| Wartości w polu enum |
TARGET_TYPE_UNSPECIFIED |
Ustaw, gdy typ celu nie jest określony. |
ACCOUNTS_ONLY |
Wyświetlaj zaproszenia tylko do grup docelowych typu Konto. |
LOCATIONS_ONLY |
Wyświetlaj zaproszenia tylko w przypadku elementów docelowych typu Lokalizacja. |
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-25 UTC.
[null,null,["Ostatnia aktualizacja: 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. |"]]
