class PartnersChannelsSites extends Resource (View source)

The "sites" collection of methods.

Typical usage is:

 $displayvideoService = new Google\Service\DisplayVideo(...);
 $sites = $displayvideoService->partners_channels_sites;

Methods

bulkEdit(string $partnerId, string $channelId, BulkEditSitesRequest $postBody, array $optParams = [])

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. (sites.bulkEdit)

create(string $partnerId, string $channelId, Site $postBody, array $optParams = [])

Creates a site in a channel. (sites.create)

delete(string $partnerId, string $channelId, string $urlOrAppId, array $optParams = [])

Deletes a site from a channel. (sites.delete)

listPartnersChannelsSites(string $partnerId, string $channelId, array $optParams = [])

Lists sites in a channel. (sites.listPartnersChannelsSites)

replace(string $partnerId, string $channelId, ReplaceSitesRequest $postBody, array $optParams = [])

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. This method regularly experiences high latency. We recommend increasing your default timeout to avoid errors. (sites.replace)

Details

BulkEditSitesResponse bulkEdit(string $partnerId, string $channelId, BulkEditSitesRequest $postBody, array $optParams = [])

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. (sites.bulkEdit)

Parameters

string $partnerId

The ID of the partner that owns the parent channel.

string $channelId

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

BulkEditSitesRequest $postBody
array $optParams

Optional parameters.

Return Value

BulkEditSitesResponse

Exceptions

Exception

Site create(string $partnerId, string $channelId, Site $postBody, array $optParams = [])

Creates a site in a channel. (sites.create)

Parameters

string $partnerId

The ID of the partner that owns the parent channel.

string $channelId

Required. The ID of the parent channel in which the site will be created.

Site $postBody
array $optParams

Optional parameters.

Return Value

Site

Exceptions

Exception

DisplayvideoEmpty delete(string $partnerId, string $channelId, string $urlOrAppId, array $optParams = [])

Deletes a site from a channel. (sites.delete)

Parameters

string $partnerId

The ID of the partner that owns the parent channel.

string $channelId

Required. The ID of the parent channel to which the site belongs.

string $urlOrAppId

Required. The URL or app ID of the site to delete.

array $optParams

Optional parameters.

Return Value

DisplayvideoEmpty

Exceptions

Exception

ListSitesResponse listPartnersChannelsSites(string $partnerId, string $channelId, array $optParams = [])

Lists sites in a channel. (sites.listPartnersChannelsSites)

Parameters

string $partnerId

The ID of the partner that owns the parent channel.

string $channelId

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

array $optParams

Optional parameters.

Return Value

ListSitesResponse

Exceptions

Exception

ReplaceSitesResponse replace(string $partnerId, string $channelId, ReplaceSitesRequest $postBody, array $optParams = [])

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. This method regularly experiences high latency. We recommend increasing your default timeout to avoid errors. (sites.replace)

Parameters

string $partnerId

The ID of the partner that owns the parent channel.

string $channelId

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

ReplaceSitesRequest $postBody
array $optParams

Optional parameters.

Return Value

ReplaceSitesResponse

Exceptions

Exception