Struct google_api_proto::google::ads::googleads::v16::services::GenerateKeywordHistoricalMetricsRequest

pub struct GenerateKeywordHistoricalMetricsRequest {
    pub customer_id: String,
    pub keywords: Vec<String>,
    pub language: Option<String>,
    pub include_adult_keywords: bool,
    pub geo_target_constants: Vec<String>,
    pub keyword_plan_network: i32,
    pub aggregate_metrics: Option<KeywordPlanAggregateMetrics>,
    pub historical_metrics_options: Option<HistoricalMetricsOptions>,
}

Request message for [KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics][google.ads.googleads.v16.services.KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics].

Fields

customer_id: String

The ID of the customer with the recommendation.

keywords: Vec<String>

A list of keywords to get historical metrics. Not all inputs will be returned as a result of near-exact deduplication. For example, if stats for “car” and “cars” are requested, only “car” will be returned. A maximum of 10,000 keywords can be used.

language: Option<String>

The resource name of the language to target. Each keyword belongs to some set of languages; a keyword is included if language is one of its languages. If not set, all keywords will be included.

include_adult_keywords: bool

If true, adult keywords will be included in response. The default value is false.

geo_target_constants: Vec<String>

The resource names of the location to target. Maximum is 10. An empty list MAY be used to specify all targeting geos.

keyword_plan_network: i32

Targeting network. If not set, Google Search And Partners Network will be used.

aggregate_metrics: Option<KeywordPlanAggregateMetrics>

The aggregate fields to include in response.

historical_metrics_options: Option<HistoricalMetricsOptions>

The options for historical metrics data.

Implementations

impl GenerateKeywordHistoricalMetricsRequest

pub fn language(&self) -> &str

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

pub fn keyword_plan_network(&self) -> KeywordPlanNetwork

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

pub fn set_keyword_plan_network(&mut self, value: KeywordPlanNetwork)

Sets keyword_plan_network to the provided enum value.

Trait Implementations

impl Clone for GenerateKeywordHistoricalMetricsRequest

fn clone(&self) -> GenerateKeywordHistoricalMetricsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GenerateKeywordHistoricalMetricsRequest

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

Formats the value using the given formatter.

impl Default for GenerateKeywordHistoricalMetricsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for GenerateKeywordHistoricalMetricsRequest

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 GenerateKeywordHistoricalMetricsRequest

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