Struct gapi_grpc::google::ads::googleads::v5::resources::AdGroup

[+] Show declaration

pub struct AdGroup {
    pub resource_name: String,
    pub id: i64,
    pub name: String,
    pub status: i32,
    pub type: i32,
    pub ad_rotation_mode: i32,
    pub base_ad_group: String,
    pub tracking_url_template: String,
    pub url_custom_parameters: Vec<CustomParameter>,
    pub campaign: String,
    pub cpc_bid_micros: i64,
    pub cpm_bid_micros: i64,
    pub target_cpa_micros: i64,
    pub cpv_bid_micros: i64,
    pub target_cpm_micros: i64,
    pub target_roas: f64,
    pub percent_cpc_bid_micros: i64,
    pub explorer_auto_optimizer_setting: Option<ExplorerAutoOptimizerSetting>,
    pub display_custom_bid_dimension: i32,
    pub final_url_suffix: String,
    pub targeting_setting: Option<TargetingSetting>,
    pub effective_target_cpa_micros: i64,
    pub effective_target_cpa_source: i32,
    pub effective_target_roas: f64,
    pub effective_target_roas_source: i32,
    pub labels: Vec<String>,
}

[−] Expand description

An ad group.

Fields

resource_name: String

[−] Expand description

Immutable. The resource name of the ad group. Ad group resource names have the form:

customers/{customer_id}/adGroups/{ad_group_id}

id: i64

[−] Expand description

Output only. The ID of the ad group.

name: String

[−] Expand description

The name of the ad group.

This field is required and should not be empty when creating new ad groups.

It must contain fewer than 255 UTF-8 full-width characters.

It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.

status: i32

[−] Expand description

The status of the ad group.

type: i32

[−] Expand description

Immutable. The type of the ad group.

ad_rotation_mode: i32

[−] Expand description

The ad rotation mode of the ad group.

base_ad_group: String

[−] Expand description

Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null.

For base ad groups, this field equals the ad group resource name.

This field is read-only.

tracking_url_template: String

[−] Expand description

The URL template for constructing a tracking URL.

url_custom_parameters: Vec<CustomParameter>

[−] Expand description

The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls.

campaign: String

[−] Expand description

Immutable. The campaign to which the ad group belongs.

cpc_bid_micros: i64

[−] Expand description

The maximum CPC (cost-per-click) bid.

cpm_bid_micros: i64

[−] Expand description

The maximum CPM (cost-per-thousand viewable impressions) bid.

target_cpa_micros: i64

[−] Expand description

The target CPA (cost-per-acquisition).

cpv_bid_micros: i64

[−] Expand description

Output only. The CPV (cost-per-view) bid.

target_cpm_micros: i64

[−] Expand description

Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown.

target_roas: f64

[−] Expand description

The target ROAS (return-on-ad-spend) override. If the ad group’s campaign bidding strategy is a standard Target ROAS strategy, then this field overrides the target ROAS specified in the campaign’s bidding strategy. Otherwise, this value is ignored.

percent_cpc_bid_micros: i64

[−] Expand description

The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * [fraction].

explorer_auto_optimizer_setting: Option<ExplorerAutoOptimizerSetting>

[−] Expand description

Settings for the Display Campaign Optimizer, initially termed “Explorer”.

display_custom_bid_dimension: i32

[−] Expand description

Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search.

final_url_suffix: String

[−] Expand description

URL template for appending params to Final URL.

targeting_setting: Option<TargetingSetting>

[−] Expand description

Setting for targeting related features.

effective_target_cpa_micros: i64

[−] Expand description

Output only. The effective target CPA (cost-per-acquisition). This field is read-only.

effective_target_cpa_source: i32

[−] Expand description

Output only. Source of the effective target CPA. This field is read-only.

effective_target_roas: f64

[−] Expand description

Output only. The effective target ROAS (return-on-ad-spend). This field is read-only.

effective_target_roas_source: i32

[−] Expand description

Output only. Source of the effective target ROAS. This field is read-only.

labels: Vec<String>

[−] Expand description

Output only. The resource names of labels attached to this ad group.

Implementations

impl AdGroup[−]

pub fn status(&self) -> AdGroupStatus[−]

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: AdGroupStatus)[−]

Sets status to the provided enum value.

pub fn type(&self) -> AdGroupType[−]

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

pub fn set_type(&mut self, value: AdGroupType)[−]

Sets type to the provided enum value.

pub fn ad_rotation_mode(&self) -> AdGroupAdRotationMode[−]

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

pub fn set_ad_rotation_mode(&mut self, value: AdGroupAdRotationMode)[−]

Sets ad_rotation_mode to the provided enum value.

pub fn display_custom_bid_dimension(&self) -> TargetingDimension[−]

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

pub fn set_display_custom_bid_dimension(&mut self, value: TargetingDimension)[−]

Sets display_custom_bid_dimension to the provided enum value.

pub fn effective_target_cpa_source(&self) -> BiddingSource[−]

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

pub fn set_effective_target_cpa_source(&mut self, value: BiddingSource)[−]

Sets effective_target_cpa_source to the provided enum value.

pub fn effective_target_roas_source(&self) -> BiddingSource[−]

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

pub fn set_effective_target_roas_source(&mut self, value: BiddingSource)[−]

Sets effective_target_roas_source to the provided enum value.

Trait Implementations

impl Clone for AdGroup[+]

[+] Show hidden undocumented items

fn clone(&self) -> AdGroup[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for AdGroup[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Default for AdGroup[+]

[+] Show hidden undocumented items

fn default() -> AdGroup[−]

Returns the “default value” for a type.

impl Message for AdGroup[+]

[+] Show hidden undocumented items

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, [−]

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, [−]

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

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, [−]

Decodes an instance of the message from a buffer.

pub 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.

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, [−]

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

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, [−]

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

impl PartialEq<AdGroup> for AdGroup[+]

[+] Show hidden undocumented items

fn eq(&self, other: &AdGroup) -> bool[−]

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

fn ne(&self, other: &AdGroup) -> bool[−]

This method tests for !=.

impl StructuralPartialEq for AdGroup