Create Google Ads Search campaign

curl --request POST \
  --url https://api.sapt.ai/projects/{projectId}/google-ads/customers/{customerId}/campaigns/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "dailyBudget": 123,
  "locations": [
    "<string>"
  ],
  "languages": [
    "<string>"
  ],
  "adGroupName": "<string>",
  "keywords": [
    {
      "text": "<string>"
    }
  ],
  "ad": {
    "headlines": [
      "<string>"
    ],
    "descriptions": [
      "<string>"
    ],
    "finalUrl": "<string>",
    "path1": "<string>",
    "path2": "<string>"
  },
  "loginCustomerId": "<string>",
  "targetCpa": 123,
  "negativeKeywords": [
    {
      "text": "<string>"
    }
  ],
  "startDate": "<string>",
  "endDate": "<string>",
  "exemptPolicyViolationKeys": [
    {
      "policyName": "<string>",
      "violatingText": "<string>"
    }
  ],
  "ignorablePolicyTopics": [
    "<string>"
  ],
  "autoExemptPolicyViolations": true,
  "validateOnly": true
}
'

import requests

url = "https://api.sapt.ai/projects/{projectId}/google-ads/customers/{customerId}/campaigns/search"

payload = {
    "name": "<string>",
    "dailyBudget": 123,
    "locations": ["<string>"],
    "languages": ["<string>"],
    "adGroupName": "<string>",
    "keywords": [{ "text": "<string>" }],
    "ad": {
        "headlines": ["<string>"],
        "descriptions": ["<string>"],
        "finalUrl": "<string>",
        "path1": "<string>",
        "path2": "<string>"
    },
    "loginCustomerId": "<string>",
    "targetCpa": 123,
    "negativeKeywords": [{ "text": "<string>" }],
    "startDate": "<string>",
    "endDate": "<string>",
    "exemptPolicyViolationKeys": [
        {
            "policyName": "<string>",
            "violatingText": "<string>"
        }
    ],
    "ignorablePolicyTopics": ["<string>"],
    "autoExemptPolicyViolations": True,
    "validateOnly": True
}
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>',
    dailyBudget: 123,
    locations: ['<string>'],
    languages: ['<string>'],
    adGroupName: '<string>',
    keywords: [{text: '<string>'}],
    ad: {
      headlines: ['<string>'],
      descriptions: ['<string>'],
      finalUrl: '<string>',
      path1: '<string>',
      path2: '<string>'
    },
    loginCustomerId: '<string>',
    targetCpa: 123,
    negativeKeywords: [{text: '<string>'}],
    startDate: '<string>',
    endDate: '<string>',
    exemptPolicyViolationKeys: [{policyName: '<string>', violatingText: '<string>'}],
    ignorablePolicyTopics: ['<string>'],
    autoExemptPolicyViolations: true,
    validateOnly: true
  })
};

