このチュートリアルでは、アカウントのデータを操作する方法を説明します。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}
アカウントの更新
アカウント名の変更は基本管理作業です。アカウント名を変更するには、accounts.update
API を使用します。
特定のアカウントを名前で更新するには、次のように記述します。
$ PUT https://mybusinessaccountmanagement.googleapis.com/v1/accounts/{accountId} { "account": { "accountName": "Anne Droyd" }, "languageCode": "en", "validateOnly": "true" }
制限事項
- アカウントで編集可能なフィールドは
accountName
のみです。渡された他のフィールドは無視されます。 - この方法で更新できるのは、
BUSINESS
タイプのアカウントのみです。