Felo API PlatformFelo API Platform

Data API / DataForSEO / Merchant

Setting Google Shopping Product Info Tasks

Queues a lookup of one specific Google Shopping product, returning a task id. Identify the product with product_id and the gid or data_docid taken from a get_dataforseo_merchant_google_products_fetch result. This family is asynchronous throughout: submit returns a task id in tasks[0].id, and the fetch tool returns the result once it is ready. Retrieve with get_dataforseo_merchant_google_product_info_fetch.

Параметры

Параметров пути, запроса и заголовков нет.

Тело запроса

  • product_idstringНеобязательный

    unique product identifier on Google Shopping required field if data_docid or gid is not specified we recommend specifying product_id together with data_docid and gid for optimal results; you can get this value for a certain product by making a separate request to the Google Shopping Products endpoint example: 4485466949985702538 learn more about the parameter in this help center guide

  • data_docidstringНеобязательный

    unique identifier of the SERP data element required field if product_id or gid is not specified we recommend specifying data_docid together with product_id and gid for optimal results; you can get this value for a certain element by making a separate request to the Google Shopping Products endpoint example: 13071766526042404278

  • gidstringНеобязательный

    global product identifier on Google Shopping required field if product_id or data_docid is not specified we recommend specifying gid together with product_id and data_docid for optimal results; you can get this value for a certain product by making a separate request to the Google Shopping Products endpoint example: 4702526954592161872 learn more about the parameter in this help center guide

  • priorityintegerНеобязательный

    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.

  • location_namestringНеобязательный

    full name of the 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 Google Shopping locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations example: London,England,United Kingdom

  • location_codeintegerНеобязательный

    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 Google Shopping locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/merchant/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 example: 53.476225,-2.243572,200

  • language_namestringНеобязательный

    full name of the 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 Google Shopping languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages example: English

  • language_codestringНеобязательный

    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 Google Shopping languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages example: en

  • se_domainstringНеобязательный

    search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: google.co.uk, google.com.au, google.de, etc.

  • 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

  • postback_urlstringНеобязательный

    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 %23 learn more on our Help Center

  • postback_datastringНеобязательный

    postback_url datatype optional field corresponds to the datatype that will be sent to your server possible values: advanced

  • pingback_urlstringНеобязательный

    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 %23 learn more on our Help Center

Пример запроса

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/merchant/google/product_info/task_post" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "product_id": "<string>",
  "data_docid": "<string>",
  "gid": "<string>",
  "priority": 0,
  "location_name": "<string>",
  "location_code": 0,
  "location_coordinate": "<string>",
  "language_name": "<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 tasksarray

  • tasks_errorintegerНеобязательный

    the number of tasks in the tasks array returned with an error

  • tasksstring[]Необязательный

    array of tasks

  • idstringНеобязательный

    unique task identifier in our system in the Universally unique identifier (UUID) format

  • status_codeintegerНеобязательный

    status code of the task generated by DataForSEO; can be within the following range: 10000-60000

  • status_messagestringНеобязательный

    informational message of the task

  • 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 in this case, the value will be null