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.ListInvites.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:

ייצוג 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

סוג היעד שאליו מיועדת ההזמנה.

טיפוסים בני מנייה (enums)
TARGET_TYPE_UNSPECIFIED מוגדר כשסוג היעד לא צוין.
ACCOUNTS_ONLY הצג הזמנות רק ליעדים מסוג 'חשבון'.
LOCATIONS_ONLY הצגת הזמנות רק ליעדים מסוג 'מיקום'.