API Endpoints
Ad-Group

/external/v2/advertisers/{advertiserId}/campaigns/{campaignId}/spa/ad-groups/{adGroupId}

PUT
https://<pcm-domain>/external/v2/advertisers/{advertiserId}/campaigns/{campaignId}/spa/ad-groups/{adGroupId}
Generated server url

Updates one or multiple attributes of a SPA ad group. Only the attributes to be updated need to be specified.

The ad group can be only associated to publishers the user has access to, publishers being associated to the advertiser of the ad group and publishers having a product feed in the market of the ad groups campaign. The eligible values for publisherId can be retrieved from the API endpoint GET /external/v2/advertisers/{advertiserId}/eligible/publisher-markets. Make sure to pass the query string parameter marketId representing the market of the ad groups campaign as well as adGroupType with value SPA.

The ad group can only target sites available for the ad groups publisher and campaigns market. The site must contain at least one SPA ad unit. Furthermore, the ad group can only target locations available in the site the ad group is targeting. The eligible values for targetingSiteIds and targetingLocations can be retrieved from the API endpoint GET /external/v2/advertisers/{advertiserId}/eligible/site-locations. Make sure to pass the query string parameter adGroupType with value SPA. By default, all eligible sites and locations being available at the time of the ad group creation are targeted.

Rules:

  • name of an ad group under a campaign must be unique.
  • startDate must be before endDate.
  • startDate must be a present or future date.
  • startDate can only be modified if the current start date is a future date.
  • budget must always be greater than equal to budgetSpent.
  • dailyBudget must always be less than or equal to budget.
  • dailyBudget must always be less than or equal to monthBudget.
  • dailyBudget must always be less than or equal to weeklyBudget.
  • weeklyBudget must always be less than or equal to budget.
  • weeklyBudget must always be less than or equal to monthBudget.
  • monthlyBudget must always be less than or equal to budget.

Note:

  • In order to drop endDate, dailyBudget, weeklyBudget or monthlyBudget explicitly set these fields to null in the request body.
Path Parameters
advertiserId
*
campaignId
*
adGroupId
*
Body Parameters
body
*
name
startDate
endDate
budget
dailyBudget
weeklyBudget
monthlyBudget
useDynamicBudget
status
targetedSiteIds
targetedLocations
defaultBid
Responses
200
OK
id
publisher
name
type
status
budget
budgetSpent
dailyBudget
weeklyBudget
monthlyBudget
useDynamicBudget
spendVelocity
startDate
endDate
targetedSiteIds
targetedLocations
defaultBid
modifiedAt
401
Unauthorized
403
Forbidden
404
Not Found
messages
422
Unprocessable Entity
messages