Site ads
Control and customize ad placements on your docs site.
Manage the advertisement strategy within your docs. You can specify ad placements, track usage, and adjust settings to best fit your organization's needs.
Updates the advertising configuration for a site, including the review status and topic category used to select relevant ads. This controls GitBook's monetization feature for sites opted into the ads program.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequiredPattern:
A unique entity identifier
^[a-zA-Z0-9_-]+$siteIdstringRequired
The unique id of the site
Body
statusstring · enumOptionalPossible values:
topicstring · enumOptionalPossible values:
Topic of the content
Responses
204
OK
post/orgs/{organizationId}/sites/{siteId}/ads
204
OK
No content
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pagestringOptional
Identifier of the page results to fetch.
limitnumber · max: 1000Optional
The number of results per page
statusstring · enumOptionalDefault:
Filter sites by their ads review status
in-reviewPossible values: Header parameters
X-GitBook-Partner-KeystringRequired
Responses
200
OK
application/json
countnumberOptional
Total count of objects in the list
get/ads/sites
200
OK
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
siteIdstringRequired
The unique id of the site
Header parameters
X-GitBook-Partner-KeystringRequired
Body
or
or
Responses
204
OK
patch/ads/sites/{siteId}
204
OK
No content
Last updated
Was this helpful?