batchGet(languageCode=None, names=None, regionCode=None, view=None, x__xgafv=None)

Returns a list of business categories for the provided language and GConcept ids.

Args:
languageCode: string, Required. The BCP 47 code of language that the category names should be returned in.
names: string, Required. At least one name must be set. The GConcept ids the localized category names should be returned for. To return details for more than one category, repeat this parameter in the request. (repeated)
regionCode: string, Optional. The ISO 3166-1 alpha-2 country code used to infer non-standard language.
view: string, Required. Specifies which parts to the Category resource should be returned in the response.
Allowed values
CATEGORY_VIEW_UNSPECIFIED - Not specified, equivalent to CATEGORY_METADATA_ONLY.
BASIC - The server response will only include Category fields display_name, category_id and language_code. It omits any service type metadata related fields.
FULL - Returns all the fields in the response.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response message for BusinessCategories.BatchGetBusinessCategories.
"categories": [ # Categories that match the GConcept ids provided in the request. They will not come in the same order as category ids in the request.
{ # A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see `categories.list`.
"displayName": "A String", # Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.
"moreHoursTypes": [ # Output only. More hours types that are available for this business category.
{ # More hours types that a business can offers, in addition to its regular hours.
"displayName": "A String", # Output only. The human-readable English display name for the hours type.
"hoursTypeId": "A String", # Output only. A stable ID provided by Google for this hours type.
"localizedDisplayName": "A String", # Output only. The human-readable localized display name for the hours type.
},
],
"name": "A String", # Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).
"serviceTypes": [ # Output only. A list of all the service types that are available for this business category.
{ # A message describing a service type that the business offers.
"displayName": "A String", # Output only. The human-readable display name for the service type.
"serviceTypeId": "A String", # Output only. A stable ID (provided by Google) for this service type.
},
],
},
],
}

close()

Close httplib2 connections.

list(filter=None, languageCode=None, pageSize=None, pageToken=None, regionCode=None, view=None, x__xgafv=None)

Returns a list of business categories. Search will match the category name but not the category ID. Search only matches the front of a category name (that is, 'food' may return 'Food Court' but not 'Fast Food Restaurant').

Args:
filter: string, Optional. Filter string from user. The only field that supported is `displayName`. Eg: `filter=displayName=foo`.
languageCode: string, Required. The BCP 47 code of language.
pageSize: integer, Optional. How many categories to fetch per page. Default is 100, minimum is 1, and maximum page size is 100.
pageToken: string, Optional. If specified, the next page of categories will be fetched.
regionCode: string, Required. The ISO 3166-1 alpha-2 country code.
view: string, Required. Specifies which parts to the Category resource should be returned in the response.
Allowed values
CATEGORY_VIEW_UNSPECIFIED - Not specified, equivalent to CATEGORY_METADATA_ONLY.
BASIC - The server response will only include Category fields display_name, category_id and language_code. It omits any service type metadata related fields.
FULL - Returns all the fields in the response.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response message for BusinessCategories.ListCategories.
"categories": [ # The matching categories based on the requested parameters.
{ # A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see `categories.list`.
"displayName": "A String", # Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.
"moreHoursTypes": [ # Output only. More hours types that are available for this business category.
{ # More hours types that a business can offers, in addition to its regular hours.
"displayName": "A String", # Output only. The human-readable English display name for the hours type.
"hoursTypeId": "A String", # Output only. A stable ID provided by Google for this hours type.
"localizedDisplayName": "A String", # Output only. The human-readable localized display name for the hours type.
},
],
"name": "A String", # Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).
"serviceTypes": [ # Output only. A list of all the service types that are available for this business category.
{ # A message describing a service type that the business offers.
"displayName": "A String", # Output only. The human-readable display name for the service type.
"serviceTypeId": "A String", # Output only. A stable ID (provided by Google) for this service type.
},
],
},
],
"nextPageToken": "A String", # If the number of categories exceeded the requested page size, this field will be populated with a token to fetch the next page of categories on a subsequent call to `ListCategories`.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

My Business Business Information API . categories

Instance Methods

Method Details