patterns.check
Check patterns for create or update process.
Parameters
| struct |
user { |
|
| string |
session |
Session (as retrieved from client.loginByToken())
|
| int |
userId |
(optional) Managed user ID
|
|
} |
|
|
| array |
patterns ( |
|
| struct |
{ |
|
| int |
id |
Pattern id, that will be updated (excludes: groupId, pattern)
|
| int |
groupId |
Group id, where the pattern will be created (excludes: id)
|
| string |
pattern |
Pattern (excludes: id)
|
| int |
cpc |
(optional) (can be null) Change pattern maximal CPC (in halers) or nil to use group default
|
| int |
cpt |
(optional) (can be null) Change pattern maximal CPT (in halers) or nil to use group default
|
| string |
status |
(optional) Change pattern/set status:
-
active:
Active
-
suspend:
Suspended
|
|
} |
|
|
|
) |
|
|
Response
| struct |
{ |
|
| int |
status |
Status code (see bellow)
|
| string |
statusMessage |
Status code description
|
| string |
session |
(optional) 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:
cpt_too_highcpt_too_lowfloating_invalid_targetinggroup_access_deniedgroup_pattern_duplicity: Given patterns already exist in the same group.group_pattern_parameters_duplicity: Duplicate patterns for the same group in input parameters.not_allowed_for_campaign_typepattern_access_deniedpattern_cpc_is_too_lowpattern_cpc_out_of_rangepattern_id_parameters_duplicity: Pattern ID duplicity in input parameters.pattern_invalid_statuspattern_too_longpattern_value_invalidsimple_ads_invalid_targetinguser_access_denied
