Keywords

SklikApi. Keywords

(private) new Keywords()

Methods

get(keywordIds) → {Object}

Gets details of keywords with specified IDs.

Parameters:
Name Type Description
keywordIds number | Array.<number>

ID of keyword or array with keyword IDs.
See:
Returns:

Keyword details.

Type
Object

list(restrictionFilter, listOptions) → {Object}

Lists keywords in the groups with specified IDs.

Parameters:
Name Type Description
restrictionFilter Object

List filter (group IDs etc.).
listOptions Object

Options of the list.

Properties
Name Type Description
onlyId boolean

Return only IDs of keywords.
See:
Returns:

List of keywords.

Type
Object

stats(keywordIds, params) → {Object}

Gets keyword statistics.

Parameters:
Name Type Description
keywordIds number | Array.<number>

ID of campaign or array with campaign IDs.
params Object

Parameters for the statistics report.
See:
Returns:

Campaign statistics.

Type
Object

suggest(query, restrictionFilteropt) → {Object}

Gets keyword suggestions.

Parameters:
Name Type Attributes Description
query string

Search query.
restrictionFilter Object <optional>

Suggestions limit, offset and ordering.
See:
Returns:

List of keyword suggestions.

Type
Object

suggest.stats(query) → {Object}

Gets statistics for given queries.

Example:

sklik.Keywords.suggest.stats(["ppc", "remarketing"]);
Parameters:
Name Type Description
query string | Array.<string>

List of search queries.
See:
Returns:

Search statistics for given queries.

Type
Object