Get Google Ads Result
curl --request POST \
--url https://public.plai.io/gads/get_google_ads_result \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"userId": "<string>",
"campaignId": "<string>",
"startDate": "<string>",
"endDate": "<string>"
}
'import requests
url = "https://public.plai.io/gads/get_google_ads_result"
payload = {
"userId": "<string>",
"campaignId": "<string>",
"startDate": "<string>",
"endDate": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
userId: '<string>',
campaignId: '<string>',
startDate: '<string>',
endDate: '<string>'
})
};
fetch('https://public.plai.io/gads/get_google_ads_result', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://public.plai.io/gads/get_google_ads_result",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'userId' => '<string>',
'campaignId' => '<string>',
'startDate' => '<string>',
'endDate' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://public.plai.io/gads/get_google_ads_result"
payload := strings.NewReader("{\n \"userId\": \"<string>\",\n \"campaignId\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://public.plai.io/gads/get_google_ads_result")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"userId\": \"<string>\",\n \"campaignId\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public.plai.io/gads/get_google_ads_result")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userId\": \"<string>\",\n \"campaignId\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"results": {
"success": true,
"stats": [
{
"campaignid": "<string>",
"campaignName": "<string>",
"servingStatus": "<string>",
"advertising_channel_type": "<string>",
"status": "<string>",
"avgPosition": "<string>",
"clicks": "<string>",
"conversions": "<string>",
"cost": "<string>",
"ctr": "<string>",
"impressions": "<string>",
"interactions": "<string>",
"topImpressionPercentage": "<string>",
"videoViews": "<string>",
"videoViewRate": "<string>",
"averageCpv": "<string>",
"cpm": "<string>",
"conversionRateRanking": "<string>",
"costPerConversion": "<string>",
"dateStart": "<string>",
"cpc": "<string>",
"timeUnit": "<string>",
"spend": "<string>",
"phone_calls": "<string>",
"phone_impressions": "<string>",
"phone_through_rate": "<string>",
"searchImpressionShare": "<string>",
"searchBudgetLostImpressionShare": "<string>",
"searchRankLostImpressionShare": "<string>",
"primary_status": "<string>",
"primary_status_reasons": [
"<string>"
],
"all_conversions": "<string>",
"all_conversions_value": "<string>",
"display_spend": "<string>",
"display_cpc": "<string>",
"display_costPerConversion": "<string>"
}
],
"error": "<string>"
}
}Campaign
Get Google Ads Result
This endpoint retrieves performance metrics and detailed reporting data for a specific Google Ads campaign. Users can fetch insights such as clicks, impressions, conversions, cost, and more within a selected date range. It helps evaluate how well a campaign is performing across various key metrics.
POST
/
gads
/
get_google_ads_result
Get Google Ads Result
curl --request POST \
--url https://public.plai.io/gads/get_google_ads_result \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"userId": "<string>",
"campaignId": "<string>",
"startDate": "<string>",
"endDate": "<string>"
}
'import requests
url = "https://public.plai.io/gads/get_google_ads_result"
payload = {
"userId": "<string>",
"campaignId": "<string>",
"startDate": "<string>",
"endDate": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
userId: '<string>',
campaignId: '<string>',
startDate: '<string>',
endDate: '<string>'
})
};
fetch('https://public.plai.io/gads/get_google_ads_result', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://public.plai.io/gads/get_google_ads_result",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'userId' => '<string>',
'campaignId' => '<string>',
'startDate' => '<string>',
'endDate' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://public.plai.io/gads/get_google_ads_result"
payload := strings.NewReader("{\n \"userId\": \"<string>\",\n \"campaignId\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://public.plai.io/gads/get_google_ads_result")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"userId\": \"<string>\",\n \"campaignId\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public.plai.io/gads/get_google_ads_result")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userId\": \"<string>\",\n \"campaignId\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"results": {
"success": true,
"stats": [
{
"campaignid": "<string>",
"campaignName": "<string>",
"servingStatus": "<string>",
"advertising_channel_type": "<string>",
"status": "<string>",
"avgPosition": "<string>",
"clicks": "<string>",
"conversions": "<string>",
"cost": "<string>",
"ctr": "<string>",
"impressions": "<string>",
"interactions": "<string>",
"topImpressionPercentage": "<string>",
"videoViews": "<string>",
"videoViewRate": "<string>",
"averageCpv": "<string>",
"cpm": "<string>",
"conversionRateRanking": "<string>",
"costPerConversion": "<string>",
"dateStart": "<string>",
"cpc": "<string>",
"timeUnit": "<string>",
"spend": "<string>",
"phone_calls": "<string>",
"phone_impressions": "<string>",
"phone_through_rate": "<string>",
"searchImpressionShare": "<string>",
"searchBudgetLostImpressionShare": "<string>",
"searchRankLostImpressionShare": "<string>",
"primary_status": "<string>",
"primary_status_reasons": [
"<string>"
],
"all_conversions": "<string>",
"all_conversions_value": "<string>",
"display_spend": "<string>",
"display_cpc": "<string>",
"display_costPerConversion": "<string>"
}
],
"error": "<string>"
}
}Request Body
string
required
User ID, If not already created, make a user on create user
page first. If already created,
retrieve the user ID from get profile
page.
string
required
Campaign ID
string
Start Date Format:
YYYY-MM-DD, use to filter the results by start date.string
End Date Format:
YYYY-MM-DD, use to filter the results by end date.Response
boolean
Indicates that the HTTP response was successful (status code 200 OK).
object
Show Results Object
Show Results Object
boolean
Indicates whether the specific operation or API action was successful.
object[]
Show Stats Object
Show Stats Object
string
Campaign ID
string
Campaign Name
string
Serving Status of ad
string
Advertising Channel Type
string
Status
string
Average Position
string
Clicks
string
Conversions
string
Cost
string
CTR
string
Impressions
string
Interactions
string
Top Impression Percentage
string
Video Views
string
Video View Rate
string
Average CPV
string
CPM
string
Conversion Rate Ranking
string
Cost Per Conversion
string
Date Start
string
CPC
string
Time Unit
string
Spend
string
Phone Calls
string
Phone Impressions
string
Phone Through Rate
string
Search Impression Share
string
Search Budget Lost Impression Share
string
Search Rank Lost Impression Share
string
Primary Status
string[]
Primary Status Reasons
string
All Conversions
string
All Conversions Value
string
Display Spend
string
Display CPC
string
Display Cost Per Conversion
string
Error string if something went wrong