Google Business · Google Business Attributes

Get attribute metadata

Fetches attribute metadata.

GEThttps://api.pozy.ai/v1/accounts/{accountId}/gmb-attribute-metadata
getGmbAttributeMetadata

Guide: Location details

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the accounts resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

NameTypeNotes
accountIdrequiredstring

Query parameters

NameTypeNotes
locationIdstring
categoryNamestring
regionCodestring
languageCodestring
pageSizeinteger1 to 200
pageTokenstring

Example

curl -X GET "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/gmb-attribute-metadata" \
  -H "Authorization: Bearer $POZY_API_KEY"

Response

200 on success

  • successboolean
  • accountIdstring
  • locationIdstring
  • attributeMetadataarray of object
    7 child fields
    • parentstring
    • valueTypestring
    • displayNamestring
    • groupDisplayNamestring
    • repeatableboolean
    • deprecatedboolean
    • valueMetadataarray of object
      2 child fields
      • valuestring
      • displayNamestring
  • nextPageTokenstring
200 response
{
  "success": true,
  "accountId": "696e0b682d0a31188e7a2ba9",
  "locationId": "6e99c3dd69982b334a43b0b2",
  "attributeMetadata": [
    {
      "parent": "string",
      "valueType": "string",
      "displayName": "Acme",
      "groupDisplayName": "Acme",
      "repeatable": true,
      "deprecated": true,
      "valueMetadata": [
        {
          "value": "string",
          "displayName": "Acme"
        }
      ]
    }
  ],
  "nextPageToken": "string"
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is scoped to other profiles or has this resource group disabled.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Google Business Attributes