My Business Business Information API . attributes

close()

Close httplib2 connections.

list(categoryName=None, languageCode=None, pageSize=None, pageToken=None, parent=None, regionCode=None, showAll=None, x__xgafv=None)

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

Args:
  categoryName: string, The primary category stable ID to find available attributes. Must be of the format categories/{category_id}.
  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.
  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.
  parent: string, Resource name of the location to look up available attributes. If this field is set, category_name, region_code, language_code and show_all are not required and must not be set.
  regionCode: string, The ISO 3166-1 alpha-2 country code to find available attributes.
  showAll: boolean, Metadata for all available attributes are returned when this field is set to true, disregarding parent and category_name fields. language_code and region_code are required when show_all is set to true.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for AttributesService.ListAttributeMetadata.
  "attributeMetadata": [ # A collection of attribute metadata for the available attributes.
    { # Metadata for an attribute. Contains display information for the attribute, including a localized name and a heading for grouping related attributes together.
      "deprecated": True or False, # If true, the attribute is deprecated and should no longer be used. If deprecated, updating this attribute will not result in an error, but updates will not be saved. At some point after being deprecated, the attribute will be removed entirely and it will become an error.
      "displayName": "A String", # The localized display name for the attribute, if available; otherwise, the English display name.
      "groupDisplayName": "A String", # The localized display name of the group that contains this attribute, if available; otherwise, the English group name. Related attributes are collected into a group and should be displayed together under the heading given here.
      "parent": "A String", # The unique identifier for the attribute.
      "repeatable": True or False, # If true, the attribute supports multiple values. If false, only a single value should be provided.
      "valueMetadata": [ # For some types of attributes (for example, enums), a list of supported values and corresponding display names for those values is provided.
        { # Metadata for supported attribute values.
          "displayName": "A String", # The display name for this value, localized where available; otherwise, in English. The value display name is intended to be used in context with the attribute display name. For example, for a "WiFi" enum attribute, this could contain "Paid" to represent paid Wi-Fi.
          "value": "", # The attribute value.
        },
      ],
      "valueType": "A String", # The value type for the attribute. Values set and retrieved should be expected to be of this type.
    },
  ],
  "nextPageToken": "A 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.
}

list_next(previous_request, previous_response)

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.