Serp

Google Ads Search provides information on ads that are run by advertisers on Google Ads. Information is based on the Ads Transparency platform and adapted for the convenience of DataForSEO users. ‌‌

post/v3/serp/google/ads_search/task_post

Request

  • Base URL: https://api.dataforseo.com
  • URL: https://api.dataforseo.com/v3/serp/google/ads_search/task_post
  • Auth: HTTP basic

Request body

advertiser_idsstring[]
<p><em>advertiser identifiers</em><p><strong>required field if <code>target</code> is not specified</strong></p><br><p>you can specify the maximum of 25 values in this array;<p><code>advertiser_ids</code> values for this parameter can be found in the <a href="http://docs.dataforseo.com/v3/serp/google/ads_advertisers/task_get/advanced/" rel="noopener noreferrer" target="_blank">Google Ads Advertisers</a> endpoint;</p>
targetstring
<p><em>domain name</em><p><strong>required field if <code>advertiser_ids</code> is not specified</strong><p>domain name associated with an advertiser account</p>
location_codeinteger nullable
<p><em>search engine location code</em><p>optional field<p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/ads_search/locations</code><p>example:<p><code class="long-string">2840</code></p><br><p><strong>Note:</strong> if you don't specify <code>location_name</code>, <code>location_code</code>, or <code>location_coordinate</code>, the ads will be searched across all the available locations</p>
depthinteger nullable
<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>40</code><p>max value: <code>700</code></p><br><strong>Your account will be billed per each SERP containing up to 40 results;</strong><p>Setting depth above 40 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 40 results</a>;<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-ads-search-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
priorityinteger nullable
<p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-ads-search-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
pingback_urlstring nullable
<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>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.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>
postback_urlstring nullable
<p><em>URL for sending task results</em><p>optional field<p>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<p>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.<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>
postback_datastring
<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the function you used for setting a task<p>possible values:<p><code>advanced</code></p>
location_namestring nullable
<p><em>full name of search engine location</em><p>optional field<p><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/ads_search/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p><br><p><strong>Note:</strong> if you don't specify <code>location_name</code>, <code>location_code</code>, or <code>location_coordinate</code>, the ads will be searched across all the available locations</p>
location_coordinatestring nullable
<p><em>GPS coordinates of a location</em><p>optional field<p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><p>example:<p><code class="long-string">52.6178549,-155.352142</code></p><br><p><strong>Note:</strong> if you don't specify <code>location_name</code>, <code>location_code</code>, or <code>location_coordinate</code>, the ads will be searched across all the available locations</p>
tagstring nullable
<p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
platformstring nullable
<p><em>advertising platform</em><p>optional field<p>possible values: <code>all</code>, <code>google_play</code>, <code>google_maps</code>, <code>google_search</code>, <code>google_shopping</code>, <code>youtube</code><p>default value: <code>all</code></p>
formatstring nullable
<p><em>ad format</em><p>optional field<p>possible values: <code>all</code>, <code>text</code>, <code>image</code>, <code>video</code></p>
date_fromstring
<p><em>starting date of the time range</em><p>optional field<p>required field if <code>date_to</code> is specified; </p><br><p>date format: <code>"yyyy-mm-dd"</code><p>minimum value: 2018-05-31<p>maximum value: today's date<p>example:<p><code>"2020-01-01"</code></p>
date_tostring
<p><em>ending date of the time range</em><p>optional field<p>required field if <code>date_from</code> is specified; </p><br><p>date format: <code>"yyyy-mm-dd"</code><p>minimum value: 2018-05-31<p>maximum value: today's date<p>example:<p><code>"2020-01-01"</code></p>

Example request

[
  {
    "location_code": 2840,
    "platform": "google_search",
    "advertiser_ids": [
      "AR13752565271262920705",
      "AR02439908557932462081"
    ]
  }
]

Response

Successful operation

versionstring nullable

the current version of the API

status_codeinteger nullable

general status code you can find the full list of the response codes here

status_messagestring nullable

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

timestring nullable

total execution time, seconds

costnumber double nullable

total tasks cost, USD

tasks_countinteger nullable

the number of tasks in the tasks array

tasks_errorinteger nullable

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

Changes

    • breaking

      the //////////// response's property type changed from string to object for status

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////