Skip to main content

A container for the details of a paged collection of ad groups.

Note: This type only applies to the Cost Per Click (CPC) funding model; it does not apply to the Cost Per Sale (CPS) funding model.

Types that use AdGroupPagedCollectionResponse

Not used by any types.

Call that uses AdGroupPagedCollectionResponse

GET
/ad_campaign/{campaign_id}/ad_group

Fields

Field
Type
Description
adGroups
array of AdGroup
The details of existing ad groups, such as the name, ID, and status of the ad groups.
href
string
The URI of the current page of results from the result set.
limit
integer
The number of items returned on a single page from the result set. This value can be set in the request with the limit query parameter.
next
string
The call URI that can be used to retrieve the next page in the result set. This value is returned only if there is an additional page of results to display from the result set.
offset
integer
The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter.

Default: 0


Note: The items in a paginated result set use a zero-based list, where the first item in the list has an offset of 0.
prev
string
The call URI that can be used to retrieve the previous page in the result set. Basically, all of the request parameters will remain the same except the offset value, which will be decreased to retrieve the previous page of results.
total
integer
The total number of items retrieved in the result set.

Note: If no items are found, this field is returned with a value of 0.