Google Business Profile Business Profile Mybusinessbusinessinformation Attributes API

openapi: 3.1.0
info:
  title: My Business Business Information API Attributes API
  version: v1
  description: Generated from Google's published Discovery document for My Business Business Information API (mybusinessbusinessinformation
    v1, revision 20261110). 1 operation(s).
  contact:
    name: Google
    url: https://developers.google.com/
  termsOfService: https://developers.google.com/terms
externalDocs:
  url: https://developers.google.com/my-business/
servers:
- url: https://mybusinessbusinessinformation.googleapis.com
paths:
  /v1/attributes:
    get:
      operationId: mybusinessbusinessinformation.attributes.list
      summary: List attributes
      description: Returns the list of attributes that would be available for a location with the given primary category and
        country.
      parameters:
      - name: categoryName
        in: query
        required: false
        description: Optional. The primary category stable ID to find available attributes. Must be of the format `categories/{category_id}`
          (e.g., `categories/gcid:restaurant`). Required if `parent` is not set and `show_all` is false.
        schema:
          type: string
      - name: languageCode
        in: query
        required: false
        description: Optional. The BCP 47 code of language to get attribute display names in. If this language is not available,
          they will be provided in English.
        schema:
          type: string
      - name: pageSize
        in: query
        required: false
        description: How many attributes to include per page. Default is 200, minimum is 1.
        schema:
          type: integer
          format: int32
      - name: pageToken
        in: query
        required: false
        description: If specified, the next page of attribute metadata is retrieved.
        schema:
          type: string
      - name: parent
        in: query
        required: false
        description: 'Optional. 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. Format: `locations/{location_id}`
          (e.g., `locations/1234567890`).'
        schema:
          type: string
      - name: regionCode
        in: query
        required: false
        description: Optional. The ISO 3166-1 alpha-2 country code to find available attributes. Required if `parent` is not
          set.
        schema:
          type: string
      - name: showAll
        in: query
        required: false
        description: Optional. If set to true, metadata for all available attributes are returned, disregarding `parent` and
          `category_name` fields. `language_code` and `region_code` are required when `show_all` is set to true.
        schema:
          type: boolean
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAttributeMetadataResponse'
        4XX:
          content: &id001
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content: *id001
          description: Error response (google.rpc.Status)
      security:
      - apiKey: []
      tags:
      - Attributes
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: query
      name: key
      description: API key; accepted by methods that do not need user data.
  schemas:
    AttributeMetadata:
      properties:
        valueMetadata:
          type: array
          items:
            $ref: '#/components/schemas/AttributeValueMetadata'
          description: For some types of attributes (for example, enums), a list of supported values and corresponding display
            names for those values is provided.
        groupDisplayName:
          type: string
          description: 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.
        valueType:
          enum:
          - ATTRIBUTE_VALUE_TYPE_UNSPECIFIED
          - BOOL
          - ENUM
          - URL
          - REPEATED_ENUM
          description: The value type for the attribute. Values set and retrieved should be expected to be of this type.
          type: string
        displayName:
          description: The localized display name for the attribute, if available; otherwise, the English display name.
          type: string
        parent:
          type: string
          description: The unique identifier for the attribute.
        deprecated:
          type: boolean
          description: 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.
        repeatable:
          description: If true, the attribute supports multiple values. If false, only a single value should be provided.
          type: boolean
      type: object
      description: Metadata for an attribute. Contains display information for the attribute, including a localized name and
        a heading for grouping related attributes together.
    AttributeValueMetadata:
      properties:
        displayName:
          type: string
          description: 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:
          description: The attribute value.
      description: Metadata for supported attribute values.
      type: object
    GoogleRpcError:
      type: object
      description: The error envelope every Google API returns.
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
            status:
              type: string
            details:
              type: array
              items:
                type: object
    ListAttributeMetadataResponse:
      type: object
      description: Response for AttributesService.ListAttributeMetadata.
      properties:
        attributeMetadata:
          description: A collection of attribute metadata for the available attributes.
          items:
            $ref: '#/components/schemas/AttributeMetadata'
          type: array
        nextPageToken:
          description: 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.
          type: string
x-provenance:
  method: harvested
  publisher: Google
  source: https://mybusinessbusinessinformation.googleapis.com/$discovery/rest?version=v1
  note: converted by discovery-to-openapi.py from Google's Discovery document (revision 20261110)