Google Business Performance API has a
NEW API method that allows fetching multiple `DailyMetrics` in a single API request. Review the
deprecation schedule and instructions to migrate over from v4 reportInsights API method to Google Business Profile Performance API.
ServiceList
Stay organized with collections
Save and categorize content based on your preferences.
A service list containing one or more service items.
| JSON representation |
{
"name": string,
"serviceItems": [
{
object (ServiceItem)
}
]
} |
| Fields |
name |
string
Required. Google identifier for this location in the form: accounts/{accountId}/locations/{locationId}/serviceList
|
serviceItems[] |
object (ServiceItem)
Service items that are contained within this service list. Duplicated service items will be removed automatically.
|
ServiceItem
A message that describes a single service item. It is used to describe the type of service that the merchant provides. For example, haircut can be a service.
| JSON representation |
{
"isOffered": boolean,
"price": {
object (Money)
},
// Union field service_item_info can be only one of the following:
"structuredServiceItem": {
object (StructuredServiceItem)
},
"freeFormServiceItem": {
object (FreeFormServiceItem)
}
// End of list of possible types for union field service_item_info.
} |
| Fields |
isOffered |
boolean
Optional. This field decides whether or not the input service is offered by the merchant.
|
price |
object (Money)
Optional. Represents the monetary price of the service item. We recommend that currencyCode and units should be set when including a price.
|
Union field service_item_info. One of the following fields should always be set. service_item_info can be only one of the following: |
structuredServiceItem |
object (StructuredServiceItem)
This field will be set case of structured services data.
|
freeFormServiceItem |
object (FreeFormServiceItem)
This field will be set case of free-form services data.
|
StructuredServiceItem
Represents a structured service offered by the merchant. For eg: toilet_installation.
| JSON representation |
{
"serviceTypeId": string,
"description": string
} |
| Fields |
serviceTypeId |
string
Required. The serviceTypeId field is a Google provided unique ID that can be found in ServiceTypeMetadata. This information is provided by categories.batchGet rpc service.
|
description |
string
Optional. Description of structured service item. The character limit is 300.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eA service list allows businesses to display the services they offer, containing one or more service items with details like price and availability.\u003c/p\u003e\n"],["\u003cp\u003eService items can be structured, using predefined service types, or free-form, allowing custom service descriptions.\u003c/p\u003e\n"],["\u003cp\u003eStructured service items utilize a \u003ccode\u003eserviceTypeId\u003c/code\u003e for categorization, while free-form items rely on a \u003ccode\u003ecategoryId\u003c/code\u003e and custom labels.\u003c/p\u003e\n"],["\u003cp\u003eEach service item can include a price and indicate whether it's currently offered by the business.\u003c/p\u003e\n"],["\u003cp\u003eService lists are identified by a unique Google identifier associated with a specific location.\u003c/p\u003e\n"]]],["The content defines a service list, which contains multiple service items. Each service item can be structured or free-form, and includes details like whether it's offered (`isOffered`) and its price. Structured items have a `serviceTypeId` and optional description, while free-form items require a `categoryId` and a `label`. Service list `name` is a Google identifier and it has an array of `serviceItems`. `service_item_info` must include one type of service `structuredServiceItem` or `freeFormServiceItem`.\n"],null,["# ServiceList\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [ServiceItem](#ServiceItem)\n - [JSON representation](#ServiceItem.SCHEMA_REPRESENTATION)\n- [StructuredServiceItem](#StructuredServiceItem)\n - [JSON representation](#StructuredServiceItem.SCHEMA_REPRESENTATION)\n- [FreeFormServiceItem](#FreeFormServiceItem)\n - [JSON representation](#FreeFormServiceItem.SCHEMA_REPRESENTATION)\n\nA service list containing one or more service items.\n\n| JSON representation ||\n|---------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"name\": string, \"serviceItems\": [ { object (/my-business/reference/rest/v4/ServiceList#ServiceItem) } ] } ``` |\n\n| Fields ||\n|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. Google identifier for this location in the form: `accounts/{accountId}/locations/{locationId}/serviceList` |\n| `serviceItems[]` | `object (`[ServiceItem](/my-business/reference/rest/v4/ServiceList#ServiceItem)`)` Service items that are contained within this service list. Duplicated service items will be removed automatically. |\n\nServiceItem\n-----------\n\nA message that describes a single service item. It is used to describe the type of service that the merchant provides. For example, haircut can be a service.\n\n| JSON representation ||\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"isOffered\": boolean, \"price\": { object (/my-business/reference/rest/v4/accounts.locations#Location.Money) }, // Union field `service_item_info` can be only one of the following: \"structuredServiceItem\": { object (/my-business/reference/rest/v4/ServiceList#StructuredServiceItem) }, \"freeFormServiceItem\": { object (/my-business/reference/rest/v4/ServiceList#FreeFormServiceItem) } // End of list of possible types for union field `service_item_info`. } ``` |\n\n| Fields ||\n|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| `isOffered` | `boolean` Optional. This field decides whether or not the input service is offered by the merchant. |\n| `price` | `object (`[Money](/my-business/reference/rest/v4/accounts.locations#Location.Money)`)` Optional. Represents the monetary price of the service item. We recommend that currencyCode and units should be set when including a price. |\n| Union field `service_item_info`. One of the following fields should always be set. `service_item_info` can be only one of the following: |||\n| `structuredServiceItem` | `object (`[StructuredServiceItem](/my-business/reference/rest/v4/ServiceList#StructuredServiceItem)`)` This field will be set case of structured services data. |\n| `freeFormServiceItem` | `object (`[FreeFormServiceItem](/my-business/reference/rest/v4/ServiceList#FreeFormServiceItem)`)` This field will be set case of free-form services data. |\n\nStructuredServiceItem\n---------------------\n\nRepresents a structured service offered by the merchant. For eg: toilet_installation.\n\n| JSON representation ||\n|------------------------------------------------------------|---|\n| ``` { \"serviceTypeId\": string, \"description\": string } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `serviceTypeId` | `string` Required. The `serviceTypeId` field is a Google provided unique ID that can be found in `ServiceTypeMetadata`. This information is provided by categories.batchGet rpc service. |\n| `description` | `string` Optional. Description of structured service item. The character limit is 300. |\n\nFreeFormServiceItem\n-------------------\n\nRepresents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for of such services via a geomerchant surface.\n\n| JSON representation ||\n|--------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"categoryId\": string, \"label\": { object (/my-business/reference/rest/v4/accounts.locations#Location.Label) } } ``` |\n\n| Fields ||\n|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `categoryId` | `string` Required. The `categoryId` and `serviceTypeId` should match the possible combinations provided in the `Category` message. |\n| `label` | `object (`[Label](/my-business/reference/rest/v4/accounts.locations#Location.Label)`)` Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated via serviceTypeId. |"]]