v0.1.0-beta

OpenAPI 3.1.0

Setting Live Google My Business Info Tasks

Felo API Support

MIT

Server

https://openapi.felo.ai

Client Libraries

Shell Curl

DataForSEO

SEO, search-engine results, keyword research, backlinks and AI visibility data.

DataForSEO Operations

post/v1/beta/dataforseo/business_data/google/my_business_info/live

Setting Live Google My Business Info Tasks

One Google Business Profile: name, address, phone, hours, rating, category and the attributes Google shows on the panel. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. The queued twin is post_dataforseo_business_google_gmb_info_submit. For what the owner has posted recently use post_dataforseo_business_google_gmb_updates_submit, and for customer opinion post_dataforseo_business_google_reviews_submit.

Body

required

application/json

Type: array object[]
- Type: object
  keyword
  Type: string
  required
  
  keyword required field the keyword you specify should indicate the name of the local establishment you can specify up to 700 characters in the keyword filed all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”; this field can also be used to pass the following parameters: cid – a unique, google-defined id of the business entity; place_id – an identifier of the business entity in Google Maps; spp – a unique identifier of local services featured in the local_pack element of Google SERP example: cid:194604053573767737 place_id:GhIJQWDl0CIeQUARxks3icF8U8A spp:CgsvZy8xdGN4cWRraBoUChIJPZDrEzLsZIgRoNrpodC5P30 learn more about the cid and place_id identifiers in this help center article learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
  
  language_code
  Type: string
  
  search engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages example: en
  
  language_name
  Type: string
  
  full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages example: English
  
  location_code
  Type: integer
  
  search engine location code required field if you don’t specify location_name or location_coordinate if you use this field, you don’t need to specify location_name or location_coordinate you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations example: 2840
  
  location_coordinate
  Type: string
  
  GPS coordinates of a location required field if you don’t specify location_name or location_code if you use this field, you don’t need to specify location_name or location_code location_coordinate parameter should be specified in the “latitude,longitude,radius” format the maximum number of decimal digits for “latitude” and “longitude”: 7 the minimum value for “radius”: 199.9 (mm) the maximum value for “radius”: 199999 (mm) example: 53.476225,-2.243572,200
  
  location_name
  Type: string
  
  full name of search engine location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you can receive the list of available locations with location_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/locations example: London,England,United Kingdom
  
  tag
  Type: string
  
  user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response
  
  Empty object
  Empty object

Responses

200
Type: object

Successful response
directory
Type: array string[]

items of the directory includes information about businesses that are located within the target business establishment and have the same address

directory.1
Type: integer

the number of 1-star ratings

directory.2
Type: integer

the number of 2-star ratings

directory.3
Type: integer

the number of 3-star ratings

directory.4
Type: integer

the number of 4-star ratings

directory.5
Type: integer

the number of 5-star ratings

directory.address
Type: string

street address of the business entity

directory.address_info
Type: object

object containing address components of the business entity

directory.borough
Type: string

administrative unit or district the business entity location belongs to

directory.category
Type: string

business category Google My Business general category that best describes the services provided by the business entity

directory.category_ids
Type: array string[]

global category IDs universal category IDs that do not change based on the selected country

directory.cid
Type: string

google-defined client id unique id of a local establishment; can be used with Google Reviews API to get a full list of reviews learn more about the identifier in this help center article

directory.city
Type: string

name of the city where the business entity is located

directory.country_code
Type: string

ISO country code of the business entity location

directory.domain
Type: string

domain of the business entity

directory.feature_id
Type: string

the unique identifier of the element in SERP learn more about the identifier in this help center article

directory.hotel_rating
Type: integer

hotel class rating class ratings range between 1-5 stars, learn more if there is no hotel class rating information, the value will be null

directory.is_claimed
Type: boolean

shows whether the entity is verified by its owner on Google Maps

directory.is_directory_item
Type: boolean

business establishment is a part of the directory indicates whether the business establishment is a part of the directory; if true, the item is a part of the larger directory of businesses with the same address (e.g., a mall or a business centre); note: if the business establishment is a parent item in the directory, the value will be null

directory.items
Type: array string[]

array of directory items

directory.latitude
Type: number

latitude coordinate of the local establishments in google maps example: "latitude": 51.584091

directory.local_justifications
Type: array string[]

Google local justifications snippets of text that “justify” why the business is showing up for search query

directory.longitude
Type: number

longitude coordinate of the local establishment in google maps example: "longitude": -0.31365919999999997

directory.main_image
Type: string

URL of the main image featured in Google My Business profile

directory.phone
Type: string

phone number of the business entity

directory.place_id
Type: string

unique place identifier place id of the local establishment featured in the element learn more about the identifier in this help center article

directory.price_level
Type: string

