Felo API PlatformFelo API Platform

Data API / DataForSEO / Business Data

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.

Parameters

No path, query, or header parameters.

Request body

  • keywordstringRequired

    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

  • location_namestringOptional

    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

  • location_codeintegerOptional

    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_coordinatestringOptional

    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

  • language_namestringOptional

    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

  • language_codestringOptional

    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

  • tagstringOptional

    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

Example request

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/business_data/google/my_business_info/live" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "keyword": "<string>",
  "location_name": "<string>",
  "location_code": 0,
  "location_coordinate": "<string>",
  "language_name": "<string>",
  "language_code": "<string>",
  "tag": "<string>"
}'

Response

Response fields

  • versionstringOptional

    the current version of the API

  • status_codeintegerOptional

    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

  • status_messagestringOptional

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

  • timestringOptional

    execution time, seconds

  • costnumberOptional

    *total tasks cost, USD*

  • tasks_countintegerOptional

    *the number of tasks in the tasks array*

  • tasks_errorintegerOptional

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

  • tasksstring[]Optional

    array of tasks

  • idstringOptional

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

  • status_codeintegerOptional

    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

  • status_messagestringOptional

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

  • timestringOptional

    execution time, seconds

  • costnumberOptional

    cost of the task, USD

  • result_countintegerOptional

    number of elements in the result array

  • pathstring[]Optional

    URL path

  • dataobjectOptional

    contains the same parameters that you specified in the POST request

  • resultstring[]Optional

    array of results

  • keywordstringOptional

    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

  • se_domainstringOptional

    search engine domain as specified in a POST array

  • location_codeintegerOptional

    location code in a POST array

  • language_codestringOptional

    language code in a POST array

  • check_urlstringOptional

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

  • datetimestringOptional

    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

  • item_typesstring[]Optional

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

  • items_countintegerOptional

    item types the number of items in the items array

  • itemsstring[]Optional

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

  • typestringOptional

    *type of element = ‘google\_business\_info’*

  • rank_groupintegerOptional

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

  • rank_absoluteintegerOptional

    absolute rank among all the elements

  • positionstringOptional

    the alignment in SERP

  • titlestringOptional

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

  • original_titlestringOptional

    original title of the element original title not translated by Google

  • descriptionstringOptional

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

  • categorystringOptional

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

  • category_idsstring[]Optional

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

  • additional_categoriesstring[]Optional

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

  • cidstringOptional

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

  • feature_idstringOptional

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

  • addressstringOptional

    street address of the business entity

  • address_infoobjectOptional

    object containing address components of the business entity

  • boroughstringOptional

    administrative unit or district the business entity location belongs to

  • citystringOptional

    name of the city where the business entity is located

  • zipstringOptional

    ZIP code of the business entity

  • regionstringOptional

    DMA region of the business entity location

  • country_codestringOptional

    ISO country code of the business entity location

  • place_idstringOptional

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

  • phonestringOptional

    phone number of the business entity

  • urlstringOptional

    absolute url of the business entity

  • contact_urlstringOptional

    URL of the preferred contact page

  • contributor_urlstringOptional

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

  • book_online_urlstringOptional

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

  • domainstringOptional

    domain of the business entity

  • logostringOptional

    URL of the logo featured in Google My Business profile

  • main_imagestringOptional

    URL of the main image featured in Google My Business profile

  • total_photosintegerOptional

    total count of images featured in Google My Business profile

  • snippetstringOptional

    additional information on the business entity

  • latitudenumberOptional

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

  • longitudenumberOptional

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

  • is_claimedbooleanOptional

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

  • attributesobjectOptional

    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

  • available_attributesobjectOptional

    available attributes indicates attributes a business entity can offer

  • unavailable_attributesobjectOptional

    unavailable attributes indicates attributes a business entity cannot offer

  • place_topicsobjectOptional

    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}

  • ratingobjectOptional

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

  • rating_typestringOptional

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

  • valueintegerOptional

    the value of the rating

  • votes_countintegerOptional

    the amount of feedback

  • rating_maxintegerOptional

    the maximum value for a rating_type

  • rating_distributionobjectOptional

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

  • 1integerOptional

    the number of 1-star ratings

  • 2integerOptional

    the number of 2-star ratings

  • 3integerOptional

    the number of 3-star ratings

  • 4integerOptional

    the number of 4-star ratings

  • 5integerOptional

    the number of 5-star ratings

  • people_also_searchstring[]Optional

    related business entities

  • work_timeobjectOptional

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

  • work_hoursobjectOptional

    open hours information about work hours of the local establishment

  • timetableobjectOptional

    work hours timetable

  • sundaystring[]Optional

    work hours on Sundays

  • openobjectOptional

    opening time

  • hourintegerOptional

    hours in the 24-hour format

  • minuteintegerOptional

    minutes

  • closeobjectOptional

    closing time

  • mondaystring[]Optional

    work hours on Mondays

  • tuesdaystring[]Optional

    work hours on Tuesdays

  • wednesdaystring[]Optional

    work hours on Wednesdays

  • thursdaystring[]Optional

    work hours on Thursdays

  • fridaystring[]Optional

    work hours on Fridays

  • saturdaystring[]Optional

    work hours on Saturday

  • current_statusstringOptional

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

  • popular_timesobjectOptional

    popular times information related to busy hours of the business entity

  • popular_times_by_daysobjectOptional

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

  • sundaystring[]Optional

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

  • timeobjectOptional

    busy hours

  • hourintegerOptional

    hours in a 24-hour format

  • minuteintegerOptional

    minutes

  • popular_indexintegerOptional

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

  • local_business_linksstring[]Optional

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

  • typestringOptional

    *type of element = ‘menu’*

  • titlestringOptional

    title of the element domain of the online menu system

  • urlstringOptional

    URL to view the menu

  • delivery_servicesstring[]Optional

    lists available delivery services

  • is_directory_itembooleanOptional

    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

  • directorystring[]Optional

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

  • titlestringOptional

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

  • itemsstring[]Optional

    *array of directory items*

  • typestringOptional

    *type of element = ‘maps\_search’*

  • rank_groupintegerOptional

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

  • rank_absoluteintegerOptional

    absolute rank among all the elements

  • domainstringOptional

    domain of the business entity

  • urlstringOptional

    absolute url of the business entity

  • ratingobjectOptional

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

  • rating_typestringOptional

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

  • valueintegerOptional

    the value of the rating

  • votes_countintegerOptional

    the amount of feedback

  • rating_maxintegerOptional

    the maximum value for a rating_type

  • rating_distributionobjectOptional

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

  • 1integerOptional

    the number of 1-star ratings

  • 2integerOptional

    the number of 2-star ratings

  • 3integerOptional

    the number of 3-star ratings

  • 4integerOptional

    the number of 4-star ratings

  • 5integerOptional

    the number of 5-star ratings

  • snippetstringOptional

    additional information about the business entity

  • addressstringOptional

    street address of the business entity

  • address_infoobjectOptional

    object containing address components of the business entity

  • boroughstringOptional

    administrative unit or district the business entity location belongs to

  • citystringOptional

    name of the city where the business entity is located

  • zipstringOptional

    ZIP code of the business entity

  • regionstringOptional

    DMA region of the business entity location

  • country_codestringOptional

    ISO country code of the business entity location

  • place_idstringOptional

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

  • phonestringOptional

    phone number of the business entity

  • main_imagestringOptional

    URL of the main image featured in Google My Business profile

  • total_photosintegerOptional

    total count of images featured in Google My Business profile

  • categorystringOptional

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

  • category_idsstring[]Optional

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

  • work_hoursobjectOptional

    work hours information about work hours of the local establishment

  • feature_idstringOptional

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

  • cidstringOptional

    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

  • latitudenumberOptional

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

  • longitudenumberOptional

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

  • is_claimedbooleanOptional

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

  • local_justificationsstring[]Optional

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

  • is_directory_itembooleanOptional

    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

  • price_levelstringOptional

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

  • hotel_ratingintegerOptional

    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