v0.1.0-beta

OpenAPI 3.1.0

Get Business Data Google Reviews Results by id

Felo API Support

MIT

伺服器

https://openapi.felo.ai

用戶端程式庫

Shell Curl

DataForSEO

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

DataForSEO 操作

get/v1/beta/dataforseo/business_data/google/reviews/task_get/{id}

Get Business Data Google Reviews Results by id

Retrieves queued Google Business Profile reviews by id. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. ⚠️ Size scales with the depth set at submit and cannot be narrowed here.

路徑參數

id
類型: string
必填

DataForSEO task ID.

回應

200
類型: object

Successful response
items
類型: array string[]

found reviews you can get more results by using the depth parameter when setting a task

items.alt
類型: string

alt tag of the image

items.assessment
類型: string

feature assessment

items.feature
類型: string

reviewed feature

items.image_url
類型: string

URL of the image featured in the review

items.images
類型: array string[]

images submitted by the reviewer

items.local_guide
類型: boolean

indicates whether the reviewer has a ‘local guide’ status

items.original_owner_answer
類型: string

original text of the owner’s response the original response to the review, no auto-translate applied

items.original_review_text
類型: string

original content of the review the original content of the review, no auto-translate applied

items.owner_answer
類型: string

text of the owner’s response the owner’s response to the review

items.owner_time_ago
類型: string

publication time indicates the time (in the ‘time ago’ format) when the owner submitted the response to the review

items.owner_timestamp
類型: string

date and time of the owner’s reply to the review in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00

items.photos_count
類型: integer

total number of photos submitted by the reviewer

items.position
類型: string

the alignment of the review in SERP can take the following values: right

items.profile_image_url
類型: string

URL of the reviewer’s profile image

items.profile_name
類型: string

profile name of the reviewer

items.profile_url
類型: string

URL of the reviewer’s profile

items.rank_absolute
類型: integer

absolute rank among all the listed reviews absolute position among all reviews on the list

items.rank_group
類型: 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
類型: object

the rating score submitted by the reviewer

items.rating_max
類型: integer

the maximum value for a rating_type the maximum value for Max5 is 5

items.rating_type
類型: string

the type of the rating can take the following values: Max5

items.review_highlights
類型: array string[]

review highlights contains highlighted review criteria and assessments

items.review_id
類型: string

the unique identifier of a review on Google example: ChZDSUhNMG9nS0VJQ0FnSUMxbHFyMFlnEAE

items.review_text
類型: string

the content of the review

items.review_url
類型: string

the URL of the review

items.reviews_count
類型: integer

total number of reviews submitted by the reviewer

items.time_ago
類型: string

the time of publication indicates the time (in the ‘time ago’ format) when the review was listed

items.timestamp
類型: string

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

items.type
類型: string

type of element = ‘images_element’

items.url
類型: string

relevant image URL from Google

items.value
類型: number

the value of the rating

items.votes_count
類型: integer

the amount of feedback indicated the number of votes the review obtained

items.xpath
類型: string

the XPath of the review

result
類型: array string[]

array of results

result.check_url
類型: string

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

result.cid
類型: string

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

result.datetime
類型: 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.feature_id
類型: string

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

result.items_count
類型: integer

the number of reviews items in the results array you can get more results by using the depth parameter when setting a task

result.keyword
類型: string

keyword received in a POST array keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)

result.language_code
類型: string

language code in a POST array

result.location_code
類型: integer

location code in a POST array

result.place_id
類型: string

unique identifier of a business location assigned by Google learn more about the identifier in this help center article

result.rating
類型: object

rating of the corresponding local establishment popularity rate based on reviews and displayed in SERP

result.rating_max
類型: integer

the maximum value for a rating_type

result.rating_type
類型: string

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

result.reviews_count
類型: integer

the total number of reviews

result.se_domain
類型: string

search engine domain in a POST array

result.sub_title
類型: string

subtitle of the ‘reviews’ element in SERP additional information (e.g., address) on the ‘reviews’ element for which the reviews are collected

result.title
類型: string

title of the ‘reviews’ element in SERP the name of the local establishment for which the reviews are collected

result.type
類型: string

search engine type in a POST array

result.value
類型: number

the average rating based on all reviews

result.votes_count
類型: integer

the number of votes

tasks
類型: array string[]

array of tasks

tasks.cost
類型: number

cost of the task, USD

tasks.data
類型: object

contains the same parameters that you specified in the POST request

tasks.id
類型: string

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

tasks.path
類型: array string[]

URL path

tasks.result_count
類型: integer

number of elements in the result array

tasks.status_code
類型: 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
類型: string

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

tasks.time
類型: string

execution time, seconds

version
類型: string

the current version of the API

version.cost
類型: number

total tasks cost, USD

version.status_code
類型: 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
類型: string

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

version.tasks_count
類型: integer

the number of tasks in the tasks array

version.tasks_error
類型: integer

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

version.time
類型: 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.

get/v1/beta/dataforseo/business_data/google/reviews/task_get/{id}

curl 'https://openapi.felo.ai/v1/beta/dataforseo/business_data/google/reviews/task_get/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

顯示 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.type": "string",
  "result.se_domain": "string",
  "result.location_code": 1,
  "result.language_code": "string",
  "result.check_url": "string",
  "result.datetime": "string",
  "result.title": "string",
  "result.sub_title": "string",
  "result.rating": {},
  "result.rating_type": "string",
  "result.value": 1,
  "result.votes_count": 1,
  "result.rating_max": 1,
  "result.feature_id": "string",
  "result.place_id": "string",
  "result.cid": "string",
  "result.reviews_count": 1,
  "result.items_count": 1,
  "items": [
    "string"
  ],
  "items.type": "string",
  "items.rank_group": 1,
  "items.rank_absolute": 1,
  "items.position": "string",
  "items.xpath": "string",
  "items.review_text": "string",
  "items.original_review_text": "string",
  "items.time_ago": "string",
  "items.timestamp": "string",
  "items.rating": {},
  "items.rating_type": "string",
  "items.value": 1,
  "items.votes_count": 1,
  "items.rating_max": 1,
  "items.reviews_count": 1,
  "items.photos_count": 1,
  "items.local_guide": true,
  "items.profile_name": "string",
  "items.profile_url": "string",
  "items.review_url": "string",
  "items.profile_image_url": "string",
  "items.owner_answer": "string",
  "items.original_owner_answer": "string",
  "items.owner_time_ago": "string",
  "items.owner_timestamp": "string",
  "items.review_id": "string",
  "items.images": [
    "string"
  ],
  "items.alt": "string",
  "items.url": "string",
  "items.image_url": "string",
  "items.review_highlights": [
    "string"
  ],
  "items.feature": "string",
  "items.assessment": "string"
}

Successful response

Get Business Data Google Reviews Results by id

身分驗證Required

DataForSEO

Get Business Data Google Reviews Results by id