keywords.campaign.negative.createReport
Create report for negative keywords linked to campaign.
Parameters
| struct |
user { |
|
| string |
session |
Session (as retrieved from client.loginByToken())
|
| int |
userId |
(optional) Managed user ID
|
|
} |
|
|
| struct |
restrictionFilter { |
(optiosnl)
|
| array |
ids ( |
(optional) display keyword by given ids
|
) |
|
|
| array |
names ( |
(optional) definition of searching in creative
|
| struct |
{ |
|
| string |
operator |
comparison for following operators:
-
CONTAINS:
contains
-
NOT_CONTAINS:
does not contain
-
PHRASE:
phrase (contain phrase)
-
NEGATIVE_PHRASE:
negative phrase(does not contain phrase)
-
STARTS_WITH:
starts with
-
NOT_STARTS_WITH:
does not start with
-
ENDS_WITH:
ends with
-
NOT_ENDS_WITH:
does not end with
|
|
} |
|
|
|
) |
|
|
| array |
matchType ( |
(optional) return only keywords with following states:
|
|
string
|
|
|
(optional) type of conformity:
-
negativeBroad:
Broad match; query must contain all words from keyword, in any order (default)
-
negativePhrase:
Phrase match (`"keyword"`); keyword must match query with words in correct order
-
negativeExact:
Exact match (`[keyword]`); keyword must match exactly entire query
|
|
) |
|
|
| bool |
isDeleted |
(optional) returns deleted/undeleted. If unassigned returns both.
|
| struct |
campaign { |
(optional) filters for superior campaign
|
| array |
ids ( |
(optional) display keywords from next campaigns (excludes: names)
|
|
|
) |
|
|
| array |
names ( |
(optional) definition of search in campaign names
|
| struct |
{ |
|
| string |
operator |
comparison for following operators:
|
|
} |
|
|
|
) |
|
|
| array |
status ( |
(optional) returns only keywords with following states of their campaigns:
|
|
|
) |
|
|
| array |
mixedStatus ( |
(optional) returns only keywords with following states of their campaigns
|
|
string
|
|
|
allowed states:
-
active:
active
-
active-exhausted_day_budget:
exhausted day budget
-
active-expired_budget:
expired budget
-
active-expired_clicks:
max number of clicks has been reached
-
active-expired_time:
outside time plan
-
active-low_budget:
low budget
-
active-waiting:
waiting for confirmation
-
suspended:
suspended by user
-
deleted:
deleted
|
|
) |
|
|
| bool |
isDeleted |
(optional) returns deleted/undeleted. If unassigned returns both.
|
|
} |
|
|
|
} |
|
|
Response
| struct |
{ |
|
| int |
reportId |
id of report
|
| long |
totalCount |
number of entities
|
| string |
statusMessage |
verbal description of return code
|
| 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:
campaign_no_accesscampaign_not_existdate_boundary_exceededkeyword_access_deniedmissing_attributeuser_access_deniedwrong_attribute_valuewrong_param_value
