Homepage
CommunityBlogLog inSign up

Ads

Manage advertisement settings and placements.

List all the sites with ads configured

get
Authorizations
Query parameters
pagestring

Identifier of the page results to fetch.

limitnumber · max: 1000

The number of results per page

statusstring · enum · default: "in-review"

Filter sites by their ads review status

Options: in-review, live, rejected
Header parameters
X-GitBook-Partner-Keystringrequired
Responses
curl -L \
  --url 'https://api.gitbook.com/v1/ads/sites' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'X-GitBook-Partner-Key: text'
{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "id": "text",
      "url": "text",
      "email": "text",
      "topic": "webdev",
      "status": "in-review"
    }
  ]
}

OK

Update the Ads configuration for a site

patch
Authorizations
Path parameters
siteIdstringrequired

The unique id of the site

Header parameters
X-GitBook-Partner-Keystringrequired
Body
one of

Responses
curl -L \
  --request PATCH \
  --url 'https://api.gitbook.com/v1/ads/sites/{siteId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'X-GitBook-Partner-Key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "live",
    "zoneId": "text",
    "reportingId": "text"
  }'
No body

OK

Was this helpful?