索引
AccessControl
(介面) (已淘汰)Accounts
(介面) (已淘汰)BusinessCategories
(介面)BusinessMessagingService
(介面)Followers
(介面)FoodMenuService
(介面)GoogleLocations
(介面)HealthProviderAttributesService
(介面)Insights
(介面)InsuranceNetworkService
(介面)LocalPosts
(介面)Locations
(介面)Media
(介面)QuestionsAndAnswers
(介面)Reviews
(介面)ServiceLists
(介面)Verifications
(介面)AcceptInvitationRequest
(訊息)Account
(訊息) (已淘汰)Account.OrganizationInfo
(訊息)AccountRole
(列舉)AccountState
(訊息)AccountState.AccountStatus
(列舉)AccountType
(列舉)AdWordsLocationExtensions
(訊息)AddressInput
(訊息)Admin
(訊息)Admin.AdminRole
(列舉)AlertType
(列舉)Allergen
(列舉)Answer
(訊息)AssociateLocationRequest
(訊息)Attribute
(訊息)AttributeMetadata
(訊息)AttributeMetadata.AttributeValueMetadata
(訊息)AttributeValueType
(列舉)Author
(訊息)Author.AuthorType
(列舉)BasicMetricsRequest
(訊息)BatchGetBusinessCategoriesRequest
(訊息)BatchGetBusinessCategoriesResponse
(訊息)BatchGetLocationsRequest
(訊息)BatchGetLocationsResponse
(訊息)BatchGetReviewsRequest
(訊息)BatchGetReviewsResponse
(訊息)BusinessHours
(訊息)CallToAction
(訊息)CallToAction.ActionType
(列舉)Category
(訊息)CategoryView
(列舉)Chain
(訊息)Chain.ChainName
(訊息)Chain.ChainUrl
(訊息)ClearLocationAssociationRequest
(訊息)CompleteVerificationRequest
(訊息)CompleteVerificationResponse
(訊息)CreateAccountAdminRequest
(訊息)CreateAccountRequest
(訊息)CreateLocalPostRequest
(訊息)CreateLocationAdminRequest
(訊息)CreateLocationRequest
(訊息)CreateMediaItemRequest
(訊息)CreateQuestionRequest
(訊息)DeclineInvitationRequest
(訊息)DeleteAccountAdminRequest
(訊息)DeleteAnswerRequest
(訊息)DeleteLocalPostRequest
(訊息)DeleteLocationAdminRequest
(訊息)DeleteLocationRequest
(訊息)DeleteMediaItemRequest
(訊息)DeleteNotificationsRequest
(訊息)DeleteQuestionRequest
(訊息)DeleteReviewReplyRequest
(訊息)DietaryRestriction
(列舉)DimensionalMetricValue
(訊息)DimensionalMetricValue.TimeDimension
(訊息)DrivingDirectionMetricsRequest
(訊息)DrivingDirectionMetricsRequest.NumDays
(列舉)EmailInput
(訊息)ErrorDetail
(訊息)ErrorDetail.ErrorCode
(列舉)FetchVerificationOptionsRequest
(訊息)FetchVerificationOptionsResponse
(訊息)FindMatchingLocationsRequest
(訊息)FindMatchingLocationsResponse
(訊息)FollowersMetadata
(訊息)FoodMenu
(訊息)FoodMenu.Cuisine
(列舉)FoodMenuItem
(訊息)FoodMenuItemAttributes
(訊息)FoodMenuItemAttributes.Ingredient
(訊息)FoodMenuItemAttributes.PortionSize
(訊息)FoodMenuItemOption
(訊息)FoodMenuSection
(訊息)FoodMenus
(訊息)GenerateAccountNumberRequest
(訊息)GetAccountRequest
(訊息)GetChainRequest
(訊息)GetCustomerMediaItemRequest
(訊息)GetFollowersMetadataRequest
(訊息)GetFoodMenusRequest
(訊息)GetHealthProviderAttributesRequest
(訊息)GetLocalPostRequest
(訊息)GetLocationRequest
(訊息)GetMediaItemRequest
(訊息)GetNotificationsRequest
(訊息)GetReviewRequest
(訊息)GetServiceListRequest
(訊息)GoogleLocation
(訊息)GoogleUpdatedLocation
(訊息)HealthProviderAttributes
(訊息)InsuranceNetwork
(訊息)InternalError
(訊息)Invitation
(訊息)Invitation.TargetLocation
(訊息)ListAccountAdminsRequest
(訊息)ListAccountAdminsResponse
(訊息)ListAccountsRequest
(訊息)ListAccountsResponse
(訊息)ListAnswersRequest
(訊息)ListAnswersResponse
(訊息)ListAttributeMetadataRequest
(訊息)ListAttributeMetadataResponse
(訊息)ListBusinessCategoriesRequest
(訊息)ListBusinessCategoriesResponse
(訊息)ListCustomerMediaItemsRequest
(訊息)ListCustomerMediaItemsResponse
(訊息)ListInsuranceNetworksRequest
(訊息)ListInsuranceNetworksResponse
(訊息)ListInvitationsRequest
(訊息)ListInvitationsRequest.TargetType
(列舉)ListInvitationsResponse
(訊息)ListLocalPostsRequest
(訊息)ListLocalPostsResponse
(訊息)ListLocationAdminsRequest
(訊息)ListLocationAdminsResponse
(訊息)ListLocationsRequest
(訊息)ListLocationsResponse
(訊息)ListMediaItemsRequest
(訊息)ListMediaItemsResponse
(訊息)ListQuestionsRequest
(訊息)ListQuestionsResponse
(訊息)ListRecommendedGoogleLocationsRequest
(訊息)ListRecommendedGoogleLocationsResponse
(訊息)ListReviewsRequest
(訊息)ListReviewsResponse
(訊息)ListVerificationsRequest
(訊息)ListVerificationsResponse
(訊息)LocalPost
(訊息)LocalPost.LocalPostState
(列舉)LocalPostEvent
(訊息)LocalPostMetrics
(訊息)LocalPostOffer
(訊息)LocalPostTopicType
(列舉)Location
(訊息)Location.Metadata
(訊息)Location.Metadata.Duplicate
(訊息)Location.Metadata.Duplicate.Access
(列舉)Location.RelationshipData
(訊息)LocationDrivingDirectionMetrics
(訊息)LocationDrivingDirectionMetrics.TopDirectionSources
(訊息)LocationDrivingDirectionMetrics.TopDirectionSources.RegionCount
(訊息)LocationKey
(訊息)LocationMetrics
(訊息)LocationReview
(訊息)LocationState
(訊息)MatchedLocation
(訊息)MediaItem
(訊息)MediaItem.Attribution
(訊息)MediaItem.Dimensions
(訊息)MediaItem.LocationAssociation
(訊息)MediaItem.LocationAssociation.Category
(列舉)MediaItem.MediaFormat
(列舉)MediaItem.MediaInsights
(訊息)MediaItemDataRef
(訊息)MenuLabel
(訊息)Metric
(列舉)MetricOption
(列舉)MetricRequest
(訊息)MetricValue
(訊息)MoreHours
(訊息)MoreHoursType
(訊息)NetworkState
(列舉)NotificationType
(列舉)Notifications
(訊息)NutritionFacts
(訊息)NutritionFacts.CaloriesFact
(訊息)NutritionFacts.EnergyUnit
(列舉)NutritionFacts.MassUnit
(列舉)NutritionFacts.NutritionFact
(訊息)OpenInfo
(訊息)OpenInfo.OpenForBusiness
(列舉)PermissionLevel
(列舉)PhoneInput
(訊息)PlaceInfo
(訊息)Places
(訊息)PointRadius
(訊息)PreparationMethod
(列舉)PriceList
(訊息) (已淘汰)PriceList.Label
(訊息)PriceList.Section
(訊息)PriceList.Section.Item
(訊息)PriceList.Section.SectionType
(列舉)Profile
(訊息)Question
(訊息)RepeatedEnumAttributeValue
(訊息)ReportGoogleLocationRequest
(訊息)ReportGoogleLocationRequest.BadLocationReason
(列舉)ReportGoogleLocationRequest.BadRecommendationReason
(列舉)ReportLocalPostInsightsRequest
(訊息)ReportLocalPostInsightsResponse
(訊息)ReportLocationInsightsRequest
(訊息)ReportLocationInsightsResponse
(訊息)Review
(訊息)Review.Reviewer
(訊息)Review.StarRating
(列舉)ReviewReply
(訊息)SearchChainsRequest
(訊息)SearchChainsResponse
(訊息)SearchGoogleLocationsRequest
(訊息)SearchGoogleLocationsResponse
(訊息)ServiceAreaBusiness
(訊息)ServiceAreaBusiness.BusinessType
(列舉)ServiceBusinessContext
(訊息)ServiceList
(訊息)ServiceList.ServiceItem
(訊息)ServiceList.ServiceItem.FreeFormServiceItem
(訊息)ServiceList.ServiceItem.StructuredServiceItem
(訊息)ServiceType
(訊息)SpecialHourPeriod
(訊息)SpecialHours
(訊息)Spiciness
(列舉)StartUploadMediaItemDataRequest
(訊息)TimeInterval
(訊息)TimePeriod
(訊息)TimeRange
(訊息)TransferLocationRequest
(訊息)UpdateAccountAdminRequest
(訊息)UpdateAccountRequest
(訊息)UpdateFoodMenusRequest
(訊息)UpdateHealthProviderAttributesRequest
(訊息)UpdateLocalPostRequest
(訊息)UpdateLocationAdminRequest
(訊息)UpdateLocationRequest
(訊息)UpdateMediaItemRequest
(訊息)UpdateNotificationsRequest
(訊息)UpdateQuestionRequest
(訊息)UpdateReviewReplyRequest
(訊息)UpdateServiceListRequest
(訊息)UpsertAnswerRequest
(訊息)UrlAttributeValue
(訊息)ValidationError
(訊息)Verification
(訊息)Verification.VerificationState
(列舉)VerificationMethod
(列舉)VerificationOption
(訊息)VerificationOption.AddressVerificationData
(訊息)VerificationOption.EmailVerificationData
(訊息)VerificationOption.PhoneVerificationData
(訊息)VerifyLocationRequest
(訊息)VerifyLocationResponse
(訊息)
AccessControl
這項服務可讓您管理有權存取帳戶和地點的使用者。
AcceptInvitation | |
---|---|
接受指定的邀請。
|
CreateAccountAdmin | |
---|---|
邀請指定使用者成為指定帳戶的管理員。邀請對象必須接受邀請,才能獲得帳戶存取權。如要透過程式輔助方式接受邀請,請參閱 [Accept 邀請] [google.mybusiness.v4.AcceptInvite]。
|
CreateLocationAdmin | |
---|---|
邀請指定使用者成為指定位置的管理員。邀請對象必須接受邀請,才能取得該地點的存取權。如要透過程式輔助方式接受邀請,請參閱 [Accept 邀請] [google.mybusiness.v4.AcceptInvite]。
|
DeclineInvitation | |
---|---|
拒絕指定的邀請。
|
DeleteAccountAdmin | |
---|---|
從指定帳戶中移除指定的管理員。
|
DeleteLocationAdmin | |
---|---|
移除指定營業地點管理員的管理員身分。
|
ListAccountAdmins | |
---|---|
列出指定帳戶的管理員。
|
ListInvitations | |
---|---|
列出指定帳戶的待回覆邀請。
|
ListLocationAdmins | |
---|---|
列出指定位置的所有管理員。
|
UpdateAccountAdmin | |
---|---|
更新指定帳戶管理員。只有管理員的管理員角色可以更新。
|
UpdateLocationAdmin | |
---|---|
更新特定營業地點管理員的管理員。只有管理員的管理員角色可以更新。
|
客戶
這個 API 可讓您管理 Google 的企業帳戶。可讓您管理 Account
資源。並定義下列資源模型:
API 擁有一組名為
accounts/*
的Account
資源為方便起見,您可以在已驗證呼叫端的個人帳戶中使用「me」同義詞,而非帳戶 ID。範例:GET /v4/accounts/me GET /v4/accounts/me/locations
CreateAccount | |
---|---|
在指定父項底下以指定名稱和類型建立帳戶。
|
DeleteNotifications | |
---|---|
清除帳戶的 Pub/Sub 通知設定。
|
GenerateAccountNumber | |
---|---|
為這個帳戶產生帳號。建立帳戶時不會佈建帳號。如有需要,請透過這項要求建立帳號。
|
GetAccount | |
---|---|
取得指定帳戶。如果帳戶不存在,或呼叫端沒有帳戶的存取權限,系統會傳回
|
GetNotifications | |
---|---|
傳回帳戶的 Pub/Sub 通知設定。
|
ListAccounts | |
---|---|
列出已驗證使用者的所有帳戶。包括使用者擁有的所有帳戶,以及使用者擁有管理權限的所有帳戶。
|
UpdateAccount | |
---|---|
更新指定的商家帳戶。個人帳戶無法使用這個方法更新。
|
UpdateNotifications | |
---|---|
為通知商家檔案的帳戶設定 Pub/Sub 通知設定,以便傳送下列主題的 Pub/Sub 通知:
每個帳戶只能有一個通知設定資源,而且只能設定一個 Pub/Sub 主題。
|
BusinessCategories
這個 API 會顯示 Google 上商家所在地點支援的類別。您可以取得所有可用業務類別的分頁清單,也可以按特定字詞搜尋。詳情請參閱本文中的「類別」一節:https://support.google.com/business/answer/3038177
BatchGetBusinessCategories | |
---|---|
傳回指定語言和 GConcept ID 的業務類別清單。
|
ListBusinessCategories | |
---|---|
傳回業務類別清單。搜尋會比對類別名稱,而不是類別 ID。
|
BusinessMessagingService
讓商家可以註冊商家傳訊功能,方便搜尋商家所在地點的消費者提供通訊管道。如要查看地點的商家訊息並執行動作,你必須是該地點的 MANAGER
或 OWNER
。
粉絲
這個 API 會公開追蹤者的 Management API。
GetFollowersMetadata | |
---|---|
取得地點的追蹤者設定。 如果帳戶或地點不存在,系統會傳回 NOT_FOUND。如果該地點未通過驗證或未連線到 Google 地圖,就會傳回 PRE 條件_FAILED 。
|
FoodMenuService
這個 API 可以取得及更新商家所在地點的食物菜單。
請注意,Location.PriceList 同時也是類型之一的「menus」,但其中的欄位有限。與 FoodMenus 共用相同的下游儲存空間。遷移至 FoodMenuService 後,強烈建議用戶端不要使用 Location.PriceList 以更新選單資料,這可能會導致資料意外遺失。
GetFoodMenus | |
---|---|
傳回特定地點的食物菜單。只有在 location.location_state.can_have_food_menu 為 true 時,才會呼叫此函式。
|
UpdateFoodMenus | |
---|---|
更新特定地點的菜單。只有在 location.location_state.can_have_food_menu 為 true 時,才會呼叫此函式。
|
GoogleLocations
這個 API 可讓您存取及搜尋 GoogleLocation
。
ListRecommendedGoogleLocations | |
---|---|
列出對指定商家檔案帳戶建議的所有 個人帳戶的最佳化建議是依據使用者在商家檔案中可存取的所有地點 (包括可透過營業地點群組存取的地點) 產生,並是系統為使用者產生的所有最佳化建議的超集。
|
ReportGoogleLocation | |
---|---|
|
SearchGoogleLocations | |
---|---|
搜尋與指定要求相符的所有可能位置。
|
HealthProviderAttributesService
這項服務可以管理與地點連結的健康提供者屬性 (例如特定地點接受的保險)。
GetHealthProviderAttributes | |
---|---|
傳回特定位置的健康提供者屬性。
|
UpdateHealthProviderAttributes | |
---|---|
更新特定地點的健康提供者屬性。
|
深入分析結果
針對 Google 服務中的一或多項商家資訊產生報表,詳細列出消費者洞察。針對基本指標的匯總資料,您最多可查詢 18 個月內的資料。支援細目的指標可顯示這個時間範圍內的匯總資料,並按星期幾或一天中的時段細分。您可在指定天數內透過快照回報行車路線要求。
ReportLocalPostInsights | |
---|---|
針對與單一商家資訊相關的一組當地貼文傳回深入分析。哪些指標及其回報方式是 Request proto 中的指定選項。
|
ReportLocationInsights | |
---|---|
傳回報表,其中包含按地區劃分的一或多個指標的洞察。
|
InsuranceNetworkService
這項服務可讓你在 Google 上取得健康商家所在地點的所有支援的保險網。
ListInsuranceNetworks | |
---|---|
傳回 Google 支援的所有保險網絡清單。
|
LocalPosts
這個 API 會公開本機貼文的 Management API。
CreateLocalPost | |
---|---|
建立並傳回與指定位置相關聯的新當地貼文。
|
DeleteLocalPost | |
---|---|
刪除本機貼文。如果本機貼文不存在,系統會傳回
|
GetLocalPost | |
---|---|
取得指定的當地貼文。如果本機貼文不存在,系統會傳回
|
ListLocalPosts | |
---|---|
傳回與位置相關的當地貼文清單。
|
UpdateLocalPost | |
---|---|
更新指定的當地貼文,並傳回更新後的當地貼文。
|
位置
這個 API 可讓你在 Google 上管理商家所在地點。可讓您管理 Location
資源。並定義下列資源模型:
AssociateLocation | |
---|---|
將位置與地點 ID 建立關聯。並覆寫先前的所有關聯。地點必須未經驗證,這項操作才有效。關聯必須是有效,也就是說,會顯示在
|
BatchGetLocations | |
---|---|
取得指定帳戶中所有指定地區。
|
ClearLocationAssociation | |
---|---|
清除地點與地點 ID 之間的關聯。地點必須未經驗證,這項操作才有效。
|
CreateLocation | |
---|---|
建立並傳回指定帳戶擁有的新
|
DeleteLocation | |
---|---|
刪除位置。 |
FindMatchingLocations | |
---|---|
尋找與指定地區相符的所有可能地點。地點必須未經驗證,這項操作才有效。
|
GetChain | |
---|---|
取得指定的鏈結。如果鏈結不存在,則傳回
|
GetGoogleUpdatedLocation | |
---|---|
取得指定位置的 Google 更新版本。如果位置不存在,則傳回
|
GetLocation | |
---|---|
取得指定位置。如果位置不存在,則傳回
|
ListAttributeMetadata | |
---|---|
針對具有指定主要類別和國家/地區的地點,傳回可用的屬性清單。
|
ListLocations | |
---|---|
列出指定帳戶的營業地點。
|
SearchChains | |
---|---|
根據連鎖店名稱搜尋鏈結。
|
TransferLocation | |
---|---|
這類營業地點會從使用者擁有的帳戶中移動到同一個使用者管理的其他帳戶。使用者必須是與這個地點目前相關聯的帳戶擁有者,並至少是目標帳戶的管理員。傳回包含新資源名稱的位置。
|
UpdateLocation | |
---|---|
更新指定的位置。 相片只能在設有 Google+ 專頁的地點上傳。 如果位置不存在,則傳回
|
媒體
這項服務可管理與位置資訊連結的媒體 (相片和影片)。
CreateMediaItem | |
---|---|
針對位置建立新的媒體項目。
|
DeleteMediaItem | |
---|---|
刪除指定媒體項目。
|
GetCustomerMediaItem | |
---|---|
傳回所請求客戶媒體項目的中繼資料。
|
GetMediaItem | |
---|---|
傳回所請求媒體項目的中繼資料。
|
ListCustomerMediaItems | |
---|---|
傳回與客戶提供地點相關的媒體項目清單。
|
ListMediaItems | |
---|---|
傳回與位置相關聯的媒體項目清單。
|
StartUploadMediaItemData | |
---|---|
產生
|
UpdateMediaItem | |
---|---|
更新指定媒體項目的中繼資料。這只能用來更新媒體項目的類別,但新類別不能是「遮蔽」或「PROFILE」。
|
QuestionsAndAnswers
這項服務可讓您管理地點的問題和答案。問答功能僅適用於已驗證的地點。
CreateQuestion | |
---|---|
在指定位置新增問題。
|
DeleteAnswer | |
---|---|
刪除目前使用者針對問題所撰寫的答案。
|
DeleteQuestion | |
---|---|
刪除目前使用者所撰寫的特定問題。
|
ListAnswers | |
---|---|
傳回指定問題的答案分頁清單。
|
ListQuestions | |
---|---|
針對指定位置傳回分頁式問題清單和部分答案。
|
UpdateQuestion | |
---|---|
更新目前使用者所撰寫的特定問題。
|
UpsertAnswer | |
---|---|
建立答案或更新使用者針對指定問題所撰寫的現有答案。每位使用者的每個問題只能建立一個答案。
|
評論
這個 API 可為 Review 提供 CRUD 作業。google.mybusiness.v4.Reviews
.
BatchGetReviews | |
---|---|
傳回所有指定地點的評論分頁清單。指定地點必須經過驗證,這項操作才有效。
|
DeleteReviewReply | |
---|---|
刪除對指定評論的回應。指定地點已通過驗證時,這項作業才有效。
|
GetReview | |
---|---|
傳回指定評論。指定地點已通過驗證時,這項作業才有效。如果評論不存在或已遭刪除,會傳回
|
ListReviews | |
---|---|
傳回指定位置的評論分頁清單。指定地點已通過驗證時,這項作業才有效。
|
UpdateReviewReply | |
---|---|
更新對指定評論的回覆。如果回覆不存在,即會建立回覆。指定地點已通過驗證時,這項作業才有效。
|
ServiceLists
這個 API 可讓作業取得並更新 Google 上商家所在地點的服務清單。服務清單包含商家提供的服務清單。服務包括剪髮、安裝熱水器等。
GetServiceList | |
---|---|
取得位置的指定服務清單。
|
UpdateServiceList | |
---|---|
更新地點的指定服務清單。
|
認證
這個 API 可讓您管理 Google 的地點驗證。可讓您管理 Verification
資源。
每個 Location
都有一組 Verification
資源,名為 accounts/*/locations/*/verifications/*
。
CompleteVerification | |
---|---|
完成 只有非
|
FetchVerificationOptions | |
---|---|
回報特定語言地區所有符合資格的驗證選項。
|
ListVerifications | |
---|---|
列出地點的驗證結果,按照建立時間排序。
|
VerifyLocation | |
---|---|
開始地點驗證程序。
|
AcceptInvitationRequest
要求 AccessControl.Accept 邀請 的訊息。
欄位 | |
---|---|
name |
接受的邀請名稱。 |
帳戶
帳戶是商家所在地點的容器,如果您是商家唯一的管理者,可以使用個人 Google 帳戶。如要與多位使用者共同管理地點,請建立商家帳戶。
欄位 | |
---|---|
name |
資源名稱,格式為 |
account_name |
帳戶名稱。 |
type |
僅供輸出。指定這個帳戶的 |
role |
僅供輸出。指定呼叫端在這個帳戶中擁有的 |
state |
僅供輸出。表示這個帳戶的 |
account_number |
帳戶參考號碼 (如有提供)。 |
permission_level |
僅供輸出。指定呼叫端在這個帳戶中擁有的 |
organization_info |
機構的其他資訊。系統只會為機構帳戶填入這項資訊。 |
OrganizationInfo
為機構儲存的其他資訊。
欄位 | |
---|---|
registered_domain |
帳戶的註冊網域。 |
postal_address |
帳戶的郵寄地址。 |
phone_number |
機構聯絡電話。 |
AccountRole
指出已驗證使用者對這個帳戶的存取層級。詳情請參閱說明中心文章。
列舉 | |
---|---|
ACCOUNT_ROLE_UNSPECIFIED |
未指定。 |
OWNER |
這位使用者為這個帳戶的擁有者。(在 UI 中顯示為「主要擁有者」)。 |
CO_OWNER |
使用者是該帳戶的共同擁有者。(UI 中會顯示為「Owner」)。 |
MANAGER |
使用者可以管理這個帳戶。 |
COMMUNITY_MANAGER |
使用者可以管理帳戶的社交 (Google+) 專頁。(在使用者介面中顯示為「Site Manager」)。 |
AccountState
指出帳戶狀態,例如帳戶是否已通過 Google 驗證。
欄位 | |
---|---|
status |
通過驗證後,日後建立的地點就會自動連結至 Google 地圖,而 Google+ 專頁不需經過審核即可建立。 |
AccountStatus
表示帳戶的驗證狀態。
列舉 | |
---|---|
ACCOUNT_STATUS_UNSPECIFIED |
未指定。 |
VERIFIED |
已驗證帳戶。 |
UNVERIFIED |
帳戶未經驗證,也未提出驗證要求。 |
VERIFICATION_REQUESTED |
帳戶尚未驗證,但已提出驗證要求。 |
AccountType
表示屬於個人/使用者帳戶或企業帳戶。
列舉 | |
---|---|
ACCOUNT_TYPE_UNSPECIFIED |
未指定。 |
PERSONAL |
使用者帳戶。 |
LOCATION_GROUP |
一組地點。詳情請參閱說明中心文章。 |
USER_GROUP |
使用者群組,用於將機構員工區隔成不同群組。詳情請參閱說明中心文章。 |
ORGANIZATION |
代表公司的機構。詳情請參閱說明中心文章。 |
AdWordsLocationExtensions
AdWords 中顯示的額外資訊。
欄位 | |
---|---|
ad_phone |
顯示在 AdWords 地點額外資訊中的備用電話號碼,而非位置的主要電話號碼。 |
AddressInput
地址驗證的輸入內容。
欄位 | |
---|---|
mailer_contact_name |
要接收郵件的聯絡人姓名。 |
管理員
欄位 | |
---|---|
name |
資源名稱。如果是帳戶管理員,格式如下: 如果是地點管理員,則格式為: |
admin_name |
管理員的名稱。初次邀請時,這是指邀請對象的電子郵件地址。在 |
role |
|
pending_invitation |
僅供輸出。表示這位管理員是否有指定資源的待處理邀請。 |
AdminRole
表示管理員擁有的存取層級。詳情請參閱說明中心文章。
列舉 | |
---|---|
ADMIN_ROLE_UNSPECIFIED |
未指定。 |
OWNER |
管理員有擁有者層級存取權,同時也是主要擁有者。(在 UI 中顯示為「主要擁有者」)。 |
CO_OWNER |
管理員有擁有者層級存取權。(UI 中會顯示為「Owner」)。 |
MANAGER |
管理員有管理員存取權。 |
COMMUNITY_MANAGER |
可管理社交 (Google+) 專頁。(在使用者介面中顯示為「Site Manager」)。 |
AlertType
建立快訊貼文的事件類型。
列舉 | |
---|---|
ALERT_TYPE_UNSPECIFIED |
未指定快訊。 |
COVID_19 |
與 2019 年冠狀病毒疾病相關快訊。COVID 貼文僅支援摘要欄位和行動號召欄位。如果這些快訊不再相關,就會停用建立 COVID-19 類型的新快訊。不過,商家仍可管理現有的 COVID-19 貼文。 |
過敏原
食品的過敏資訊。
列舉 | |
---|---|
ALLERGEN_UNSPECIFIED |
未指定過敏原 |
DAIRY |
乳製品相關的過敏原 |
EGG |
蛋相關的過敏原 |
FISH |
魚類的過敏原 |
PEANUT |
花生相關的過敏原 |
SHELLFISH |
貝類相關過敏原 |
SOY |
大豆相關過敏原 |
TREE_NUT |
樹木堅果相關的過敏原 |
WHEAT |
小麥相關過敏原 |
解答
代表問題的答案
欄位 | |
---|---|
name |
僅供輸出。答案帳戶的專屬名稱/*/locations/*/questions/*/answers/* |
author |
僅供輸出。答案的作者。 |
upvote_count |
僅供輸出。答案的認同票數。 |
text |
答案文字。當中至少要有一個非空白字元。長度上限為 4096 個半形字元。 |
create_time |
僅供輸出。撰寫答案的時間戳記。 |
update_time |
僅供輸出。上次修改答案的時間戳記。 |
AssociateLocationRequest
Locations.AssociateLocationRequest 的要求訊息。
欄位 | |
---|---|
name |
要建立關聯位置的資源名稱, |
place_id |
要建立的關聯。如未設定,表示沒有相符結果。 |
屬性
地點屬性。屬性可提供與位置相關的額外資訊。位置可設定的屬性可能會因該位置的屬性 (例如類別) 而有所不同。可用屬性由 Google 決定,且可能會在不變更 API 的情況下新增及移除。
欄位 | |
---|---|
attribute_id |
屬性的 ID。屬性 ID 由 Google 提供。 |
value_type |
僅供輸出。此屬性包含的值類型。這應用於決定如何解讀這個值。 |
values[] |
這項屬性的值。提供的值類型必須符合該屬性的預期;詳情請參閱 AttributeValueType。這是個重複欄位,當中可以提供多個屬性值。屬性類型僅支援一個值。 |
repeated_enum_value |
如果屬性值類型為 REPEATED_ENUM,這個類型就會包含屬性值,其他值欄位則必須留空。 |
url_values[] |
如果屬性值類型為「網址」,則這個欄位會包含這項屬性的值,而其他值欄位則須留空。 |
AttributeMetadata
屬性的中繼資料,包含屬性的顯示資訊,包括本地化名稱,以及將相關屬性分組的標題。
欄位 | |
---|---|
attribute_id |
屬性的 ID。 |
value_type |
屬性的值類型。設定和擷取的值應該屬於此類型。 |
display_name |
屬性的本地化顯示名稱 (如有);否則為英文顯示名稱。 |
group_display_name |
包含這個屬性的群組的本地化顯示名稱 (如有),否則請使用英文群組名稱。相關屬性會彙整成群組,並顯示於這裡指定的標題下方。 |
is_repeatable |
如果為 true,則屬性支援多個值。如果設為 false,則只能提供一個值。 |
value_metadata[] |
系統會針對部分類型的屬性 (例如列舉),列出支援的值清單和這些值的對應顯示名稱。 |
is_deprecated |
如果為 true,則屬性已淘汰,不應再使用。如果已淘汰,更新這個屬性不會導致錯誤,但系統不會儲存更新內容。在遭到淘汰的某個時間點,這個屬性會徹底移除,並導致錯誤發生。 |
AttributeValueMetadata
支援屬性值的中繼資料。
欄位 | |
---|---|
value |
屬性值。 |
display_name |
這個值的顯示名稱 (如有本地化版本),否則為英文。這個值的顯示名稱必須搭配屬性顯示名稱使用。 舉例來說,「Wi-Fi」列舉屬性可能包含「付費」一詞,代表付費 Wi-Fi。 |
AttributeValueType
屬性的值類型。
列舉 | |
---|---|
ATTRIBUTE_VALUE_TYPE_UNSPECIFIED |
未指定。 |
BOOL |
這項屬性的值是布林值。 |
ENUM |
屬性包含預先定義的可用值清單。此屬性的中繼資料會列出這些值。 |
URL |
這項屬性的值是網址。 |
REPEATED_ENUM |
屬性值是一個列舉,其中含有多個可明確設定或取消的可能值。 |
作者
代表問題或答案的作者
欄位 | |
---|---|
display_name |
使用者的顯示名稱 |
profile_photo_url |
使用者的個人資料相片網址。 |
type |
作者的使用者類型。 |
AuthorType
顯示作者的使用者類型,以列舉表示。
列舉 | |
---|---|
AUTHOR_TYPE_UNSPECIFIED |
請勿使用此屬性。 |
REGULAR_USER |
一般使用者。 |
LOCAL_GUIDE |
在地嚮導 |
MERCHANT |
位置的擁有者/管理員 |
BasicMetricsRequest
索取基本指標洞察。
欄位 | |
---|---|
metric_requests[] |
一組用來傳回值的指標,包括資料傳回方式的選項。 |
time_range |
要收集指標的範圍。最長範圍為要求日期起 18 個月。在某些情況下,接近要求日期後的日子可能仍會遺失資料。系統會在回應的 |
BatchGetBusinessCategoriesRequest
要求 BusinessCategories.BatchGetBusinessCategories 要求訊息。
欄位 | |
---|---|
language_code |
必要欄位。應傳回類別名稱的 BCP 47 語言代碼。 |
category_ids[] |
必要欄位。至少須設定一個名稱。應傳回本地化類別名稱的 GConcept ID。 |
region_code |
選用設定。用來推斷非標準語言的 ISO 3166-1 alpha-2 國家/地區代碼。 |
view |
必要欄位。指定要在回應中傳回 Category 資源的哪些部分。 |
BatchGetBusinessCategoriesResponse
BusinessCategories.BatchGetBusinessCategories 的回應訊息。
欄位 | |
---|---|
categories[] |
與要求中提供的 GConcept ID 相符的類別。順序與要求中的類別 ID 順序不同。 |
BatchGetLocationsRequest
Locations.BatchGetLocations 的要求訊息。
欄位 | |
---|---|
name |
要擷取營業地點的帳戶名稱。 |
location_names[] |
要擷取的位置集合,以名稱指定。 |
BatchGetLocationsResponse
Locations.BatchGetLocations 的回應訊息。
欄位 | |
---|---|
locations[] |
地點集合。 |
BatchGetReviewsRequest
Review.BatchGetReviews 要求訊息。
欄位 | |
---|---|
name |
要擷取多個地點評論清單的帳戶名稱。 |
location_names[] |
要擷取評論的地點集合,以名稱指定。 |
page_size |
每網頁要擷取的評論數量。預設值為 50。 |
page_token |
如果有指定,系統會擷取下一頁的評論。 |
order_by |
選用設定。指定要做為評論排序依據的欄位。如未指定,傳回的評論順序會預設為 |
ignore_rating_only_reviews |
是否忽略僅限評分的評論。 |
BatchGetReviewsResponse
Review.BatchGetReviews 的回應訊息。
欄位 | |
---|---|
location_reviews[] |
包含位置資訊的評論。 |
next_page_token |
如果評論數超過要求的頁面大小,系統會在這個欄位填入一個符記,以擷取後續呼叫的下一頁評論。如果沒有任何評論,回應中就不會顯示這個欄位。 |
BusinessHours
代表這個地點營業的時間範圍。保留 TimePeriod
執行個體的集合。
欄位 | |
---|---|
periods[] |
這個地點營業的一系列次數。每個時段代表地點在一週中營業的時段。 |
CallToAction
使用者點閱貼文時執行的動作
欄位 | |
---|---|
action_type |
將要執行的動作類型。 |
url |
使用者按下廣告後會前往的網址。如為來電行動號召,請勿設定這個欄位。 |
ActionType
將要執行的動作類型。
列舉 | |
---|---|
ACTION_TYPE_UNSPECIFIED |
未指定類型。 |
BOOK |
這則貼文要求使用者進行預約/表格等。 |
ORDER |
這則貼文希望使用者下訂單。 |
SHOP |
這則貼文希望使用者瀏覽產品目錄。 |
LEARN_MORE |
這則貼文希望使用者前往其網站瞭解詳情。 |
SIGN_UP |
這則貼文要求使用者註冊/註冊/加入內容。 |
GET_OFFER |
已淘汰,在「 |
CALL |
這則貼文希望使用者致電商家。 |
類別
說明商家性質 (而非業務內容) 的類別。如需有效類別 ID 清單,以及各類別人類可讀名稱的對應清單,請參閱 categories.list。
欄位 | |
---|---|
display_name |
。使用者可理解的類別名稱。系統會在讀取位置時設定這個字串。修改位置時,必須設定 注意:這個欄位只會用於回應。凡是在要求中指定的值,都會遭到忽略。 |
category_id |
。這個類別的固定 ID (由 Google 提供)。修改類別時 (建立或更新位置時),必須指定 注意:這個欄位只會用於回應。凡是在要求中指定的值,都會遭到忽略。 |
service_types[] |
。此業務類別適用所有服務類型的清單。 注意:這個欄位只會用於回應。凡是在要求中指定的值,都會遭到忽略。 |
more_hours_types[] |
僅供輸出。這個業務類別可用的更多營業時間類型。 |
CategoryView
用於限制伺服器傳回的資料量。
列舉 | |
---|---|
CATEGORY_VIEW_UNSPECIFIED |
未指定,等同於 CATEGORY_METADATA_ONLY。 |
BASIC |
伺服器回應只會包含「Category」欄位「display_name」、「category_id」和「language_code」。其中會省略任何服務類型中繼資料相關欄位。 |
FULL |
傳回回應中的所有欄位。 |
吊鍊
連鎖店是指您的商家所在地點可與品牌建立關聯的品牌。
欄位 | |
---|---|
name |
鏈結的資源名稱,格式為 |
chain_names[] |
鏈結的名稱。 |
websites[] |
連鎖店的網站。 |
location_count |
屬於這個連鎖店的地點數量。 |
ChainName
顯示鏈結時使用的名稱。
欄位 | |
---|---|
display_name |
這個鏈結的顯示名稱。 |
language_code |
名稱語言的 BCP 47 代碼。 |
ChainUrl
顯示鏈結時使用的網址。
欄位 | |
---|---|
url |
這個鏈結的網址。 |
ClearLocationAssociationRequest
Locations.ClearLocationAssociationRequest 的要求訊息。
欄位 | |
---|---|
name |
要解除關聯的位置資源名稱。 |
CompleteVerificationRequest
Verifications.CompleteVerificationAction 要求訊息。
欄位 | |
---|---|
name |
待驗證作業的資源名稱。 |
pin |
商家收到的 PIN 碼,才能完成驗證。 |
CompleteVerificationResponse
Verifications.CompleteVerificationAction 的回應訊息。
欄位 | |
---|---|
verification |
完成驗證。 |
CreateAccountAdminRequest
要求 AccessControl.CreateAccountAdmin 的訊息。
欄位 | |
---|---|
parent |
管理員所建立帳戶的資源名稱。 |
admin |
由管理員建立 |
CreateAccountRequest
Account.CreateAccount 的要求訊息。
欄位 | |
---|---|
primary_owner |
帳戶的資源名稱,將是所建立帳戶的主要擁有者。格式應為 |
account |
要建立的帳戶帳戶資訊。唯一允許使用的欄位為 account_name 和 type。 |
CreateLocalPostRequest
CreateLocalPost 要求訊息。
欄位 | |
---|---|
parent |
要建立這則當地貼文的地點名稱。 |
local_post |
新的本機貼文中繼資料。 |
CreateLocationAdminRequest
要求 AccessControl.CreateLocationAdmin 的訊息。
欄位 | |
---|---|
parent |
為管理員建立的位置資源名稱。 |
admin |
由管理員建立 |
CreateLocationRequest
Locations.CreateLocation 的要求訊息。
欄位 | |
---|---|
parent |
要建立這個地點的帳戶名稱。 |
location |
新的位置中繼資料。 |
validate_only |
如果為 true,表示要求已通過驗證,而且不會實際建立位置。 |
request_id |
伺服器用於偵測重複要求的專屬要求 ID。建議您使用 UUID。長度上限為 50 個半形字元。 |
CreateMediaItemRequest
Media.CreateMediaItem 的要求訊息。
欄位 | |
---|---|
parent |
建立這個媒體項目的位置資源名稱。 |
media_item |
要建立的媒體項目。 |
CreateQuestionRequest
FAQAndAnswers.CreateQuestion 要求訊息
欄位 | |
---|---|
parent |
提問地點的名稱。 |
question |
新問題。 |
DeclineInvitationRequest
要求 AccessControl.拒絕邀請的訊息。
欄位 | |
---|---|
name |
目前遭到拒絕的帳戶邀請名稱。 |
DeleteAccountAdminRequest
要求 AccessControl.DeleteAccountAdmin 的訊息。
欄位 | |
---|---|
name |
要從帳戶中移除的管理員的資源名稱。 |
DeleteAnswerRequest
要求關於 QuestionAndAnswers.DeleteAnswer 的訊息
欄位 | |
---|---|
parent |
待刪除答案的問題名稱。 |
DeleteLocalPostRequest
要求 DeleteLocalPost 的訊息。
欄位 | |
---|---|
name |
要刪除的本機貼文名稱。 |
DeleteLocationAdminRequest
要求 AccessControl.DeleteLocationAdmin 的訊息。
欄位 | |
---|---|
name |
要從位置移除的管理員資源名稱。 |
DeleteLocationRequest
Locations.DeleteLocation 的要求訊息。
欄位 | |
---|---|
name |
要刪除的位置名稱。 |
DeleteMediaItemRequest
Media.DeleteMediaItem 的要求訊息。
欄位 | |
---|---|
name |
要刪除的媒體項目名稱。 |
DeleteNotificationsRequest
Account.DeleteNotification 要求訊息。
欄位 | |
---|---|
name |
要清除通知設定的資源名稱。 |
DeleteQuestionRequest
AskAndAnswers.DeleteQuestion 要求訊息
欄位 | |
---|---|
name |
要刪除的問題名稱。 |
DeleteReviewReplyRequest
要求 Review.DeleteReviewReply。
欄位 | |
---|---|
name |
待刪除評論回覆的名稱。 |
DietaryRestriction
食品的飲食資訊。
列舉 | |
---|---|
DIETARY_RESTRICTION_UNSPECIFIED |
未指定飲食類型 |
HALAL |
將食物定義為清真料理。 |
KOSHER |
以猶太料理的形式呈現。 |
ORGANIC |
將食物描述為有機料理。 |
VEGAN |
將食物定義為純素餐點。 |
VEGETARIAN |
將食物定義為素食料理。 |
DimensionalMetricValue
包含指定時間維度的單一指標值。
欄位 | |
---|---|
metric_option |
要求這個維度值的選項。 |
time_dimension |
值的維度。 |
value |
值。如未設定任何值,就會遺漏要求的資料。 |
TimeDimension
用來分隔資料的維度。
欄位 | |
---|---|
day_of_week |
這個值對應的星期幾 (「MONDAY」到「SUNDAY」)。已設定 BREAKDOWN_DAY_OF_WEEK 選項。 |
time_of_day |
這個值對應的一天中的小時 (0 到 23)。已設定 BREAKDOWN_HOUR_OF_DAY 選項。 |
time_range |
這個值涵蓋的時間範圍。針對 AGGREGATED_TOTAL 和 AGGREGATED_DAILY 選項設定。 |
DrivingDirectionMetricsRequest
行車路線分析要求。
欄位 | |
---|---|
num_days |
匯總資料的天數。傳回的結果將包含過去要求的天數資料。有效值為 7、30 和 90。 |
language_code |
語言的 BCP 47 代碼。如未提供語言代碼,則預設為英文。 |
NumDays
這項要求可以支援的天數。
列舉 | |
---|---|
SEVEN |
7 天。這是預設值。 |
THIRTY |
30 天。 |
NINETY |
90 天。 |
EmailInput
輸入電子郵件驗證
欄位 | |
---|---|
email_address |
接收 PIN 碼的電子郵件地址。 系統只會接受 FetchVerificationOptions 所提供的其中一個地址電子郵件地址。如果將 |
ErrorDetail
詳細說明導致驗證或內部失敗的錯誤。
欄位 | |
---|---|
code |
狀態碼,應為 |
field |
導向要求主體中欄位的路徑。此值是一系列以點分隔的 ID,用於識別通訊協定緩衝區欄位。舉例來說,「error_details.field」就會識別此欄位。 |
message |
欄位造成失敗的原因說明。訊息內容為英文,可能不適合向使用者顯示。 |
value |
要求失敗的值。 |
field_index |
如果重複產生這個錯誤的要求欄位,這個欄位會包含該欄位中項目的索引 (從零開始),導致驗證失敗。 |
ErrorCode
ErrorDetail
的錯誤代碼:
- 1 至 199:適用於所有欄位的常見錯誤代碼。
- 1000 到 1099:相片相關錯誤代碼。
- 1100 到 1199:地址和經緯度相關錯誤代碼。
- 1200 至 1299:類別相關錯誤代碼。
- 1300 至 1399:作業相關錯誤代碼。
列舉 | |
---|---|
ERROR_CODE_UNSPECIFIED |
全部接收的錯誤代碼。 |
MISSING_VALUE |
未提供必要的值。 |
INVALID_VALUE |
輸入的值無效。 |
INVALID_CHARACTERS |
發現無效字元。 |
TOO_MANY_ITEMS |
項目數量超過重複欄位中的數量上限。 |
READ_ONLY |
無法修改唯讀欄位。 |
OVERLAPPING_RANGES |
「重複」欄位中的項目是指彼此重疊的範圍。 |
INVERTED_RANGE |
提供的範圍反轉。這也包括空白範圍的案例。 |
VALUE_OUTSIDE_ALLOWED_RANGE |
輸入的值超出允許的範圍。 |
MISSING_DEPENDENT_FIELD |
必要的相依欄位不存在。 |
FIELD_HAS_DEPENDENCIES |
相依欄位為必填欄位,且無法移除。 |
UNSUPPORTED_VALUE |
您提供的值可能有效,但由於其他限制,因此不受支援。 |
EXPIRED_VALUE |
您提供的值已過期且失效。 |
PHOTO_FETCH_FAILED |
無法從指定網址擷取相片。 |
PHOTO_UPLOAD_FAILED |
無法從指定網址上傳相片。 |
GEOCODE_ERROR |
自動判斷經緯度時發生錯誤。 |
LAT_LNG_OUTSIDE_COUNTRY |
您提供的經緯度並非位於提供的國家/地區。 |
LAT_LNG_REQUIRED |
必須提供緯度和經度。 |
LAT_LNG_TOO_FAR_FROM_ADDRESS |
經緯度和地址組合相距太遠。 |
CATEGORY_NOT_VERIFIED |
提供的類別未經驗證。 |
OPERATION_EXECUTION_ERROR |
一般作業執行錯誤。 |
OPERATION_UNSUPPORTED_UNDER_ACCOUNT_CONDITION |
因帳戶條件而無法執行這項作業。 |
LOCATION_DISABLED_FOR_LOCAL_POST_API |
Local Post API 的位置已停用。 |
FetchVerificationOptionsRequest
Verifications.FetchVerificationOptions 的要求訊息。
欄位 | |
---|---|
name |
要驗證位置的資源名稱。 |
language_code |
BCP 47 語言代碼,代表用於驗證程序的語言。可用選項因語言而異。 |
context |
服務商家驗證的額外背景資訊。對商家類型為「CUSTOMER_LOCATION_ONLY」的地點必填。如果為其他商家類型設定的話,則系統會擲回 INVALID_COUNTRY。 |
FetchVerificationOptionsResponse
Verifications.FetchVerificationOptions 的回應訊息。
欄位 | |
---|---|
options[] |
可用的驗證選項。 |
FindMatchingLocationsRequest
Locations.FindMatchingLocations 的要求訊息
欄位 | |
---|---|
name |
要尋找相符項目的位置資源名稱。 |
language_code |
比對位置的偏好語言 (採用 BCP-47 格式)。 |
num_results |
要傳回的相符項目數量。預設值為 3,最多 10。請注意,如果要求更多,延遲時間可能會增加。沒有分頁。 |
max_cache_duration |
已淘汰,所有要求都會忽略這個欄位。 |
FindMatchingLocationsResponse
Locations.FindMatchingLocations 的回應訊息。
欄位 | |
---|---|
matched_locations[] |
可能與指定地點相符的一組地點,依比對程度由高至低列出。如果有完全相符的項目,會排在第一個位置。 |
match_time |
上次對這個位置執行比對演算法的時間。 |
FollowersMetadata
某個地點的追蹤者中繼資料。
欄位 | |
---|---|
name |
此 <帳戶>/{account_id}/locations/{location_id}/followers/metadata 的資源名稱 |
count |
該地點的追蹤者總數。 |
FoodMenu
供應餐點的商家菜單。
欄位 | |
---|---|
labels[] |
必要欄位。選單的語言標記標籤。例如「菜單」、「午餐特餐」。顯示名稱的長度不得超過 140 個半形字元,說明不得超過 1,000 個半形字元。至少須指定一組標籤。 |
source_url |
選用設定。有要前往的選單來源網址。 |
sections[] |
必要欄位。選單的各個部分。 |
cuisines[] |
選用設定。餐點菜單料理資訊。強烈建議您提供這個欄位。 |
料理
餐廳的飲食資訊。
列舉 | |
---|---|
CUISINE_UNSPECIFIED |
未指定料理 |
AMERICAN |
美式餐廳 |
ASIAN |
亞洲料理 |
BRAZILIAN |
巴西料理 |
BREAK_FAST |
早餐 |
BRUNCH |
早午餐 |
CHICKEN |
雞 |
CHINESE |
中式餐點 |
FAMILY |
家庭式料理 |
FAST_FOOD |
速食 |
FRENCH |
法式餐廳 |
GREEK |
希臘料理 |
GERMAN |
德國料理 |
HAMBURGER |
漢堡 |
INDIAN |
印度餐廳 |
INDONESIAN |
印尼料理 |
ITALIAN |
義式餐廳 |
JAPANESE |
日式餐廳 |
KOREAN |
韓式餐廳 |
LATIN_AMERICAN |
拉丁美洲餐廳 |
MEDITERRANEAN |
地中海料理 |
MEXICAN |
墨西哥餐廳 |
PAKISTANI |
巴基斯坦料理 |
PIZZA |
披薩 |
SEAFOOD |
海鮮 |
SPANISH |
西班牙料理 |
SUSHI |
壽司 |
THAI |
泰式料理 |
TURKISH |
土耳其料理 |
VEGETARIAN |
素食料理 |
VIETNAMESE |
越南料理 |
OTHER_CUISINE |
其他美食 |
FoodMenuItem
章節項目。這可以是料理本身,也可以包含多個 FoodMenuItemOption。
欄位 | |
---|---|
labels[] |
必要欄位。這個選單項目的語言標記標籤。顯示名稱的長度不得超過 140 個半形字元,說明不得超過 1,000 個半形字元。至少須指定一組標籤。 |
attributes |
必要欄位。商品的詳細屬性。指定商品選項後,系統會將其視為基本屬性,並填入各個選項。 |
options[] |
選用設定。這個選項適用於提供多個不同選項的商品,使用者必須做出選擇。例如「一般」和「大」披薩。指定選項後,項目層級的標籤和屬性會自動成為第一個選項的標籤和屬性。客戶只需要在此欄位中指定其他食物選項。 |
FoodMenuItemAttributes
食品/甜點的屬性。
欄位 | |
---|---|
price |
必要欄位。食物的價格。 |
spiciness |
選用設定。食物的辣度水平。 |
allergen[] |
選用設定。與食物相關的過敏原。強烈建議您提供這個欄位。 |
dietary_restriction[] |
選用設定。食物的飲食資訊。強烈建議您提供這個欄位。 |
nutrition_facts |
選用設定。食物選項的營養資訊。強烈建議您提供這個欄位。 |
ingredients[] |
選用設定。餐點選擇的食材。 |
serves_num_people |
選用設定。這個餐點選項可供應人數。 |
preparation_methods[] |
選用設定。餐點選項準備方法。 |
portion_size |
選用設定。訂單大小,以商品單位表示。(例如 4 個「肉串」、6 件「罐子」) |
media_keys[] |
選用設定。菜餚相關媒體的媒體鍵。僅支援相片媒體,如果有多個相關相片,系統會將第一張相片視為首選相片。 |
食材
這則訊息代表食物的食材資訊。
欄位 | |
---|---|
labels[] |
必要欄位。用於說明食材的標籤。顯示名稱的長度不得超過 140 個半形字元,說明不得超過 1,000 個半形字元。至少須指定一組標籤。 |
PortionSize
餐點份量大小。
欄位 | |
---|---|
quantity |
必要欄位。段落的數量。 |
unit[] |
必要欄位。重複的 name_info 欄位適用於多種語言的單位。 |
FoodMenuItemOption
商品的選項。必須明確選取使用者。
欄位 | |
---|---|
labels[] |
必要欄位。這個選單項目選項的語言標記標籤。E.g.: 「牛肉麵」、「素食河粉」、「小披薩」、「大披薩」。顯示名稱的長度不得超過 140 個半形字元,說明不得超過 1,000 個半形字元。至少須指定一組標籤。 |
attributes |
必要欄位。商品選項的詳細屬性。未指定的個別屬性則會繼承商品層級的屬性,但屬性為基本屬性。 |
FoodMenuSection
選單部分。當中可能包含多項商品/食物。
欄位 | |
---|---|
labels[] |
必要欄位。這個選單區的語言標記標籤。顯示名稱的長度不得超過 140 個半形字元,說明不得超過 1,000 個半形字元。至少須指定一組標籤。 |
items[] |
必要欄位。章節項目。每個版面至少要有一個項目。 |
FoodMenus
供應餐點的商家菜單。
欄位 | |
---|---|
name |
必要欄位。這個地點的 Google ID,格式為: |
menus[] |
選用設定。一系列食物菜單。 |
GenerateAccountNumberRequest
帳戶.GenerateAccountNumber 的要求訊息。
欄位 | |
---|---|
name |
要產生帳戶號碼的帳戶名稱。 |
GetAccountRequest
Account.GetAccount 的要求訊息。
欄位 | |
---|---|
name |
要擷取的帳戶名稱。 |
GetChainRequest
Locations.GetChain 要求訊息。
欄位 | |
---|---|
name |
鏈結的資源名稱,格式為 |
GetCustomerMediaItemRequest
Media.GetCustomerMediaItem 的要求訊息。
欄位 | |
---|---|
name |
所要求客戶媒體項目的資源名稱。 |
GetFollowersMetadataRequest
要求訊息以取得特定地點的追蹤者中繼資料。
欄位 | |
---|---|
name |
地點追蹤者中繼資料的資源名稱。accounts/{account_id}/locations/{location_id}/followers/metadata |
GetFoodMenusRequest
要求 FoodMenu.GetFoodMenus 的訊息
欄位 | |
---|---|
name |
必要欄位。這個地點的 Google ID,格式為: |
read_mask |
選用設定。要傳回的特定欄位。如果未指定遮罩,則會傳回完整的 FoodMenu (與「*」相同)。您無法單獨指定重複欄位的項目。例如,「name」和「menus」是有效的遮罩,而「menus.sections」則是無效的遮罩。 |
GetHealthProviderAttributesRequest
HealthProviderAttributes.GetHealthProviderAttributes 的要求訊息
欄位 | |
---|---|
name |
必要欄位。這個地點的 Google ID,格式為:accounts/{account_id}/locations/{location_id}/healthProviderAttributes |
language_code |
選用設定。語言的 BCP 47 代碼。如未提供語言代碼,則預設為英文。目前僅支援「en」。 |
GetLocalPostRequest
要求 LocalPosts.GetLocalPost 的訊息。
欄位 | |
---|---|
name |
要擷取的本機貼文名稱。 |
GetLocationRequest
Locations.GetLocation 的要求訊息。
欄位 | |
---|---|
name |
要擷取的位置名稱。 |
GetMediaItemRequest
Media.GetMediaItem 的要求訊息。
欄位 | |
---|---|
name |
要求的媒體項目名稱。 |
GetNotificationsRequest
Account.GetNotification 要求訊息。
欄位 | |
---|---|
name |
通知設定資源名稱。 |
GetReviewRequest
要求 Review.GetReview。
欄位 | |
---|---|
name |
要擷取的評論名稱。 |
GetServiceListRequest
取得服務清單要求訊息。
欄位 | |
---|---|
name |
必要欄位。這個地點的 Google ID,格式為: |
GoogleLocation
代表 Google 上顯示的 Location
。例如使用者、其他人已聲明擁有權,或是未聲明擁有權的地點。
欄位 | |
---|---|
name |
這個 GoogleLocation 的資源名稱,格式為 |
location |
預先填入的 |
request_admin_rights_url |
這個網址會將使用者重新導向至要求管理員權限使用者介面的網址。只有在任何使用者 (包括目前的使用者) 已聲明這個地點的擁有權時,系統才會顯示這個欄位。 |
GoogleUpdatedLocation
代表 Google 修改的位置。
欄位 | |
---|---|
location |
這個位置的 Google 更新版本。 |
diff_mask |
Google 更新的欄位。 |
HealthProviderAttributes
與這個位置連結的醫療提供者屬性。
欄位 | |
---|---|
name |
必要欄位。這個地點的 Google ID,格式為: |
insurance_networks[] |
選用設定。當地接種保險網絡清單。 |
InsuranceNetwork
單一保險網絡。下一個 ID:5
欄位 | |
---|---|
network_id |
必要欄位。Google 產生的這個保險網絡 ID。 |
network_names |
僅供輸出。以要求語言呈現的網路顯示名稱對應,語言為鍵,本地化顯示名稱為值。系統預設會設定英文的顯示名稱。 |
payer_names |
僅供輸出。付款人顯示名稱對應 (以要求語言表示),語言為金鑰,本地化顯示名稱為值。系統預設會設定英文的顯示名稱。 |
state |
僅供輸出。這個保險網的州別。 |
InternalError
內部故障說明。
欄位 | |
---|---|
error_details[] |
針對個別失敗情況提供詳細資料。 |
邀請
僅供輸出。代表待回覆的邀請。
欄位 | ||
---|---|---|
name |
邀請的資源名稱。 |
|
role |
帳戶中受邀的角色。 |
|
聯集欄位 target 。表示這項邀請的目標對象。target 只能是下列其中一項: |
||
target_account |
這封邀請的填入帳戶都含有使用者。 |
|
target_location |
這項邀請的目標地區。 |
TargetLocation
代表待回覆邀請的指定地區。
欄位 | |
---|---|
location_name |
受邀使用者的位置名稱。 |
location_address |
使用者受邀地點的地址。 |
ListAccountAdminsRequest
AccessControl.ListAccountAdmins 的要求訊息。
欄位 | |
---|---|
parent |
要從哪個帳戶名稱擷取管理員名單。 |
ListAccountAdminsResponse
AccessControl.ListAccountAdmins 的回應訊息。
欄位 | |
---|---|
admins[] |
|
ListAccountsRequest
要求關於 accounts.ListAccounts 的訊息。
欄位 | |
---|---|
page_size |
每頁要擷取的帳戶數量。預設值為 20,下限為 2,頁面大小上限為 20。 |
page_token |
指定後,系統會擷取帳戶的下一頁。如果呼叫 |
name |
要擷取直接存取帳戶清單的帳戶資源名稱。這個方式僅適用於「機構」和「使用者群組」。如果空白,系統會為已驗證使用者傳回 |
filter |
篩選器會限制要傳回的帳戶。回應只會包含符合篩選條件的項目。如果 舉例來說,含有 |
ListAccountsResponse
Account.ListAccounts 的回應訊息。
欄位 | |
---|---|
accounts[] |
使用者有權存取的帳戶集合。除非已篩除,否則執行查詢者的個人帳戶一律是搜尋結果的第一個項目。 |
next_page_token |
如果帳戶數量超過請求的頁面大小,系統會在這個欄位填入權杖,以便在後續呼叫 |
ListAnswersRequest
AskAndAnswers.ListAnswers 的要求訊息
欄位 | |
---|---|
parent |
要擷取答案的問題名稱。 |
page_size |
每頁要擷取的答案數。 |
page_token |
如果有指定,系統會擷取下一頁的答案。 |
order_by |
傳回答案的順序。有效選項包括「update_time desc」和「up votes_count desc」,這會傳回依要求欄位遞減排序的答案。預設的排序順序為「update_time desc」。 |
ListAnswersResponse
FAQAndAnswers.ListAnswers 的回應訊息
欄位 | |
---|---|
answers[] |
請求的答案。 |
total_size |
這個問題在所有網頁中張貼的答案總數。 |
next_page_token |
如果答案數量超過要求的頁面大小上限,系統會在這個欄位填入一個符記,以便在後續呼叫時擷取下一頁的答案。如果沒有其他答案,回應中就不會顯示這個欄位。 |
ListAttributeMetadataRequest
Locations.ListAttributeMetadata 的要求訊息。如果提供位置資源名稱,系統就會使用該位置填入其餘條件。如果沒有,則應提供類別和國家/地區。
欄位 | |
---|---|
name |
用來查詢可用屬性的位置資源名稱。 |
category_id |
主要類別固定 ID 來尋找可用的屬性。 |
country |
使用 ISO 3166-1 alpha-2 國家/地區代碼來尋找可用屬性。 |
language_code |
要取得屬性顯示名稱的 BCP 47 語言代碼。如果沒有這個語言,系統將以英文提供。 |
page_size |
每頁應包含的屬性數量。預設值為 200,最小值為 1。 |
page_token |
指定時,系統會擷取屬性中繼資料的下一頁。如果呼叫 |
ListAttributeMetadataResponse
Locations.ListAttributeMetadata。
欄位 | |
---|---|
attributes[] |
可用屬性的一組屬性中繼資料。 |
next_page_token |
如果屬性數量超過要求的頁面大小,系統會在這個欄位填入一個符記,以便在後續呼叫 |
ListBusinessCategoriesRequest
欄位 | |
---|---|
region_code |
ISO 3166-1 alpha-2 國家/地區代碼。 |
language_code |
BCP 47 語言代碼。如果沒有支援的語言,則預設為英文。 |
search_term |
使用者的選用篩選器字串。 |
page_size |
每頁要擷取的類別數量。預設值為 100,下限為 1,頁面大小上限為 100。 |
page_token |
如果有指定,系統會擷取下一頁的類別。 |
view |
選用設定。指定要在回應中傳回 Category 資源的哪些部分。 |
ListBusinessCategoriesResponse
欄位 | |
---|---|
categories[] |
類別。類別是基本資料檢視畫面。但不包含任何 ServiceType 資訊。 |
total_category_count |
要求參數的類別總數。 |
next_page_token |
如果類別數量超過要求的頁面大小,系統會在這個欄位填入一個符記,以便在後續呼叫 |
ListCustomerMediaItemsRequest
Media.ListCustomerMediaItems 的要求訊息。
欄位 | |
---|---|
parent |
要列出客戶媒體項目的地點名稱。 |
page_size |
每頁要傳回的媒體項目數量。預設值為 100,支援的頁面大小上限為 200。 |
page_token |
如有指定,系統會傳回媒體項目的下一頁。 |
ListCustomerMediaItemsResponse
Media.ListCustomerMediaItems 的回應訊息。
欄位 | |
---|---|
media_items[] |
傳回的媒體項目清單。 |
total_media_item_count |
這個位置的媒體項目總數 (與分頁無關)。這個數字只是約略值,特別是在結果多頁時。 |
next_page_token |
如果媒體項目數量超過要求的頁面大小,系統會在這個欄位填入符記,以便在後續呼叫 ListCustomerMediaItems 時擷取媒體項目的下一頁。 |
ListInsuranceNetworksRequest
InsuranceNetworkService.ListInsuranceNetworks 的要求訊息
欄位 | |
---|---|
parent |
必要欄位。要列出保險網絡的地區名稱。名稱的格式為:accounts/{account_id}/locations/{location_id} |
language_code |
選用設定。語言的 BCP 47 代碼。如未提供語言代碼,則預設為英文。目前僅支援「en」。 |
page_size |
每頁要傳回的保險網絡。預設值為 5,000。頁面大小上限為 10000。 |
page_token |
若指定,系統會傳回保險網的下一頁。 |
ListInsuranceNetworksResponse
InsuranceNetworkService.ListInsuranceNetworks 的回應訊息
欄位 | |
---|---|
networks[] |
Google 支援的保險網絡清單。 |
next_page_token |
如果保險網路數量超過要求的網頁大小,系統會在這個欄位填入代碼,以便在後續呼叫 ListInsuranceNetworks 時擷取保險網的下一頁。 |
ListInvitationsRequest
AccessControl.List 邀請 s 的要求訊息。
欄位 | |
---|---|
parent |
要擷取邀請清單的帳戶名稱。 |
target_type |
指定要在回應中顯示的目標類型。 |
TargetType
邀請適用的目標類型。
列舉 | |
---|---|
ALL |
列出所有目標類型的邀請。此為預設值。 |
ACCOUNTS_ONLY |
僅列出帳戶類型的邀請。 |
LOCATIONS_ONLY |
僅列出「地區」類型的邀請。 |
ListInvitationsResponse
AccessControl.List 邀請 s 的回應訊息。
欄位 | |
---|---|
invitations[] |
帳戶中待處理的地點邀請。這裡列出的邀請數不得超過 1000。 |
ListLocalPostsRequest
ListLocalPosts 的要求訊息
欄位 | |
---|---|
parent |
要列出當地貼文的地區名稱。 |
page_size |
每頁要傳回的當地貼文數量。預設值為 20。頁面大小下限為 1,檔案大小上限為 100。 |
page_token |
若指定,系統會傳回當地貼文的下一頁。 |
ListLocalPostsResponse
ListLocalPosts 的回應訊息
欄位 | |
---|---|
local_posts[] |
傳回的當地貼文清單。 |
next_page_token |
如果當地貼文數量超過要求的頁面大小,系統會在這個欄位填入權杖,並在後續呼叫 |
ListLocationAdminsRequest
要求 AccessControl.ListLocationAdmins 的訊息。
欄位 | |
---|---|
parent |
要列出管理員的地點名稱。 |
ListLocationAdminsResponse
AccessControl.ListLocationAdmins 的回應訊息。
欄位 | |
---|---|
admins[] |
|
ListLocationsRequest
Locations.ListLocations 的要求訊息。
欄位 | |
---|---|
parent |
要擷取營業地點的帳戶名稱。如果 |
page_size |
每頁要擷取的位置數量。預設值為 100,下限為 1,頁面大小上限為 100。 |
page_token |
若指定,函式會擷取接下來 |
filter |
篩選器會限制要傳回的地點。回應只會包含符合篩選條件的項目。如果 如要進一步瞭解有效的欄位和使用方式範例,請參閱使用位置資料指南。 |
language_code |
要取得顯示位置資源的 BCP 47 語言。如果 Google 助理不支援該語言,系統將以當地語言提供。如果兩者皆無法使用,將會以英文提供。 已淘汰,2020 年 8 月 15 日過後,這個欄位將不再套用。而是一律使用地點的語言。 |
order_by |
要求的排序順序。下列 SQL 語法應以半形逗號分隔多個欄位。預設的排序順序是遞增。如要指定遞減順序,請加入後置字元「 desc」。order_by 的有效欄位為 location_name 和 store_code。例如:「location_name、store_code desc」、「location_name」或「store_code desc」 |
ListLocationsResponse
Locations.ListLocations 的回應訊息。
欄位 | |
---|---|
locations[] |
地點。 |
next_page_token |
如果地點數量超過要求的頁面大小,系統會在這個欄位填入權杖,以便在後續呼叫 |
total_size |
清單中位置的約略數量,與分頁無關。 |
ListMediaItemsRequest
Media.ListMediaItems 的要求訊息。
欄位 | |
---|---|
parent |
要列出媒體項目的位置名稱。 |
page_size |
每頁要傳回的媒體項目數量。預設值為 100,這也是可透過 Google My Business API 新增至某個地點的媒體項目數量上限。頁面大小上限為 2500。 |
page_token |
如有指定,系統會傳回媒體項目的下一頁。 |
ListMediaItemsResponse
Media.ListMediaItems 的回應訊息。
欄位 | |
---|---|
media_items[] |
傳回的媒體項目清單。 |
total_media_item_count |
這個位置的媒體項目總數 (與分頁無關)。 |
next_page_token |
如果媒體項目數量超過要求的頁面大小,系統會在這個欄位填入符記,以便在後續呼叫 ListMediaItems 時擷取媒體項目的下一頁。 |
ListQuestionsRequest
AskAndAnswers.ListQuestions 的要求訊息
欄位 | |
---|---|
parent |
要擷取問題的地點名稱。 |
page_size |
每頁要擷取的問題數量。 |
page_token |
如果有指定,系統會擷取下一頁的問題。 |
answers_per_question |
每個問題要擷取的答案數量。 |
filter |
篩選器會限制要傳回的問題。目前唯一支援的篩選器是「ignore_answered=true」 |
order_by |
傳回問題的訂單。有效選項包括「update_time desc」和「uperation_count desc」,這會傳回依要求欄位遞減排序的問題。預設的排序順序為「update_time desc」。 |
ListQuestionsResponse
FAQAndAnswers.ListQuestions 的回應訊息
欄位 | |
---|---|
questions[] |
請求的問題 |
total_size |
這個地點在所有網頁上張貼的問題總數。 |
next_page_token |
如果問題數量超過要求的頁面大小上限,系統會在這個欄位填入一個符記,以便在後續呼叫時擷取下一頁的問題。如果沒有其他問題,回覆中就不會顯示這個欄位。 |
ListRecommendedGoogleLocationsRequest
要求訊息,列出商家檔案帳戶的建議地點。
欄位 | |
---|---|
name |
要擷取建議的 Google 位置的帳戶資源名稱。 |
page_size |
每頁要擷取的位置數量。預設值為 25,下限為 1,頁面大小上限為 100。 |
page_token |
如果指定,系統會擷取下一頁的位置。 |
ListRecommendedGoogleLocationsResponse
GoogleLocations.ListRecommendedGoogleLocations 的回應訊息。
也包含自上次系統向這個商家檔案帳戶建議後,其他商家檔案使用者聲明擁有權的地點。
欄位 | |
---|---|
google_locations[] |
建議商家檔案帳戶的地點。每個項目都代表 Google 地圖上顯示的 |
total_size |
這個商家檔案帳戶的建議地點總數 (不受分頁影響)。 |
next_page_token |
在分頁期間,如果下一頁中還有更多可擷取的位置,系統會在此欄位填入一個符記,以便在後續呼叫中擷取下一頁的位置。如果沒有其他可擷取的地點,回應中就不會出現這個欄位。 |
ListReviewsRequest
Review.ListReviews 要求訊息。
欄位 | |
---|---|
parent |
要擷取評論的地點名稱。 |
page_size |
每網頁要擷取的評論數量。 |
page_token |
如果有指定,系統會擷取下一頁的評論。 |
order_by |
指定要做為評論排序依據的欄位。如未指定,傳回的評論順序會預設為 |
ListReviewsResponse
Review.ListReviews 的回應訊息。
欄位 | |
---|---|
reviews[] |
評論。 |
average_rating |
此地點所有評論的平均星級評等 (以 1 到 5 分表示,5 代表最高評分)。 |
total_review_count |
這個地點的評論總數。 |
next_page_token |
如果評論數超過要求的頁面大小,系統會在這個欄位填入一個符記,以便在後續呼叫 ListReview 時擷取下一頁的評論。如果沒有任何評論,回應中就不會顯示這個欄位。 |
ListVerificationsRequest
要求有關 Verifications.ListVerifications 的訊息。
欄位 | |
---|---|
parent |
驗證要求所屬位置的資源名稱。 |
page_size |
每網頁包含的驗證數量上限。如未設定,請全部傳回。 |
page_token |
如果有指定,系統會傳回下一頁驗證。 |
ListVerificationsResponse
Verifications.ListVerifications 的回應訊息。
欄位 | |
---|---|
verifications[] |
驗證清單。 |
next_page_token |
如果驗證次數超過要求的頁面大小,系統會在這個欄位填入一個符記,以擷取後續呼叫的下一頁驗證。如果沒有其他屬性,回應中就不會顯示這個欄位。 |
LocalPost
代表地區的當地貼文。
欄位 | |
---|---|
name |
僅供輸出。這則當地貼文的 Google ID,格式為: |
language_code |
當地貼文的語言。 |
summary |
當地貼文的說明/內文。 |
call_to_action |
使用者點按促銷活動後會前往的網址。系統會忽略「 |
create_time |
僅供輸出。建立貼文的時間。 |
update_time |
僅供輸出。使用者上次修改貼文的時間。 |
event |
活動資訊。主題類型 |
state |
僅供輸出。貼文的狀態,指出貼文生命週期的哪個部分。 |
media[] |
與 post 相關聯的媒體。source_url 是 LocalPost MediaItem 唯一支援的資料欄位。 |
search_url |
僅供輸出。Google 搜尋中的當地貼文連結。這個連結可用於透過社群媒體、電子郵件、簡訊等管道分享貼文。 |
topic_type |
必要欄位。貼文的主題類型:標準、活動、優惠或快訊。 |
alert_type |
要建立貼文的快訊類型。這個欄位僅適用於「topic_type 快訊」貼文,其運作方式屬於「快訊」的子類型。 |
offer |
優惠貼文的其他資料。只有在 topic_type 為 OFFER 時,才需要設定這個屬性。 |
LocalPostState
表示發布內容的狀態
列舉 | |
---|---|
LOCAL_POST_STATE_UNSPECIFIED |
未指定州。 |
REJECTED |
這則貼文因違反內容政策而遭到拒絕。 |
LIVE |
這則貼文已發布,且目前會顯示在搜尋結果中。 |
PROCESSING |
系統正在處理這則貼文,因此不會在搜尋結果中顯示。 |
LocalPostEvent
與當地貼文相關活動的所有資訊。
欄位 | |
---|---|
title |
事件的名稱。 |
schedule |
活動的開始和結束日期/時間。 |
LocalPostMetrics
針對當地貼文要求的所有指標,
欄位 | |
---|---|
local_post_name |
|
metric_values[] |
要求指標的值清單。 |
LocalPostOffer
優惠貼文的特定欄位。
欄位 | |
---|---|
coupon_code |
選用設定。可在店面或線上提供的優惠代碼。 |
redeem_online_url |
選用設定。線上兌換連結。 |
terms_conditions |
選用設定。優惠條款及細則。 |
LocalPostTopicType
當地貼文的主題類型,用於選取建立並轉譯貼文的不同範本。
列舉 | |
---|---|
LOCAL_POST_TOPIC_TYPE_UNSPECIFIED |
未指定文章類型。 |
STANDARD |
貼文包含摘要和圖片等基本資訊。 |
EVENT |
貼文包含基本資訊和活動。 |
OFFER |
貼文包含基本資訊、活動和優惠相關內容 (例如優待券代碼) |
ALERT |
與進行中活動相關的高優先順序且及時公告。這類貼文並非一律開放編輯。 |
位置
欄位 | |
---|---|
name |
這個地點的 Google ID,格式為: 比對內容時,這個欄位不會填入。 |
language_code |
地點使用的語言。請在建立期間設定,且無法更新。 |
store_code |
這個位置的外部 ID,在單一帳戶中不得重複。藉此將該地點與您自己的記錄建立關聯。 |
location_name |
位置名稱必須如實反映商家的實際名稱,且與店面、網站和文具一致,客戶所知的名稱必須一致。您可將相關資訊加入資源的其他欄位 (例如 |
primary_phone |
盡量直接與個別商家地點聯絡的電話號碼。請提供本地電話號碼,避免使用客服中心的客服專線號碼。 |
additional_phones[] |
除了主要電話號碼外,貴商家最多還可以登錄兩組電話號碼 (僅限手機或市話,不接受傳真)。 |
address |
請提供精確、精確的地址,用來說明您的商家所在地點。我們不接受位於偏遠地區的郵政信箱或信箱。目前,您最多可以在地址中指定五個 |
primary_category |
與這個地點所屬核心商家最相符的類別。 |
additional_categories[] |
其他用來描述您商家的類別。類別可協助客戶準確找到感興趣的服務。為確保商家資訊正確且上線,請盡量減少描述整體核心業務的類別。盡可能選用足以代表您主要業務的精確類別。 |
website_url |
此商家的網址。如果可以,請使用能代表這個個別商家所在地點的網址,而非代表所有地點或品牌的一般網站/網址。 |
regular_hours |
商家的營業時間。 |
special_hours |
商家的特殊營業時間。通常包括假日營業時間及一般營業時間以外的其他時間。會覆寫一般營業時間。 |
service_area |
服務範圍商家在客戶的所在地提供服務。如果這個商家是區域服務商家,這個欄位會說明商家提供的區域。 |
location_key |
可將這個商家連結到其他 Google 資源 (例如 Google+ 專頁和 Google 地圖地點) 的一組金鑰。 |
labels[] |
一組任意形式的字串,讓您可以標記商家。這些標籤「不會」向使用者顯示,只有您自己看得到。每個標籤的長度不得超過 255 個字元。 |
ad_words_location_extensions |
AdWords 中顯示的額外資訊。 |
latlng |
使用者提供的經緯度。建立位置時,如果提供的地址地理編碼成功,系統就會忽略這個欄位。只有在建立期間接受使用者提供 |
open_info |
表示地點目前是否營業中的標記。 |
location_state |
僅供輸出。代表位置狀態的一組布林值。 |
attributes[] |
此位置的屬性。 |
metadata |
僅供輸出。其他不開放使用者編輯的資訊。 |
price_lists[] |
已淘汰:這個地區的價格清單資訊。 |
profile |
用自己的方式介紹商家,並向使用者介紹商家和產品的獨特故事。 |
relationship_data |
與這個地點相關的所有地點和連鎖店。 |
more_hours[] |
其他部門或特定客戶的詳細營業時間。 |
Metadata
地點的其他 (無法編輯)。
欄位 | |
---|---|
duplicate |
與這個地點重複的地點相關資訊。只有在 |
maps_url |
地點在 Google 地圖上的連結。 |
new_review_url |
消費者在 Google 搜尋上對該地點留下評論的網頁連結。 |
Duplicate
與這個地點重複的地點相關資訊。
欄位 | |
---|---|
location_name |
重複位置的資源名稱。只有在已驗證使用者有權存取該位置,而且該位置未刪除時,才會填寫此欄位。 |
place_id |
重複地點的地點 ID。 |
access |
指出使用者是否可以存取重複的位置。 |
存取權
使用者對重複位置的存取層級。這會取代擁有權,建議改用。
列舉 | |
---|---|
ACCESS_UNSPECIFIED |
未指定。 |
ACCESS_UNKNOWN |
無法判斷使用者是否能存取重複的位置。 |
ALLOWED |
使用者可以存取副本的位置。 |
INSUFFICIENT |
使用者無法存取重複的位置。 |
RelationshipData
與此地點相關的所有家長和兒童地點資訊。
欄位 | |
---|---|
parent_chain |
這個位置所屬鏈結的資源名稱。 |
LocationDrivingDirectionMetrics
將使用者通常來自哪些地區編入索引。系統會計算各個區域前往這個地點的行車路線要求數量,藉此擷取這項資料。
欄位 | |
---|---|
location_name |
這個指標值所屬的位置資源名稱。 |
top_direction_sources[] |
按來源區域劃分的行車路線要求。按照慣例,這些結果是按數量排序,最多為 10 筆結果。 |
time_zone |
地點的時區 (IANA 時區 ID,例如「歐洲/倫敦」)。 |
TopDirectionSources
駕駛路線要求來源最高的區域。
欄位 | |
---|---|
day_count |
資料匯總的天數。 |
region_counts[] |
按數量遞減排序的區域。 |
RegionCount
與相關要求數量相關聯的區域。
欄位 | |
---|---|
latlng |
區域中心。 |
label |
使用者可理解的區域標籤。 |
count |
來自這個區域的駕駛路線要求數量。 |
LocationKey
位置的替代/代理鍵參照。
欄位 | |
---|---|
plus_page_id |
僅供輸出。如果這個地點有相關聯的 Google+ 專頁,系統就會填入這個地點的 Google+ 專頁 ID。 |
place_id |
如果這個地點已經通過驗證,且該位置已連結至 Google 地圖上/出現在 Google 地圖上,這個欄位就會填入該位置的地點 ID。這個 ID 可用於多種 Places API。 如果這個地點未經驗證,如果地點已與 Google 地圖上顯示的地點相關聯,這個欄位就會填入資料。 您可以在 Create 呼叫期間設定此欄位,但無法在 Update 中設定。 額外的 |
explicit_no_place_id |
僅供輸出。如果值為 true,代表這是刻意設定的地點 ID,與尚未建立任何關聯。 |
request_id |
僅供輸出。用來建立這個位置的 |
LocationMetrics
這是指在某個時間範圍內,與地點相關的一系列指標和 BreakdownMetrics。
欄位 | |
---|---|
location_name |
這些值所屬的位置資源名稱。 |
time_zone |
地點的 IANA 時區。 |
metric_values[] |
要求指標的值清單。 |
LocationReview
代表評論與位置資訊。
欄位 | |
---|---|
name |
位置資源名稱。 |
review |
地點評論。 |
LocationState
包含一組反映位置狀態的布林值。
欄位 | |
---|---|
is_google_updated |
僅供輸出。指出與這個地點相關聯的地點 ID 是否有更新資料。 |
is_duplicate |
僅供輸出。指出該地點是否與其他地點重複。 |
is_suspended |
僅供輸出。指出該地點是否遭停權。使用者無法在 Google 產品中看到已停權的地點。如果你認為這是誤判,請參閱說明中心文章。 |
can_update |
僅供輸出。用於指出地點是否可更新。 |
can_delete |
僅供輸出。指出能否使用 Google My Business API 刪除地點。 |
is_verified |
僅供輸出。表示地點是否已通過驗證。 |
needs_reverification |
僅供輸出。指出該地點是否需要重新驗證。 |
is_pending_review |
僅供輸出。指出該地點是否正在等待審核。 |
is_disabled |
僅供輸出。用於指出地點是否已停用。 |
is_published |
僅供輸出。指出地點是否已發布。 |
is_disconnected |
僅供輸出。指出該地點是否與 Google 地圖上的某個地點中斷連線。 |
is_local_post_api_disabled |
僅供輸出。指出這個位置的 accounts.locations.localPosts 是否已停用。 |
can_modify_service_list |
僅供輸出。指出清單是否可修改 ServiceList。 |
can_have_food_menus |
僅供輸出。說明商家資訊是否適用於食物選單。 |
has_pending_edits |
僅供輸出。指出這個地點的任何房源是否處於編輯待處理狀態。 |
has_pending_verification |
僅供輸出。表示該地點是否有待處理的驗證要求。 |
can_operate_health_data |
僅供輸出。指出該位置是否能對健康資料執行操作。 |
can_operate_lodging_data |
僅供輸出。指出地點是否能在住宿資料上運作。 |
MatchedLocation
代表可能與位置相符的結果。
欄位 | |
---|---|
location |
幾乎已填入的位置,可做為可能的比對結果。未填入的欄位包括但不限於:名稱 (比對位置無法透過 |
is_exact_match |
這是完全相符的結果嗎? |
MediaItem
單一媒體項目。
欄位 | ||
---|---|---|
name |
此媒體項目的資源名稱。 |
|
media_format |
此媒體項目的格式。媒體項目建立時必須設定,而且在其他要求中皆為唯讀。設定完成後即無法更新。 |
|
location_association |
呼叫 透過 |
|
google_url |
僅供輸出。此媒體項目的 Google 代管網址。這個網址可能會隨時間變動,因此不是靜態網址。影片會顯示重疊的播放圖示的預覽圖片。 |
|
thumbnail_url |
僅供輸出。此媒體項目的縮圖網址 (如有提供)。 |
|
create_time |
僅供輸出。這個媒體項目的建立時間。 |
|
dimensions |
僅供輸出。尺寸 (寬度和高度),以像素為單位。 |
|
insights |
僅供輸出。這個媒體項目的統計資料。 |
|
attribution |
僅供輸出。客戶媒體項目的歸因資訊。您必須向使用者顯示這個作者資訊,且不得刪除或修改出處。 |
|
description |
這個媒體項目的說明。說明無法透過 Google My Business API 修改,但可在建立不是封面相片的媒體項目時設定。 |
|
聯集欄位 除了 所有上傳的相片都必須符合商家檔案相片規範。 |
||
source_url |
可從公開存取的網址擷取媒體項目。 建立這個項目或 data_ref 時,必須設為指定媒體項目的來源。 如果在建立媒體項目時使用 無法更新這個欄位。 |
|
data_ref |
僅限輸入。透過 建立媒體項目時
或
都必須設定。 |
歸因
客戶媒體項目的作者資訊,例如貢獻者的名稱和個人資料相片。
欄位 | |
---|---|
profile_name |
要做為媒體項目歸因的使用者名稱。 |
profile_photo_url |
來源使用者個人資料相片縮圖的網址。 |
takedown_url |
下架頁面的網址,當中可以檢舉不當的媒體項目。 |
profile_url |
歸因使用者的 Google 地圖個人資料網頁網址。 |
尺寸
媒體項目的尺寸。
欄位 | |
---|---|
width_pixels |
媒體項目的寬度,以像素為單位。 |
height_pixels |
媒體項目的高度,以像素為單位。 |
LocationAssociation
媒體項目與位置的關聯方式。
欄位 | ||
---|---|---|
聯集欄位 location_attachment_type 。位置媒體必須包含相關聯的價格清單項目類別或 ID。非地點媒體 (例如當地貼文相片) 不得未提供任何資訊。location_attachment_type 只能是下列其中一項: |
||
category |
這張相片所屬的類別。 |
|
price_list_item_id |
與這張地點相片相關聯的價格清單項目 ID。 |
類別
媒體項目類別列舉。
列舉 | |
---|---|
CATEGORY_UNSPECIFIED |
未指定的類別。 |
COVER |
封面相片。一個地點只有一張封面相片。 |
PROFILE |
個人資料相片。一個地點只有一張個人資料相片。 |
LOGO |
標誌相片。 |
EXTERIOR |
外部媒體。 |
INTERIOR |
室內媒體。 |
PRODUCT |
產品媒體。 |
AT_WORK |
「工作」媒體。 |
FOOD_AND_DRINK |
飲食媒體。 |
MENU |
選單媒體。 |
COMMON_AREA |
公共區域媒體。 |
ROOMS |
聊天室媒體。 |
TEAMS |
團隊媒體。 |
ADDITIONAL |
其他未分類的媒體。 |
MediaFormat
媒體格式的列舉,
列舉 | |
---|---|
MEDIA_FORMAT_UNSPECIFIED |
未指定格式。 |
PHOTO |
媒體項目是相片。這個版本僅支援相片。 |
VIDEO |
媒體項目是影片。 |
MediaInsights
媒體項目的深入分析和統計資料。
欄位 | |
---|---|
view_count |
僅供輸出。媒體項目的瀏覽次數。 |
MediaItemDataRef
參照透過 Google My Business API 上傳的 MediaItem
的相片二進位資料。
使用 StartUploadMediaItemData
建立資料參照,並在將位元組上傳到 [UpdateMedia] 後,接著呼叫 CreateMediaItem
時使用這項參照。
欄位 | |
---|---|
resource_name |
這個媒體項目二進位資料的專屬 ID。用於使用 [UpdateMedia] 上傳相片資料,以及用 上傳位元組的範例: 針對 |
MenuLabel
顯示選單及其各種子元件時使用的標籤。
欄位 | |
---|---|
display_name |
必要欄位。元件的顯示名稱。 |
description |
選用設定。元件的補充資訊。 |
language_code |
選用設定。BCP 47 語言代碼。如果沒有支援的語言,則預設為英文。 |
指標
資源相關資料的指標。
列舉 | |
---|---|
METRIC_UNSPECIFIED |
未指定指標。 |
ALL |
要求所有可用指標的簡要說明。「全部」納入的指標,會因要求深入分析的資源而異。 |
QUERIES_DIRECT |
直接搜尋位置時,資源顯示的次數。 |
QUERIES_INDIRECT |
資源因類別搜尋 (例如餐廳) 而顯示的次數。 |
QUERIES_CHAIN |
資源因所屬連鎖店或販售的品牌進行搜尋而獲得的次數。例如星巴克, 愛迪達。這是 QUERIES_INDIRECT 的子集。 |
VIEWS_MAPS |
資源在 Google 地圖上獲得觀看的次數。 |
VIEWS_SEARCH |
資源在 Google 搜尋上的瀏覽次數。 |
ACTIONS_WEBSITE |
網站的點擊次數。 |
ACTIONS_PHONE |
電話號碼的點按次數。 |
ACTIONS_DRIVING_DIRECTIONS |
查詢行車路線的次數。 |
PHOTOS_VIEWS_MERCHANT |
商家上傳的媒體項目觀看次數。 |
PHOTOS_VIEWS_CUSTOMERS |
客戶上傳的媒體項目瀏覽次數。 |
PHOTOS_COUNT_MERCHANT |
商家目前上線的媒體項目總數。 |
PHOTOS_COUNT_CUSTOMERS |
客戶目前已上線的媒體項目總數。 |
LOCAL_POST_VIEWS_SEARCH |
當地貼文在 Google 搜尋上獲得的觀看次數。 |
LOCAL_POST_ACTIONS_CALL_TO_ACTION |
Google 上行動號召按鈕的點擊次數。 |
MetricOption
可指定在回應中如何顯示資料的選項。
列舉 | |
---|---|
METRIC_OPTION_UNSPECIFIED |
未指定指標選項。要求中將預設為 AGGREGATED_TOTAL。 |
AGGREGATED_TOTAL |
傳回整個時間範圍內的匯總值。這是預設值。 |
AGGREGATED_DAILY |
傳回跨時間範圍內的每日時間戳記值。 |
BREAKDOWN_DAY_OF_WEEK |
傳回的值會按星期幾細分。僅適用於 ACTIONS_PHONE。 |
BREAKDOWN_HOUR_OF_DAY |
傳回的值會按一天中的時段細分。僅適用於 ACTIONS_PHONE。 |
MetricRequest
傳回單一指標值的要求,以及這些值的傳回選項。
欄位 | |
---|---|
metric |
要求的指標。 |
options[] |
傳回值時應的顯示方式。 |
MetricValue
從開始時間開始的單一指標值。
欄位 | |
---|---|
metric |
要套用值的指標。 |
total_value |
這項指標的總匯總值。已為 AGGREGATED_TOTAL 選項設定。 |
dimensional_values[] |
這項指標的維度值。 |
MoreHours
地點在特定類型的商家營業的期間。
欄位 | |
---|---|
hours_type_id |
必要欄位。營業時間類型。客戶應致電 {#link businessCategories:BatchGet},取得各地點類別支援的營業時間類型。 |
periods[] |
必要欄位。這個地點的營業次數集合。每個時段代表地點在一週中營業的時段。 |
MoreHoursType
商家除了一般營業時間外,還有更多營業時間類型。
欄位 | |
---|---|
hours_type_id |
僅供輸出。Google 針對這個營業時間類型提供的固定 ID。 |
display_name |
僅供輸出。使用者容易理解的營業時間類型英文顯示名稱。 |
localized_display_name |
僅供輸出。營業時間類型的本地化顯示名稱。 |
NetworkState
與這個地點相關的保險網絡狀態。
列舉 | |
---|---|
NETWORK_STATE_UNSPECIFIED |
預設值。 |
ACCEPTED |
此網路已接受此網路。 |
PENDING_ADD |
有一項待處理的要求要將這個聯播網加入已接受清單。 |
PENDING_DELETE |
有一項待處理的要求,希望我們將這個聯播網從已接受的清單中移除。 |
NOT_ACCEPTED |
此位置不接受此網路。 |
NotificationType
傳送至 Cloud Pub/Sub 主題的通知類型。
列舉 | |
---|---|
NOTIFICATION_TYPE_UNSPECIFIED |
沒有通知類型。不會比對任何通知。 |
GOOGLE_UPDATE |
該地點有需要審查的 Google 資訊更新。通知中的 location_name 欄位會顯示 Google 資訊更新的地點資源名稱。 |
NEW_REVIEW |
該地點已新增評論。通知中的 review_name 欄位會提供新增評論的資源名稱,而 location_name 會顯示位置的資源名稱。 |
UPDATED_REVIEW |
有關該地點的評論已更新。通知中的 review_name 欄位會提供新增評論的資源名稱,而 location_name 會顯示位置的資源名稱。 |
NEW_CUSTOMER_MEDIA |
Google 地圖使用者新增了媒體項目。通知將提供新媒體項目的資源名稱。 |
NEW_QUESTION |
該地點就會新增一個問題。通知內容會提供問題的資源名稱。 |
UPDATED_QUESTION |
地點的問題已更新。通知內容會提供問題的資源名稱。 |
NEW_ANSWER |
地點即會新增答案。通知內容會提供問題和答案的資源名稱。 |
UPDATED_ANSWER |
地點的答案已更新。通知內容會提供問題和答案的資源名稱。 |
UPDATED_LOCATION_STATE |
地點的 LocationState 已更新。「通知」會包含已更新 LocationState 欄位的欄位遮罩。 |
通知
Google Cloud Pub/Sub 主題,可在位置更新或有新的評論時發布通知。每個帳戶只能有一個通知設定資源。
欄位 | |
---|---|
name |
僅供輸出。通知資源名稱。 |
topic_name |
Google Cloud Pub/Sub 主題會在這個帳戶管理的地點更新時接收通知。如未設定,系統不會發布任何通知。 mybusiness-api-pubsub@system.gserviceaccount.com 帳戶必須至少具備 Cloud Pub/Sub 主題的「發布」權限。 |
notification_types[] |
會傳送至 Cloud Pub/Sub 主題的通知類型。至少須指定一個值。如要完全停止接收通知,請使用 |
NutritionFacts
這則訊息代表食物的營養成分。
欄位 | |
---|---|
calories |
選用設定。菜餚的卡路里。 |
total_fat |
選用設定。特定食物的脂肪資訊。 |
cholesterol |
選用設定。特定食物的膽固醇資訊。 |
sodium |
選用設定。特定食物的鈉資訊。 |
total_carbohydrate |
選用設定。特定食物的碳水化合物資訊。 |
protein |
選用設定。特定食物的蛋白質資訊。 |
CaloriesFact
此訊息表示卡路里資訊,使用範圍上限和下限。必須指定較低的金額。下限與上限皆為非負數。
欄位 | |
---|---|
lower_amount |
必要欄位。卡路里較少 |
upper_amount |
選用設定。卡路里上限 |
unit |
必要欄位。指定卡路里資訊的單位。 |
EnergyUnit
可能的食物能量單位 (卡路里)。
列舉 | |
---|---|
ENERGY_UNIT_UNSPECIFIED |
未指定能源單位 |
CALORIE |
卡路里 |
JOULE |
焦耳 |
MassUnit
可能的質量單位。
列舉 | |
---|---|
MASS_UNIT_UNSPECIFIED |
未指定質量單位 |
GRAM |
Gram |
MILLIGRAM |
毫克 |
NutritionFact
此訊息表示營養資訊,包含上限和下限範圍,能以質量單位表示。必須指定較低的金額。下限與上限皆為非負數。
欄位 | |
---|---|
lower_amount |
必要欄位。營養量較低 |
upper_amount |
選用設定。營養含量上限 |
unit |
必要欄位。特定營養資訊的單位。 |
OpenInfo
商家營業狀態的相關資訊。
欄位 | |
---|---|
status |
指出該地點目前是否營業中。根據預設,所有地點都是營業中 (除非更新為已停業)。 |
can_reopen |
僅供輸出。表示這個商家是否有資格恢復營業。 |
opening_date |
地點初次開啟的日期。如果不知道確切日期,則只能提供月份和年份。日期必須是過去的日期,或在未來一年內。 |
OpenForBusiness
表示地點的狀態。
列舉 | |
---|---|
OPEN_FOR_BUSINESS_UNSPECIFIED |
未指定。 |
OPEN |
表示地點營業中。 |
CLOSED_PERMANENTLY |
表示該地點已永久停業。 |
CLOSED_TEMPORARILY |
表示該地點已暫停營業。這個值僅適用於已發布的地點 (即 location_state.is_published = true)。將狀態欄位更新為這個值時,用戶端必須明確將 update_mask 設為 open_info.status 。這次更新通話期間無法再設定其他更新遮罩。這項暫時性限制將於近期放寬,不久後就會放寬。 |
PermissionLevel
指出已驗證使用者對這個帳戶的存取層級。
列舉 | |
---|---|
PERMISSION_LEVEL_UNSPECIFIED |
未指定。 |
OWNER_LEVEL |
使用者俱備擁有者層級權限。 |
MEMBER_LEVEL |
使用者擁有成員層級權限。 |
PhoneInput
PHONE_CALL/SMS 驗證的輸入內容。
欄位 | |
---|---|
phone_number |
應撥打或接收 SMS 的電話號碼。且必須是適用選項中其中一個電話號碼。 |
PlaceInfo
定義以地點 ID 表示的區域。
欄位 | |
---|---|
name |
地點的本地化名稱。例如 |
place_id |
地點的 ID。必須與 region 對應。 |
地點介面集
用於定義由一組地點代表的區域聯集。
欄位 | |
---|---|
place_infos[] |
以地點 ID 表示的區域。地點數量上限為 20 個地點。 |
PointRadius
以特定點 (經緯度) 為中心的半徑範圍。
欄位 | |
---|---|
latlng |
經緯度,指定半徑定義區域的中心。 |
radius_km |
該地點周圍區域的距離 (以公里為單位)。 |
PreparationMethod
食物的製備方式。
列舉 | |
---|---|
PREPARATION_METHOD_UNSPECIFIED |
未指定準備方法 |
BAKED |
烘焙法 |
BARBECUED |
烤肉方法 |
BASTED |
烘焙法 |
BLANCHED |
傾斜法 |
BOILED |
沸化方法 |
BRAISED |
宣揚法務 |
CODDLED |
已編碼的方法 |
FERMENTED |
發酵方法 |
FRIED |
收尾法 |
GRILLED |
燒烤方法 |
KNEADED |
Kneaded 方法 |
MARINATED |
邊界方法 |
PAN_FRIED |
平移方法 |
PICKLED |
所選方法 |
PRESSURE_COOKED |
施壓加壓方式 |
ROASTED |
旋轉方法 |
SAUTEED |
理想方法 |
SEARED |
密封方法 |
SIMMERED |
模擬方法 |
SMOKED |
煙燻方法 |
STEAMED |
蒸汽化方法 |
STEEPED |
陡峭的方法 |
STIR_FRIED |
熱炒 |
OTHER_METHOD |
其他方式 |
PriceList
已淘汰:商品價格資訊清單。價格清單由一或多份價格清單組成,每個清單都包含一或多個專區,內含一或多個商品。舉例來說,食物價格清單可能代表早餐/午餐/晚餐菜單,而菜單包括漢堡/牛排/海鮮。
欄位 | |
---|---|
price_list_id |
必要欄位。價格清單的 ID。你無法在這個地區複製價目表、專區和項目 ID。 |
labels[] |
必要欄位。價格清單的語言標記標籤。 |
source_url |
擷取價格清單的來源網址 (選填)。舉例來說,這可能是系統自動剪輯來填入菜單資訊的網頁網址。 |
sections[] |
必要欄位。這份價目表的版面。每份價目表都必須包含至少一個版面。 |
標籤
顯示價格清單、專區或商品時使用的標籤。
欄位 | |
---|---|
display_name |
必要欄位。價格清單、專區或商品的顯示名稱。 |
description |
選用設定。價格清單、專區或商品的說明。 |
language_code |
選用設定。這些字串適用的 BCP-47 語言代碼。每種語言只能設定一組標籤。 |
章節
價格清單的一個部分,包含一或多個商品。
欄位 | |
---|---|
section_id |
必要欄位。章節 ID。你無法在這個地區複製價目表、專區和項目 ID。 |
labels[] |
必要欄位。區段的語言標記標籤。版面名稱和說明建議不要超過 140 個半形字元。至少須指定一組標籤。 |
section_type |
選用設定。目前價目表部分的類型。預設值為 FOOD。 |
items[] |
價目表這部分包含的商品。 |
項目
單一清單項目。價格清單上的每項商品子類都應有專屬的商品和價格資料。
欄位 | |
---|---|
item_id |
必要欄位。商品的 ID。你無法在這個地區複製價目表、專區和項目 ID。 |
labels[] |
必要欄位。項目的語言標記標籤。項目名稱的建議長度上限為 140 個半形字元,說明的長度則不超過 250 個半形字元。至少須指定一組標籤。 |
price |
選用設定。商品的價格。 |
SectionType
版面類型。
列舉 | |
---|---|
SECTION_TYPE_UNSPECIFIED |
未指定。 |
FOOD |
區段包含代表食物的項目。 |
SERVICES |
區段包含代表服務的項目。 |
設定檔
與地點設定檔相關的所有資訊。
欄位 | |
---|---|
description |
請說出地點說明,任何人都無法編輯。 |
問題
代表單一問題及部分答案。
欄位 | |
---|---|
name |
僅供輸出。問題的專屬名稱。帳戶/*/locations/*/questions/* |
author |
僅供輸出。問題的作者。 |
upvote_count |
僅供輸出。問題的認同票數。 |
text |
問題的文字。其中應包含至少 3 個字詞,且總長度大於或等於 10 個字元。長度上限為 4096 個半形字元。 |
create_time |
僅供輸出。寫入問題時的時間戳記。 |
update_time |
僅供輸出。上次修改問題時的時間戳記。 |
top_answers[] |
僅供輸出。問題的答案清單,依認同票數排序。視要求參數而定 (answers_per_question) 可能未必是完整的答案清單 |
total_answer_count |
僅供輸出。這個問題張貼的答案總數。 |
RepeatedEnumAttributeValue
value_type
為 REPEATED_ENUM 的屬性值。當中包含兩份值 ID 清單,分別設為 (true) 和未設定 (false) 的值。缺少的值會視為不明。至少須指定一個值。
欄位 | |
---|---|
set_values[] |
設定的列舉值。 |
unset_values[] |
未設定的列舉值。 |
ReportGoogleLocationRequest
要求回報 GoogleLocation
的訊息。
欄位 | ||
---|---|---|
name |
[GoogleLocation] 的資源名稱,格式為 |
|
location_group_name |
選用設定。回報這個 Google 位置的地區群組名稱,格式為 |
|
report_reason_elaboration |
選用設定。輸入文字,說明使用者檢舉這個地點的原因。長度上限為 512 個半形字元。 |
|
report_reason_language_code |
選用設定。 |
|
聯集欄位 report_reason 。系統回報這個地點的原因。必須提供原因。report_reason 只能是下列其中一項: |
||
report_reason_bad_location |
使用者回報這個地點的原因與地點本身有關。 |
|
report_reason_bad_recommendation |
建議問題影響到使用者回報這個地點的原因。如果商家檔案帳戶推薦了該地點,這份報表就非常實用。 |
BadLocationReason
地點本身資料品質有問題時,系統回報地點的一組可能原因。
列舉 | |
---|---|
BAD_LOCATION_REASON_UNSPECIFIED |
未指定。 |
NOT_A_LOCATION |
建議的位置並非實際位置。 |
PERMANENTLY_CLOSED |
建議的地點已永久停業。 |
DOES_NOT_EXIST |
建議的位置不存在。 |
SPAM |
建議的地點為垃圾內容、不實或令人反感。 |
NOT_A_BUSINESS |
建議的地點為私人或住家。 |
MOVED |
建議的位置已移至新位置。 應搭配指定新地址的 |
DUPLICATE |
建議的地點與另一個地點重複。 |
BadRecommendationReason
建議品質有問題時,回報地點的一組可能原因 (系統向使用者建議這個地點時)。
列舉 | |
---|---|
BAD_RECOMMENDATION_REASON_UNSPECIFIED |
未指定。 |
NOT_A_STORE_FRONT |
建議的地點並非店面。 |
NOT_PART_OF_SUGGESTED_CHAIN |
建議位置不屬於傳回位置的 應一併附上指定正確鏈結名稱的 |
IRRELEVANT |
建議的位置與使用者無關。 應隨附 |
ReportLocalPostInsightsRequest
Insights.ReportLocalPostInsights 要求訊息
欄位 | |
---|---|
name |
必要欄位。要擷取深入分析的地點名稱。 |
local_post_names[] |
必要欄位。要擷取洞察資料的貼文清單。所有貼文都必須屬於 |
basic_request |
要求在報表中納入基本指標洞察。此要求適用於所有所要求的貼文。 |
ReportLocalPostInsightsResponse
Insights.ReportLocalPostInsights 的回應訊息
欄位 | |
---|---|
name |
|
local_post_metrics[] |
每要求一則與這個位置相應的貼文,只能有一個項目。 |
time_zone |
地點的時區 (IANA 時區 ID,例如「歐洲/倫敦」)。 |
ReportLocationInsightsRequest
Insights.ReportLocationInsights 的要求訊息。
欄位 | |
---|---|
name |
帳戶資源名稱。 |
location_names[] |
要擷取洞察資料的地點集合,由名稱指定。 |
basic_request |
要求在報表中納入基本指標洞察。 |
driving_directions_request |
要求將有關行車路線要求的深入分析資訊納入報告中。 |
ReportLocationInsightsResponse
Insights.ReportLocationInsights
的回應訊息。
欄位 | |
---|---|
location_metrics[] |
按位置劃分的指標值集合。 |
location_driving_direction_metrics[] |
行車方向相關指標的一組值。 |
立即詳閱
僅供輸出。代表某地點的評論。
欄位 | |
---|---|
name |
資源名稱。審查方式為 |
review_id |
經過加密的專屬 ID。 |
reviewer |
評論的作者。 |
star_rating |
評論的星級評等。 |
comment |
含有標記的純文字評論內文。 |
create_time |
撰寫評論的時間戳記。 |
update_time |
上次修改評論的時間戳記。 |
review_reply |
這個地點的擁有者/管理員對這則評論的回覆。 |
評論者
代表評論的作者。
欄位 | |
---|---|
profile_photo_url |
評論者的個人資料相片連結。只有在 |
display_name |
評論者的名稱。只有在 |
is_anonymous |
指出評論者是否選擇保持匿名。 |
StarRating
星級評等 (滿分五顆星),其中五分是最高分。
列舉 | |
---|---|
STAR_RATING_UNSPECIFIED |
未指定。 |
ONE |
一顆星 (滿分 5 顆星)。 |
TWO |
2 顆星 (滿分 5 顆星)。 |
THREE |
3 顆星 (滿分 5 顆星)。 |
FOUR |
4 顆星 (滿分 5 顆星)。 |
FIVE |
最高星級評等。 |
ReviewReply
代表營業地點擁有者/管理員對評論的回覆。
欄位 | |
---|---|
comment |
回覆內文 (含有標記的純文字)。長度上限為 4096 個位元組。 |
update_time |
僅供輸出。上次修改回覆的時間戳記。 |
SearchChainsRequest
Locations.SearchChains 的要求訊息。
欄位 | |
---|---|
chain_display_name |
使用鏈結名稱搜尋鏈結。支援完全/部分/模糊/相關查詢。範例:"walmart、"wal-mart"、"walmmmart"、"聃" |
result_count |
這項查詢傳回的相符鏈結數量上限。預設值為 10。可能的值上限為 500。 |
SearchChainsResponse
Locations.SearchChains 的回應訊息。
欄位 | |
---|---|
chains[] |
與 SearchChainsRequest 中查詢的 ChaininC_display_name 相符的鏈結。如果沒有相符項目,這個欄位會留空。結果會依關聯性排序。 |
SearchGoogleLocationsRequest
要求 GoogleLocations.SearchGoogleLocations 的訊息。
欄位 | ||
---|---|---|
result_count |
要傳回的相符項目數量。預設值為 3,最多 10。請注意,如果要求更多,延遲時間可能會增加。沒有分頁。 |
|
聯集欄位 search_query 。搜尋查詢。能以位置物件或字串查詢的形式提供。search_query 只能是下列其中一項: |
||
location |
要搜尋的位置。如有提供,系統會找出與提供的地點詳細資料相符的地點。 |
|
query |
要搜尋的文字查詢。查詢字串的搜尋結果會比提供確切位置來得準確,但可提供較不精確的符合項目。 |
SearchGoogleLocationsResponse
GoogleLocations.SearchGoogleLocations 的回應訊息。
欄位 | |
---|---|
google_locations[] |
可能與指定要求相符的 GoogleLocation 集合,按精確度由高至低列出。 |
ServiceAreaBusiness
服務範圍商家在顧客的營業地點提供服務 (例如鎖匠或水電工)。
欄位 | ||
---|---|---|
business_type |
表示服務區域商家的 |
|
聯集欄位 coverageArea 。指出商家提供服務的涵蓋範圍。coverageArea 只能是下列其中一項: |
||
radius |
僅供輸出。此商家以某點為中心的中心區域。 |
|
places |
此商家透過一組地點指定的服務範圍。 |
BusinessType
指出此商家是否只在消費者的所在地點 (例如拖車車) 提供現場服務,或者同時在地址和現場提供服務 (例如設有用餐區的披薩店,以及代客送貨服務)。
列舉 | |
---|---|
BUSINESS_TYPE_UNSPECIFIED |
僅供輸出。未指定。 |
CUSTOMER_LOCATION_ONLY |
只在周邊地區提供服務 (不在商家地址附近)。 |
CUSTOMER_AND_BUSINESS_LOCATION |
在商家地址和周邊區域提供服務。 |
ServiceBusinessContext
服務商家驗證的其他資料。
欄位 | |
---|---|
address |
地點的驗證地址。這些資訊可用於啟用更多驗證選項或傳送明信片。 |
ServiceList
包含一或多個服務項目的服務清單。
欄位 | |
---|---|
name |
必要欄位。這個地點的 Google ID,格式為: |
service_items[] |
這份服務清單中的服務項目。系統會自動移除重複的服務項目。 |
ServiceItem
描述單一服務項目的訊息。用來說明商家提供的服務類型。例如理髮並非服務。
欄位 | ||
---|---|---|
is_offered |
選用設定。這個欄位會決定商家是否提供輸入服務。 |
|
price |
選用設定。代表服務項目的貨幣價格。加入價格時,建議您設定 currency_code 和 unit。 |
|
聯集欄位 service_item_info 。請一律設定下列其中一個欄位。service_item_info 只能是下列其中一項: |
||
structured_service_item |
這個欄位會設定結構化資料的大小寫。 |
|
free_form_service_item |
這個欄位會設為任意形式服務資料的值。 |
FreeFormServiceItem
代表商家提供的任意形式服務。這些服務並未包含在 Google 的結構服務資料中。商家透過 Geomerchant 途徑手動輸入此類服務的名稱。
欄位 | |
---|---|
category_id |
必要欄位。 |
label |
必要欄位。項目的語言標記標籤。項目名稱的建議長度上限為 140 個半形字元,說明的長度則不超過 250 個半形字元。只有在輸入內容為自訂服務項目時,才需要設定這個欄位。標準化服務類型應透過 service_type_id 更新。 |
StructuredServiceItem
代表商家提供的結構化服務。例如:ilet_installation。
欄位 | |
---|---|
service_type_id |
必要欄位。 |
description |
選用設定。結構化服務項目的說明。長度上限為 300 個半形字元。 |
ServiceType
商家所提供服務類型的訊息。
欄位 | |
---|---|
service_type_id |
僅供輸出。這個服務類型的固定 ID (由 Google 提供)。 |
display_name |
僅供輸出。使用者容易理解的服務類型的顯示名稱。 |
SpecialHourPeriod
代表某個地點的營業時間與正常營業時間不同的時間範圍。特殊時段必須代表小於 24 小時的範圍。open_time
和 start_date
必須早於 close_time
和 end_date
。close_time
和 end_date
可以延長至指定 start_date
之後的當天凌晨 11:59。舉例來說,以下為有效的輸入內容:
start_date=2015-11-23, open_time=08:00, close_time=18:00
start_date=2015-11-23, end_date=2015-11-23, open_time=08:00,
close_time=18:00 start_date=2015-11-23, end_date=2015-11-24,
open_time=13:00, close_time=11:59
下列輸入內容無效:
start_date=2015-11-23, open_time=13:00, close_time=11:59
start_date=2015-11-23, end_date=2015-11-24, open_time=13:00,
close_time=12:00 start_date=2015-11-23, end_date=2015-11-25,
open_time=08:00, close_time=18:00
欄位 | |
---|---|
start_date |
這個特殊時段的起始日期。 |
open_time |
|
end_date |
這個特殊時段的結束日期。如未設定 |
close_time |
地點打烊時, |
is_closed |
如果設為 True,系統會忽略 |
SpecialHours
代表一個地點的營業時間與正常營業時間不同的時間範圍。
欄位 | |
---|---|
special_hour_periods[] |
商家一般營業時間的例外狀況清單。 |
辣度
食品的辣度。
列舉 | |
---|---|
SPICINESS_UNSPECIFIED |
未指定等級 |
MILD |
輕微辣度的象徵。 |
MEDIUM |
中度鼓勵。 |
HOT |
表示熱辣。最高最高峰。 |
StartUploadMediaItemDataRequest
Media.StartUploadMediaItemData 的要求訊息。
欄位 | |
---|---|
parent |
要新增這個媒體項目的位置資源名稱。 |
TimeInterval
時間間隔 (含頭尾)。這個欄位必須包含所有有效欄位。
欄位 | |
---|---|
start_date |
此期間的開始日期。 |
start_time |
這個時間範圍的開始時間。 |
end_date |
此期間的結束日期。 |
end_time |
這段期間的結束時間。 |
TimePeriod
代表商家營業的時間範圍,從指定的營業時間開始,到指定結束日/時間結束為止。打烊時間必須晚於開幕時間,例如當天稍晚或隨後幾天。
欄位 | |
---|---|
open_day |
表示這個期間從開始當天起算的 |
open_time |
以 24 小時 ISO 8601 擴充格式 (hh:mm) 表示的時間。有效值為 00:00-24:00,其中 24:00 代表指定日期欄位結束的午夜。 |
close_day |
表示這個週期結束的 |
close_time |
以 24 小時 ISO 8601 擴充格式 (hh:mm) 表示的時間。有效值為 00:00-24:00,其中 24:00 代表指定日期欄位結束的午夜。 |
TimeRange
時間範圍。系統會在範圍內提取資料,並將這個範圍內的資料轉換成半開公開值 (即 [start_time, end_time)]。
欄位 | |
---|---|
start_time |
範圍開始的 Epoch 紀元時間戳記 (含首尾)。 |
end_time |
範圍結束的 Epoch 紀元時間戳記 (不含)。 |
TransferLocationRequest
要求 Locations.TransferLocation 的訊息。
欄位 | |
---|---|
name |
要轉移的地點名稱。 |
to_account |
要接收位置的帳戶資源名稱 (例如「accounts/8675309」)。 |
UpdateAccountAdminRequest
AccessControl.UpdateAccountAdmin 的要求訊息。
欄位 | |
---|---|
name |
待更新管理員的資源名稱。 |
admin |
更新後的管理員。注意:唯一可編輯的欄位為 |
UpdateAccountRequest
帳戶.UpdateAccount 的要求訊息。
欄位 | |
---|---|
name |
要更新的帳戶名稱。 |
account |
已更新的帳戶資訊。注意:唯一可編輯的欄位為 |
validate_only |
如果為 true,表示該要求已通過驗證,而不會實際更新帳戶。 |
UpdateFoodMenusRequest
FoodMenu.UpdateFoodMenus 的要求訊息
欄位 | |
---|---|
food_menus |
必要欄位。更新後的飲食菜單資訊。如要取消設定選單,請更新選單區域, |
update_mask |
選用設定。要更新的特定欄位。如果沒有指定遮罩,系統會將此視為完整的更新,並將所有欄位設為傳入的值,要求中可能包含未設定的空白欄位。無法個別更新重複欄位的項目。注意:FoodMenus 的「name」是無法更新的資源 ID。 |
UpdateHealthProviderAttributesRequest
HealthProviderAttributes.UpdateHealthProviderAttributes 的要求訊息
欄位 | |
---|---|
health_provider_attributes |
必要欄位。更新的健康提供者屬性。 |
update_mask |
選用設定。要更新的特定欄位。如果沒有指定遮罩,系統會將此視為完整的更新,並將所有欄位設為傳入的值,要求中可能包含未設定的空白欄位。在 V1 中,只有 surer_networks 欄位要更新。我們稍後會支援更多屬性。 |
UpdateLocalPostRequest
要求 UpdateLocalPost 的訊息。
欄位 | |
---|---|
name |
要更新的當地貼文名稱。 |
local_post |
更新後的當地貼文資訊。 |
update_mask |
要更新的特定欄位。您必須在遮罩中指定要更新的每個欄位。 |
UpdateLocationAdminRequest
要求 AccessControl.UpdateLocationAdmin 的訊息。
欄位 | |
---|---|
name |
待更新管理員的資源名稱。 |
admin |
更新後的管理員。注意:唯一可編輯的欄位為 |
UpdateLocationRequest
Locations.UpdateLocation 的要求訊息。
欄位 | |
---|---|
name |
要更新的地點名稱。 |
location |
更新的位置資訊。 |
update_mask |
要更新的特定欄位。如果沒有指定遮罩,系統會將此視為完整的更新,並將所有欄位設為傳入的值,要求中可能包含未設定的空白欄位。 |
validate_only |
如果為 true,表示要求已在驗證,而不會實際更新位置。 |
attribute_mask |
要更新的屬性 ID。系統只會更新遮罩中註記的屬性。如果遮罩中有屬性出現在遮罩中,且位置沒有,系統將移除該屬性。空白的遮罩會更新所有屬性。 設定這個欄位時,update_mask 應包含屬性做為其中一個要更新的欄位。 |
UpdateMediaItemRequest
Media.UpdateMediaItem 的要求訊息。
欄位 | |
---|---|
name |
要更新的媒體項目名稱。 |
media_item |
要更新的媒體項目。 只能更新類別或價格清單項目 ID。 |
update_mask |
要更新的特定欄位。如果沒有指定遮罩,系統會將此視為完整的更新,並將所有可編輯的欄位設為傳入的值。 |
UpdateNotificationsRequest
Account.UpdateNotifications 的要求訊息。
欄位 | |
---|---|
name |
通知設定資源名稱。 |
notifications |
更新後的通知設定。 |
UpdateQuestionRequest
FAQAndAnswers.UpdateQuestion 的要求訊息
欄位 | |
---|---|
name |
要更新的問題名稱。 |
question |
更新的問題。 |
UpdateReviewReplyRequest
要求 Review.UpdateReviewReply。
欄位 | |
---|---|
name |
要回覆的評論名稱。 |
review_reply |
對評論的回覆。如果已有回覆,則舊回覆會取代舊回覆。 |
UpdateServiceListRequest
更新服務清單要求訊息。
欄位 | |
---|---|
service_list |
選用設定。更新後的服務清單資訊。如果將這個欄位留空,API 會刪除 ServiceList。如果設定了 ServiceList,API 將取代原本的 ServiceList。 |
update_mask |
選用設定。要更新的特定欄位。如果沒有指定遮罩,系統會將此視為完整的更新,並將所有欄位設為傳入的值,要求中可能包含未設定的空白欄位。無法個別更新重複欄位的項目。 |
UpsertAnswerRequest
AskAndAnswers.UpsertResponse 要求訊息
欄位 | |
---|---|
parent |
要輸入答案的問題名稱。 |
answer |
新的答案。 |
UrlAttributeValue
網址 value_type
的屬性值。
欄位 | |
---|---|
url |
網址。 |
ValidationError
說明用戶端要求中的驗證失敗。
欄位 | |
---|---|
error_details[] |
詳細說明個別驗證失敗的情況 (含整數錯誤代碼)。 |
驗證
驗證是指某個地點的驗證嘗試。
欄位 | |
---|---|
name |
驗證的資源名稱。 |
method |
驗證方式。 |
state |
驗證狀態, |
create_time |
要求驗證的時間戳記。 |
VerificationState
所有可能的驗證狀態。
列舉 | |
---|---|
VERIFICATION_STATE_UNSPECIFIED |
預設值會產生錯誤。 |
PENDING |
正在等待驗證, |
COMPLETED |
驗證完成。 |
FAILED |
驗證失敗, |
VerificationMethod
指定 Google 用來驗證位置資訊的程序。
列舉 | |
---|---|
VERIFICATION_METHOD_UNSPECIFIED |
預設值會產生錯誤。 |
ADDRESS |
將含有驗證 PIN 碼的明信片寄到特定郵寄地址。你可以使用 PIN 碼完成 Google 驗證程序。 |
EMAIL |
將內含驗證 PIN 碼的電子郵件傳送至特定電子郵件地址。你可以使用 PIN 碼完成 Google 驗證程序。 |
PHONE_CALL |
撥打特定電話號碼的驗證 PIN 碼。你可以使用 PIN 碼完成 Google 驗證程序。 |
SMS |
傳送內含驗證 PIN 碼的簡訊到特定的電話號碼。你可以使用 PIN 碼完成 Google 驗證程序。 |
AUTO |
在使用者不需執行其他操作的情況下驗證地點。部分地區可能無法使用這個選項。 |
VerificationOption
驗證選項是指如何驗證位置 (以驗證方法表示),以及驗證的目的地 (以多媒體廣告資料表示)。
欄位 | ||
---|---|---|
verification_method |
驗證地點的方法。 |
|
聯集欄位 DisplayData 。其中一個顯示資料。資料必須與方法相符。如果對應的方法沒有任何顯示資料,則為空白。DisplayData 只能是下列其中一項: |
||
phone_data |
只有在方法為 PHONE_CALL 或 SMS 時才需要設定。 |
|
address_data |
只有在方法為 導致 時,才需要設定。 |
|
email_data |
只有在方法為 EMAIL 時才會設定。 |
AddressVerificationData
透過明信片顯示驗證資料。
欄位 | |
---|---|
business_name |
商家的商家名稱。 |
address |
明信片的收件地址。 |
EmailVerificationData
顯示透過電子郵件進行驗證的資料。
欄位 | |
---|---|
domain_name |
電子郵件地址中的網域名稱,例如 foo@gmail.com 中的「gmail.com」 |
user_name |
電子郵件地址中的使用者名稱,例如 foo@gmail.com 中的「foo」 |
is_user_name_editable |
用戶端是否可提供其他使用者名稱。 |
PhoneVerificationData
顯示電話驗證資料 (例如通話和簡訊)。
欄位 | |
---|---|
phone_number |
要接收 PIN 碼的電話號碼。 |
VerifyLocationRequest
Verifications.VerifyLocation 的要求訊息。
欄位 | ||
---|---|---|
name |
要驗證位置的資源名稱。 |
|
method |
驗證方法。 |
|
language_code |
BCP 47 語言代碼,代表用於驗證程序的語言。 |
|
context |
服務商家驗證的額外背景資訊。對商家類型為「CUSTOMER_LOCATION_ONLY」的地點必填。如果是地址驗證,地址將用於寄送明信片。至於其他方法,則應與傳遞給 FetchVerificationOptions 的方法。如果為其他類型的商家所在地點設定 INVALID_VALUE,則系統會擲回該字串。 |
|
聯集欄位 RequestData 。除了顯示資料以外,特定方法的使用者輸入資料。資料必須符合要求的方法。如果不需要資料,請留空。RequestData 只能是下列其中一項: |
||
email_input |
EMAIL 方法的輸入內容。 |
|
address_input |
ADDRESS 方法的輸入內容。 |
|
phone_input |
PHONE_CALL/SMS 方法的輸入內容 |
VerifyLocationResponse
Verifications.VerifyLocation 的回應訊息。
欄位 | |
---|---|
verification |
已建立的驗證要求。 |