Method: accounts.invitations.list
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
בתיבת הדו-שיח הזו מפורטים הזמנות בהמתנה לחשבון שצוין.
בקשת HTTP
GET https://mybusinessaccountmanagement.googleapis.com/v1/{parent=accounts/*}/invitations
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
| פרמטרים |
parent |
string
חובה. שם החשבון שממנו מאוחזרת רשימת ההזמנות. accounts/{account_id}/invitations
|
פרמטרים של שאילתה
| פרמטרים |
filter |
string
זה שינוי אופציונלי. אפשר לסנן את התגובה דרך השדה Invite.target_type.
|
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
הודעת תגובה ל-AccessControl.List שמחs.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
| ייצוג JSON |
{
"invitations": [
{
object (Invitation)
}
]
} |
| שדות |
invitations[] |
object (Invitation)
אוסף של הזמנות שממתינות לחשבון. מספר ההזמנות שמופיע כאן לא יכול לחרוג מ-1,000.
|
היקפי ההרשאות
נדרש היקף ההרשאות הבא של OAuth:
https://www.googleapis.com/auth/business.manage
למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.
הזמנה
| ייצוג 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.
} |
| שדות |
name |
string
חובה. שם המשאב של ההזמנה. accounts/{account_id}/invitations/{invitation_id}.
|
role |
enum (AdminRole)
פלט בלבד. התפקיד שהוזמן בחשבון.
|
targetType |
enum (TargetType)
פלט בלבד. ההגדרה קובעת אילו סוגי יעדים יופיעו בתשובה.
|
שדה איחוד target. מציין את היעד עבור ההזמנה הזו. target יכול להיות רק אחת מהאפשרויות הבאות: |
targetAccount |
object (Account)
החשבון המאוכלס בדלילות שההזמנה הזו מיועדת אליו.
|
targetLocation |
object (TargetLocation)
מיקום היעד הגיאוגרפי להזמנה הזו.
|
TargetLocation
מייצג מיקום יעד להזמנה בהמתנה.
| ייצוג JSON |
{
"locationName": string,
"address": string
} |
| שדות |
locationName |
string
שם המיקום שאליו המשתמש מוזמן.
|
address |
string
הכתובת של המיקום שאליו המשתמש מוזמן.
|
TargetType
סוג הטירגוט שאליו שייכת הזמנה מסוימת.
| טיפוסים בני מנייה (enum) |
TARGET_TYPE_UNSPECIFIED |
הגדרה כשסוג היעד לא צוין. |
ACCOUNTS_ONLY |
הצגת רשימה של הזמנות רק ליעדים מסוג 'חשבון'. |
LOCATIONS_ONLY |
הצגת רשימה של הזמנות רק לטירגוטים מסוג 'מיקום'. |
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 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. |"]]
