Method: accounts.invitations.list

지정된 계정의 대기 중인 초대를 나열합니다.

HTTP 요청

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

URL은 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 개요를 참고하세요.

초대장

대기 중인 초대를 나타냅니다.

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 위치 유형의 대상에 대한 초대만 나열합니다.