Google My Business API

Google My Business API 提供介面,方便你管理 Google 上的商家位置資訊。

服務:mybusiness.googleapis.com

如要呼叫這項服務,建議您使用 Google 提供的用戶端程式庫。如果應用程式需要使用您自己的程式庫來呼叫這項服務,請在提出 API 要求時使用下列資訊。

探索文件

探索文件是一種機器可解讀的規格,用於說明和使用 REST API。此文件用於建構用戶端程式庫、IDE 外掛程式,以及與 Google API 互動的其他工具。一項服務可能會提供多個探索文件。此服務提供下列探索文件:

服務端點

服務端點是指定 API 服務網路位址的基準網址。一項服務可能有多個服務端點。這項服務有以下服務端點,且下方的 URI 皆以此服務端點為基準:

  • https://mybusiness.googleapis.com

REST 資源:v4.accounts

方法
create
(deprecated)
POST /v4/accounts
在指定父項底下以指定名稱和類型建立帳戶。
deleteNotifications
(deprecated)
DELETE /v4/{name=accounts/*/notifications}
清除帳戶的 Pub/Sub 通知設定。
generateAccountNumber
(deprecated)
POST /v4/{name=accounts/*}:generateAccountNumber
為這個帳戶產生帳號。
get
(deprecated)
GET /v4/{name=accounts/*}
取得指定帳戶。
getNotifications
(deprecated)
GET /v4/{name=accounts/*/notifications}
傳回帳戶的 Pub/Sub 通知設定。
list
(deprecated)
GET /v4/accounts
列出已驗證使用者的所有帳戶。
listRecommendGoogleLocations GET /v4/{name=accounts/*}:recommendGoogleLocations
列出對指定商家檔案帳戶建議的所有GoogleLocation
update
(deprecated)
PUT /v4/{name=accounts/*}
更新指定的商家帳戶。
updateNotifications
(deprecated)
PUT /v4/{name=accounts/*/notifications}

為通知商家檔案的帳戶設定 Pub/Sub 通知設定,以便傳送下列主題的 Pub/Sub 通知:

  • 針對這個帳戶所管理營業地點的新評論。

REST 資源:v4.accounts.admins