property price level can take values: inexpensive, moderate, expensive, very_expensive if there is no price level information, the value will be null

directory.rank_absolute
Type: integer

absolute rank among all the elements

directory.rank_group
Type: integer

position within a group of elements with identical type values positions of elements with different type values are omitted from the rank_group

directory.rating
Type: object

the element’s rating the popularity rate based on reviews and displayed in SERP

directory.rating_distribution
Type: object

the distribution of ratings of the business entity the object displays the number of 1-star to 5-star ratings, as reviewed by users

directory.rating_max
Type: integer

the maximum value for a rating_type

directory.rating_type
Type: string

the type of rating here you can find the following elements: Max5, Percents, CustomMax

directory.region
Type: string

DMA region of the business entity location

directory.snippet
Type: string

additional information about the business entity

directory.title
Type: string

title of the element in SERP the name of the business entity

directory.total_photos
Type: integer

total count of images featured in Google My Business profile

directory.type
Type: string

type of element = ‘maps_search’

directory.url
Type: string

absolute url of the business entity

directory.value
Type: integer

the value of the rating

directory.votes_count
Type: integer

the amount of feedback

directory.work_hours
Type: object

work hours information about work hours of the local establishment

directory.zip
Type: string

ZIP code of the business entity

items
Type: array string[]

encountered item types types of search engine results encountered in the items array; possible item types: google_business_info

items.1
Type: integer

the number of 1-star ratings

items.2
Type: integer

the number of 2-star ratings

items.3
Type: integer

the number of 3-star ratings

items.4
Type: integer

the number of 4-star ratings

items.5
Type: integer

the number of 5-star ratings

items.additional_categories
Type: array string[]

additional business categories additional Google My Business categories that describe the services provided by the business entity in more detail

items.address
Type: string

street address of the business entity

items.address_info
Type: object

object containing address components of the business entity

items.attributes
Type: object

service details in a form of user-reviewed checks; service details of a business entity displayed in a form of checks and based on user feedback and business category

items.available_attributes
Type: object

available attributes indicates attributes a business entity can offer

items.book_online_url
Type: string

URL in the ‘book online’ button of the element URL directing users to the online booking or order page of the business entity

items.borough
Type: string

administrative unit or district the business entity location belongs to

items.category
Type: string

business category Google My Business general category that best describes the services provided by the business entity

items.category_ids
Type: array string[]

global category IDs universal category IDs that do not change based on the selected country

items.cid
Type: string

google-defined client id unique id of a local establishment learn more about the identifier in this help center article

items.city
Type: string

name of the city where the business entity is located

items.close
Type: object

closing time

items.contact_url
Type: string

URL of the preferred contact page

items.contributor_url
Type: string

URL of the user’s or entity’s Local Guides profile, if available

items.country_code
Type: string

ISO country code of the business entity location

items.current_status
Type: string

current status of the establishment possible values: opened, closed, temporarily_closed, closed_forever

items.description
Type: string

description of the element in SERP the description of the business entity for which the results are collected

items.domain
Type: string

domain of the business entity

items.feature_id
Type: string

the unique identifier of the element in SERP learn more about the identifier in this help center article

items.friday
Type: array string[]

work hours on Fridays

items.hour
Type: integer

hours in the 24-hour format

items.is_claimed
Type: boolean

shows whether the entity is verified by its owner on Google Maps

items.latitude
Type: number

latitude coordinate of the local establishments in google maps example: "latitude": 51.584091

items.logo
Type: string

URL of the logo featured in Google My Business profile

items.longitude
Type: number

longitude coordinate of the local establishment in google maps example: "longitude": -0.31365919999999997

items.main_image
Type: string

URL of the main image featured in Google My Business profile

items.minute
Type: integer

minutes

items.monday
Type: array string[]

work hours on Mondays

items.open
Type: object

opening time

items.original_title
Type: string

original title of the element original title not translated by Google

items.people_also_search
Type: array string[]

related business entities

items.phone
Type: string

phone number of the business entity

items.place_id
Type: string

unique place identifier place id of the local establishment featured in the element learn more about the identifier in this help center article

items.place_topics
Type: object

keywords mentioned in customer reviews contains most popular keywords related to products/services mentioned in customer reviews of a business entity and the number of reviews mentioning each keyword example: "place_topics": {"egg roll": 48,"birthday": 33}

items.position
Type: string

the alignment in SERP

items.rank_absolute
Type: integer

absolute rank among all the elements

items.rank_group
Type: integer

position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group

items.rating
Type: object

the element’s rating the popularity rate based on reviews and displayed in SERP

items.rating_distribution
Type: object

the distribution of ratings of the business entity the object displays the number of 1-star to 5-star ratings, as reviewed by users

items.rating_max
Type: integer

the maximum value for a rating_type

items.rating_type
Type: string

