keywords.check
Check keywords attributes before updating a keyword or creating a new one.
You can not change name or matchType of an existing keyword (you can remove this keyword and create a new one).
Therefore if keyword definition in keywords array contains id - it cannot contain name or matchType.
Parameters
| struct |
user { |
|
| string |
session |
Session (as retrieved from client.loginByToken())
|
| int |
userId |
(optional) Managed user ID
|
|
} |
|
|
| array |
keywords ( |
|
| struct |
{ |
|
| long |
id |
(optional) Keyword ID, that will be updated (excludes: name, matchType)
|
| int |
groupId |
(optional) Group ID, where the keyword will be created (have to be set name and matchType fields)
|
| string |
name |
(optional) Keyword
|
| string |
matchType |
(optional) Keyword match type:
-
broad:
Broad match; query must contain all words from keyword, in any order
-
phrase:
Phrase match (`"keyword"`); keyword must match query with words in correct order
-
exact:
Exact match (`[keyword]`); keyword must match exactly entire query
|
| int |
cpc |
(optional) (can be null) Change keyword maximal CPC (in halers) or nil to use group default
|
| string |
url |
(optional) (can be null) Change (or unset if nil) keyword target URL
|
| string |
status |
(optional) Change keyword status: [default: active]
-
active:
Active (default for check create)
-
suspend:
Suspended
|
|
} |
|
|
|
) |
|
|
Response
| struct |
{ |
|
| string |
statusMessage |
Status code description
|
| string |
session |
Refreshed session
|
| array |
diagnostics ( |
(optional) Various diagnostics(warnings, errors, other information)
|
|
|
) |
|
|
|
} |
|
|
Response status codes:
List of all possible response status codes:
200: OK206: Partially OK301: User is serviced400: Bad arguments401: Invalid session403: Access Denied404: Not found406: Bad values of attributes413: Too many items requested.429: Too many requests. Has to wait.500: Server Error.409: Conflict
Diagnostics:
List of all possible diagnostics:
ambiguous_check: Some items contain keyword `id` and some `groupId` or for check `create` attributes `name` or `matchType` are missing! Can not recognize check category (create or update?)floating_invalid_targetinggroup_access_deniedkeyword_access_deniedkeyword_cpc_is_too_lowkeyword_cpc_out_of_rangekeyword_duplicatekeyword_name_forbidden_charskeyword_name_missingkeyword_name_too_longkeyword_name_with_too_many_wordskeyword_url_is_not_urlnot_allowed_for_campaign_typesimple_ads_invalid_targetinguser_access_denied
