Package google.mybusiness.accountmanagement.v1

색인

AccessControl

이 서비스를 사용하면 계정 및 위치에 액세스할 수 있는 사용자를 관리할 수 있습니다.

AcceptInvitation

rpc AcceptInvitation(AcceptInvitationRequest) returns (Empty)

지정된 초대를 수락합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 OAuth 2.0 개요를 참고하세요.
CreateAccountAdmin

rpc CreateAccountAdmin(CreateAccountAdminRequest) returns (Admin)

지정된 사용자를 지정된 계정의 관리자로 초대합니다. 초대를 받은 사용자가 초대를 수락해야 계정에 대한 액세스 권한이 부여됩니다. 프로그래매틱 방식으로 초대를 수락하려면 [AcceptInvitation] [google.mybusiness.accountmanagement.v1.AcceptInvitation] 을(를) 참조하세요.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 OAuth 2.0 개요를 참고하세요.
CreateLocationAdmin

rpc CreateLocationAdmin(CreateLocationAdminRequest) returns (Admin)

지정된 사용자를 지정된 위치의 관리자로 초대합니다. 초대를 받은 사용자가 초대를 수락해야 위치에 대한 액세스 권한이 부여됩니다. 프로그래매틱 방식으로 초대를 수락하려면 [AcceptInvitation] [google.mybusiness.accountmangement.v1.AcceptInvitation] 을 참조하세요.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 OAuth 2.0 개요를 참고하세요.
DeclineInvitation

rpc DeclineInvitation(DeclineInvitationRequest) returns (Empty)

지정된 초대를 거부합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 OAuth 2.0 개요를 참고하세요.
DeleteAccountAdmin

rpc DeleteAccountAdmin(DeleteAccountAdminRequest) returns (Empty)

지정된 계정에서 지정된 관리자를 삭제합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 OAuth 2.0 개요를 참고하세요.
DeleteLocationAdmin

rpc DeleteLocationAdmin(DeleteLocationAdminRequest) returns (Empty)

지정된 위치의 관리자로 지정된 관리자를 삭제합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 OAuth 2.0 개요를 참고하세요.
ListAccountAdmins

rpc ListAccountAdmins(ListAccountAdminsRequest) returns (ListAccountAdminsResponse)

지정된 계정의 관리자를 나열합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 OAuth 2.0 개요를 참고하세요.
ListInvitations

rpc ListInvitations(ListInvitationsRequest) returns (ListInvitationsResponse)

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

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 OAuth 2.0 개요를 참고하세요.
ListLocationAdmins

rpc ListLocationAdmins(ListLocationAdminsRequest) returns (ListLocationAdminsResponse)

지정된 위치의 모든 관리자를 나열합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 OAuth 2.0 개요를 참고하세요.
TransferLocation

rpc TransferLocation(TransferLocationRequest) returns (Empty)

사용자가 소유한 계정에서 동일한 사용자가 관리하는 다른 계정으로 위치를 이동합니다. 사용자는 위치가 현재 연결된 계정의 소유자여야 하며, 대상 계정의 관리자 이상이어야 합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 OAuth 2.0 개요를 참고하세요.
UpdateAccountAdmin

rpc UpdateAccountAdmin(UpdateAccountAdminRequest) returns (Admin)

지정된 계정 관리자의 관리자를 업데이트합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 OAuth 2.0 개요를 참고하세요.
UpdateLocationAdmin

rpc UpdateLocationAdmin(UpdateLocationAdminRequest) returns (Admin)

지정된 위치의 관리자를 업데이트합니다. 관리자의 AdminRole만 업데이트할 수 있습니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 OAuth 2.0 개요를 참고하세요.

계정