the type of rating here you can find the following elements: Max5, Percents, CustomMax

items.region
Type: string

DMA region of the business entity location

items.saturday
Type: array string[]

work hours on Saturday

items.snippet
Type: string

additional information on the business entity

items.sunday
Type: array string[]

work hours on Sundays

items.thursday
Type: array string[]

work hours on Thursdays

items.timetable
Type: object

work hours timetable

items.title
Type: string

title of the element in SERP the name of the business entity for which the results are collected

items.total_photos
Type: integer

total count of images featured in Google My Business profile

items.tuesday
Type: array string[]

work hours on Tuesdays

items.type
Type: string

type of element = ‘google_business_info’

items.unavailable_attributes
Type: object

unavailable attributes indicates attributes a business entity cannot offer

items.url
Type: string

absolute url of the business entity

items.value
Type: integer

the value of the rating

items.votes_count
Type: integer

the amount of feedback

items.wednesday
Type: array string[]

work hours on Wednesdays

items.work_hours
Type: object

open hours information about work hours of the local establishment

items.work_time
Type: object

work time details information related to operational hours of the business entity

items.zip
Type: string

ZIP code of the business entity

local_business_links
Type: array string[]

available interactions with the business list of options to interact with the business directly from search results

local_business_links.delivery_services
Type: array string[]

lists available delivery services

local_business_links.is_directory_item
Type: boolean

business establishment is a part of the directory indicates whether the business establishment is a part of the directory; if true, the item is a part of the larger directory of businesses with the same address (e.g., a mall or a business centre); note: if the business establishment is a parent item in the directory, the value will be null

local_business_links.title
Type: string

title of the element domain of the online menu system

local_business_links.type
Type: string

type of element = ‘menu’

local_business_links.url
Type: string

URL to view the menu

popular_times
Type: object

popular times information related to busy hours of the business entity

popular_times.hour
Type: integer

hours in a 24-hour format

popular_times.minute
Type: integer

minutes

popular_times.popular_index
Type: integer

popularity index relative time-bound popularity index measured from 0 to 100; higher value corresponds to a busier time of a day

popular_times.popular_times_by_days
Type: object

popular hours information about busy hours of the local establishment on each day of the week

popular_times.sunday
Type: array string[]

busy hours on sunday can take values of the corresponding days of the week

popular_times.time
Type: object

busy hours

result
Type: array string[]

array of results

result.check_url
Type: string

direct URL to search engine results you can use it to make sure that we provided accurate results

result.datetime
Type: string

date and time when the result was received in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00

result.item_types
Type: array string[]

item types types of search engine results encountered in the items array; possible item types: google_business_info

result.items_count
Type: integer

item types the number of items in the items array

result.keyword
Type: string

keyword received in a POST array keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) this field will contain the cid parameter if you specified it in the keyword field when setting a task; example: cid:2946633002421908862 learn more about the parameter in this help center article

result.language_code
Type: string

language code in a POST array

result.location_code
Type: integer

location code in a POST array

result.se_domain
Type: string

search engine domain as specified in a POST array

tasks
Type: array string[]

array of tasks

tasks.cost
Type: number

cost of the task, USD

tasks.data
Type: object

contains the same parameters that you specified in the POST request

tasks.id
Type: string

task identifier unique task identifier in our system in the UUID format

tasks.path
Type: array string[]

URL path

tasks.result_count
Type: integer

number of elements in the result array

tasks.status_code
Type: integer

status code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of the response codes here

tasks.status_message
Type: string

informational message of the task you can find the full list of general informational messages here

tasks.time
Type: string

execution time, seconds

version
Type: string

the current version of the API

version.cost
Type: number

total tasks cost, USD

version.status_code
Type: integer

general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions

version.status_message
Type: string

general informational message you can find the full list of general informational messages here

version.tasks_count
Type: integer

the number of tasks in the tasks array

version.tasks_error
Type: integer

the number of tasks in the tasks array that were returned an error

version.time
Type: string

execution time, seconds
application/json
400

Bad request
401

Unauthorized
402

The request cannot proceed because a billing requirement is not met.
403

The account is not permitted to perform this operation.
429

Rate limit exceeded
500

Internal server error
502

The service could not complete the request.
503

The API or billing service is temporarily unavailable.
504

The service timed out while processing the request.
default

The operation failed. Keep the response request ID when contacting Felo support.

post/v1/beta/dataforseo/business_data/google/my_business_info/live

curl https://openapi.felo.ai/v1/beta/dataforseo/business_data/google/my_business_info/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {},
  {}
]'

Show Schema

