Method: accounts.invitations.list

列出指定帳戶的待回覆邀請。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

必要欄位。要擷取邀請清單的帳戶名稱。accounts/{account_id}/invitations

查詢參數

參數
filter

string

選用設定。系統支援透過 Invite.target_type 欄位篩選回應。

要求主體

要求主體必須為空白。

回應主體

AccessControl.ListInvites 的回應訊息。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "invitations": [
    {
      object (Invitation)
    }
  ]
}
欄位
invitations[]

object (Invitation)

帳戶仍待處理的邀請集合。這裡列出的邀請數不得超過 1000 則。

授權範圍

需要下列 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

邀請的目標類型。

列舉
TARGET_TYPE_UNSPECIFIED 在未指定目標類型時設定。
ACCOUNTS_ONLY 僅列出帳戶目標類型的邀請。
LOCATIONS_ONLY 僅針對地點類型列出邀請。