Method: advertisers.channels.sites.bulkEdit

  • This document details the Bulk Edit Sites endpoint for the sunset Display & Video 360 API v3, and recommends using v4 instead.

  • The bulkEdit operation allows for the deletion and creation of multiple sites under a single channel using a POST request.

  • The request requires path parameters for channelId and a union parameter owner (either advertiserId or partnerId).

  • The request body contains lists for deletedSites (site URLs or app IDs) and createdSites (Site objects).

  • A successful response contains an instance of BulkEditSitesResponse and requires the https://www.googleapis.com/auth/display-video OAuth scope for authorization.

Bulk edits sites under a single channel.

The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites.

HTTP request

POST https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/channels/{channelId}/sites:bulkEdit

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
channelId

string (int64 format)

Required. The ID of the parent channel to which the sites belong.
Union parameter 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:
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 
{
  "deletedSites": [
    string
  ],
  "createdSites": [
    {
      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
deletedSites[]

string

The sites to delete in batch, specified as a list of site url_or_app_ids.
createdSites[]

object (Site)

The sites to create in batch, 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 BulkEditSitesResponse.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.