com.google.api.services.displayvideo.v4

Class DisplayVideo.Partners.Channels.Sites

java.lang.Object

com.google.api.services.displayvideo.v4.DisplayVideo.Partners.Channels.Sites

Enclosing class:

DisplayVideo.Partners.Channels

public class DisplayVideo.Partners.Channels.Sites
extends Object

The "sites" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DisplayVideo.Partners.Channels.Sites.BulkEdit
class	DisplayVideo.Partners.Channels.Sites.Create
class	DisplayVideo.Partners.Channels.Sites.Delete
class	DisplayVideo.Partners.Channels.Sites.List
class	DisplayVideo.Partners.Channels.Sites.Replace

Constructor Summary

Constructors

Constructor and Description
Sites()

Method Summary

Modifier and Type	Method and Description
DisplayVideo.Partners.Channels.Sites.BulkEdit	bulkEdit(Long partnerId, Long channelId, BulkEditSitesRequest content) Bulk edits sites under a single channel.
DisplayVideo.Partners.Channels.Sites.Create	create(Long partnerId, Long channelId, Site content) Creates a site in a channel.
DisplayVideo.Partners.Channels.Sites.Delete	delete(Long partnerId, Long channelId, String urlOrAppId) Deletes a site from a channel.
DisplayVideo.Partners.Channels.Sites.List	list(Long partnerId, Long channelId) Lists sites in a channel.
DisplayVideo.Partners.Channels.Sites.Replace	replace(Long partnerId, Long channelId, ReplaceSitesRequest content) Replaces all of the sites under a single channel.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Sites

public Sites()

Method Detail

bulkEdit

public DisplayVideo.Partners.Channels.Sites.BulkEdit bulkEdit(Long partnerId,
                                                              Long channelId,
                                                              BulkEditSitesRequest content)
                                                       throws IOException

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. Create a request for the method "sites.bulkEdit". This request holds the parameters needed by the displayvideo server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

partnerId - The ID of the partner that owns the parent channel.

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

content - the BulkEditSitesRequest

Returns:

the request

Throws:

IOException

create

public DisplayVideo.Partners.Channels.Sites.Create create(Long partnerId,
                                                          Long channelId,
                                                          Site content)
                                                   throws IOException

Creates a site in a channel. Create a request for the method "sites.create". This request holds the parameters needed by the displayvideo server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

partnerId - The ID of the partner that owns the parent channel.

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

content - the Site

Returns:

the request

Throws:

IOException

delete

public DisplayVideo.Partners.Channels.Sites.Delete delete(Long partnerId,
                                                          Long channelId,
                                                          String urlOrAppId)
                                                   throws IOException

Deletes a site from a channel. Create a request for the method "sites.delete". This request holds the parameters needed by the displayvideo server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

partnerId - The ID of the partner that owns the parent channel.

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

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

Returns:

the request

Throws:

IOException

list

public DisplayVideo.Partners.Channels.Sites.List list(Long partnerId,
                                                      Long channelId)
                                               throws IOException

Lists sites in a channel. Create a request for the method "sites.list". This request holds the parameters needed by the displayvideo server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

partnerId - The ID of the partner that owns the parent channel.

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

Returns:

the request

Throws:

IOException

replace

public DisplayVideo.Partners.Channels.Sites.Replace replace(Long partnerId,
                                                            Long channelId,
                                                            ReplaceSitesRequest content)
                                                     throws IOException

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](/display- video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors. Create a request for the method "sites.replace". This request holds the parameters needed by the displayvideo server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

partnerId - The ID of the partner that owns the parent channel.

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

content - the ReplaceSitesRequest

Returns:

the request

Throws:

IOException