Method: accounts.invitations.list

מציגה רשימה של הזמנות בהמתנה לחשבון שצוין.

בקשת HTTP

GET https://mybusinessaccountmanagement.googleapis.com/v1/{parent=accounts/*}/invitations

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
parent

string

חובה. שם החשבון שממנו מאוחזרת רשימת ההזמנות. accounts/{account_id}/invitations

פרמטרים של שאילתה

פרמטרים
filter

string

אופציונלי. אפשר לסנן את התגובה באמצעות השדה Invitation.target_type.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

הודעת תגובה ל-AccessControl.ListInvitations.

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

ייצוג ב-JSON 
{
  "invitations": [
    {
      object (Invitation)
    }
  ]
}
שדות
invitations[]

object (Invitation)

אוסף של הזמנות שממתינות לאישור בחשבון. מספר ההזמנות שמופיעות כאן לא יכול להיות גדול מ-1,000.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/business.manage

ניתן למצוא מידע נוסף כאן: OAuth 2.0 Overview.

הזמנה

מייצג הזמנה בהמתנה.

ייצוג ב-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,
  "placeId": string
}
שדות
locationName

string

השם של המיקום שאליו המשתמש מוזמן.
address

string

הכתובת של המיקום שאליו המשתמש מוזמן. לא תמיד מאוכלס.
placeId

string

פלט בלבד. מזהה המקום של המיקום שאליו הוזמן המשתמש. לא תמיד מאוכלס.

TargetType

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

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