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)

指定したビジネスの管理者に指定した Admin を削除します。

認可スコープ

次の 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)

指定したアカウント管理者の Admin を更新します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、OAuth 2.0 の概要をご覧ください。
UpdateLocationAdmin

rpc UpdateLocationAdmin(UpdateLocationAdminRequest) returns (Admin)

指定したビジネスの 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

必須。アカウントのタイプが含まれます。この API を使用して、タイプ PERSONAL および ORGANIZATION のアカウントを作成することはできません。
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+）ページを管理できます。（管理画面では「サイト管理者」と表示されます）。この API では、SITE_MCC ロールを持つアカウント管理者の作成はできません。

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

（省略可）1 ページあたりで取得するアカウント数。デフォルト値は 20 で、最大値は 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

Admin のコレクション。

TransferLocationRequest

AccessControl.TransferLocation に対するリクエスト メッセージです。

フィールド
name

string

必須。移管するビジネスの名前。locations/{location_id}.
destination_account

string

必須。ビジネスの移管先となるアカウント リソースの名前（例: "accounts/{account}"）。

UpdateAccountAdminRequest

AccessControl.UpdateAccountAdmin に対するリクエスト メッセージです。

フィールド
account_admin

Admin

必須。最新バージョンの Admin。
update_mask

FieldMask

必須。更新するフィールドです。編集可能なフィールドはロールのみです。

UpdateAccountRequest

Accounts.UpdateAccount に対するリクエスト メッセージです。

フィールド
account

Account

必須。更新されたアカウント。
update_mask

FieldMask

必須。更新するフィールドです。編集可能なフィールドは accountName のみです。
validate_only

bool

（省略可）true の場合、アカウントが実際に更新されることなく、リクエストの検証のみが行われます。

UpdateLocationAdminRequest

AccessControl.UpdateLocationAdmin に対するリクエスト メッセージです。

フィールド
location_admin

Admin

必須。最新バージョンの Admin。
update_mask

FieldMask

必須。更新するフィールドです。編集可能なフィールドはロールのみです。