campaigns

Overview

Name	campaigns
Type	Resource
Id	googledevelopers.displayvideo.campaigns

Fields

Name	Datatype	Description
name	string	Output only. The resource name of the campaign.
updateTime	string	Output only. The timestamp when the campaign was last updated. Assigned by the system.
campaignFlight	object	Settings that track the planned spend and duration of a campaign.
displayName	string	Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes.
campaignId	string	Output only. The unique ID of the campaign. Assigned by the system.
campaignGoal	object	Settings that control the goal of a campaign.
entityStatus	string	Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. Accepted values are ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED, and ENTITY_STATUS_PAUSED. For CreateCampaign method, ENTITY_STATUS_ARCHIVED is not allowed.
campaignBudgets	array	The list of budgets available to this campaign. If this field is not set, the campaign uses an unlimited budget.
frequencyCap	object	Settings that control the number of times a user may be shown with the same ad during a given time period.
advertiserId	string	Output only. The unique ID of the advertiser the campaign belongs to.

Methods

Name	Accessible by	Required Params	Description
advertisers_campaigns_get	SELECT	advertisersId, campaignsId	Gets a campaign.
advertisers_campaigns_list	SELECT	advertisersId	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.
advertisers_campaigns_create	INSERT	advertisersId	Creates a new campaign. Returns the newly created campaign if successful.
advertisers_campaigns_delete	DELETE	advertisersId, campaignsId	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.
advertisers_campaigns_patch	EXEC	advertisersId, campaignsId	Updates an existing campaign. Returns the updated campaign if successful.