v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13177414729.5 KB
advertisers

Lists sites in a channel.

get/v4/advertisers/{+advertiserId}/channels/{+channelId}/sites

Path parameters

advertiserIdstring required

The ID of the advertiser that owns the parent channel.

channelIdstring required

Required. The ID of the parent channel to which the requested sites belong.

Query parameters

filterstring

Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of {field} {operator} {value}. * All fields must use the HAS (:) operator. Supported fields: * urlOrAppId Examples: * All sites for which the URL or app ID contains "google": urlOrAppId : "google" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

orderBystring

Field by which to sort the list. Acceptable values are: * urlOrAppId (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: urlOrAppId desc.

pageSizeinteger

Requested page size. Must be between 1 and 10000. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

pageTokenstring

A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListSites method. If not specified, the first page of results will be returned.

partnerIdstring

The ID of the partner that owns the parent channel.

Response

Successful response