Struct googapis::google::ads::googleads::v8::resources::Campaign [−][src]
pub struct Campaign {Show 38 fields
pub resource_name: String,
pub id: Option<i64>,
pub name: Option<String>,
pub status: i32,
pub serving_status: i32,
pub ad_serving_optimization_status: i32,
pub advertising_channel_type: i32,
pub advertising_channel_sub_type: i32,
pub tracking_url_template: Option<String>,
pub url_custom_parameters: Vec<CustomParameter>,
pub real_time_bidding_setting: Option<RealTimeBiddingSetting>,
pub network_settings: Option<NetworkSettings>,
pub hotel_setting: Option<HotelSettingInfo>,
pub dynamic_search_ads_setting: Option<DynamicSearchAdsSetting>,
pub shopping_setting: Option<ShoppingSetting>,
pub targeting_setting: Option<TargetingSetting>,
pub geo_target_type_setting: Option<GeoTargetTypeSetting>,
pub local_campaign_setting: Option<LocalCampaignSetting>,
pub app_campaign_setting: Option<AppCampaignSetting>,
pub labels: Vec<String>,
pub experiment_type: i32,
pub base_campaign: Option<String>,
pub campaign_budget: Option<String>,
pub bidding_strategy_type: i32,
pub accessible_bidding_strategy: String,
pub start_date: Option<String>,
pub end_date: Option<String>,
pub final_url_suffix: Option<String>,
pub frequency_caps: Vec<FrequencyCapEntry>,
pub video_brand_safety_suitability: i32,
pub vanity_pharma: Option<VanityPharma>,
pub selective_optimization: Option<SelectiveOptimization>,
pub optimization_goal_setting: Option<OptimizationGoalSetting>,
pub tracking_setting: Option<TrackingSetting>,
pub payment_mode: i32,
pub optimization_score: Option<f64>,
pub excluded_parent_asset_field_types: Vec<i32>,
pub campaign_bidding_strategy: Option<CampaignBiddingStrategy>,
}
Expand description
A campaign.
Fields
resource_name: String
Immutable. The resource name of the campaign. Campaign resource names have the form:
customers/{customer_id}/campaigns/{campaign_id}
id: Option<i64>
Output only. The ID of the campaign.
name: Option<String>
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.
status: i32
The status of the campaign.
When a new campaign is added, the status defaults to ENABLED.
serving_status: i32
Output only. The ad serving status of the campaign.
ad_serving_optimization_status: i32
The ad serving optimization status of the campaign.
advertising_channel_type: i32
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.
advertising_channel_sub_type: i32
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.
tracking_url_template: Option<String>
The URL template for constructing a tracking URL.
url_custom_parameters: Vec<CustomParameter>
The list of mappings used to substitute custom parameter tags in a
tracking_url_template
, final_urls
, or mobile_final_urls
.
real_time_bidding_setting: Option<RealTimeBiddingSetting>
Settings for Real-Time Bidding, a feature only available for campaigns targeting the Ad Exchange network.
network_settings: Option<NetworkSettings>
The network settings for the campaign.
hotel_setting: Option<HotelSettingInfo>
Immutable. The hotel setting for the campaign.
dynamic_search_ads_setting: Option<DynamicSearchAdsSetting>
The setting for controlling Dynamic Search Ads (DSA).
shopping_setting: Option<ShoppingSetting>
The setting for controlling Shopping campaigns.
targeting_setting: Option<TargetingSetting>
Setting for targeting related features.
geo_target_type_setting: Option<GeoTargetTypeSetting>
The setting for ads geotargeting.
local_campaign_setting: Option<LocalCampaignSetting>
The setting for local campaign.
app_campaign_setting: Option<AppCampaignSetting>
The setting related to App Campaign.
labels: Vec<String>
Output only. The resource names of labels attached to this campaign.
experiment_type: i32
Output only. The type of campaign: normal, draft, or experiment.
base_campaign: Option<String>
Output only. The resource name of the base campaign of a draft or experiment campaign.
For base campaigns, this is equal to resource_name
.
This field is read-only.
campaign_budget: Option<String>
The budget of the campaign.
bidding_strategy_type: i32
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.
accessible_bidding_strategy: String
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.
start_date: Option<String>
The date when campaign started.
end_date: Option<String>
The last day of the campaign.
final_url_suffix: Option<String>
Suffix used to append query parameters to landing pages that are served with parallel tracking.
frequency_caps: Vec<FrequencyCapEntry>
A list that limits how often each user will see this campaign’s ads.
video_brand_safety_suitability: i32
Output only. 3-Tier Brand Safety setting for the campaign.
vanity_pharma: Option<VanityPharma>
Describes how unbranded pharma ads will be displayed.
selective_optimization: Option<SelectiveOptimization>
Selective optimization setting for this campaign, which includes a set of conversion actions to optimize this campaign towards.
optimization_goal_setting: Option<OptimizationGoalSetting>
Optimization goal setting for this campaign, which includes a set of optimization goal types.
tracking_setting: Option<TrackingSetting>
Output only. Campaign-level settings for tracking information.
payment_mode: i32
Payment mode for the campaign.
optimization_score: Option<f64>
Output only. Optimization score of the campaign.
Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns.
See “About optimization score” at https://support.google.com/google-ads/answer/9061546.
This field is read-only.
excluded_parent_asset_field_types: Vec<i32>
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.
campaign_bidding_strategy: Option<CampaignBiddingStrategy>
The bidding strategy for the campaign.
Must be either portfolio (created via BiddingStrategy service) or standard, that is embedded into the campaign.
Implementations
Returns the enum value of status
, or the default if the field is set to an invalid enum value.
Sets status
to the provided enum value.
Returns the enum value of ad_serving_optimization_status
, or the default if the field is set to an invalid enum value.
Sets ad_serving_optimization_status
to the provided enum value.
Returns the enum value of advertising_channel_type
, or the default if the field is set to an invalid enum value.
Sets advertising_channel_type
to the provided enum value.
Returns the enum value of advertising_channel_sub_type
, or the default if the field is set to an invalid enum value.
Sets advertising_channel_sub_type
to the provided enum value.
Returns the enum value of experiment_type
, or the default if the field is set to an invalid enum value.
Sets experiment_type
to the provided enum value.
Returns the enum value of serving_status
, or the default if the field is set to an invalid enum value.
Sets serving_status
to the provided enum value.
Returns the enum value of bidding_strategy_type
, or the default if the field is set to an invalid enum value.
Sets bidding_strategy_type
to the provided enum value.
Returns the enum value of video_brand_safety_suitability
, or the default if the field is set to an invalid enum value.
Sets video_brand_safety_suitability
to the provided enum value.
Returns the enum value of payment_mode
, or the default if the field is set to an invalid enum value.
Sets payment_mode
to the provided enum value.
Returns the value of base_campaign
, or the default value if base_campaign
is unset.
Returns the value of tracking_url_template
, or the default value if tracking_url_template
is unset.
Returns the value of campaign_budget
, or the default value if campaign_budget
is unset.
Returns the value of start_date
, or the default value if start_date
is unset.
Returns the value of end_date
, or the default value if end_date
is unset.
Returns the value of final_url_suffix
, or the default value if final_url_suffix
is unset.
Returns the value of optimization_score
, or the default value if optimization_score
is unset.
pub fn excluded_parent_asset_field_types(
&self
) -> FilterMap<Cloned<Iter<'_, i32>>, fn(_: i32) -> Option<AssetFieldType>>
pub fn excluded_parent_asset_field_types(
&self
) -> FilterMap<Cloned<Iter<'_, i32>>, fn(_: i32) -> Option<AssetFieldType>>
Returns an iterator which yields the valid enum values contained in excluded_parent_asset_field_types
.
Appends the provided enum value to excluded_parent_asset_field_types
.
Trait Implementations
fn merge_field<B>(
&mut self,
tag: u32,
wire_type: WireType,
buf: &mut B,
ctx: DecodeContext
) -> Result<(), DecodeError> where
B: Buf,
Returns the encoded length of the message without a length delimiter.
Encodes the message to a buffer. Read more
Encodes the message to a newly allocated buffer.
Encodes the message with a length-delimiter to a buffer. Read more
Encodes the message with a length-delimiter to a newly allocated buffer.
Decodes an instance of the message from a buffer. Read more
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
Decodes a length-delimited instance of the message from the buffer.
Decodes an instance of the message from a buffer, and merges it into self
. Read more
Decodes a length-delimited instance of the message from buffer, and
merges it into self
. Read more
Auto Trait Implementations
impl RefUnwindSafe for Campaign
impl UnwindSafe for Campaign
Blanket Implementations
Mutably borrows from an owned value. Read more
Wrap the input message T
in a tonic::Request
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more