Version: Next

TaskPublicConfig

Public-facing display configuration of a task's public landing page.

The task is published when publishedAt is set and unpublished when it is null. The publishedAt field is read-only - use TaskClient.publish and TaskClient.unpublish to change the publication state.

Hierarchy

GeneratedTaskPublicConfig
- TaskPublicConfig

Added in 2.25.0

Index

Properties

optionalinheriteddatasetName

datasetName?: null | string

Name of the dataset from the Actor's dataset schema whose results are displayed. When null, the Actor's default dataset is used. That is, the only dataset the Actor declares, or the one named default when it declares several.

optionalinheriteddatasetView

datasetView?: null | string

Key of the dataset view from the Actor's dataset schema used to display results. Must be one of the views declared on the resolved dataset. You can't publish a task without it.

optionalinheritedinputSchemaFields

inputSchemaFields?: null | string[]

Names of the task input fields displayed on the public task page.

optionalreadonlyinheritedpublishedAt

publishedAt?: null | Date

Format: date-time

2025-06-16T09:20:45.777Z

Time when the task was published, or null if the task isn't published. This field is server-controlled. To publish or unpublish a task, use the Update task endpoint and set isPublic.

optionalinheritedseoDescription

seoDescription?: null | string

Description of the Actor task to display by search engines such as Google. Defaults to the task description. At most 160 characters.

optionalinheritedseoTitle

seoTitle?: null | string

Scrape data from a website

Name of the Actor task to display by search engines such as Google. Defaults to the task title. At most 60 characters.