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 הצגת רשימה של הזמנות רק לטירגוטים מסוג 'מיקום'.