fetch('https://api.sapt.ai/projects/{projectId}/google-ads/customers/{customerId}/campaigns/search', 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://api.sapt.ai/projects/{projectId}/google-ads/customers/{customerId}/campaigns/search",
  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>',
    'dailyBudget' => 123,
    'locations' => [
        '<string>'
    ],
    'languages' => [
        '<string>'
    ],
    'adGroupName' => '<string>',
    'keywords' => [
        [
                'text' => '<string>'
        ]
    ],
    'ad' => [
        'headlines' => [
                '<string>'
        ],
        'descriptions' => [
                '<string>'
        ],
        'finalUrl' => '<string>',
        'path1' => '<string>',
        'path2' => '<string>'
    ],
    'loginCustomerId' => '<string>',
    'targetCpa' => 123,
    'negativeKeywords' => [
        [
                'text' => '<string>'
        ]
    ],
    'startDate' => '<string>',
    'endDate' => '<string>',
    'exemptPolicyViolationKeys' => [
        [
                'policyName' => '<string>',
                'violatingText' => '<string>'
        ]
    ],
    'ignorablePolicyTopics' => [
        '<string>'
    ],
    'autoExemptPolicyViolations' => true,
    'validateOnly' => true
  ]),
  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 := "https://api.sapt.ai/projects/{projectId}/google-ads/customers/{customerId}/campaigns/search"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"dailyBudget\": 123,\n  \"locations\": [\n    \"<string>\"\n  ],\n  \"languages\": [\n    \"<string>\"\n  ],\n  \"adGroupName\": \"<string>\",\n  \"keywords\": [\n    {\n      \"text\": \"<string>\"\n    }\n  ],\n  \"ad\": {\n    \"headlines\": [\n      \"<string>\"\n    ],\n    \"descriptions\": [\n      \"<string>\"\n    ],\n    \"finalUrl\": \"<string>\",\n    \"path1\": \"<string>\",\n    \"path2\": \"<string>\"\n  },\n  \"loginCustomerId\": \"<string>\",\n  \"targetCpa\": 123,\n  \"negativeKeywords\": [\n    {\n      \"text\": \"<string>\"\n    }\n  ],\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"exemptPolicyViolationKeys\": [\n    {\n      \"policyName\": \"<string>\",\n      \"violatingText\": \"<string>\"\n    }\n  ],\n  \"ignorablePolicyTopics\": [\n    \"<string>\"\n  ],\n  \"autoExemptPolicyViolations\": true,\n  \"validateOnly\": true\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("https://api.sapt.ai/projects/{projectId}/google-ads/customers/{customerId}/campaigns/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"dailyBudget\": 123,\n  \"locations\": [\n    \"<string>\"\n  ],\n  \"languages\": [\n    \"<string>\"\n  ],\n  \"adGroupName\": \"<string>\",\n  \"keywords\": [\n    {\n      \"text\": \"<string>\"\n    }\n  ],\n  \"ad\": {\n    \"headlines\": [\n      \"<string>\"\n    ],\n    \"descriptions\": [\n      \"<string>\"\n    ],\n    \"finalUrl\": \"<string>\",\n    \"path1\": \"<string>\",\n    \"path2\": \"<string>\"\n  },\n  \"loginCustomerId\": \"<string>\",\n  \"targetCpa\": 123,\n  \"negativeKeywords\": [\n    {\n      \"text\": \"<string>\"\n    }\n  ],\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"exemptPolicyViolationKeys\": [\n    {\n      \"policyName\": \"<string>\",\n      \"violatingText\": \"<string>\"\n    }\n  ],\n  \"ignorablePolicyTopics\": [\n    \"<string>\"\n  ],\n  \"autoExemptPolicyViolations\": true,\n  \"validateOnly\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sapt.ai/projects/{projectId}/google-ads/customers/{customerId}/campaigns/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"dailyBudget\": 123,\n  \"locations\": [\n    \"<string>\"\n  ],\n  \"languages\": [\n    \"<string>\"\n  ],\n  \"adGroupName\": \"<string>\",\n  \"keywords\": [\n    {\n      \"text\": \"<string>\"\n    }\n  ],\n  \"ad\": {\n    \"headlines\": [\n      \"<string>\"\n    ],\n    \"descriptions\": [\n      \"<string>\"\n    ],\n    \"finalUrl\": \"<string>\",\n    \"path1\": \"<string>\",\n    \"path2\": \"<string>\"\n  },\n  \"loginCustomerId\": \"<string>\",\n  \"targetCpa\": 123,\n  \"negativeKeywords\": [\n    {\n      \"text\": \"<string>\"\n    }\n  ],\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"exemptPolicyViolationKeys\": [\n    {\n      \"policyName\": \"<string>\",\n      \"violatingText\": \"<string>\"\n    }\n  ],\n  \"ignorablePolicyTopics\": [\n    \"<string>\"\n  ],\n  \"autoExemptPolicyViolations\": true,\n  \"validateOnly\": true\n}"

response = http.request(request)
puts response.read_body

