Skip to main content

A type that defines the keywords of the paged collection.

Types that use KeywordPagedCollectionResponse

Not used by any types.

Call that uses KeywordPagedCollectionResponse

GET
/ad_campaign/{campaign_id}/keyword

Fields

Field
Type
Description
href
string
The URI of the current page of results from the result set.
keywords
array of Keyword
This array contains all of the keywords that match the request criteria. Keywords will be sorted by adGroupId, regardless of whether you searched for keywords across the entire campaign, or if you searched for keywords within one or specific ad groups.
limit
integer
The number of keywords 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.

Max length: 2048
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.

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.

Max length: 2048
total
integer
The total number of keywords retrieved in the result set.

If no keywords are found, this field is returned with a value of 0.