{
  "version": "string",
  "version.status_code": 1,
  "version.status_message": "string",
  "version.time": "string",
  "version.cost": 1,
  "version.tasks_count": 1,
  "version.tasks_error": 1,
  "tasks": [
    "string"
  ],
  "tasks.id": "string",
  "tasks.status_code": 1,
  "tasks.status_message": "string",
  "tasks.time": "string",
  "tasks.cost": 1,
  "tasks.result_count": 1,
  "tasks.path": [
    "string"
  ],
  "tasks.data": {},
  "result": [
    "string"
  ],
  "result.keyword": "string",
  "result.se_domain": "string",
  "result.location_code": 1,
  "result.language_code": "string",
  "result.check_url": "string",
  "result.datetime": "string",
  "result.item_types": [
    "string"
  ],
  "result.items_count": 1,
  "items": [
    "string"
  ],
  "items.type": "string",
  "items.rank_group": 1,
  "items.rank_absolute": 1,
  "items.position": "string",
  "items.title": "string",
  "items.original_title": "string",
  "items.description": "string",
  "items.category": "string",
  "items.category_ids": [
    "string"
  ],
  "items.additional_categories": [
    "string"
  ],
  "items.cid": "string",
  "items.feature_id": "string",
  "items.address": "string",
  "items.address_info": {},
  "items.borough": "string",
  "items.city": "string",
  "items.zip": "string",
  "items.region": "string",
  "items.country_code": "string",
  "items.place_id": "string",
  "items.phone": "string",
  "items.url": "string",
  "items.contact_url": "string",
  "items.contributor_url": "string",
  "items.book_online_url": "string",
  "items.domain": "string",
  "items.logo": "string",
  "items.main_image": "string",
  "items.total_photos": 1,
  "items.snippet": "string",
  "items.latitude": 1,
  "items.longitude": 1,
  "items.is_claimed": true,
  "items.attributes": {},
  "items.available_attributes": {},
  "items.unavailable_attributes": {},
  "items.place_topics": {},
  "items.rating": {},
  "items.rating_type": "string",
  "items.value": 1,
  "items.votes_count": 1,
  "items.rating_max": 1,
  "items.rating_distribution": {},
  "items.1": 1,
  "items.2": 1,
  "items.3": 1,
  "items.4": 1,
  "items.5": 1,
  "items.people_also_search": [
    "string"
  ],
  "items.work_time": {},
  "items.work_hours": {},
  "items.timetable": {},
  "items.sunday": [
    "string"
  ],
  "items.open": {},
  "items.hour": 1,
  "items.minute": 1,
  "items.close": {},
  "items.monday": [
    "string"
  ],
  "items.tuesday": [
    "string"
  ],
  "items.wednesday": [
    "string"
  ],
  "items.thursday": [
    "string"
  ],
  "items.friday": [
    "string"
  ],
  "items.saturday": [
    "string"
  ],
  "items.current_status": "string",
  "popular_times": {},
  "popular_times.popular_times_by_days": {},
  "popular_times.sunday": [
    "string"
  ],
  "popular_times.time": {},
  "popular_times.hour": 1,
  "popular_times.minute": 1,
  "popular_times.popular_index": 1,
  "local_business_links": [
    "string"
  ],
  "local_business_links.type": "string",
  "local_business_links.title": "string",
  "local_business_links.url": "string",
  "local_business_links.delivery_services": [
    "string"
  ],
  "local_business_links.is_directory_item": true,
  "directory": [
    "string"
  ],
  "directory.title": "string",
  "directory.items": [
    "string"
  ],
  "directory.type": "string",
  "directory.rank_group": 1,
  "directory.rank_absolute": 1,
  "directory.domain": "string",
  "directory.url": "string",
  "directory.rating": {},
  "directory.rating_type": "string",
  "directory.value": 1,
  "directory.votes_count": 1,
  "directory.rating_max": 1,
  "directory.rating_distribution": {},
  "directory.1": 1,
  "directory.2": 1,
  "directory.3": 1,
  "directory.4": 1,
  "directory.5": 1,
  "directory.snippet": "string",
  "directory.address": "string",
  "directory.address_info": {},
  "directory.borough": "string",
  "directory.city": "string",
  "directory.zip": "string",
  "directory.region": "string",
  "directory.country_code": "string",
  "directory.place_id": "string",
  "directory.phone": "string",
  "directory.main_image": "string",
  "directory.total_photos": 1,
  "directory.category": "string",
  "directory.category_ids": [
    "string"
  ],
  "directory.work_hours": {},
  "directory.feature_id": "string",
  "directory.cid": "string",
  "directory.latitude": 1,
  "directory.longitude": 1,
  "directory.is_claimed": true,
  "directory.local_justifications": [
    "string"
  ],
  "directory.is_directory_item": true,
  "directory.price_level": "string",
  "directory.hotel_rating": 1
}

Successful response

Setting Live Google My Business Info Tasks

AuthenticationRequired

DataForSEO

Setting Live Google My Business Info Tasks