{
  "campaignResourceName": "<string>",
  "validateOnly": true,
  "appliedPolicyExemptions": [
    {
      "policyName": "<string>",
      "violatingText": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

POST

projects

{projectId}

google-ads

customers

{customerId}

campaigns

Create Google Ads Search campaign

curl --request POST \
  --url https://api.sapt.ai/projects/{projectId}/google-ads/customers/{customerId}/campaigns/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "dailyBudget": 123,
  "locations": [
    "<string>"
  ],
  "languages": [
    "<string>"
  ],
  "adGroupName": "<string>",
  "keywords": [
    {
      "text": "<string>"
    }
  ],
  "ad": {
    "headlines": [
      "<string>"
    ],
    "descriptions": [
      "<string>"
    ],
    "finalUrl": "<string>",
    "path1": "<string>",
    "path2": "<string>"
  },
  "loginCustomerId": "<string>",
  "targetCpa": 123,
  "negativeKeywords": [
    {
      "text": "<string>"
    }
  ],
  "startDate": "<string>",
  "endDate": "<string>",
  "exemptPolicyViolationKeys": [
    {
      "policyName": "<string>",
      "violatingText": "<string>"
    }
  ],
  "ignorablePolicyTopics": [
    "<string>"
  ],
  "autoExemptPolicyViolations": true,
  "validateOnly": true
}
'

import requests

url = "https://api.sapt.ai/projects/{projectId}/google-ads/customers/{customerId}/campaigns/search"

payload = {
    "name": "<string>",
    "dailyBudget": 123,
    "locations": ["<string>"],
    "languages": ["<string>"],
    "adGroupName": "<string>",
    "keywords": [{ "text": "<string>" }],
    "ad": {
        "headlines": ["<string>"],
        "descriptions": ["<string>"],
        "finalUrl": "<string>",
        "path1": "<string>",
        "path2": "<string>"
    },
    "loginCustomerId": "<string>",
    "targetCpa": 123,
    "negativeKeywords": [{ "text": "<string>" }],
    "startDate": "<string>",
    "endDate": "<string>",
    "exemptPolicyViolationKeys": [
        {
            "policyName": "<string>",
            "violatingText": "<string>"
        }
    ],
    "ignorablePolicyTopics": ["<string>"],
    "autoExemptPolicyViolations": True,
    "validateOnly": True
}
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>',
    dailyBudget: 123,
    locations: ['<string>'],
    languages: ['<string>'],
    adGroupName: '<string>',
    keywords: [{text: '<string>'}],
    ad: {
      headlines: ['<string>'],
      descriptions: ['<string>'],
      finalUrl: '<string>',
      path1: '<string>',
      path2: '<string>'
    },
    loginCustomerId: '<string>',
    targetCpa: 123,
    negativeKeywords: [{text: '<string>'}],
    startDate: '<string>',
    endDate: '<string>',
    exemptPolicyViolationKeys: [{policyName: '<string>', violatingText: '<string>'}],
    ignorablePolicyTopics: ['<string>'],
    autoExemptPolicyViolations: true,
    validateOnly: true
  })
};

fetch('https://api.sapt.ai/projects/{projectId}/google-ads/customers/{customerId}/campaigns/search', 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://api.sapt.ai/projects/{projectId}/google-ads/customers/{customerId}/campaigns/search",
  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>',
    'dailyBudget' => 123,
    'locations' => [
        '<string>'
    ],
    'languages' => [
        '<string>'
    ],
    'adGroupName' => '<string>',
    'keywords' => [
        [
                'text' => '<string>'
        ]
    ],
    'ad' => [
        'headlines' => [
                '<string>'
        ],
        'descriptions' => [
                '<string>'
        ],
        'finalUrl' => '<string>',
        'path1' => '<string>',
        'path2' => '<string>'
    ],
    'loginCustomerId' => '<string>',
    'targetCpa' => 123,
    'negativeKeywords' => [
        [
                'text' => '<string>'
        ]
    ],
    'startDate' => '<string>',
    'endDate' => '<string>',
    'exemptPolicyViolationKeys' => [
        [
                'policyName' => '<string>',
                'violatingText' => '<string>'
        ]
    ],
    'ignorablePolicyTopics' => [
        '<string>'
    ],
    'autoExemptPolicyViolations' => true,
    'validateOnly' => true
  ]),
  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 := "https://api.sapt.ai/projects/{projectId}/google-ads/customers/{customerId}/campaigns/search"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"dailyBudget\": 123,\n  \"locations\": [\n    \"<string>\"\n  ],\n  \"languages\": [\n    \"<string>\"\n  ],\n  \"adGroupName\": \"<string>\",\n  \"keywords\": [\n    {\n      \"text\": \"<string>\"\n    }\n  ],\n  \"ad\": {\n    \"headlines\": [\n      \"<string>\"\n    ],\n    \"descriptions\": [\n      \"<string>\"\n    ],\n    \"finalUrl\": \"<string>\",\n    \"path1\": \"<string>\",\n    \"path2\": \"<string>\"\n  },\n  \"loginCustomerId\": \"<string>\",\n  \"targetCpa\": 123,\n  \"negativeKeywords\": [\n    {\n      \"text\": \"<string>\"\n    }\n  ],\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"exemptPolicyViolationKeys\": [\n    {\n      \"policyName\": \"<string>\",\n      \"violatingText\": \"<string>\"\n    }\n  ],\n  \"ignorablePolicyTopics\": [\n    \"<string>\"\n  ],\n  \"autoExemptPolicyViolations\": true,\n  \"validateOnly\": true\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("https://api.sapt.ai/projects/{projectId}/google-ads/customers/{customerId}/campaigns/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"dailyBudget\": 123,\n  \"locations\": [\n    \"<string>\"\n  ],\n  \"languages\": [\n    \"<string>\"\n  ],\n  \"adGroupName\": \"<string>\",\n  \"keywords\": [\n    {\n      \"text\": \"<string>\"\n    }\n  ],\n  \"ad\": {\n    \"headlines\": [\n      \"<string>\"\n    ],\n    \"descriptions\": [\n      \"<string>\"\n    ],\n    \"finalUrl\": \"<string>\",\n    \"path1\": \"<string>\",\n    \"path2\": \"<string>\"\n  },\n  \"loginCustomerId\": \"<string>\",\n  \"targetCpa\": 123,\n  \"negativeKeywords\": [\n    {\n      \"text\": \"<string>\"\n    }\n  ],\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"exemptPolicyViolationKeys\": [\n    {\n      \"policyName\": \"<string>\",\n      \"violatingText\": \"<string>\"\n    }\n  ],\n  \"ignorablePolicyTopics\": [\n    \"<string>\"\n  ],\n  \"autoExemptPolicyViolations\": true,\n  \"validateOnly\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sapt.ai/projects/{projectId}/google-ads/customers/{customerId}/campaigns/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"dailyBudget\": 123,\n  \"locations\": [\n    \"<string>\"\n  ],\n  \"languages\": [\n    \"<string>\"\n  ],\n  \"adGroupName\": \"<string>\",\n  \"keywords\": [\n    {\n      \"text\": \"<string>\"\n    }\n  ],\n  \"ad\": {\n    \"headlines\": [\n      \"<string>\"\n    ],\n    \"descriptions\": [\n      \"<string>\"\n    ],\n    \"finalUrl\": \"<string>\",\n    \"path1\": \"<string>\",\n    \"path2\": \"<string>\"\n  },\n  \"loginCustomerId\": \"<string>\",\n  \"targetCpa\": 123,\n  \"negativeKeywords\": [\n    {\n      \"text\": \"<string>\"\n    }\n  ],\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"exemptPolicyViolationKeys\": [\n    {\n      \"policyName\": \"<string>\",\n      \"violatingText\": \"<string>\"\n    }\n  ],\n  \"ignorablePolicyTopics\": [\n    \"<string>\"\n  ],\n  \"autoExemptPolicyViolations\": true,\n  \"validateOnly\": true\n}"

