com.google.api.services.displayvideo.v4

Class DisplayVideo.Advertisers.AdGroups

java.lang.Object

com.google.api.services.displayvideo.v4.DisplayVideo.Advertisers.AdGroups

Enclosing class:

DisplayVideo.Advertisers

public class DisplayVideo.Advertisers.AdGroups
extends Object

The "adGroups" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DisplayVideo.Advertisers.AdGroups.BulkEditAssignedTargetingOptions
class	DisplayVideo.Advertisers.AdGroups.BulkListAssignedTargetingOptions
class	DisplayVideo.Advertisers.AdGroups.Create
class	DisplayVideo.Advertisers.AdGroups.Delete
class	DisplayVideo.Advertisers.AdGroups.Get
class	DisplayVideo.Advertisers.AdGroups.List
class	DisplayVideo.Advertisers.AdGroups.Patch
class	DisplayVideo.Advertisers.AdGroups.TargetingTypes The "targetingTypes" collection of methods.
class	DisplayVideo.Advertisers.AdGroups.YoutubeAssetTypes The "youtubeAssetTypes" collection of methods.

Constructor Summary

Constructors

Constructor and Description
AdGroups()

Method Summary

Modifier and Type	Method and Description
DisplayVideo.Advertisers.AdGroups.BulkEditAssignedTargetingOptions	bulkEditAssignedTargetingOptions(Long advertiserId, BulkEditAdGroupAssignedTargetingOptionsRequest content) Bulk edits targeting options for multiple ad groups.
DisplayVideo.Advertisers.AdGroups.BulkListAssignedTargetingOptions	bulkListAssignedTargetingOptions(Long advertiserId) Lists assigned targeting options for multiple ad groups across targeting types.
DisplayVideo.Advertisers.AdGroups.Create	create(Long advertiserId, AdGroup content) Creates a new ad group.
DisplayVideo.Advertisers.AdGroups.Delete	delete(Long advertiserId, Long adGroupId) Deletes a AdGroup.
DisplayVideo.Advertisers.AdGroups.Get	get(Long advertiserId, Long adGroupId) Gets an ad group.
DisplayVideo.Advertisers.AdGroups.List	list(Long advertiserId) Lists ad groups.
DisplayVideo.Advertisers.AdGroups.Patch	patch(Long advertiserId, Long adGroupId, AdGroup content) Updates an existing ad group.
DisplayVideo.Advertisers.AdGroups.TargetingTypes	targetingTypes() An accessor for creating requests from the TargetingTypes collection.
DisplayVideo.Advertisers.AdGroups.YoutubeAssetTypes	youtubeAssetTypes() An accessor for creating requests from the YoutubeAssetTypes collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdGroups

public AdGroups()

Method Detail

bulkEditAssignedTargetingOptions

public DisplayVideo.Advertisers.AdGroups.BulkEditAssignedTargetingOptions bulkEditAssignedTargetingOptions(Long advertiserId,
                                                                                                           BulkEditAdGroupAssignedTargetingOptionsRequest content)
                                                                                                    throws IOException

Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users. Create a request for the method "adGroups.bulkEditAssignedTargetingOptions". 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:

advertiserId - Required. The ID of the advertiser the ad groups belong to.

content - the BulkEditAdGroupAssignedTargetingOptionsRequest

Returns:

the request

Throws:

IOException

bulkListAssignedTargetingOptions

public DisplayVideo.Advertisers.AdGroups.BulkListAssignedTargetingOptions bulkListAssignedTargetingOptions(Long advertiserId)
                                                                                                    throws IOException

Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included. Create a request for the method "adGroups.bulkListAssignedTargetingOptions". 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:

advertiserId - Required. The ID of the advertiser the line items belongs to.

Returns:

the request

Throws:

IOException

create

public DisplayVideo.Advertisers.AdGroups.Create create(Long advertiserId,
                                                       AdGroup content)
                                                throws IOException

Creates a new ad group. Returns the newly created ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users. Create a request for the method "adGroups.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:

advertiserId - Output only. The unique ID of the advertiser the ad group belongs to.

content - the AdGroup

Returns:

the request

Throws:

IOException

delete

public DisplayVideo.Advertisers.AdGroups.Delete delete(Long advertiserId,
                                                       Long adGroupId)
                                                throws IOException

Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users. Create a request for the method "adGroups.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:

advertiserId - Required. The ID of the advertiser this ad group belongs to.

adGroupId - Required. The ID of the ad group to delete.

Returns:

the request

Throws:

IOException

get

public DisplayVideo.Advertisers.AdGroups.Get get(Long advertiserId,
                                                 Long adGroupId)
                                          throws IOException

Gets an ad group. Create a request for the method "adGroups.get". 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:

advertiserId - Required. The ID of the advertiser this ad group belongs to.

adGroupId - Required. The ID of the ad group to fetch.

Returns:

the request

Throws:

IOException

list

public DisplayVideo.Advertisers.AdGroups.List list(Long advertiserId)
                                            throws IOException

Lists ad groups. Create a request for the method "adGroups.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:

advertiserId - Required. The ID of the advertiser the ad groups belongs to.

Returns:

the request

Throws:

IOException

patch

public DisplayVideo.Advertisers.AdGroups.Patch patch(Long advertiserId,
                                                     Long adGroupId,
                                                     AdGroup content)
                                              throws IOException

Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users. Create a request for the method "adGroups.patch". 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:

advertiserId - Output only. The unique ID of the advertiser the ad group belongs to.

adGroupId - Output only. The unique ID of the ad group. Assigned by the system.

content - the AdGroup

Returns:

the request

Throws:

IOException

targetingTypes

public DisplayVideo.Advertisers.AdGroups.TargetingTypes targetingTypes()

An accessor for creating requests from the TargetingTypes collection.

The typical use is:

    DisplayVideo displayvideo = new DisplayVideo(...);
    DisplayVideo.TargetingTypes.List request = displayvideo.targetingTypes().list(parameters ...)
 

Returns:

the resource collection

youtubeAssetTypes

public DisplayVideo.Advertisers.AdGroups.YoutubeAssetTypes youtubeAssetTypes()

An accessor for creating requests from the YoutubeAssetTypes collection.

The typical use is:

    DisplayVideo displayvideo = new DisplayVideo(...);
    DisplayVideo.YoutubeAssetTypes.List request = displayvideo.youtubeAssetTypes().list(parameters ...)
 

Returns:

the resource collection