- בקשת HTTP
- פרמטרים של נתיב
- פרמטרים של שאילתה
- גוף הבקשה
- גוף התשובה
- היקפי הרשאות
- הזמנה
- TargetLocation
- TargetType
בתיבת הדו שיח הזו רשומים הזמנות בהמתנה לחשבון שצוין.
בקשת HTTP
GET https://mybusinessaccountmanagement.googleapis.com/v1/{parent=accounts/*}/invitations
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
parent |
חובה. שם החשבון שממנו מאוחזרת רשימת ההזמנות. |
פרמטרים של שאילתה
פרמטרים | |
---|---|
filter |
אפשרות. אפשר לסנן את התשובה באמצעות השדה Invite.target_type. |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התגובה
הודעת תגובה ל-AccessControl.ListInvites.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
ייצוג JSON |
---|
{
"invitations": [
{
object ( |
שדות | |
---|---|
invitations[] |
אוסף של הזמנות שממתינות לחשבון. מספר ההזמנות המפורטות כאן לא יכול לחרוג מ-1,000. |
היקפי הרשאות
נדרש היקף OAuth הבא:
https://www.googleapis.com/auth/business.manage
למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.
הזמנה
מייצג הזמנה בהמתנה.
ייצוג JSON |
---|
{ "name": string, "role": enum ( |
שדות | |
---|---|
name |
חובה. שם המשאב של ההזמנה. |
role |
פלט בלבד. התפקיד שהוזמן בחשבון. |
targetType |
פלט בלבד. ההגדרה קובעת אילו סוגי טירגוט יופיעו בתגובה. |
שדה איחוד target . שדה זה מציין את היעד של ההזמנה הזו. הערך של target יכול להיות רק אחת מהאפשרויות הבאות: |
|
targetAccount |
החשבון המאוכלס בדלילות שהזמנה זו מיועדת לו. |
targetLocation |
מיקום היעד הגיאוגרפי שההזמנה הזו שייכת לו. |
TargetLocation
מייצג מיקום יעד להזמנה בהמתנה.
ייצוג JSON |
---|
{ "locationName": string, "address": string } |
שדות | |
---|---|
locationName |
שם המיקום שאליו המשתמש מוזמן. |
address |
כתובת המיקום שאליו המשתמש מוזמן. |
TargetType
סוג היעד שאליו מיועדת ההזמנה.
טיפוסים בני מנייה (enums) | |
---|---|
TARGET_TYPE_UNSPECIFIED |
מוגדר כשסוג היעד לא צוין. |
ACCOUNTS_ONLY |
הצג הזמנות רק ליעדים מסוג 'חשבון'. |
LOCATIONS_ONLY |
הצגת הזמנות רק ליעדים מסוג 'מיקום'. |