Skip to main content
POST
/
api
/
v1
/
google-ads
/
positive-keywords
Add Positive Keyword
curl --request POST \
  --url http://localhost:8000/api/v1/google-ads/positive-keywords \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "<string>",
  "match_type": "EXACT",
  "campaign_id": 123
}
'
{
  "text": "<string>",
  "match_type": "EXACT",
  "id": 123,
  "ad_group": {
    "id": 123,
    "name": "<string>",
    "status": "<string>"
  },
  "campaign": {
    "id": 123,
    "name": "<string>",
    "status": "<string>",
    "channel_type": "SEARCH"
  },
  "user_provided_reason": "<string>"
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

customer_id
string
required

Body

application/json

Schema for adding a keyword

text
string
required

The keyword text

match_type
enum<string>
required

The match type of the keyword

Available options:
EXACT,
PHRASE,
BROAD,
BROAD_MODIFIER,
NEGATIVE
campaign_id
integer
required

Response

Successful Response

Schema for positive keyword data

text
string
required

The keyword text

match_type
enum<string>
required

The match type of the keyword

Available options:
EXACT,
PHRASE,
BROAD,
BROAD_MODIFIER,
NEGATIVE
id
integer
required

The ID of the positive keyword

ad_group
KeywordAdGroupSchema · object

Schema for ad group information related to a keyword

campaign
KeywordCampaignSchema · object

Schema for campaign information related to a keyword

user_provided_reason
string | null

The reason provided by the user for the positive keyword recommendation