Struct google_api_proto::google::ads::googleads::v17::services::GenerateRecommendationsRequest

pub struct GenerateRecommendationsRequest {
    pub customer_id: String,
    pub recommendation_types: Vec<i32>,
    pub advertising_channel_type: i32,
    pub campaign_sitelink_count: Option<i32>,
    pub conversion_tracking_status: Option<i32>,
    pub bidding_info: Option<BiddingInfo>,
    pub ad_group_info: Vec<AdGroupInfo>,
    pub seed_info: Option<SeedInfo>,
}

Request message for [RecommendationService.GenerateRecommendations][google.ads.googleads.v17.services.RecommendationService.GenerateRecommendations].

Fields

customer_id: String

Required. The ID of the customer generating recommendations.

recommendation_types: Vec<i32>

Required. List of eligible recommendation_types to generate. If the uploaded criteria isn’t sufficient to make a recommendation, or the campaign is already in the recommended state, no recommendation will be returned for that type. Generally, a recommendation is returned if all required fields for that recommendation_type are uploaded, but there are cases where this is still not sufficient.

The following recommendation_types are supported for recommendation generation: KEYWORD, MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN, MAXIMIZE_CONVERSION_VALUE_OPT_IN, SET_TARGET_CPA, SET_TARGET_ROAS, SITELINK_ASSET, TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN

advertising_channel_type: i32

Required. Advertising channel type of the campaign. The following advertising_channel_types are supported for recommendation generation: PERFORMANCE_MAX and SEARCH

campaign_sitelink_count: Option<i32>

Optional. Number of sitelinks on the campaign. This field is necessary for the following recommendation_types: SITELINK_ASSET

conversion_tracking_status: Option<i32>

Optional. Current conversion tracking status. This field is necessary for the following recommendation_types: MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN, MAXIMIZE_CONVERSION_VALUE_OPT_IN, SET_TARGET_CPA, SET_TARGET_ROAS, TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN

bidding_info: Option<BiddingInfo>

Optional. Current bidding information of the campaign. This field is necessary for the following recommendation_types: MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN, MAXIMIZE_CONVERSION_VALUE_OPT_IN, SET_TARGET_CPA, SET_TARGET_ROAS, TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN

ad_group_info: Vec<AdGroupInfo>

Optional. Current AdGroup Information. Supports information from a single AdGroup. This field is optional for the following recommendation_types: KEYWORD

seed_info: Option<SeedInfo>

Optional. Seed information for Keywords. This field is necessary for the following recommendation_types: KEYWORD

Implementations

impl GenerateRecommendationsRequest

pub fn recommendation_types( &self, ) -> FilterMap<Cloned<Iter<'_, i32>>, fn(_: i32) -> Option<RecommendationType>>

Returns an iterator which yields the valid enum values contained in recommendation_types.

pub fn push_recommendation_types(&mut self, value: RecommendationType)

Appends the provided enum value to recommendation_types.

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 campaign_sitelink_count(&self) -> i32

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

pub fn conversion_tracking_status(&self) -> ConversionTrackingStatus

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

pub fn set_conversion_tracking_status( &mut self, value: ConversionTrackingStatus, )

Sets conversion_tracking_status to the provided enum value.

Trait Implementations

impl Clone for GenerateRecommendationsRequest

fn clone(&self) -> GenerateRecommendationsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GenerateRecommendationsRequest

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

Formats the value using the given formatter.

impl Default for GenerateRecommendationsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for GenerateRecommendationsRequest

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 GenerateRecommendationsRequest

fn eq(&self, other: &GenerateRecommendationsRequest) -> 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 GenerateRecommendationsRequest