方法
create
(deprecated)
POST /v4/{parent=accounts/*}/admins
邀請指定使用者成為指定帳戶的管理員。
delete
(deprecated)
DELETE /v4/{name=accounts/*/admins/*}
從指定帳戶中移除指定管理員。
list
(deprecated)
GET /v4/{parent=accounts/*}/admins
列出指定帳戶的管理員。
patch
(deprecated)
PATCH /v4/{name=accounts/*/admins/*}
更新指定帳戶管理員。

REST 資源:v4.accounts.invitations

方法
accept
(deprecated)
POST /v4/{name=accounts/*/invitations/*}:accept
接受指定的邀請。
decline
(deprecated)
POST /v4/{name=accounts/*/invitations/*}:decline
拒絕指定的邀請。
list
(deprecated)
GET /v4/{parent=accounts/*}/invitations
列出指定帳戶的待處理邀請。

REST 資源:v4.accounts.locations

方法
associate POST /v4/{name=accounts/*/locations/*}:associate
將地點與地點 ID 建立關聯。
batchGet POST /v4/{name=accounts/*}/locations:batchGet
取得指定帳戶中所有指定地區。
batchGetReviews POST /v4/{name=accounts/*}/locations:batchGetReviews
傳回所有指定地區的分頁評論清單。
clearAssociation POST /v4/{name=accounts/*/locations/*}:clearAssociation
清除地點與地點 ID 之間的關聯。
create POST /v4/{parent=accounts/*}/locations
建立並傳回指定帳戶擁有的新 location
delete DELETE /v4/{name=accounts/*/locations/*}
刪除位置。
fetchVerificationOptions POST /v4/{name=accounts/*/locations/*}:fetchVerificationOptions
回報特定地區語言的所有適用驗證選項。
findMatches POST /v4/{name=accounts/*/locations/*}:findMatches
尋找與指定地區相符的所有可能地點。
get GET /v4/{name=accounts/*/locations/*}
取得指定位置。
getFoodMenus GET /v4/{name=accounts/*/locations/*/foodMenus}
傳回特定地點的菜單。
getGoogleUpdated GET /v4/{name=accounts/*/locations/*}:googleUpdated
取得指定位置的 Google 更新版本。
getHealthProviderAttributes GET /v4/{name=accounts/*/locations/*/healthProviderAttributes}
傳回特定地點的健康提供者屬性。
getServiceList GET /v4/{name=accounts/*/locations/*/serviceList}
取得地點的指定服務清單。
list GET /v4/{parent=accounts/*}/locations
列出指定帳戶的地點。
patch PATCH /v4/{name=accounts/*/locations/*}
更新指定位置。
reportInsights POST /v4/{name=accounts/*}/locations:reportInsights
傳回報表,當中含有各地區對一或多個指標的洞察資料。
transfer
(deprecated)
POST /v4/{name=accounts/*/locations/*}:transfer
將營業地點從使用者擁有的帳戶移至同一個使用者管理的其他帳戶。
updateFoodMenus PATCH /v4/{foodMenus.name=accounts/*/locations/*/foodMenus}
更新特定地點的菜單。
updateHealthProviderAttributes PATCH /v4/{healthProviderAttributes.name=accounts/*/locations/*/healthProviderAttributes}
更新特定地點的健康提供者屬性。
updateServiceList PATCH /v4/{serviceList.name=accounts/*/locations/*/serviceList}
更新地點的指定服務清單。
verify POST /v4/{name=accounts/*/locations/*}:verify
啟動地點驗證程序。

REST 資源:v4.accounts.locations.admins

方法
create
(deprecated)
POST /v4/{parent=accounts/*/locations/*}/admins
邀請指定的使用者成為指定位置的管理員。
delete
(deprecated)
DELETE /v4/{name=accounts/*/locations/*/admins/*}
移除指定營業地點管理員的管理員身分。
list
(deprecated)
GET /v4/{parent=accounts/*/locations/*}/admins
列出指定位置的所有管理員。
patch
(deprecated)
PATCH /v4/{name=accounts/*/locations/*/admins/*}
更新指定位置管理員的管理員。

REST 資源:v4.accounts.locations.followers

方法
getMetadata GET /v4/{name=accounts/*/locations/*/followers/metadata}
取得地點的追蹤者設定。

REST 資源:v4.accounts.locations.insuranceNetworks

方法
list GET /v4/{parent=accounts/*/locations/*}/insuranceNetworks
傳回 Google 支援的所有保險網絡清單。

REST 資源:v4.accounts.locations.localPosts

方法
create POST /v4/{parent=accounts/*/locations/*}/localPosts
建立並傳回與指定地點相關聯的新當地貼文。
delete DELETE /v4/{name=accounts/*/locations/*/localPosts/*}
刪除本機貼文。
get GET /v4/{name=accounts/*/locations/*/localPosts/*}
取得指定的當地貼文。
list GET /v4/{parent=accounts/*/locations/*}/localPosts
傳回與地點相關聯的當地貼文清單。
patch PATCH /v4/{name=accounts/*/locations/*/localPosts/*}
更新指定的當地貼文,並傳回更新後的當地貼文。
reportInsights POST /v4/{name=accounts/*/locations/*}/localPosts:reportInsights
針對與單一商家資訊相關聯的一組當地貼文傳回深入分析。

REST 資源:v4.accounts.locations.media

方法
create POST /v4/{parent=accounts/*/locations/*}/media
建立位置的新媒體項目。
delete DELETE /v4/{name=accounts/*/locations/*/media/*}
刪除指定媒體項目。
get GET /v4/{name=accounts/*/locations/*/media/*}
傳回所要求媒體項目的中繼資料。
list GET /v4/{parent=accounts/*/locations/*}/media
傳回與位置相關聯的媒體項目清單。
patch PATCH /v4/{name=accounts/*/locations/*/media/*}
更新指定媒體項目的中繼資料。
startUpload POST /v4/{parent=accounts/*/locations/*}/media:startUpload
產生 MediaItemDataRef 用於上傳媒體項目。

REST 資源:v4.accounts.locations.media.customers

方法
get GET /v4/{name=accounts/*/locations/*/media/customers/*}
傳回所要求客戶媒體項目的中繼資料。
list GET /v4/{parent=accounts/*/locations/*}/media/customers
傳回與客戶提供地點相關的媒體項目清單。

REST 資源:v4.accounts.locations.questions

方法
create POST /v4/{parent=accounts/*/locations/*}/questions
新增指定地點的問題。
delete DELETE /v4/{name=accounts/*/locations/*/questions/*}
刪除目前使用者撰寫的特定問題。
list GET /v4/{parent=accounts/*/locations/*}/questions
傳回分頁清單,其中列出特定位置的問題和部分答案。
patch PATCH /v4/{name=accounts/*/locations/*/questions/*}
更新目前使用者撰寫的特定問題。

REST 資源:v4.accounts.locations.questions.answers

方法
delete DELETE /v4/{parent=accounts/*/locations/*/questions/*}/answers:delete
刪除目前使用者針對問題所撰寫的答案。
list GET /v4/{parent=accounts/*/locations/*/questions/*}/answers
傳回指定問題的答案分頁清單。
upsert POST /v4/{parent=accounts/*/locations/*/questions/*}/answers:upsert
建立答案或更新使用者針對指定問題撰寫的現有答案。

REST 資源:v4.accounts.locations.reviews

方法
deleteReply DELETE /v4/{name=accounts/*/locations/*/reviews/*}/reply
刪除對指定評論的回應。
get GET /v4/{name=accounts/*/locations/*/reviews/*}
傳回指定評論。
list GET /v4/{parent=accounts/*/locations/*}/reviews
傳回指定地點的評論分頁清單。
updateReply PUT /v4/{name=accounts/*/locations/*/reviews/*}/reply
更新對特定評論的回覆。

REST 資源:v4.accounts.locations.verifications

方法
complete POST /v4/{name=accounts/*/locations/*/verifications/*}:complete
完成「PENDING」驗證。
list GET /v4/{parent=accounts/*/locations/*}/verifications
列出地點的驗證作業,按照建立時間排序。

REST 資源:v4.attributes

方法
list GET /v4/attributes
傳回在指定主要類別和國家/地區,可用的地點可用的屬性清單。

REST 資源:v4.categories

方法
batchGet GET /v4/categories:batchGet
針對指定語言和 GConcept ID 傳回業務類別清單。
list GET /v4/categories
傳回業務類別清單。

REST 資源:v4.chains

方法
get GET /v4/{name=chains/*}
取得指定鏈結。
search GET /v4/chains:search
根據連鎖店名稱搜尋鏈結。

REST 資源:v4.googleLocations

方法
report POST /v4/{name=googleLocations/*}:report
檢舉GoogleLocation
search POST /v4/googleLocations:search
搜尋與指定要求相符的所有可能位置。

服務:mybusiness.googleapis.com

如要呼叫這項服務,建議您使用 Google 提供的用戶端程式庫。如果應用程式需要使用您自己的程式庫來呼叫這項服務,請在提出 API 要求時使用下列資訊。

探索文件

探索文件是一種機器可解讀的規格,用於說明和使用 REST API。此文件用於建構用戶端程式庫、IDE 外掛程式,以及與 Google API 互動的其他工具。一項服務可能會提供多個探索文件。此服務提供下列探索文件:

服務端點

服務端點是指定 API 服務網路位址的基準網址。一項服務可能有多個服務端點。這項服務有以下服務端點,且下方的 URI 皆以此服務端點為基準:

  • https://mybusiness.googleapis.com

REST 資源:v1.media

方法
upload POST /v1/media/{resourceName=**}
POST /upload/v1/media/{resourceName=**}
上傳媒體。