ビジネスプロフィール設定

/v1/settings/business/profile

/v1/settings/business/profileエンドポイントを使用して、ビジネスの住所、ビジネスの説明、ビジネスの連絡先メールアドレス、ビジネスの業種、ビジネスのウェブサイトなど、ビジネスプロフィール設定を構成します。

開始する前に

ビジネスプロフィール設定にアクセスするには、必ずadminアカウントを使用してください。

取得

ビジネスプロフィール設定を取得するには、GET API呼び出しを送信します。

例

GET /v1/settings/business/profile

成功すると、ビジネスプロフィールのデータを含むprofileオブジェクトなどが応答として返されます。データの詳細な説明については、下記のパラメーターのリストをご覧ください。

{
   "settings": {
     "business": {
        "profile": {
          "address": "new-business-address",
          "description": "business-description",
          "email": "new-business-email",
          "vertical": "business-industry",
          "websites": [ "website-1", "website-2" ]
        }
      }
}

エラーが発生した場合は、エラーおよびステータスメッセージをご覧ください。

ビジネスプロフィール設定の更新

ビジネスプロフィール設定を更新するには、POST API呼び出しを送信します。

例

POST /v1/settings/business/profile
{
    "address": "your-business-address",
    "description": "your-business-description",
    "email": "your-business-email",
    "vertical": "your-business-industry",
    "websites": [ "your-website-1", "your-website-2" ]
}

パラメーター

名前	説明
`address` 型: 文字列	ビジネスの住所。最大256文字です。
`description` 型: 文字列	ビジネスの説明。最大512文字です。
`email` 型: 文字列	ビジネスの連絡先のメールアドレス(有効なメールアドレス形式で指定)。最大128文字です。
`vertical` 型: 文字列	ビジネスの業種。使用可能な次の値のいずれかを指定する必要があります。 `Automotive` `Beauty, Spa and Salon` `Clothing and Apparel` `Education` `Entertainment` `Event Planning and Service` `Finance and Banking` `Food and Grocery` `Public Service` `Hotel and Lodging` `Medical and Health` `Non-profit` `Professional Services` `Shopping and Retail` `Travel and Transportation` `Restaurant` `Other` ビジネスの業種を設定した後、空の値に戻すことはできません。
`websites` 型: 文字列の配列	ビジネスに関連付けられた(`http://`または`https://`を含む) URL (例: ウェブサイト、Facebookページ、Instagram)。最大2つのウェブサイト(それぞれ最大256文字)を指定できます。

部分更新

一部のフィールドのみを新しい情報に更新する場合は、次のように、必要なフィールドのみを変更するリクエストを実行できます。

  POST /v1/settings/business/profile
{
    "address": "new-business-address",
    "email": "new-business-email"
}

リクエストが成功した場合は、HTTPステータスコード200 OKに加え、nullまたは{}が返されます。エラーが発生した場合は、エラーおよびステータスメッセージをご覧ください。