Method: accounts.invitations.list
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
בתיבת הדו-שיח הזו מפורטים הזמנות בהמתנה לחשבון שצוין.
בקשת HTTP
GET https://mybusiness.googleapis.com/v4/{parent=accounts/*}/invitations
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
| פרמטרים |
parent |
string
שם החשבון שממנו מאוחזרת רשימת ההזמנות.
|
פרמטרים של שאילתה
| פרמטרים |
targetType |
enum (TargetType)
ההגדרה קובעת אילו סוגי יעדים יופיעו בתשובה.
|
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
הודעת תגובה ל-AccessControl.List שמחs.
| ייצוג JSON |
{
"invitations": [
{
object (Invitation)
}
]
} |
| שדות |
invitations[] |
object (Invitation)
אוסף של הזמנות למיקום שממתינות לחשבון. מספר ההזמנות שמופיע כאן לא יכול לחרוג מ-1,000.
|
היקפי הרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/plus.business.managehttps://www.googleapis.com/auth/business.manage
למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.
TargetType
סוג הטירגוט שאליו שייכת הזמנה מסוימת.
| טיפוסים בני מנייה (enum) |
ALL |
הצגת רשימה של הזמנות לכל סוגי היעדים. (זוהי ברירת המחדל) |
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\u003eThis endpoint retrieves pending invitations for a specified Google My Business account.\u003c/p\u003e\n"],["\u003cp\u003eIt allows filtering by target type (Account or Location) using the \u003ccode\u003etargetType\u003c/code\u003e query parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a list of invitations with details, limited to a maximum of 1000.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization is required using specific OAuth scopes related to business management.\u003c/p\u003e\n"],["\u003cp\u003eThis endpoint is deprecated; consider using the Account Management API instead.\u003c/p\u003e\n"]]],["This document outlines the process of listing pending invitations for a specified account using the deprecated API. It uses a `GET` request to `https://mybusiness.googleapis.com/v4/{parent=accounts/*}/invitations`. The `parent` path parameter specifies the account. The `targetType` query parameter filters invitation types. An empty request body is required. The response returns a JSON array of `invitations`, each represented as an object. The request needs either the `plus.business.manage` or `business.manage` authorization scope. Three types are available: ALL, ACCOUNTS_ONLY and LOCATIONS_ONLY.\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- [TargetType](#TargetType)\n\n| Deprecated. Please use the [Account Management API](https://developers.google.com/my-business/reference/accountmanagement/rest/v1/accounts.invitations/list) instead.\nLists pending invitations for the specified account.\n\n### HTTP request\n\n`GET https://mybusiness.googleapis.com/v4/{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` The name of the account from which the list of invitations is being retrieved. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `targetType` | `enum (`[TargetType](/my-business/reference/rest/v4/accounts.invitations/list#TargetType)`)` Specifies which target types should appear in the response. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nResponse message for AccessControl.ListInvitations.\n\n| JSON representation ||\n|------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"invitations\": [ { object (/my-business/reference/rest/v4/accounts.invitations#Invitation) } ] } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `invitations[]` | `object (`[Invitation](/my-business/reference/rest/v4/accounts.invitations#Invitation)`)` A collection of location invitations that are pending for the account. The number of invitations listed here cannot exceed 1000. |\n\n### Authorization Scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/plus.business.manage`\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\nTargetType\n----------\n\nThe type of target an invitation is for.\n\n| Enums ||\n|------------------|-------------------------------------------------------------|\n| `ALL` | List invitations for all target types. This is the default. |\n| `ACCOUNTS_ONLY` | List invitations only for targets of type Account. |\n| `LOCATIONS_ONLY` | List invitations only for targets of type Location. |"]]
