keywords.set
Adds new negative and/or positive keywords to group.
If particular keyword from keywords array currently exists in the group:
* Cpc or url will be updated if provided in the keyword attributes
* If keyword is currently in removed state, It will be restored and set as Active
If cpc is not passed in the keyword attributes, group's default will be used.
Parameters
struct |
user { |
|
string |
session |
Session (as retrieved from client.loginByToken() )
|
int |
userId |
(optional) Managed user ID
|
|
} |
|
|
int |
groupId |
Id of the group to which the keywords will be set or created
|
array |
keywords ( |
|
struct |
{ |
|
string |
matchType |
Keyword match type:
-
broad :
Broad match; query must contain all words from keyword, in any order (default)
-
phrase :
Phrase match (`"keyword"`); keyword must match query with words in appropriate order
-
exact :
Exact match (`[keyword]`); keyword must match exactly entire query
|
int |
cpc |
(optional) (can be null) Keyword max cost per click (in halers), or use nil for the group default
|
string |
url |
(optional) (can be null) Target URL (or nil to set the no target URL, which is default)
|
|
} |
|
|
|
) |
|
|
bool |
removeOthers |
(optional) If set to True, remove all keywords (both negative and positive) from the group, that are not
|
Response
struct |
{ |
|
string |
statusMessage |
Status code description
|
string |
session |
Refreshed session
|
array |
keywordIds ( |
List of affected keyword IDs.
|
) |
|
|
array |
diagnostics ( |
(optional) Various diagnostics(warnings, errors, other information)
|
|
) |
|
|
|
} |
|
|
Response status codes:
List of all possible response status codes:
200: OK
206: Partially OK
301: User is serviced
400: Bad arguments
401: Invalid session
403: Access Denied
404: Not found
406: Bad values of attributes
413: Too many items requested.
429: Too many requests. Has to wait.
500: Server Error.
409: Conflict
Diagnostics:
List of all possible diagnostics:
floating_invalid_targeting
group_access_denied
keyword_cpc_is_too_low
keyword_cpc_out_of_range
keyword_duplicate
keyword_name_forbidden_chars
keyword_name_missing
keyword_name_too_long
keyword_name_with_too_many_words
keyword_url_is_not_url
not_allowed_for_campaign_type
simple_ads_invalid_targeting
user_access_denied