Felo API PlatformFelo API Platform
v0.1.0-beta
OpenAPI 3.1.0

Setting Business Data Google Reviews Tasks

服务器:https://openapi.felo.ai
客户端库

DataForSEO

​

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

Setting Business Data Google Reviews Tasks

​

Queues Google Business Profile reviews, returning a task id. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. Retrieve with get_dataforseo_business_google_reviews_fetch; the profile itself is post_dataforseo_business_google_gmb_info_live.

请求体
必填
application/json
  • 类型: array object[]
    • 类型: object
      • cid
        类型: string

        unique, google-defined id of the business entity required field if you don’t specify keyword or place_id example: 194604053573767737 learn more about the identifier in this help center article

      • depth
        类型: integer

        parsing depth optional field number of reviews in SERP we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row default value: 10 maximum value: 4490 Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; The cost can be calculated on the Pricing page.

      • keyword
        类型: string

        keyword required field if you don’t specify cid or place_id 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”; if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, the charge per task will be multiplied by 5 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article

      • language_code
        类型: 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 the https://api.dataforseo.com/v3/business_data/google/languages example: en

      • language_name
        类型: 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 the https://api.dataforseo.com/v3/business_data/google/languages example: English

      • location_code
        类型: 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
        类型: 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 example: 53.476225,-2.243572,200

      • location_name
        类型: 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 the https://api.dataforseo.com/v3/business_data/google/locations example: London,England,United Kingdom

      • pingback_url
        类型: string

        notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23learn more on our Help Center

      • place_id
        类型: string

        identifier of the business entity in Google Maps required field if you don’t specify keyword or cid example: GhIJQWDl0CIeQUARxks3icF8U8A learn more about the identifier in this help center article

      • postback_url
        类型: string

        return URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23learn more on our Help Center

      • priority
        类型: integer

        task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page.

      • sort_by
        类型: string

        results sorting parameters optional field you can use this field to sort the results possible types of sorting: newest – sort by newest first highest_rating – sort by highest rating lowest_rating – sort by lowest rating relevant – sort by relevance default value: relevant

      • tag
        类型: 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

      空对象
      空对象
      空对象
响应
  • 200
    类型: object

    Successful response

    • result
      类型: array string[]

      array of results in this case, the value will be null

    • 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

      unique task identifier in our system in the Universally unique identifier (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

    • tasks.status_message
      类型: string

      informational message of the task

    • 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 returned with 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.

Request Example for post/v1/beta/dataforseo/business_data/google/reviews/task_post
curl https://openapi.felo.ai/v1/beta/dataforseo/business_data/google/reviews/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {},
  {},
  {}
]'
{
  "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"
  ]
}
Setting Business Data Google Reviews Tasks