Add an ad group to a draft
curl --request POST \
--url http://localhost:8000/api/v1/campaigns/drafts/{draft_id}/ad-groups \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"cpc_bid_micros": 123,
"keywords": [
{
"text": "<string>",
"cpc_bid_micros": 123,
"final_url": "<string>",
"market_analysis_keyword_id": 123
}
]
}
'import requests
url = "http://localhost:8000/api/v1/campaigns/drafts/{draft_id}/ad-groups"
payload = {
"name": "<string>",
"cpc_bid_micros": 123,
"keywords": [
{
"text": "<string>",
"cpc_bid_micros": 123,
"final_url": "<string>",
"market_analysis_keyword_id": 123
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
cpc_bid_micros: 123,
keywords: [
{
text: '<string>',
cpc_bid_micros: 123,
final_url: '<string>',
market_analysis_keyword_id: 123
}
]
})
};
fetch('http://localhost:8000/api/v1/campaigns/drafts/{draft_id}/ad-groups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8000",
CURLOPT_URL => "http://localhost:8000/api/v1/campaigns/drafts/{draft_id}/ad-groups",
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([
'name' => '<string>',
'cpc_bid_micros' => 123,
'keywords' => [
[
'text' => '<string>',
'cpc_bid_micros' => 123,
'final_url' => '<string>',
'market_analysis_keyword_id' => 123
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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 := "http://localhost:8000/api/v1/campaigns/drafts/{draft_id}/ad-groups"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"cpc_bid_micros\": 123,\n \"keywords\": [\n {\n \"text\": \"<string>\",\n \"cpc_bid_micros\": 123,\n \"final_url\": \"<string>\",\n \"market_analysis_keyword_id\": 123\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:8000/api/v1/campaigns/drafts/{draft_id}/ad-groups")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"cpc_bid_micros\": 123,\n \"keywords\": [\n {\n \"text\": \"<string>\",\n \"cpc_bid_micros\": 123,\n \"final_url\": \"<string>\",\n \"market_analysis_keyword_id\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/api/v1/campaigns/drafts/{draft_id}/ad-groups")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"cpc_bid_micros\": 123,\n \"keywords\": [\n {\n \"text\": \"<string>\",\n \"cpc_bid_micros\": 123,\n \"final_url\": \"<string>\",\n \"market_analysis_keyword_id\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"cpc_bid_micros": 25000000000,
"keywords": [
{
"id": 123,
"text": "<string>",
"cpc_bid_micros": 25000000000,
"final_url": "<string>",
"source_market_analysis_keyword_id": 123
}
],
"rsas": [
{
"id": 123,
"ad_group_id": 123,
"headlines": [
{
"text": "<string>",
"reason": "<string>"
}
],
"descriptions": [
{
"text": "<string>",
"reason": "<string>"
}
],
"final_url": "<string>",
"final_mobile_url": "<string>",
"display_path_1": "<string>",
"display_path_2": "<string>",
"tracking_url_template": "<string>",
"generation_status": "pending",
"generation_task_id": "<string>",
"generation_error": "<string>"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Campaigns
Add an ad group to a draft
Create a new ad group within a campaign draft.
Optionally include keywords in the request to create them with the ad group.
POST
/
api
/
v1
/
campaigns
/
drafts
/
{draft_id}
/
ad-groups
Add an ad group to a draft
curl --request POST \
--url http://localhost:8000/api/v1/campaigns/drafts/{draft_id}/ad-groups \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"cpc_bid_micros": 123,
"keywords": [
{
"text": "<string>",
"cpc_bid_micros": 123,
"final_url": "<string>",
"market_analysis_keyword_id": 123
}
]
}
'import requests
url = "http://localhost:8000/api/v1/campaigns/drafts/{draft_id}/ad-groups"
payload = {
"name": "<string>",
"cpc_bid_micros": 123,
"keywords": [
{
"text": "<string>",
"cpc_bid_micros": 123,
"final_url": "<string>",
"market_analysis_keyword_id": 123
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
cpc_bid_micros: 123,
keywords: [
{
text: '<string>',
cpc_bid_micros: 123,
final_url: '<string>',
market_analysis_keyword_id: 123
}
]
})
};
fetch('http://localhost:8000/api/v1/campaigns/drafts/{draft_id}/ad-groups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8000",
CURLOPT_URL => "http://localhost:8000/api/v1/campaigns/drafts/{draft_id}/ad-groups",
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([
'name' => '<string>',
'cpc_bid_micros' => 123,
'keywords' => [
[
'text' => '<string>',
'cpc_bid_micros' => 123,
'final_url' => '<string>',
'market_analysis_keyword_id' => 123
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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 := "http://localhost:8000/api/v1/campaigns/drafts/{draft_id}/ad-groups"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"cpc_bid_micros\": 123,\n \"keywords\": [\n {\n \"text\": \"<string>\",\n \"cpc_bid_micros\": 123,\n \"final_url\": \"<string>\",\n \"market_analysis_keyword_id\": 123\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:8000/api/v1/campaigns/drafts/{draft_id}/ad-groups")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"cpc_bid_micros\": 123,\n \"keywords\": [\n {\n \"text\": \"<string>\",\n \"cpc_bid_micros\": 123,\n \"final_url\": \"<string>\",\n \"market_analysis_keyword_id\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/api/v1/campaigns/drafts/{draft_id}/ad-groups")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"cpc_bid_micros\": 123,\n \"keywords\": [\n {\n \"text\": \"<string>\",\n \"cpc_bid_micros\": 123,\n \"final_url\": \"<string>\",\n \"market_analysis_keyword_id\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"cpc_bid_micros": 25000000000,
"keywords": [
{
"id": 123,
"text": "<string>",
"cpc_bid_micros": 25000000000,
"final_url": "<string>",
"source_market_analysis_keyword_id": 123
}
],
"rsas": [
{
"id": 123,
"ad_group_id": 123,
"headlines": [
{
"text": "<string>",
"reason": "<string>"
}
],
"descriptions": [
{
"text": "<string>",
"reason": "<string>"
}
],
"final_url": "<string>",
"final_mobile_url": "<string>",
"display_path_1": "<string>",
"display_path_2": "<string>",
"tracking_url_template": "<string>",
"generation_status": "pending",
"generation_task_id": "<string>",
"generation_error": "<string>"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Query Parameters
Auto-regenerate RSAs for the new ad group
Body
application/json
⌘I