Class GoogleAdsSearchads360V0ResourcesCampaign
A campaign.
Implements
Inherited Members
Namespace: Google.Apis.SA360.v0.Data
Assembly: Google.Apis.SA360.v0.dll
Syntax
public class GoogleAdsSearchads360V0ResourcesCampaign : IDirectResponseSchema
Properties
AccessibleBiddingStrategy
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource.
Declaration
[JsonProperty("accessibleBiddingStrategy")]
public virtual string AccessibleBiddingStrategy { get; set; }
Property Value
Type | Description |
---|---|
string |
AdServingOptimizationStatus
The ad serving optimization status of the campaign.
Declaration
[JsonProperty("adServingOptimizationStatus")]
public virtual string AdServingOptimizationStatus { get; set; }
Property Value
Type | Description |
---|---|
string |
AdvertisingChannelSubType
Immutable. Optional refinement to advertising_channel_type
. Must be a valid sub-type of the parent channel
type. Can be set only when creating campaigns. After campaign is created, the field can not be changed.
Declaration
[JsonProperty("advertisingChannelSubType")]
public virtual string AdvertisingChannelSubType { get; set; }
Property Value
Type | Description |
---|---|
string |
AdvertisingChannelType
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in
network_settings
. This field is required and should not be empty when creating new campaigns. Can be set
only when creating campaigns. After the campaign is created, the field can not be changed.
Declaration
[JsonProperty("advertisingChannelType")]
public virtual string AdvertisingChannelType { get; set; }
Property Value
Type | Description |
---|---|
string |
BiddingStrategy
The resource name of the portfolio bidding strategy used by the campaign.
Declaration
[JsonProperty("biddingStrategy")]
public virtual string BiddingStrategy { get; set; }
Property Value
Type | Description |
---|---|
string |
BiddingStrategySystemStatus
Output only. The system status of the campaign's bidding strategy.
Declaration
[JsonProperty("biddingStrategySystemStatus")]
public virtual string BiddingStrategySystemStatus { get; set; }
Property Value
Type | Description |
---|---|
string |
BiddingStrategyType
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding
scheme to create a standard bidding strategy or the bidding_strategy
field to create a portfolio bidding
strategy. This field is read-only.
Declaration
[JsonProperty("biddingStrategyType")]
public virtual string BiddingStrategyType { get; set; }
Property Value
Type | Description |
---|---|
string |
CampaignBudget
The resource name of the campaign budget of the campaign.
Declaration
[JsonProperty("campaignBudget")]
public virtual string CampaignBudget { get; set; }
Property Value
Type | Description |
---|---|
string |
CreateTime
Output only. The timestamp when this campaign was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. create_time will be deprecated in v1. Use creation_time instead.
Declaration
[JsonProperty("createTime")]
public virtual string CreateTime { get; set; }
Property Value
Type | Description |
---|---|
string |
CreationTime
Output only. The timestamp when this campaign was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
Declaration
[JsonProperty("creationTime")]
public virtual string CreationTime { get; set; }
Property Value
Type | Description |
---|---|
string |
DynamicSearchAdsSetting
The setting for controlling Dynamic Search Ads (DSA).
Declaration
[JsonProperty("dynamicSearchAdsSetting")]
public virtual GoogleAdsSearchads360V0ResourcesCampaignDynamicSearchAdsSetting DynamicSearchAdsSetting { get; set; }
Property Value
Type | Description |
---|---|
GoogleAdsSearchads360V0ResourcesCampaignDynamicSearchAdsSetting |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
EffectiveLabels
Output only. The resource names of effective labels attached to this campaign. An effective label is a label inherited or directly assigned to this campaign.
Declaration
[JsonProperty("effectiveLabels")]
public virtual IList<string> EffectiveLabels { get; set; }
Property Value
Type | Description |
---|---|
IList<string> |
EndDate
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format. On create, defaults to 2037-12-30, which means the campaign will run indefinitely. To set an existing campaign to run indefinitely, set this field to 2037-12-30.
Declaration
[JsonProperty("endDate")]
public virtual string EndDate { get; set; }
Property Value
Type | Description |
---|---|
string |
EngineId
Output only. ID of the campaign in the external engine account. This field is for non-Google Ads account only, for example, Yahoo Japan, Microsoft, Baidu etc. For Google Ads entity, use "campaign.id" instead.
Declaration
[JsonProperty("engineId")]
public virtual string EngineId { get; set; }
Property Value
Type | Description |
---|---|
string |
ExcludedParentAssetFieldTypes
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level.
Declaration
[JsonProperty("excludedParentAssetFieldTypes")]
public virtual IList<string> ExcludedParentAssetFieldTypes { get; set; }
Property Value
Type | Description |
---|---|
IList<string> |
FinalUrlSuffix
Suffix used to append query parameters to landing pages that are served with parallel tracking.
Declaration
[JsonProperty("finalUrlSuffix")]
public virtual string FinalUrlSuffix { get; set; }
Property Value
Type | Description |
---|---|
string |
FrequencyCaps
A list that limits how often each user will see this campaign's ads.
Declaration
[JsonProperty("frequencyCaps")]
public virtual IList<GoogleAdsSearchads360V0CommonFrequencyCapEntry> FrequencyCaps { get; set; }
Property Value
Type | Description |
---|---|
IList<GoogleAdsSearchads360V0CommonFrequencyCapEntry> |
GeoTargetTypeSetting
The setting for ads geotargeting.
Declaration
[JsonProperty("geoTargetTypeSetting")]
public virtual GoogleAdsSearchads360V0ResourcesCampaignGeoTargetTypeSetting GeoTargetTypeSetting { get; set; }
Property Value
Type | Description |
---|---|
GoogleAdsSearchads360V0ResourcesCampaignGeoTargetTypeSetting |
Id
Output only. The ID of the campaign.
Declaration
[JsonProperty("id")]
public virtual long? Id { get; set; }
Property Value
Type | Description |
---|---|
long? |
Labels
Output only. The resource names of labels attached to this campaign.
Declaration
[JsonProperty("labels")]
public virtual IList<string> Labels { get; set; }
Property Value
Type | Description |
---|---|
IList<string> |
LastModifiedTime
Output only. The datetime when this campaign was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
Declaration
[JsonProperty("lastModifiedTime")]
public virtual string LastModifiedTime { get; set; }
Property Value
Type | Description |
---|---|
string |
ManualCpa
Standard Manual CPA bidding strategy. Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action. Supported only for Local Services campaigns.
Declaration
[JsonProperty("manualCpa")]
public virtual GoogleAdsSearchads360V0CommonManualCpa ManualCpa { get; set; }
Property Value
Type | Description |
---|---|
GoogleAdsSearchads360V0CommonManualCpa |
ManualCpc
Standard Manual CPC bidding strategy. Manual click-based bidding where user pays per click.
Declaration
[JsonProperty("manualCpc")]
public virtual GoogleAdsSearchads360V0CommonManualCpc ManualCpc { get; set; }
Property Value
Type | Description |
---|---|
GoogleAdsSearchads360V0CommonManualCpc |
ManualCpm
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions.
Declaration
[JsonProperty("manualCpm")]
public virtual GoogleAdsSearchads360V0CommonManualCpm ManualCpm { get; set; }
Property Value
Type | Description |
---|---|
GoogleAdsSearchads360V0CommonManualCpm |
MaximizeConversionValue
Standard Maximize Conversion Value bidding strategy that automatically sets bids to maximize revenue while spending your budget.
Declaration
[JsonProperty("maximizeConversionValue")]
public virtual GoogleAdsSearchads360V0CommonMaximizeConversionValue MaximizeConversionValue { get; set; }
Property Value
Type | Description |
---|---|
GoogleAdsSearchads360V0CommonMaximizeConversionValue |
MaximizeConversions
Standard Maximize Conversions bidding strategy that automatically maximizes number of conversions while spending your budget.
Declaration
[JsonProperty("maximizeConversions")]
public virtual GoogleAdsSearchads360V0CommonMaximizeConversions MaximizeConversions { get; set; }
Property Value
Type | Description |
---|---|
GoogleAdsSearchads360V0CommonMaximizeConversions |
Name
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
NetworkSettings
The network settings for the campaign.
Declaration
[JsonProperty("networkSettings")]
public virtual GoogleAdsSearchads360V0ResourcesCampaignNetworkSettings NetworkSettings { get; set; }
Property Value
Type | Description |
---|---|
GoogleAdsSearchads360V0ResourcesCampaignNetworkSettings |
OptimizationGoalSetting
Optimization goal setting for this campaign, which includes a set of optimization goal types.
Declaration
[JsonProperty("optimizationGoalSetting")]
public virtual GoogleAdsSearchads360V0ResourcesCampaignOptimizationGoalSetting OptimizationGoalSetting { get; set; }
Property Value
Type | Description |
---|---|
GoogleAdsSearchads360V0ResourcesCampaignOptimizationGoalSetting |
PercentCpc
Standard Percent Cpc bidding strategy where bids are a fraction of the advertised price for some good or service.
Declaration
[JsonProperty("percentCpc")]
public virtual GoogleAdsSearchads360V0CommonPercentCpc PercentCpc { get; set; }
Property Value
Type | Description |
---|---|
GoogleAdsSearchads360V0CommonPercentCpc |
RealTimeBiddingSetting
Settings for Real-Time Bidding, a feature only available for campaigns targeting the Ad Exchange network.
Declaration
[JsonProperty("realTimeBiddingSetting")]
public virtual GoogleAdsSearchads360V0CommonRealTimeBiddingSetting RealTimeBiddingSetting { get; set; }
Property Value
Type | Description |
---|---|
GoogleAdsSearchads360V0CommonRealTimeBiddingSetting |
ResourceName
Immutable. The resource name of the campaign. Campaign resource names have the form:
customers/{customer_id}/campaigns/{campaign_id}
Declaration
[JsonProperty("resourceName")]
public virtual string ResourceName { get; set; }
Property Value
Type | Description |
---|---|
string |
SelectiveOptimization
Selective optimization setting for this campaign, which includes a set of conversion actions to optimize this campaign towards. This feature only applies to app campaigns that use MULTI_CHANNEL as AdvertisingChannelType and APP_CAMPAIGN or APP_CAMPAIGN_FOR_ENGAGEMENT as AdvertisingChannelSubType.
Declaration
[JsonProperty("selectiveOptimization")]
public virtual GoogleAdsSearchads360V0ResourcesCampaignSelectiveOptimization SelectiveOptimization { get; set; }
Property Value
Type | Description |
---|---|
GoogleAdsSearchads360V0ResourcesCampaignSelectiveOptimization |
ServingStatus
Output only. The ad serving status of the campaign.
Declaration
[JsonProperty("servingStatus")]
public virtual string ServingStatus { get; set; }
Property Value
Type | Description |
---|---|
string |
ShoppingSetting
The setting for controlling Shopping campaigns.
Declaration
[JsonProperty("shoppingSetting")]
public virtual GoogleAdsSearchads360V0ResourcesCampaignShoppingSetting ShoppingSetting { get; set; }
Property Value
Type | Description |
---|---|
GoogleAdsSearchads360V0ResourcesCampaignShoppingSetting |
StartDate
The date when campaign started in serving customer's timezone in YYYY-MM-DD format.
Declaration
[JsonProperty("startDate")]
public virtual string StartDate { get; set; }
Property Value
Type | Description |
---|---|
string |
Status
The status of the campaign. When a new campaign is added, the status defaults to ENABLED.
Declaration
[JsonProperty("status")]
public virtual string Status { get; set; }
Property Value
Type | Description |
---|---|
string |
TargetCpa
Standard Target CPA bidding strategy that automatically sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.
Declaration
[JsonProperty("targetCpa")]
public virtual GoogleAdsSearchads360V0CommonTargetCpa TargetCpa { get; set; }
Property Value
Type | Description |
---|---|
GoogleAdsSearchads360V0CommonTargetCpa |
TargetCpm
A bidding strategy that automatically optimizes cost per thousand impressions.
Declaration
[JsonProperty("targetCpm")]
public virtual GoogleAdsSearchads360V0CommonTargetCpm TargetCpm { get; set; }
Property Value
Type | Description |
---|---|
GoogleAdsSearchads360V0CommonTargetCpm |
TargetImpressionShare
Target Impression Share bidding strategy. An automated bidding strategy that sets bids to achieve a chosen percentage of impressions.
Declaration
[JsonProperty("targetImpressionShare")]
public virtual GoogleAdsSearchads360V0CommonTargetImpressionShare TargetImpressionShare { get; set; }
Property Value
Type | Description |
---|---|
GoogleAdsSearchads360V0CommonTargetImpressionShare |
TargetRoas
Standard Target ROAS bidding strategy that automatically maximizes revenue while averaging a specific target return on ad spend (ROAS).
Declaration
[JsonProperty("targetRoas")]
public virtual GoogleAdsSearchads360V0CommonTargetRoas TargetRoas { get; set; }
Property Value
Type | Description |
---|---|
GoogleAdsSearchads360V0CommonTargetRoas |
TargetSpend
Standard Target Spend bidding strategy that automatically sets your bids to help get as many clicks as possible within your budget.
Declaration
[JsonProperty("targetSpend")]
public virtual GoogleAdsSearchads360V0CommonTargetSpend TargetSpend { get; set; }
Property Value
Type | Description |
---|---|
GoogleAdsSearchads360V0CommonTargetSpend |
TrackingSetting
Output only. Campaign-level settings for tracking information.
Declaration
[JsonProperty("trackingSetting")]
public virtual GoogleAdsSearchads360V0ResourcesCampaignTrackingSetting TrackingSetting { get; set; }
Property Value
Type | Description |
---|---|
GoogleAdsSearchads360V0ResourcesCampaignTrackingSetting |
TrackingUrlTemplate
The URL template for constructing a tracking URL.
Declaration
[JsonProperty("trackingUrlTemplate")]
public virtual string TrackingUrlTemplate { get; set; }
Property Value
Type | Description |
---|---|
string |
UrlCustomParameters
The list of mappings used to substitute custom parameter tags in a tracking_url_template
, final_urls
, or
mobile_final_urls
.
Declaration
[JsonProperty("urlCustomParameters")]
public virtual IList<GoogleAdsSearchads360V0CommonCustomParameter> UrlCustomParameters { get; set; }
Property Value
Type | Description |
---|---|
IList<GoogleAdsSearchads360V0CommonCustomParameter> |
UrlExpansionOptOut
Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false.
Declaration
[JsonProperty("urlExpansionOptOut")]
public virtual bool? UrlExpansionOptOut { get; set; }
Property Value
Type | Description |
---|---|
bool? |