Sklik API

Keywords

keywords.negative.createReport

Create report for negative keywords.

Parameters

struct user {
string session

Session (as retrieved from client.loginByToken())

int userId

(optional) Managed user ID

}
struct restrictionFilter {

(optional)

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
string value

value

}
)
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 group {

(optional) filters for superior group

array ids (

(optional) display kws from next groups (excludes: names)

int

group id

)
array names (

(optional) definition of searching in groups names

struct {
string operator

comparison for following operators:

string value

value

}
)
array mixedStatus (

(optional) return only keywords with following states of their groups:

string

states:

)
array status (

(optional) returns only keywords with following states of their groups:

string

states:

)
bool isDeleted

(optional) return deleted/undeleted. If unassigned returns both.

}
struct campaign {

(optional) filters for superior campaign

array ids (

(optional) display keywords from next campaigns (excludes: names)

int

campaign id

)
array names (

(optional) definition of search in campaign names

struct {
string operator

comparison for following operators:

string value

value

}
)
array status (

(optional) returns only keywords with following states of their campaigns:

string

states:

)
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

int status

return code

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)

struct {
...
}
)
}

Response status codes:

List of all possible response status codes:

Diagnostics:

List of all possible diagnostics:

Copyright © 1996-2024

www.seznam.cz Help Contact