Method: advertisers.channels.sites.list

  • Display & Video 360 API v1 has been sunset.

  • This document details the sites.list method which retrieves a list of sites within a specified channel.

  • The request uses a GET method with a URL structure incorporating advertiser and channel IDs.

  • Filtering and ordering of results are possible using query parameters such as filter and orderBy.

  • The response contains an instance of ListSitesResponse and requires the https://www.googleapis.com/auth/display-video authorization scope.

Lists sites in a channel.

HTTP request

GET https://displayvideo.googleapis.com/v1/advertisers/{advertiserId}/channels/{channelId}/sites

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
channelId

string (int64 format)

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

string (int64 format)

The ID of the advertiser that owns the parent channel.

Query parameters

Parameters
pageSize

integer

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.
pageToken

string

A token identifying a page of results the server should return.

Typically, this is the value of nextPageToken returned from the previous call to sites.list method. If not specified, the first page of results will be returned.
orderBy

string

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.
filter

string

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.
partnerId

string (int64 format)

The ID of the partner that owns the parent channel.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ListSitesResponse.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/display-video

For more information, see the OAuth 2.0 Overview.