v7 - Advertiser - Demo Endpoints

Create a campaign, with automatic targeting, manual bidding by keyword and status ENABLED

Creates a campaign with automatic targeting, manual bidding and status ENABLED.

POST /advertiser-demo/sponsored-products/campaigns

  • Request

  • Response

Accept: application/vnd.advertiser.v7+json
Content-Type: application/vnd.advertiser.v7+json
Authorization: Bearer token (omitted)

{
  "name" : "Campaign 003",
  "startDate" : "2022-01-01",
  "endDate" : "2022-12-31",
  "state" : "ENABLED",
  "targetingType" : "AUTO",
  "dailyBudget" : 13.0,
  "totalBudget" : 397.0,
  "countries" : [ {
    "countryCode" : "BE"
  } ],
  "bidding" : {
    "strategy" : "MANUAL_BY_KEYWORD",
    "defaultBid" : 1
  }
}

Content-Type: application/vnd.advertiser.v7+json

Status: 202 ACCEPTED

{
  "processStatusId" : "1",
  "eventType" : "CREATE_CAMPAIGN",
  "description" : "Create a campaign.",
  "status" : "PENDING",
  "createTimestamp" : "2021-10-14T09:51:35+02:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}

Create a campaign, with automatic targeting, automatic bidding and status ENABLED

Creates a campaign with automatic targeting, automatic bidding and status ENABLED.

POST /advertiser-demo/sponsored-products/campaigns

  • Request

  • Response

Accept: application/vnd.advertiser.v7+json
Content-Type: application/vnd.advertiser.v7+json
Authorization: Bearer token (omitted)

{
  "name" : "Campaign 001.",
  "startDate" : "2022-01-01",
  "endDate" : "2022-12-31",
  "state" : "ENABLED",
  "targetingType" : "AUTO",
  "dailyBudget" : 15.0,
  "totalBudget" : 395.0,
  "countries" : [ {
    "countryCode" : "NL"
  }, {
    "countryCode" : "BE"
  } ],
  "bidding" : {
    "strategy" : "AUTO",
    "automaticBidDesiredAcosPercentage" : 15
  }
}

Content-Type: application/vnd.advertiser.v7+json

Status: 202 ACCEPTED

{
  "processStatusId" : "1",
  "eventType" : "CREATE_CAMPAIGN",
  "description" : "Create a campaign.",
  "status" : "PENDING",
  "createTimestamp" : "2021-10-14T09:51:35+02:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}

Create a campaign, with manual targeting, automatic bidding and status ENABLED

Creates a campaign with manual targeting, automatic bidding and status ENABLED.

POST /advertiser-demo/sponsored-products/campaigns

  • Request

  • Response

Accept: application/vnd.advertiser.v7+json
Content-Type: application/vnd.advertiser.v7+json
Authorization: Bearer token (omitted)

{
  "name" : "Campaign 004",
  "startDate" : "2022-01-01",
  "endDate" : "2022-12-31",
  "state" : "ENABLED",
  "targetingType" : "MANUAL",
  "dailyBudget" : 14.0,
  "totalBudget" : 399.0,
  "countries" : [ {
    "countryCode" : "NL"
  }, {
    "countryCode" : "BE"
  } ],
  "bidding" : {
    "strategy" : "AUTO",
    "automaticBidDesiredAcosPercentage" : 19
  }
}

Content-Type: application/vnd.advertiser.v7+json

Status: 202 ACCEPTED

{
  "processStatusId" : "1",
  "eventType" : "CREATE_CAMPAIGN",
  "description" : "Create a campaign.",
  "status" : "PENDING",
  "createTimestamp" : "2021-10-14T09:51:35+02:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}

Create a campaign, with manual targeting, automatic bidding and status PAUSED

Creates a campaign with manual targeting, automatic bidding and status PAUSED.

POST /advertiser-demo/sponsored-products/campaigns

  • Request

  • Response

Accept: application/vnd.advertiser.v7+json
Content-Type: application/vnd.advertiser.v7+json
Authorization: Bearer token (omitted)

{
  "name" : "Campaign 002",
  "startDate" : "2022-01-01",
  "endDate" : "2022-12-31",
  "state" : "PAUSED",
  "targetingType" : "MANUAL",
  "dailyBudget" : 14.0,
  "totalBudget" : 396.0,
  "countries" : [ {
    "countryCode" : "NL"
  } ],
  "bidding" : {
    "strategy" : "AUTO",
    "automaticBidDesiredAcosPercentage" : 10
  }
}

Content-Type: application/vnd.advertiser.v7+json

Status: 202 ACCEPTED

{
  "processStatusId" : "1",
  "eventType" : "CREATE_CAMPAIGN",
  "description" : "Create a campaign.",
  "status" : "PENDING",
  "createTimestamp" : "2021-10-14T09:51:35+02:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}

Get ad group performance results

Get the performance results of an ad group for a specific period.

GET /advertiser-demo/sponsored-products/ad-group-performance/777777?start-date=2021-08-24&end-date=2021-08-30

  • Request

  • Response

Accept: application/vnd.advertiser.v7+json
Content-Type: N/A
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.advertiser.v7+json

Status: 200 OK

{
  "adGroupPerformance" : [ {
    "date" : "2021-08-24",
    "adGroupId" : "777777",
    "adGroupName" : "My first ad group",
    "campaignId" : "774521",
    "impressions" : 100,
    "clicks" : 50,
    "ctr" : 0.5123,
    "conversions" : 20,
    "conversionRate" : 0.4123,
    "sales" : 217.21,
    "conversionsOtherEan" : 2,
    "salesOtherEan" : 3.99,
    "spent" : 16.51,
    "cpc" : 0.33,
    "acos" : 0.0761,
    "roas" : 13.1612
  }, {
    "date" : "2021-08-25",
    "adGroupId" : "777777",
    "adGroupName" : "My first ad group",
    "campaignId" : "774521",
    "impressions" : 20,
    "clicks" : 10,
    "ctr" : 0.5123,
    "conversions" : 4,
    "conversionRate" : 0.4123,
    "sales" : 43.44,
    "conversionsOtherEan" : 2,
    "salesOtherEan" : 3.99,
    "spent" : 3.31,
    "cpc" : 0.33,
    "acos" : 0.0761,
    "roas" : 13.1612
  }, {
    "date" : "2021-08-26",
    "adGroupId" : "777777",
    "adGroupName" : "My first ad group",
    "campaignId" : "774521",
    "impressions" : 80,
    "clicks" : 40,
    "ctr" : 0.5123,
    "conversions" : 16,
    "conversionRate" : 0.4123,
    "sales" : 173.76,
    "conversionsOtherEan" : 2,
    "salesOtherEan" : 3.99,
    "spent" : 13.21,
    "cpc" : 0.33,
    "acos" : 0.0761,
    "roas" : 13.1612
  }, {
    "date" : "2021-08-27",
    "adGroupId" : "777777",
    "adGroupName" : "My first ad group",
    "campaignId" : "774521",
    "impressions" : 100,
    "clicks" : 50,
    "ctr" : 0.5123,
    "conversions" : 20,
    "conversionRate" : 0.4123,
    "sales" : 217.21,
    "conversionsOtherEan" : 2,
    "salesOtherEan" : 3.99,
    "spent" : 16.51,
    "cpc" : 0.33,
    "acos" : 0.0761,
    "roas" : 13.1612
  }, {
    "date" : "2021-08-28",
    "adGroupId" : "777777",
    "adGroupName" : "My first ad group",
    "campaignId" : "774521",
    "impressions" : 100,
    "clicks" : 50,
    "ctr" : 0.5123,
    "conversions" : 20,
    "conversionRate" : 0.4123,
    "sales" : 217.21,
    "conversionsOtherEan" : 2,
    "salesOtherEan" : 3.99,
    "spent" : 16.51,
    "cpc" : 0.33,
    "acos" : 0.0761,
    "roas" : 13.1612
  }, {
    "date" : "2021-08-29",
    "adGroupId" : "777777",
    "adGroupName" : "My first ad group",
    "campaignId" : "774521",
    "impressions" : 100,
    "clicks" : 50,
    "ctr" : 0.5123,
    "conversions" : 20,
    "conversionRate" : 0.4123,
    "sales" : 217.21,
    "conversionsOtherEan" : 2,
    "salesOtherEan" : 3.99,
    "spent" : 16.51,
    "cpc" : 0.33,
    "acos" : 0.0761,
    "roas" : 13.1612
  }, {
    "date" : "2021-08-30",
    "adGroupId" : "777777",
    "adGroupName" : "My first ad group",
    "campaignId" : "774521",
    "impressions" : 100,
    "clicks" : 50,
    "ctr" : 0.5123,
    "conversions" : 20,
    "conversionRate" : 0.4123,
    "sales" : 217.21,
    "conversionsOtherEan" : 2,
    "salesOtherEan" : 3.99,
    "spent" : 16.51,
    "cpc" : 0.33,
    "acos" : 0.0761,
    "roas" : 13.1612
  } ]
}

Get advertiser performance results

Get the total performance results of all campaigns for the period requested.

GET /advertiser-demo/sponsored-products/advertiser-performance?start-date=2021-08-24&end-date=2021-08-31

  • Request

  • Response

Accept: application/vnd.advertiser.v7+json
Content-Type: N/A
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.advertiser.v7+json

Status: 200 OK

{
  "advertiserPerformance" : [ {
    "date" : "2021-08-24",
    "impressions" : 10,
    "clicks" : 5,
    "ctr" : 0.5123,
    "conversions" : 2,
    "conversionRate" : 0.4123,
    "spent" : 1.65,
    "cpc" : 0.33,
    "acos" : 0.0761
  }, {
    "date" : "2021-08-25",
    "impressions" : 20,
    "clicks" : 10,
    "ctr" : 0.5123,
    "conversions" : 4,
    "conversionRate" : 0.4123,
    "spent" : 3.31,
    "cpc" : 0.33,
    "acos" : 0.0761
  }, {
    "date" : "2021-08-26",
    "impressions" : 90,
    "clicks" : 45,
    "ctr" : 0.5123,
    "conversions" : 18,
    "conversionRate" : 0.4123,
    "spent" : 14.85,
    "cpc" : 0.33,
    "acos" : 0.0761
  }, {
    "date" : "2021-08-27",
    "impressions" : 170,
    "clicks" : 85,
    "ctr" : 0.5123,
    "conversions" : 34,
    "conversionRate" : 0.4123,
    "spent" : 28.05,
    "cpc" : 0.33,
    "acos" : 0.0761
  } ]
}

Get campaign performance results

Get the performance results of a campaign for the period requested.

GET /advertiser-demo/sponsored-products/campaign-performance/774521?start-date=2021-08-24&end-date=2021-08-31

  • Request

  • Response

Accept: application/vnd.advertiser.v7+json
Content-Type: N/A
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.advertiser.v7+json

Status: 200 OK

{
  "campaignPerformance" : [ {
    "date" : "2021-08-24",
    "campaignId" : "774521",
    "campaignName" : "My first sponsored-products campaign",
    "impressions" : 20,
    "clicks" : 10,
    "ctr" : 0.5123,
    "conversions" : 4,
    "conversionRate" : 0.4123,
    "sales" : 43.44,
    "conversionsOtherEan" : 1,
    "salesOtherEan" : 1.95,
    "spent" : 3.31,
    "cpc" : 0.33,
    "acos" : 0.0761,
    "roas" : 13.1612
  }, {
    "date" : "2021-08-26",
    "campaignId" : "774521",
    "campaignName" : "My first sponsored-products campaign",
    "impressions" : 80,
    "clicks" : 40,
    "ctr" : 0.5123,
    "conversions" : 16,
    "conversionRate" : 0.4123,
    "sales" : 173.76,
    "conversionsOtherEan" : 1,
    "salesOtherEan" : 1.95,
    "spent" : 13.21,
    "cpc" : 0.33,
    "acos" : 0.0761,
    "roas" : 13.1612
  }, {
    "date" : "2021-08-27",
    "campaignId" : "774521",
    "campaignName" : "My first sponsored-products campaign",
    "impressions" : 110,
    "clicks" : 55,
    "ctr" : 0.5123,
    "conversions" : 22,
    "conversionRate" : 0.4123,
    "sales" : 238.92,
    "conversionsOtherEan" : 1,
    "salesOtherEan" : 1.95,
    "spent" : 18.15,
    "cpc" : 0.33,
    "acos" : 0.0761,
    "roas" : 13.1612
  }, {
    "date" : "2021-08-28",
    "campaignId" : "774521",
    "campaignName" : "My first sponsored-products campaign",
    "impressions" : 110,
    "clicks" : 55,
    "ctr" : 0.5123,
    "conversions" : 22,
    "conversionRate" : 0.4123,
    "sales" : 238.92,
    "conversionsOtherEan" : 1,
    "salesOtherEan" : 1.95,
    "spent" : 18.15,
    "cpc" : 0.33,
    "acos" : 0.0761,
    "roas" : 13.1612
  }, {
    "date" : "2021-08-29",
    "campaignId" : "774521",
    "campaignName" : "My first sponsored-products campaign",
    "impressions" : 110,
    "clicks" : 55,
    "ctr" : 0.5123,
    "conversions" : 22,
    "conversionRate" : 0.4123,
    "sales" : 238.92,
    "conversionsOtherEan" : 1,
    "salesOtherEan" : 1.95,
    "spent" : 18.15,
    "cpc" : 0.33,
    "acos" : 0.0761,
    "roas" : 13.1612
  }, {
    "date" : "2021-08-30",
    "campaignId" : "774521",
    "campaignName" : "My first sponsored-products campaign",
    "impressions" : 110,
    "clicks" : 55,
    "ctr" : 0.5123,
    "conversions" : 22,
    "conversionRate" : 0.4123,
    "sales" : 238.92,
    "conversionsOtherEan" : 1,
    "salesOtherEan" : 1.95,
    "spent" : 18.15,
    "cpc" : 0.33,
    "acos" : 0.0761,
    "roas" : 13.1612
  } ]
}

Retrieve a list of campaigns

Retrieve a paginated list of campaigns.

GET /advertiser-demo/sponsored-products/campaigns?page=1

  • Request

  • Response

Accept: application/vnd.advertiser.v7+json
Content-Type: N/A
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.advertiser.v7+json

Status: 200 OK

{
  "campaigns" : [ {
    "campaignId" : "123456",
    "name" : "My first campaign.",
    "startDate" : "2022-01-01",
    "endDate" : "2022-12-31",
    "state" : "ENABLED",
    "targetingType" : "AUTO",
    "dailyBudget" : 15.99,
    "totalBudget" : 395.99,
    "countries" : [ {
      "countryCode" : "NL"
    }, {
      "countryCode" : "BE"
    } ],
    "bidding" : {
      "strategy" : "AUTO",
      "automaticBidDesiredAcosPercentage" : 15
    }
  }, {
    "campaignId" : "456789",
    "name" : "My second campaign.",
    "startDate" : "2021-10-01",
    "endDate" : "2021-12-31",
    "state" : "PAUSED",
    "targetingType" : "MANUAL",
    "dailyBudget" : 14.99,
    "totalBudget" : 396.99,
    "countries" : [ {
      "countryCode" : "NL"
    } ],
    "bidding" : {
      "strategy" : "AUTO",
      "automaticBidDesiredAcosPercentage" : 10
    }
  } ]
}

Get keywords performance results

Get the performance results of all the keywords within an ad group for the period requested.

GET /advertiser-demo/sponsored-products/keyword-performance/567890?start-date=2021-08-24&end-date=2021-08-30

  • Request

  • Response

Accept: application/vnd.advertiser.v7+json
Content-Type: N/A
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.advertiser.v7+json

Status: 200 OK

{
  "keywordPerformance" : [ {
    "campaignId" : "774521",
    "adGroupId" : "567890",
    "keywordId" : "111333",
    "keywordText" : "Stekkerdoos",
    "impressions" : 1234,
    "clicks" : 1234,
    "ctr" : 0.3112,
    "conversions" : 1234,
    "conversionRate" : 12.0,
    "spent" : 1234.99,
    "cpc" : 0.21,
    "acos" : 0.2111,
    "roas" : 0.2112,
    "averageWinningBid" : 0.21
  }, {
    "campaignId" : "774521",
    "adGroupId" : "567890",
    "keywordId" : "333111",
    "keywordText" : "Verlengsnoer",
    "impressions" : 1234,
    "clicks" : 1234,
    "ctr" : 0.3199,
    "conversions" : 1234,
    "conversionRate" : 12.0,
    "spent" : 1234.99,
    "cpc" : 0.21,
    "acos" : 0.5489,
    "roas" : 0.2199,
    "averageWinningBid" : 0.21
  }, {
    "campaignId" : "774521",
    "adGroupId" : "567890",
    "keywordId" : "111333",
    "keywordText" : "Stekkerdoos",
    "impressions" : 1234,
    "clicks" : 1234,
    "ctr" : 0.3112,
    "conversions" : 1234,
    "conversionRate" : 12.0,
    "spent" : 1234.99,
    "cpc" : 0.21,
    "acos" : 0.2111,
    "roas" : 0.2112,
    "averageWinningBid" : 0.21
  }, {
    "campaignId" : "774521",
    "adGroupId" : "567890",
    "keywordId" : "333111",
    "keywordText" : "Verlengsnoer",
    "impressions" : 1234,
    "clicks" : 1234,
    "ctr" : 0.3199,
    "conversions" : 1234,
    "conversionRate" : 12.0,
    "spent" : 1234.99,
    "cpc" : 0.21,
    "acos" : 0.5489,
    "roas" : 0.2199,
    "averageWinningBid" : 0.21
  }, {
    "campaignId" : "774521",
    "adGroupId" : "567890",
    "keywordId" : "111333",
    "keywordText" : "Stekkerdoos",
    "impressions" : 1234,
    "clicks" : 1234,
    "ctr" : 0.3112,
    "conversions" : 1234,
    "conversionRate" : 12.0,
    "spent" : 1234.99,
    "cpc" : 0.21,
    "acos" : 0.2111,
    "roas" : 0.2112,
    "averageWinningBid" : 0.21
  }, {
    "campaignId" : "774521",
    "adGroupId" : "567890",
    "keywordId" : "333111",
    "keywordText" : "Verlengsnoer",
    "impressions" : 1234,
    "clicks" : 1234,
    "ctr" : 0.3199,
    "conversions" : 1234,
    "conversionRate" : 12.0,
    "spent" : 1234.99,
    "cpc" : 0.21,
    "acos" : 0.5489,
    "roas" : 0.2199,
    "averageWinningBid" : 0.21
  }, {
    "campaignId" : "774521",
    "adGroupId" : "567890",
    "keywordId" : "333111",
    "keywordText" : "Verlengsnoer",
    "impressions" : 1234,
    "clicks" : 1234,
    "ctr" : 0.3199,
    "conversions" : 1234,
    "conversionRate" : 12.0,
    "spent" : 1234.99,
    "cpc" : 0.21,
    "acos" : 0.5489,
    "roas" : 0.2199,
    "averageWinningBid" : 0.21
  } ]
}

Get product performance results

Get the performance results of a product within an ad group for the period requested.

GET /advertiser-demo/sponsored-products/product-performance/754726?start-date=2021-08-24&end-date=2021-08-30

  • Request

  • Response

Accept: application/vnd.advertiser.v7+json
Content-Type: N/A
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.advertiser.v7+json

Status: 200 OK

{
  "productPerformance" : [ {
    "campaignId" : "774521",
    "adGroupId" : "754726",
    "targetProductId" : "124420484",
    "ean" : "8714612079508",
    "impressions" : 100,
    "clicks" : 50,
    "ctr" : 0.5648,
    "conversions" : 20,
    "conversionRate" : 0.4001,
    "sales" : 217,
    "conversionsOtherEan" : 3,
    "salesOtherEan" : 6.99,
    "spent" : 16.5,
    "cpc" : 0.33,
    "acos" : 0.0769,
    "roas" : 13.16
  }, {
    "campaignId" : "774521",
    "adGroupId" : "754726",
    "targetProductId" : "124420510",
    "ean" : "635292993862",
    "impressions" : 70,
    "clicks" : 35,
    "ctr" : 0.5654,
    "conversions" : 14,
    "conversionRate" : 0.4123,
    "sales" : 152,
    "conversionsOtherEan" : 3,
    "salesOtherEan" : 6.99,
    "spent" : 11.55,
    "cpc" : 0.33,
    "acos" : 0.0765,
    "roas" : 13.1698
  }, {
    "campaignId" : "774521",
    "adGroupId" : "754726",
    "targetProductId" : "124420382",
    "ean" : "7438253682606",
    "impressions" : 30,
    "clicks" : 15,
    "ctr" : 0.5789,
    "conversions" : 6,
    "conversionRate" : 0.4693,
    "sales" : 65,
    "conversionsOtherEan" : 7.99,
    "salesOtherEan" : 3.0,
    "spent" : 4.95,
    "cpc" : 0.33,
    "acos" : 0.0767,
    "roas" : 13.1697
  }, {
    "campaignId" : "774521",
    "adGroupId" : "754726",
    "targetProductId" : "124420484",
    "ean" : "8714612079508",
    "impressions" : 100,
    "clicks" : 50,
    "ctr" : 0.5648,
    "conversions" : 20,
    "conversionRate" : 0.4001,
    "sales" : 217,
    "conversionsOtherEan" : 3,
    "salesOtherEan" : 6.99,
    "spent" : 16.5,
    "cpc" : 0.33,
    "acos" : 0.0769,
    "roas" : 13.16
  }, {
    "campaignId" : "774521",
    "adGroupId" : "754726",
    "targetProductId" : "124420510",
    "ean" : "635292993862",
    "impressions" : 70,
    "clicks" : 35,
    "ctr" : 0.5654,
    "conversions" : 14,
    "conversionRate" : 0.4123,
    "sales" : 152,
    "conversionsOtherEan" : 3,
    "salesOtherEan" : 6.99,
    "spent" : 11.55,
    "cpc" : 0.33,
    "acos" : 0.0765,
    "roas" : 13.1698
  }, {
    "campaignId" : "774521",
    "adGroupId" : "754726",
    "targetProductId" : "124420382",
    "ean" : "7438253682606",
    "impressions" : 30,
    "clicks" : 15,
    "ctr" : 0.5789,
    "conversions" : 6,
    "conversionRate" : 0.4693,
    "sales" : 65,
    "conversionsOtherEan" : 7.99,
    "salesOtherEan" : 3.0,
    "spent" : 4.95,
    "cpc" : 0.33,
    "acos" : 0.0767,
    "roas" : 13.1697
  }, {
    "campaignId" : "774521",
    "adGroupId" : "754726",
    "targetProductId" : "124420484",
    "ean" : "8714612079508",
    "impressions" : 100,
    "clicks" : 50,
    "ctr" : 0.5648,
    "conversions" : 20,
    "conversionRate" : 0.4001,
    "sales" : 217,
    "conversionsOtherEan" : 3,
    "salesOtherEan" : 6.99,
    "spent" : 16.5,
    "cpc" : 0.33,
    "acos" : 0.0769,
    "roas" : 13.16
  } ]
}

Get search term performance results

Get the product performance results of all search terms within an ad group for the period requested.

GET /advertiser-demo/sponsored-products/search-term-performance/111777?start-date=2021-08-24&end-date=2021-08-30

  • Request

  • Response

Accept: application/vnd.advertiser.v7+json
Content-Type: N/A
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.advertiser.v7+json

Status: 200 OK

{
  "searchTermPerformance" : [ {
    "campaignId" : "774521",
    "adGroupId" : "111777",
    "keywordText" : "N/A",
    "searchTerm" : "HDMI",
    "impressions" : 40,
    "clicks" : 20,
    "ctr" : 0.5123,
    "conversions" : 8,
    "conversionRate" : 0.4123,
    "spent" : 6.61,
    "cpc" : 0.33,
    "acos" : 0.0761,
    "roas" : 13.1612,
    "averageWinningBid" : 0.33,
    "searchVolume" : 44,
    "keywordMatchType" : "N/A"
  }, {
    "campaignId" : "774521",
    "adGroupId" : "111777",
    "keywordText" : "N/A",
    "searchTerm" : "barbecueset",
    "impressions" : 100,
    "clicks" : 50,
    "ctr" : 0.5123,
    "conversions" : 20,
    "conversionRate" : 0.4123,
    "spent" : 16.51,
    "cpc" : 0.33,
    "acos" : 0.0761,
    "roas" : 13.1612,
    "averageWinningBid" : 0.33,
    "searchVolume" : 21,
    "keywordMatchType" : "N/A"
  }, {
    "campaignId" : "774521",
    "adGroupId" : "111777",
    "keywordText" : "N/A",
    "searchTerm" : "32gb",
    "impressions" : 20,
    "clicks" : 10,
    "ctr" : 0.5123,
    "conversions" : 4,
    "conversionRate" : 0.4123,
    "spent" : 3.31,
    "cpc" : 0.33,
    "acos" : 0.0761,
    "roas" : 13.1612,
    "averageWinningBid" : 0.33,
    "searchVolume" : 32,
    "keywordMatchType" : "N/A"
  }, {
    "campaignId" : "774521",
    "adGroupId" : "111777",
    "keywordText" : "N/A",
    "searchTerm" : "cryptex",
    "impressions" : 40,
    "clicks" : 20,
    "ctr" : 0.5123,
    "conversions" : 8,
    "conversionRate" : 0.4123,
    "spent" : 6.61,
    "cpc" : 0.33,
    "acos" : 0.0761,
    "roas" : 13.1612,
    "averageWinningBid" : 0.33,
    "searchVolume" : 44,
    "keywordMatchType" : "N/A"
  }, {
    "campaignId" : "774521",
    "adGroupId" : "111777",
    "keywordText" : "N/A",
    "searchTerm" : "usb",
    "impressions" : 10,
    "clicks" : 5,
    "ctr" : 0.5123,
    "conversions" : 2,
    "conversionRate" : 0.4123,
    "spent" : 1.65,
    "cpc" : 0.33,
    "acos" : 0.0761,
    "roas" : 13.1612,
    "averageWinningBid" : 0.33,
    "searchVolume" : 158,
    "keywordMatchType" : "N/A"
  }, {
    "campaignId" : "774521",
    "adGroupId" : "111777",
    "keywordText" : "N/A",
    "searchTerm" : "verstelbare",
    "impressions" : 30,
    "clicks" : 15,
    "ctr" : 0.5123,
    "conversions" : 6,
    "conversionRate" : 0.4123,
    "spent" : 4.95,
    "cpc" : 0.33,
    "acos" : 0.0761,
    "roas" : 13.1612,
    "averageWinningBid" : 0.33,
    "searchVolume" : 32,
    "keywordMatchType" : "N/A"
  }, {
    "campaignId" : "774521",
    "adGroupId" : "111777",
    "keywordText" : "N/A",
    "searchTerm" : "poot",
    "impressions" : 40,
    "clicks" : 20,
    "ctr" : 0.5123,
    "conversions" : 8,
    "conversionRate" : 0.4123,
    "spent" : 6.61,
    "cpc" : 0.33,
    "acos" : 0.0761,
    "roas" : 13.1612,
    "averageWinningBid" : 0.33,
    "searchVolume" : 44,
    "keywordMatchType" : "N/A"
  } ]
}

Retrieve a campaign by campaign id

Retrieves campaign information by using campaign id 123456.

GET /advertiser-demo/sponsored-products/campaigns/123456

  • Request

  • Response

Accept: application/vnd.advertiser.v7+json
Content-Type: N/A
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.advertiser.v7+json

Status: 200 OK

{
  "campaignId" : "123456",
  "name" : "My first campaign.",
  "startDate" : "2022-01-01",
  "endDate" : "2022-12-31",
  "state" : "ENABLED",
  "targetingType" : "AUTO",
  "dailyBudget" : 15.99,
  "totalBudget" : 395.99,
  "countries" : [ {
    "countryCode" : "NL"
  }, {
    "countryCode" : "BE"
  } ],
  "bidding" : {
    "strategy" : "AUTO",
    "automaticBidDesiredAcosPercentage" : 15
  }
}

Modify the state of an existing campaign

Modify the state of campaign with campaign id 123456 to "PAUSED".

PUT /advertiser-demo/sponsored-products/campaigns/123456

  • Request

  • Response

Accept: application/vnd.advertiser.v7+json
Content-Type: application/vnd.advertiser.v7+json
Authorization: Bearer token (omitted)

{
  "state" : "PAUSED"
}

Content-Type: application/vnd.advertiser.v7+json

Status: 202 ACCEPTED

{
  "processStatusId" : "1",
  "entityId" : "123456",
  "eventType" : "UPDATE_CAMPAIGN",
  "description" : "Update a campaign.",
  "status" : "PENDING",
  "createTimestamp" : "2021-10-14T09:51:35+02:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}