このチュートリアルでは、アカウントのデータを管理する方法について説明します。My Business Account Management API では、次のような処理が可能です。
- すべてのアカウントの一覧を取得する。
- 特定のアカウントを取得する。
- アカウントを更新する。
始める前に
My Business Account Management API を使用するには、組み込み先のアプリケーションを事前に登録し、OAuth 2.0 の認証情報を取得する必要があります。
Business Profile API の使用方法について詳しくは、基本設定をご覧ください。
すべてのアカウントの一覧を取得する
認証されたユーザーに関連付けられているアカウントを確認するには、すべてのアカウントの一覧を取得すると簡単です。accounts.list
APIを使用すると、ユーザーに関連付けられているすべてのアカウントの一覧を取得できます。
認証されたユーザーのすべてのアカウントの一覧を取得するには、次のように記述します。
$ GET https://mybusinessaccountmanagement.googleapis.com/v1/accounts
特定のアカウントを返す
場合によっては、認証されたユーザーについて特定のアカウントに関する情報だけを確認したいことがあります。accounts.get
API を使用すると、特定のアカウントを取得して、アカウントの追加情報を確認できます。
名前を指定して特定のアカウントを取得するには、次のように記述します。
$ GET https://mybusinessaccountmanagement.googleapis.com/v1/accounts/{accountId}
アカウントを更新する
アカウント名の変更は、基本的な管理作業の 1 つです。アカウント名を変更するには accounts.update
API を使用します。
名前を指定して特定のアカウントを更新するには、次のように記述します。
$ PUT https://mybusinessaccountmanagement.googleapis.com/v1/accounts/{accountId} { "account": { "accountName": "Anne Droyd" }, "languageCode": "en", "validateOnly": "true" }
制限事項
- アカウントで編集可能なフィールドは
accountName
のみです。これ以外のフィールドを渡した場合は、すべて無視されます。 - この方法で更新できるのは、
BUSINESS
タイプのアカウントのみです。