이 API를 사용하면 Google에서 비즈니스 계정을 관리할 수 있습니다. 이 클래스는 다음과 같은 리소스 모델을 정의합니다.

  • API에는 accounts/*라는 계정 리소스 컬렉션이 있습니다.

  • 편의상 인증된 발신자의 개인 계정에 대한 계정 ID 대신 동의어 'me'를 사용할 수도 있습니다. 예: GET /v1/accounts/me GET /v1/accounts/me/locations

CreateAccount

rpc CreateAccount(CreateAccountRequest) returns (Account)

지정된 상위 항목에 지정된 이름과 유형의 계정을 만듭니다.

  • 개인 계정과 조직은 만들 수 없습니다.
  • 기본 소유자로 개인 계정을 사용하여 사용자 그룹을 만들 수 없습니다.
  • 개인 계정이 조직에 속한 경우 개인 계정의 기본 소유자로 위치 그룹을 만들 수 없습니다.
  • 위치 그룹은 위치 그룹을 소유할 수 없습니다.
승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 OAuth 2.0 개요를 참고하세요.
GetAccount

rpc GetAccount(GetAccountRequest) returns (Account)

지정된 계정을 가져옵니다. 계정이 없거나 호출자에게 계정 액세스 권한이 없는 경우 NOT_FOUND를 반환합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 OAuth 2.0 개요를 참고하세요.
ListAccounts

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse)

인증된 사용자의 모든 계정을 나열합니다. 여기에는 사용자가 소유한 모든 계정과 사용자가 관리 권한을 보유한 계정이 포함됩니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 OAuth 2.0 개요를 참고하세요.
UpdateAccount

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

지정된 비즈니스 계정을 업데이트합니다. 이 방법으로는 개인 계정을 업데이트할 수 없습니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 OAuth 2.0 개요를 참고하세요.

AcceptInvitationRequest

AccessControl.AcceptInvitation 요청 메시지입니다.

필드
name

string

필수 항목입니다. 수락되는 초대의 이름입니다. accounts/{account_id}/invitations/{invitation_id}

계정

계정은 위치의 컨테이너입니다. 비즈니스의 위치를 관리하는 유일한 사용자인 경우 개인 Google 계정을 사용할 수 있습니다. 여러 사용자와 공동으로 위치를 관리하려면 비즈니스 계정을 만드세요.

필드
name

string

변경할 수 없습니다. accounts/{account_id} 형식의 리소스 이름입니다.
account_name

string

필수 항목입니다. 계정의 이름입니다. PERSONAL 유형의 계정의 경우 사용자 계정의 성과 이름입니다.
primary_owner

string

필수 항목입니다. 입력 전용. 생성 중인 계정의 기본 소유자가 될 계정의 리소스 이름입니다. accounts/{account_id} 형식이어야 합니다.
type

AccountType

필수 항목입니다. 계정 유형이 포함됩니다. PERSONAL 및 ORG 유형의 계정은 이 API를 사용하여 만들 수 없습니다.
role

AccountRole

출력 전용. 이 계정의 AccountRole을 지정합니다.
verification_state

VerificationState

출력 전용. 인증을 받으면 향후 만들어지는 위치는 자동으로 Google 지도에 연결되고, 검토 없이도 Google+ 페이지가 생성됩니다.
vetted_state

VettedState

출력 전용. Google에서 계정을 심사했는지 여부를 나타냅니다. 검증된 계정은 VETTED_PARTNER 메서드를 통해 위치를 인증할 수 있습니다.
account_number

string

출력 전용. 계정 참조 번호(프로비저닝된 경우)
permission_level

PermissionLevel

출력 전용. 사용자가 이 계정에 대해 갖는 권한 수준을 지정합니다.
organization_info

OrganizationInfo

출력 전용. 조직의 추가 정보입니다. 조직 계정의 경우에만 채워집니다.

AccountRole

인증된 사용자가 이 계정에 대해 갖는 액세스 수준을 나타냅니다. 자세한 내용은 고객센터 도움말을 참고하세요.

열거형
ACCOUNT_ROLE_UNSPECIFIED 지정되지 않음
PRIMARY_OWNER 사용자가 이 계정의 기본 소유자입니다.
OWNER 계정의 사용자 소유자입니다.
MANAGER 사용자가 이 계정을 관리할 수 있습니다.
SITE_MANAGER 사용자가 계정에서 관리할 수 있는 일부 기능만 관리할 수 있습니다.

AccountType

계정의 종류를 나타냅니다(개인/사용자 계정 또는 비즈니스 계정).

열거형
ACCOUNT_TYPE_UNSPECIFIED 지정되지 않음
PERSONAL 최종 사용자 계정.
LOCATION_GROUP 위치 그룹입니다. 자세한 내용은 고객센터 도움말을 참고하세요.
USER_GROUP 그룹으로 조직 직원을 분리하는 사용자 그룹 자세한 내용은 고객센터 도움말을 참고하세요.
ORGANIZATION 회사를 대표하는 조직입니다. 자세한 내용은 고객센터 도움말을 참고하세요.

OrganizationInfo

조직에 대해 저장된 추가 정보입니다.

필드
registered_domain

string

출력 전용. 계정에 등록된 도메인입니다.
address

PostalAddress

출력 전용. 계정의 우편 주소입니다.
phone_number

string

출력 전용. 조직의 연락처 번호입니다.

PermissionLevel

인증된 사용자가 이 계정에 대해 갖는 액세스 수준을 나타냅니다.

열거형
PERMISSION_LEVEL_UNSPECIFIED 지정되지 않음
OWNER_LEVEL 사용자에게 소유자 수준의 권한이 있습니다.
MEMBER_LEVEL 사용자에게 회원 수준 권한이 있습니다.

VerificationState

계정의 확인 상태를 나타냅니다.

열거형
VERIFICATION_STATE_UNSPECIFIED 지정되지 않음
VERIFIED 인증된 계정입니다.
UNVERIFIED 계정이 인증되지 않았으며, 인증이 요청되지 않았습니다.
VERIFICATION_REQUESTED 인증이 요청되었으나 인증이 필요한 계정입니다.

VettedState

계정의 심사 상태를 나타냅니다.

열거형
VETTED_STATE_UNSPECIFIED 지정되지 않음
NOT_VETTED Google에서 계정을 심사하지 않았습니다.
VETTED 계정이 Google의 심사를 거쳤으며 유효한 상태입니다. 심사를 마친 그룹 계정에 직접 액세스할 수 있는 계정은 자동으로 심사됩니다.
INVALID 계정이 검토되었지만 잘못된 상태입니다. 이 계정은 검증되지 않은 계정처럼 작동합니다.

관리

계정 또는 위치의 관리자입니다.

필드
name

string

변경할 수 없습니다. 리소스 이름입니다. 계정 관리자의 경우 accounts/{account_id}/admins/{admin_id} 형식입니다.

위치 관리자의 경우 locations/{location_id}/admins/{admin_id} 형식입니다.

관리자 생성 중에 이 필드를 설정하면 무시됩니다.
admin

string

선택사항입니다. 관리자의 이름입니다. 처음 초대할 때 이 주소는 초대 대상자의 이메일 주소입니다. GET 호출 시 초대가 아직 대기 중이면 사용자의 이메일 주소가 반환됩니다. 그렇지 않으면 사용자의 성과 이름이 포함됩니다.

이 필드는 관리자 생성 중에만 설정하면 됩니다.
account

string

변경할 수 없습니다. 이 관리자가 참조하는 계정 리소스의 이름입니다. locations.admins.create를 호출하여 LocationGroup을 관리자로 초대할 때 사용됩니다.

이 필드와 admin이 모두 CREATE 요청에서 설정된 경우 이 필드가 우선 적용되며 admin의 이메일 주소는 무시됩니다.

형식은 accounts/{account}입니다.
role

AdminRole

필수 항목입니다. 지정된 계정 또는 위치로 이 관리자가 사용하는 역할을 지정합니다.
pending_invitation

bool

출력 전용. 지정된 리소스에 대해 대기 중인 초대가 이 관리자에게 있는지 여부를 나타냅니다.

AdminRole

관리자의 액세스 수준을 나타냅니다. 자세한 내용은 고객센터 도움말을 참고하세요.

열거형
ADMIN_ROLE_UNSPECIFIED 지정되지 않음
PRIMARY_OWNER 관리자가 소유자 수준의 액세스 권한을 가지며 기본 소유자입니다. (UI에는 '기본 소유자'로 표시됩니다.)
OWNER 관리자에게 소유자 수준의 액세스 권한이 있습니다. (UI에 '소유자'로 표시됨)
MANAGER 관리자에게 관리 액세스 권한이 있습니다.
SITE_MANAGER 관리자가 소셜 (Google+) 페이지를 관리할 수 있습니다. (UI에는 '사이트 관리자'로 표시됨) 이 API에서는 SITE_MANAGER 역할이 있는 계정 관리자를 만들 수 없습니다.

CreateAccountAdminRequest

AccessControl.CreateAccountAdmin 요청 메시지입니다.

필드
parent

string

필수 항목입니다. 이 관리자가 생성된 계정의 리소스 이름입니다. accounts/{account_id}.
admin

Admin

필수 항목입니다. 생성할 관리자입니다. 역할은 SITE_MANAGER가 될 수 없습니다.

CreateAccountRequest

Accounts.CreateAccount에 대한 요청 메시지입니다.

필드
account

Account

필수 항목입니다. 생성할 계정의 계정 정보입니다. 계정 및 유형 필드만 허용됩니다.

CreateLocationAdminRequest

AccessControl.CreateLocationAdmin 요청 메시지입니다.

필드
parent

string

필수 항목입니다. 이 관리자가 생성된 위치의 리소스 이름입니다. locations/{location_id}/admins.
admin

Admin

필수 항목입니다. 생성할 관리자입니다.

DeclineInvitationRequest

AccessControl.DeclineInvitation 요청 메시지입니다.

필드
name

string

필수 항목입니다. 거부되는 계정 초대의 이름입니다. accounts/{account_id}/invitations/{invitation_id}

DeleteAccountAdminRequest

AccessControl.DeleteAccountAdmin 요청 메시지입니다.

필드
name

string

필수 항목입니다. 계정에서 삭제할 관리자의 리소스 이름입니다. accounts/{account_id}/admins/{admin_id}.

DeleteLocationAdminRequest

AccessControl.DeleteLocationAdmin 요청 메시지입니다.

필드
name

string

필수 항목입니다. 위치에서 삭제할 관리자의 리소스 이름입니다.

GetAccountRequest

Accounts.GetAccount에 대한 요청 메시지입니다.

필드
name

string

필수 항목입니다. 가져올 계정의 이름입니다.

초대장

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

필드
name

string

필수 항목입니다. 초대의 리소스 이름입니다. accounts/{account_id}/invitations/{invitation_id}.
role

AdminRole

출력 전용. 계정의 초대된 역할
target_type

TargetType

출력 전용. 응답에 표시되어야 하는 타겟 유형을 지정합니다.
통합 필드 target. 이 초대의 대상을 나타냅니다. target은 다음 중 하나여야 합니다.
target_account

Account

이 초대장에 사용되는 계정의 사용자 밀도가 낮습니다.
target_location

TargetLocation

이 초대의 대상 위치입니다.

TargetLocation

대기 중인 초대의 대상 위치를 나타냅니다.

필드
location_name

string

사용자가 초대된 위치의 이름입니다.
address

string

사용자가 초대된 위치의 주소입니다.

TargetType

초대 대상의 유형입니다.

열거형
TARGET_TYPE_UNSPECIFIED 대상 유형이 지정되지 않은 경우 설정됩니다.
ACCOUNTS_ONLY 계정 유형의 대상에 대한 초대만 나열합니다.
LOCATIONS_ONLY 위치 유형의 대상에 대한 초대만 나열합니다.

ListAccountAdminsRequest

AccessControl.ListAccountAdmins에 대한 요청 메시지입니다.

필드
parent

string

필수 항목입니다. 관리자 목록을 검색할 계정의 이름입니다. accounts/{account_id}/admins.

ListAccountAdminsResponse

AccessControl.ListAccountAdmins의 응답 메시지입니다.

필드
account_admins[]

Admin

관리자 인스턴스의 모음입니다.

ListAccountsRequest

Accounts.ListAccounts의 요청 메시지입니다.

필드
parent_account

string

선택사항입니다. 직접 액세스할 수 있는 계정 목록을 가져올 계정의 리소스 이름입니다. 이는 조직 및 사용자 그룹에만 적용됩니다. 비어 있으면 인증된 사용자의 ListAccounts를 반환합니다. accounts/{account_id}.
page_size

int32

선택사항입니다. 페이지당 가져올 계정 수입니다. 기본값 및 최댓값은 20입니다.
page_token

string

선택사항입니다. 지정하면 계정의 다음 페이지가 검색됩니다. accounts.list 호출이 요청된 페이지 크기에 넣을 수 있는 것보다 많은 결과를 반환하는 경우 pageToken이 반환됩니다.
filter

string

선택사항입니다. 계정의 반환을 제한하는 필터입니다. 응답에는 필터와 일치하는 항목만 포함됩니다. filter가 비어 있으면 제약 조건이 적용되지 않고 요청된 계정에 대해 모든 계정 (페이지 매김)을 가져옵니다.

예를 들어 type=USER_GROUP 필터가 있는 요청은 사용자 그룹만 반환합니다.

type 필드만 지원되는 필터입니다.

ListAccountsResponse

Accounts.ListAccounts의 응답 메시지입니다.

필드
accounts[]

Account

사용자가 액세스할 수 있는 계정의 모음입니다. 쿼리를 수행하는 사용자의 개인 계정이 필터링되지 않는 한 항상 결과의 첫 번째 항목이 됩니다.
next_page_token

string

계정 수가 요청된 페이지 크기를 초과하면 이 필드는 accounts.list에 대한 후속 호출에서 다음 계정 페이지를 가져오는 토큰으로 채워집니다. 더 이상 계정이 없으면 응답에 이 필드가 표시되지 않습니다.

ListInvitationsRequest

AccessControl.ListInvitations 요청 메시지입니다.

필드
parent

string

필수 항목입니다. 초대 목록을 가져오는 계정의 이름입니다. accounts/{account_id}/invitations
filter

string

선택사항입니다. 응답 필터링은 Invitation.target_type 필드를 통해 지원됩니다.

ListInvitationsResponse

AccessControl.ListInvitations의 응답 메시지입니다.

필드
invitations[]

Invitation

해당 계정에서 대기 중인 초대 모음입니다. 여기에 표시된 초대장 수는 1,000개를 초과할 수 없습니다.

ListLocationAdminsRequest

AccessControl.ListLocationAdmins의 요청 메시지입니다.

필드
parent

string

필수 항목입니다. 관리자를 나열할 위치의 이름입니다. locations/{location_id}/admins.

ListLocationAdminsResponse

AccessControl.ListLocationAdmins의 응답 메시지입니다.

필드
admins[]

Admin

관리자 모음입니다.

TransferLocationRequest

AccessControl.TransferLocation 요청 메시지입니다.

필드
name

string

필수 항목입니다. 이전할 위치의 이름입니다. locations/{location_id}.
destination_account

string

필수 항목입니다. 위치를 이전할 계정 리소스의 이름입니다 (예: 'accounts/{account}').

UpdateAccountAdminRequest

AccessControl.UpdateAccountAdmin 요청 메시지입니다.

필드
account_admin

Admin

필수 항목입니다. 업데이트된 버전의 관리자입니다.
update_mask

FieldMask

필수 항목입니다. 업데이트해야 하는 특정 필드 수정 가능한 유일한 필드는 역할입니다.

UpdateAccountRequest

Accounts.UpdateAccount에 대한 요청 메시지입니다.

필드
account

Account

필수 항목입니다. 업데이트된 계정
update_mask

FieldMask

필수 항목입니다. 업데이트해야 하는 특정 필드 유일하게 수정할 수 있는 필드는 accountName입니다.
validate_only

bool

선택사항입니다. true인 경우 실제로 계정을 업데이트하지 않고 요청의 유효성이 검사됩니다.

UpdateLocationAdminRequest

AccessControl.UpdateLocationAdmin 요청 메시지입니다.

필드
location_admin

Admin

필수 항목입니다. 업데이트된 버전의 관리자입니다.
update_mask

FieldMask

필수 항목입니다. 업데이트해야 하는 특정 필드 수정 가능한 유일한 필드는 역할입니다.