Play methods: apply
The Play Verbs apply as typed SDK methods, with inputs, result, refusals and an example.
Reference for Play, one group of Play methods.
Play.apply
Apply runs a Play across a Portfolio cohort, one wave at a time, measured as an Experiment. Verb page.
interface PlayVerbs {
apply(input: PlayApplyInput, options?: SB.CallOptions): SB.Call<PlayApplyOutput>
}Emits Play.applied.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
play | Play | required | The Play to run. |
cohort | string | required | The Portfolio query that selects the Startups. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
experiment | Experiment | required | The Experiment that measures the rollout. |
play | Play | required | The Play applied. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The input does not match the schema of the operation. | invalid-input | Read the schema of the operation, then send every required field with the right type. | None. |
| 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
import { $ } from 'startup-builder'
const { experiment, play } = await $.Play.apply({ play: 'play_hr4WTcrAyZ', cohort: 'Example cohort' })