Keyword methods: measure · StartupBuilder

Reference for Keyword, one group of Keyword methods.

Keyword.measure

Measure records a Keyword’s monthly search volume, difficulty, cost per click and trend in one locale. Verb page.

TypeScript

interface KeywordVerbs {
  measure(input: KeywordMeasureInput, options?: SB.CallOptions): SB.Call<Keyword>
}

Inputs

Input	Type	Required	Description
`keyword`	Keyword	required	The Keyword to measure.
`locale`	`string`		The market and language, such as `en-US`. Defaults to the Startup’s home Market.
`venue`	`string`		The search venue, such as `google-search`. Defaults to the largest one in the Market.

Returns

Output	Type	Required	Description
`keyword`	Keyword	required	The Keyword; each measure is a `Keyword.measured` Event with its method and observation time.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const keyword = await $.Keyword.measure({ keyword: 'keyword_cEoeFM4Drs' })