v1Resources/Connections/postList Google groups for a login

List Google groups for a login

Returns the Google Business Profile groups under one Google login, for the locations in this selection. Use it after the first preview call, which lists the logins in accounts, and send the resourceName of the group you pick as googleAccountName to preview and create. The login must be able to create for the client of every location in the selection that isn't excluded. If it can't, or the login doesn't exist, the response is 404. A login whose access has expired returns 409 until someone reconnects it. Groups are read live from Google, and 502 means Google didn't answer. Nothing is created or saved.

post/api/v1/connections/google-listing-create/destinations
connections:read
Request body
locationIdsarray of stringrequired
The ids of the locations to work on, up to 200. Duplicates are ignored.
accountConnectionIdstringrequired
The connectionId of the Google login to create under, from accounts in the preview response. Required for destinations and create. Optional for preview, where you send it with googleAccountName to check a destination.
Response
dataarray of objectoptional
resourceNamestringoptional
The group's Google resource name, such as accounts/123456789. Send this as googleAccountName.
displayNamestringoptional
The group's name in Google.
labelstringoptional
The name to show in a picker. When two groups share a name, the last characters of the id are added to tell them apart. Never send it as googleAccountName.
typestringoptional
Google's type for the group, such as PERSONAL or LOCATION_GROUP. ACCOUNT_TYPE_UNSPECIFIED when Google doesn't report one.
rolestringoptional
The login's role in the group, as Google reports it. Absent when Google doesn't report one.
verificationStatestringoptional
The group's verification state, as Google reports it. It doesn't decide whether you can create in the group.
creatablebooleanoptional
Whether new listings can be created in this group. Only PERSONAL and LOCATION_GROUP groups qualify, and not when the login's role is SITE_MANAGER.
reasonstring (type_not_supported | insufficient_role)optional
Why the group isn't creatable: type_not_supported (this type of group can't hold new listings) or insufficient_role (the login's role is too limited). Absent when creatable is true.
locationCountintegeroptional
About how many listings the group already holds, from Google's own count. Absent when it couldn't be read or when the group isn't a LOCATION_GROUP.
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
409The Google login's access has expired. Reconnect it, then try again. The response's code is needs_reconnection.
429Too many requests. Retry after the number of seconds in the Retry-After header.
502Google couldn't be reached to read the login's groups. Try again later. The response's code is provider_unavailable.
post/api/v1/connections/google-listing-create/destinations
Your API key
Request body*
{}

Guides that use this resource