changedInput schema / properties / body / items / oneOf
Previous value: -[
- {
- "example": [
- {
- "device": "desktop",
- "keyword": "albert einstein",
- "postback_data": "regular",
- "postback_url": "https://your-server.com/postbackscript.php",
- "tag": "some_string_123"
- }
- ],
- "properties": {
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>15</code><br>max value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 15 results;</strong> <br>Setting depth above 15 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 15 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/naver-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "device": {
- "description": "<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
- "type": "string"
- },
- "max_crawl_pages": {
- "description": "<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>default value: <code>1</code><br>max value: <code>100</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href=\"https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work\" target=\"_blank\" rel=\"noopener noreferrer\">our help center</a>",
- "type": [
- "integer",
- "null"
- ]
- },
- "os": {
- "description": "<em>device operating system</em><br>optional field<br>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><br>default value: <code>windows</code><br>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><br>default value: <code>android</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_data": {
- "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the function you used for setting a task<br>possible values:<br><code>regular</code>, <code>advanced</code>, <code>html</code>",
- "type": "string"
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/naver-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "se_domain": {
- "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically<br>however, you can set a custom search engine domain in this field<br>example:<br><code><code></code></code><em>search.naver.com</em>",
- "type": [
- "string",
- "null"
- ]
- },
- "search_param": {
- "description": "<em>additional parameters of the search query</em><br>optional field<br><a href=\"https://dataforseo.com/what-are-google-search-parameters-and-how-to-use-them-with-serp-api.html\">get the list of available parameters and additional details here</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "stop_crawl_on_match": {
- "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets",
- "items": {
- "oneOf": [
- {
- "properties": {
- "match_type": {
- "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard",
- "type": [
- "string",
- "null"
- ]
- },
- "match_value": {
- "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
- ],
- "type": [
- "object",
- "null"
- ]
- },
- "type": [
- "array",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- },
- "url": {
- "description": "<em>direct URL of the search query</em><br>optional field<br>you can specify a direct URL and we will sort it out to the necessary fields<br>in most cases, we wouldn’t recommend using this method;<br>example:<br><code class=\"long-string\">https://search.naver.com/search.naver?where=nexearch&sm=top_hty&fbm=1&ie=utf8&query=iphone</code>",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>15</code><br>max value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 15 results;</strong> <br>Setting depth above 15 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 15 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/naver-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "device": {
+ "description": "<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "max_crawl_pages": {
+ "description": "<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>default value: <code>1</code><br>max value: <code>100</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href=\"https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work\" target=\"_blank\" rel=\"noopener noreferrer\">our help center</a>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "os": {
+ "description": "<em>device operating system</em><br>optional field<br>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><br>default value: <code>windows</code><br>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><br>default value: <code>android</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_data": {
+ "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the function you used for setting a task<br>possible values:<br><code>regular</code>, <code>advanced</code>, <code>html</code>",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/naver-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "se_domain": {
+ "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically<br>however, you can set a custom search engine domain in this field<br>example:<br><code><code></code></code><em>search.naver.com</em>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "search_param": {
+ "description": "<em>additional parameters of the search query</em><br>optional field<br><a href=\"https://dataforseo.com/what-are-google-search-parameters-and-how-to-use-them-with-serp-api.html\">get the list of available parameters and additional details here</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "stop_crawl_on_match": {
+ "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets",
+ "items": {
+ "oneOf": [
+ {
+ "properties": {
+ "match_type": {
+ "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "match_value": {
+ "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+ ],
+ "type": [
+ "object",
+ "null"
+ ]
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "url": {
+ "description": "<em>direct URL of the search query</em><br>optional field<br>you can specify a direct URL and we will sort it out to the necessary fields<br>in most cases, we wouldn’t recommend using this method;<br>example:<br><code class=\"long-string\">https://search.naver.com/search.naver?where=nexearch&sm=top_hty&fbm=1&ie=utf8&query=iphone</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]
