Method: attributes.list

Returns the list of attributes that would be available for a location with the given primary category and country.

HTTP request

GET https://mybusinessbusinessinformation.googleapis.com/v1/attributes

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
parent

string

Resource name of the location to look up available attributes. If this field is set, categoryName, regionCode, languageCode and showAll are not required and must not be set.

categoryName

string

The primary category stable ID to find available attributes. Must be of the format categories/{category_id}.

regionCode

string

The ISO 3166-1 alpha-2 country code to find available attributes.

languageCode

string

The BCP 47 code of language to get attribute display names in. If this language is not available, they will be provided in English.

showAll

boolean

Metadata for all available attributes are returned when this field is set to true, disregarding parent and categoryName fields. languageCode and regionCode are required when showAll is set to true.

pageSize

integer

How many attributes to include per page. Default is 200, minimum is 1.

pageToken

string

If specified, the next page of attribute metadata is retrieved.

Request body

The request body must be empty.

Response body

Response for AttributesService.ListAttributeMetadata.

If successful, the response body contains data with the following structure:

JSON representation
 { 
 "attributeMetadata" 
 : 
 [ 
 { 
 object (  AttributeMetadata 
 
) 
 } 
 ] 
 , 
 "nextPageToken" 
 : 
 string 
 } 
Fields
nextPageToken

string

If the number of attributes exceeded the requested page size, this field will be populated with a token to fetch the next page of attributes on a subsequent call to attributes.list . If there are no more attributes, this field will not be present in the response.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/business.manage

For more information, see the OAuth 2.0 Overview .

Create a Mobile Website
View Site in Mobile | Classic
Share by: