データ 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.

パラメータ

パス・クエリ・ヘッダーのパラメータはありません。

リクエストボディ

keywordstring必須
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_namestring任意
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_codeinteger任意
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_coordinatestring任意
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_namestring任意
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_codestring任意
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
tagstring任意
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

リクエスト例

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>"
}'

レスポンス

レスポンスのフィールド

versionstring任意
the current version of the API
status_codeinteger任意
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_messagestring任意
general informational message you can find the full list of general informational messages here
timestring任意
execution time, seconds
costnumber任意
*total tasks cost, USD*
tasks_countinteger任意
*the number of tasks in the tasks array*
tasks_errorinteger任意
*the number of tasks in the tasks array that were returned an error*
tasksstring[]任意
array of tasks
idstring任意
task identifier unique task identifier in our system in the UUID format
status_codeinteger任意
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_messagestring任意
informational message of the task you can find the full list of general informational messages here
timestring任意
execution time, seconds
costnumber任意
cost of the task, USD
result_countinteger任意
number of elements in the result array
pathstring[]任意
URL path
dataobject任意
contains the same parameters that you specified in the POST request
resultstring[]任意
array of results
keywordstring任意
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_domainstring任意
search engine domain as specified in a POST array
location_codeinteger任意
location code in a POST array
language_codestring任意
language code in a POST array
check_urlstring任意
direct URL to search engine results you can use it to make sure that we provided accurate results
datetimestring任意
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[]任意
item types types of search engine results encountered in the items array; possible item types: google_business_info
items_countinteger任意
item types the number of items in the items array
itemsstring[]任意
encountered item types types of search engine results encountered in the items array; possible item types: google_business_info
typestring任意
*type of element = ‘google\_business\_info’*
rank_groupinteger任意
position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group
rank_absoluteinteger任意
absolute rank among all the elements
positionstring任意
the alignment in SERP
titlestring任意
title of the element in SERP the name of the business entity for which the results are collected
original_titlestring任意
original title of the element original title not translated by Google
descriptionstring任意
description of the element in SERP the description of the business entity for which the results are collected
categorystring任意
business category Google My Business general category that best describes the services provided by the business entity
category_idsstring[]任意
global category IDs universal category IDs that do not change based on the selected country
additional_categoriesstring[]任意
additional business categories additional Google My Business categories that describe the services provided by the business entity in more detail
cidstring任意
google-defined client id unique id of a local establishment learn more about the identifier in this help center article
feature_idstring任意
the unique identifier of the element in SERP learn more about the identifier in this help center article
addressstring任意
street address of the business entity
address_infoobject任意
object containing address components of the business entity
boroughstring任意
administrative unit or district the business entity location belongs to
citystring任意
name of the city where the business entity is located
zipstring任意
ZIP code of the business entity
regionstring任意
DMA region of the business entity location
country_codestring任意
ISO country code of the business entity location
place_idstring任意
unique place identifier place id of the local establishment featured in the element learn more about the identifier in this help center article
phonestring任意
phone number of the business entity
urlstring任意
absolute url of the business entity
contact_urlstring任意
URL of the preferred contact page
contributor_urlstring任意
URL of the user’s or entity’s Local Guides profile, if available
book_online_urlstring任意
URL in the ‘book online’ button of the element URL directing users to the online booking or order page of the business entity
domainstring任意
domain of the business entity
logostring任意
URL of the logo featured in Google My Business profile
main_imagestring任意
URL of the main image featured in Google My Business profile
total_photosinteger任意
total count of images featured in Google My Business profile
snippetstring任意
additional information on the business entity
latitudenumber任意
latitude coordinate of the local establishments in google maps example: "latitude": 51.584091
longitudenumber任意
longitude coordinate of the local establishment in google maps example: "longitude": -0.31365919999999997
is_claimedboolean任意
shows whether the entity is verified by its owner on Google Maps
attributesobject任意
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_attributesobject任意
available attributes indicates attributes a business entity can offer
unavailable_attributesobject任意
unavailable attributes indicates attributes a business entity cannot offer
place_topicsobject任意
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}
ratingobject任意
the element’s rating the popularity rate based on reviews and displayed in SERP
rating_typestring任意
the type of rating here you can find the following elements: Max5, Percents, CustomMax
valueinteger任意
the value of the rating
votes_countinteger任意
the amount of feedback
rating_maxinteger任意
the maximum value for a rating_type
rating_distributionobject任意
the distribution of ratings of the business entity the object displays the number of 1-star to 5-star ratings, as reviewed by users
1integer任意
the number of 1-star ratings
2integer任意
the number of 2-star ratings
3integer任意
the number of 3-star ratings
4integer任意
the number of 4-star ratings
5integer任意
the number of 5-star ratings
people_also_searchstring[]任意
related business entities
work_timeobject任意
work time details information related to operational hours of the business entity
work_hoursobject任意
open hours information about work hours of the local establishment
timetableobject任意
work hours timetable
sundaystring[]任意
work hours on Sundays
openobject任意
opening time
hourinteger任意
hours in the 24-hour format
minuteinteger任意
minutes
closeobject任意
closing time
mondaystring[]任意
work hours on Mondays
tuesdaystring[]任意
work hours on Tuesdays
wednesdaystring[]任意
work hours on Wednesdays
thursdaystring[]任意
work hours on Thursdays
fridaystring[]任意
work hours on Fridays
saturdaystring[]任意
work hours on Saturday
current_statusstring任意
current status of the establishment possible values: opened, closed, temporarily_closed, closed_forever
popular_timesobject任意
popular times information related to busy hours of the business entity
popular_times_by_daysobject任意
popular hours information about busy hours of the local establishment on each day of the week
sundaystring[]任意
busy hours on sunday can take values of the corresponding days of the week
timeobject任意
busy hours
hourinteger任意
hours in a 24-hour format
minuteinteger任意
minutes
popular_indexinteger任意
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[]任意
available interactions with the business list of options to interact with the business directly from search results
typestring任意
*type of element = ‘menu’*
titlestring任意
title of the element domain of the online menu system
urlstring任意
URL to view the menu
delivery_servicesstring[]任意
lists available delivery services
is_directory_itemboolean任意
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[]任意
items of the directory includes information about businesses that are located within the target business establishment and have the same address
titlestring任意
title of the element in SERP the name of the business entity
itemsstring[]任意
*array of directory items*
typestring任意
*type of element = ‘maps\_search’*
rank_groupinteger任意
position within a group of elements with identical type values positions of elements with different type values are omitted from the rank_group
rank_absoluteinteger任意
absolute rank among all the elements
domainstring任意
domain of the business entity
urlstring任意
absolute url of the business entity
ratingobject任意
the element’s rating the popularity rate based on reviews and displayed in SERP
rating_typestring任意
the type of rating here you can find the following elements: Max5, Percents, CustomMax
valueinteger任意
the value of the rating
votes_countinteger任意
the amount of feedback
rating_maxinteger任意
the maximum value for a rating_type
rating_distributionobject任意
the distribution of ratings of the business entity the object displays the number of 1-star to 5-star ratings, as reviewed by users
1integer任意
the number of 1-star ratings
2integer任意
the number of 2-star ratings
3integer任意
the number of 3-star ratings
4integer任意
the number of 4-star ratings
5integer任意
the number of 5-star ratings
snippetstring任意
additional information about the business entity
addressstring任意
street address of the business entity
address_infoobject任意
object containing address components of the business entity
boroughstring任意
administrative unit or district the business entity location belongs to
citystring任意
name of the city where the business entity is located
zipstring任意
ZIP code of the business entity
regionstring任意
DMA region of the business entity location
country_codestring任意
ISO country code of the business entity location
place_idstring任意
unique place identifier place id of the local establishment featured in the element learn more about the identifier in this help center article
phonestring任意
phone number of the business entity
main_imagestring任意
URL of the main image featured in Google My Business profile
total_photosinteger任意
total count of images featured in Google My Business profile
categorystring任意
business category Google My Business general category that best describes the services provided by the business entity
category_idsstring[]任意
global category IDs universal category IDs that do not change based on the selected country
work_hoursobject任意
work hours information about work hours of the local establishment
feature_idstring任意
the unique identifier of the element in SERP learn more about the identifier in this help center article
cidstring任意
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
latitudenumber任意
latitude coordinate of the local establishments in google maps example: "latitude": 51.584091
longitudenumber任意
longitude coordinate of the local establishment in google maps example: "longitude": -0.31365919999999997
is_claimedboolean任意
shows whether the entity is verified by its owner on Google Maps
local_justificationsstring[]任意
Google local justifications snippets of text that “justify” why the business is showing up for search query
is_directory_itemboolean任意
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_levelstring任意
property price level can take values: inexpensive, moderate, expensive, very_expensive if there is no price level information, the value will be null
hotel_ratinginteger任意
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