response = http.request(request)
puts response.read_body

{
  "campaignResourceName": "<string>",
  "validateOnly": true,
  "appliedPolicyExemptions": [
    {
      "policyName": "<string>",
      "violatingText": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

Authorizations

Authorization

string

header

required

JWT token obtained from /api/auth/token endpoint. Token is verified using JWKS and must include a valid user identifier.

Path Parameters

projectId

string<uuid>

required

customerId

string

required

Minimum string length: 1

Body

application/json

name

string

required

Required string length: 1 - 255

dailyBudget

number

required

biddingStrategy

enum<string>

required

Available options:

MAXIMIZE_CONVERSIONS,

MAXIMIZE_CLICKS,

MANUAL_CPC,

TARGET_CPA

locations

string[]

required

languages

string[]

required

adGroupName

string

required

Required string length: 1 - 255

keywords

object[]

required

Show child attributes

object

required

Show child attributes

status

enum<string>

Available options:

ENABLED,

PAUSED

targetCpa

number

negativeKeywords

object[]

Show child attributes

startDate

string

Pattern: ^\d{4}-\d{2}-\d{2}$

endDate

string

Pattern: ^\d{4}-\d{2}-\d{2}$

exemptPolicyViolationKeys

object[]

Show child attributes

ignorablePolicyTopics

string[]

Minimum string length: 1

autoExemptPolicyViolations

boolean

validateOnly

boolean

Response

Success

campaignResourceName

string

required

validateOnly

boolean

required

appliedPolicyExemptions

object[]

Show child attributes

Agents

Auth

CMS

Assets

Memory

Actions

Schedules

Contracts

Emails

Invitations

Projects

Integrations

Conversions

CRM

Calendar

Google Ads

Geo

Workflows

OAuth Clients

Project Roles

Project Templates

Dashboard Sidebar

Service Accounts

Google Analytics

Google Business

Socials

Ads

Team

Users

Web Analytics

Create Google Ads Search campaign

Authorizations

Path Parameters

Body

Response