Method: advertisers.channels.sites.replace

  • This documentation details the replaceSites method, which replaces all existing sites under a specific channel with new ones provided in the request.

  • The request requires the channelId and either the partnerId or advertiserId to identify the channel being modified.

  • A list of new sites must be included in the request body, adhering to the Site object structure.

  • Successful execution results in a ReplaceSitesResponse object in the response body.

  • The operation requires authorization with the https://www.googleapis.com/auth/display-video scope.

Replaces all of the sites under a single channel.

The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
channelId

string (int64 format)

Required. The ID of the parent channel whose sites will be replaced.
advertiserId

string (int64 format)

The ID of the advertiser that owns the parent channel.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "newSites": [
    {
      object (Site)
    }
  ],

  // Union field owner can be only one of the following:
  "partnerId": string
  // End of list of possible types for union field owner.
}
Fields
newSites[]

object (Site)

The sites that will replace the existing sites assigned to the channel, specified as a list of Sites.
Union field owner. Required. Identifies the DV360 entity that owns the parent channel. It can be either a partner or an advertiser. owner can be only one of the following:
partnerId

string (int64 format)

The ID of the partner that owns the parent channel.
advertiserId

string (int64 format)

The ID of the advertiser that owns the parent channel.

Response body

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

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.