Method: accounts.invitations.list

列出指定帳戶的待處理邀請。

HTTP 要求

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

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

路徑參數

參數
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。

Invitation

代表待處理的邀請。

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

僅供輸出。使用者受邀加入的地點 ID。不一定會填入。

TargetType

邀請的目標類型。

列舉
TARGET_TYPE_UNSPECIFIED 未指定目標類型時設定。
ACCOUNTS_ONLY 僅列出帳戶類型目標的邀請。
LOCATIONS_ONLY 僅適用於「地點」類型的目標。