Struct google_api_proto::google::ads::searchads360::v0::resources::Campaign

pub struct Campaign {

    pub resource_name: String,
    pub id: Option<i64>,
    pub name: Option<String>,
    pub status: i32,
    pub serving_status: i32,
    pub bidding_strategy_system_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 dynamic_search_ads_setting: Option<DynamicSearchAdsSetting>,
    pub shopping_setting: Option<ShoppingSetting>,
    pub geo_target_type_setting: Option<GeoTargetTypeSetting>,
    pub labels: Vec<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 selective_optimization: Option<SelectiveOptimization>,
    pub optimization_goal_setting: Option<OptimizationGoalSetting>,
    pub tracking_setting: Option<TrackingSetting>,
    pub engine_id: String,
    pub excluded_parent_asset_field_types: Vec<i32>,
    pub create_time: String,
    pub creation_time: String,
    pub last_modified_time: String,
    pub url_expansion_opt_out: Option<bool>,
    pub campaign_bidding_strategy: Option<CampaignBiddingStrategy>,
}

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.

bidding_strategy_system_status: i32

Output only. The system status of the campaign’s bidding strategy.

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.

dynamic_search_ads_setting: Option<DynamicSearchAdsSetting>

The setting for controlling Dynamic Search Ads (DSA).

shopping_setting: Option<ShoppingSetting>

The setting for controlling Shopping campaigns.

geo_target_type_setting: Option<GeoTargetTypeSetting>

The setting for ads geotargeting.

labels: Vec<String>

Output only. The resource names of labels attached to this campaign.

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 in serving customer’s timezone in YYYY-MM-DD format.

end_date: Option<String>

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.

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.

selective_optimization: Option<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.

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.

engine_id: String

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.

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.

create_time: String

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.

creation_time: String

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.

last_modified_time: String

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.

url_expansion_opt_out: Option<bool>

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.

campaign_bidding_strategy: Option<CampaignBiddingStrategy>

The bidding strategy for the campaign.

Must be either portfolio (created through BiddingStrategy service) or standard, that is embedded into the campaign.

Implementations

impl Campaign

pub fn status(&self) -> CampaignStatus

Returns the enum value of status, or the default if the field is set to an invalid enum value.

pub fn set_status(&mut self, value: CampaignStatus)

Sets status to the provided enum value.

pub fn ad_serving_optimization_status(&self) -> AdServingOptimizationStatus

Returns the enum value of ad_serving_optimization_status, or the default if the field is set to an invalid enum value.

pub fn set_ad_serving_optimization_status( &mut self, value: AdServingOptimizationStatus, )

Sets ad_serving_optimization_status to the provided enum value.

pub fn advertising_channel_type(&self) -> AdvertisingChannelType

Returns the enum value of advertising_channel_type, or the default if the field is set to an invalid enum value.

pub fn set_advertising_channel_type(&mut self, value: AdvertisingChannelType)

Sets advertising_channel_type to the provided enum value.

pub fn advertising_channel_sub_type(&self) -> AdvertisingChannelSubType

Returns the enum value of advertising_channel_sub_type, or the default if the field is set to an invalid enum value.

pub fn set_advertising_channel_sub_type( &mut self, value: AdvertisingChannelSubType, )

Sets advertising_channel_sub_type to the provided enum value.

pub fn serving_status(&self) -> CampaignServingStatus

Returns the enum value of serving_status, or the default if the field is set to an invalid enum value.

pub fn set_serving_status(&mut self, value: CampaignServingStatus)

Sets serving_status to the provided enum value.

pub fn bidding_strategy_type(&self) -> BiddingStrategyType

Returns the enum value of bidding_strategy_type, or the default if the field is set to an invalid enum value.

pub fn set_bidding_strategy_type(&mut self, value: BiddingStrategyType)

Sets bidding_strategy_type to the provided enum value.

pub fn name(&self) -> &str

Returns the value of name, or the default value if name is unset.

pub fn id(&self) -> i64

Returns the value of id, or the default value if id is unset.

pub fn tracking_url_template(&self) -> &str

Returns the value of tracking_url_template, or the default value if tracking_url_template is unset.

pub fn campaign_budget(&self) -> &str

Returns the value of campaign_budget, or the default value if campaign_budget is unset.

pub fn start_date(&self) -> &str

Returns the value of start_date, or the default value if start_date is unset.

pub fn end_date(&self) -> &str

Returns the value of end_date, or the default value if end_date is unset.

pub fn final_url_suffix(&self) -> &str

Returns the value of final_url_suffix, or the default value if final_url_suffix is unset.

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.

pub fn push_excluded_parent_asset_field_types(&mut self, value: AssetFieldType)

Appends the provided enum value to excluded_parent_asset_field_types.

pub fn url_expansion_opt_out(&self) -> bool

Returns the value of url_expansion_opt_out, or the default value if url_expansion_opt_out is unset.

pub fn bidding_strategy_system_status(&self) -> BiddingStrategySystemStatus

Returns the enum value of bidding_strategy_system_status, or the default if the field is set to an invalid enum value.

pub fn set_bidding_strategy_system_status( &mut self, value: BiddingStrategySystemStatus, )

Sets bidding_strategy_system_status to the provided enum value.

Trait Implementations

impl Clone for Campaign

fn clone(&self) -> Campaign

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Campaign

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Campaign

fn default() -> Self

Returns the “default value” for a type.

impl Message for Campaign

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Campaign

fn eq(&self, other: &Campaign) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Campaign