Class AdvertisersResource.CampaignsResource

The "campaigns" collection of methods.

Inheritance

object

AdvertisersResource.CampaignsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.DisplayVideo.v3

Assembly: Google.Apis.DisplayVideo.v3.dll

Syntax

public class AdvertisersResource.CampaignsResource

Constructors

CampaignsResource(IClientService)

Constructs a new resource.

Declaration

public CampaignsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

TargetingTypes

Gets the TargetingTypes resource.

Declaration

public virtual AdvertisersResource.CampaignsResource.TargetingTypesResource TargetingTypes { get; }

Property Value

Type	Description
AdvertisersResource.CampaignsResource.TargetingTypesResource

Methods

Create(Campaign, long)

Creates a new campaign. Returns the newly created campaign if successful.

Declaration

public virtual AdvertisersResource.CampaignsResource.CreateRequest Create(Campaign body, long advertiserId)

Parameters

Type	Name	Description
Campaign	body	The body of the request.
long	advertiserId	Output only. The unique ID of the advertiser the campaign belongs to.

Returns

Type	Description
AdvertisersResource.CampaignsResource.CreateRequest

Delete(long, long)

Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to ENTITY_STATUS_ARCHIVED, to be able to delete it. This method regularly experiences high latency. We recommend increasing your default timeout to avoid errors.

Declaration

public virtual AdvertisersResource.CampaignsResource.DeleteRequest Delete(long advertiserId, long campaignId)

Parameters

Type	Name	Description
long	advertiserId	The ID of the advertiser this campaign belongs to.
long	campaignId	The ID of the campaign we need to delete.

Returns

Type	Description
AdvertisersResource.CampaignsResource.DeleteRequest

Get(long, long)

Gets a campaign.

Declaration

public virtual AdvertisersResource.CampaignsResource.GetRequest Get(long advertiserId, long campaignId)

Parameters

Type	Name	Description
long	advertiserId	Required. The ID of the advertiser this campaign belongs to.
long	campaignId	Required. The ID of the campaign to fetch.

Returns

Type	Description
AdvertisersResource.CampaignsResource.GetRequest

List(long)

Lists campaigns in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, campaigns with ENTITY_STATUS_ARCHIVED will not be included in the results.

Declaration

public virtual AdvertisersResource.CampaignsResource.ListRequest List(long advertiserId)

Parameters

Type	Name	Description
long	advertiserId	The ID of the advertiser to list campaigns for.

Returns

Type	Description
AdvertisersResource.CampaignsResource.ListRequest

ListAssignedTargetingOptions(long, long)

Lists assigned targeting options of a campaign across targeting types.

Declaration

public virtual AdvertisersResource.CampaignsResource.ListAssignedTargetingOptionsRequest ListAssignedTargetingOptions(long advertiserId, long campaignId)

Parameters

Type	Name	Description
long	advertiserId	Required. The ID of the advertiser the campaign belongs to.
long	campaignId	Required. The ID of the campaign to list assigned targeting options for.

Returns

Type	Description
AdvertisersResource.CampaignsResource.ListAssignedTargetingOptionsRequest

Patch(Campaign, long, long)

Updates an existing campaign. Returns the updated campaign if successful.

Declaration

public virtual AdvertisersResource.CampaignsResource.PatchRequest Patch(Campaign body, long advertiserId, long campaignId)

Parameters

Type	Name	Description
Campaign	body	The body of the request.
long	advertiserId	Output only. The unique ID of the advertiser the campaign belongs to.
long	campaignId	Output only. The unique ID of the campaign. Assigned by the system.

Returns

Type	Description
AdvertisersResource.CampaignsResource.PatchRequest