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

pub struct SearchGoogleAdsRequest {
    pub customer_id: String,
    pub query: String,
    pub page_token: String,
    pub page_size: i32,
    pub validate_only: bool,
    pub return_total_results_count: bool,
    pub summary_row_setting: i32,
}

Request message for [GoogleAdsService.Search][google.ads.googleads.v17.services.GoogleAdsService.Search].

Fields

customer_id: String

Required. The ID of the customer being queried.

query: String

Required. The query string.

page_token: String

Token of the page to retrieve. If not specified, the first page of results will be returned. Use the value obtained from next_page_token in the previous response in order to request the next page of results.

page_size: i32

Number of elements to retrieve in a single page. When too large a page is requested, the server may decide to further limit the number of returned resources.

validate_only: bool

If true, the request is validated but not executed.

return_total_results_count: bool

If true, the total number of results that match the query ignoring the LIMIT clause will be included in the response. Default is false.

summary_row_setting: i32

Determines whether a summary row will be returned. By default, summary row is not returned. If requested, the summary row will be sent in a response by itself after all other query results are returned.

Implementations

impl SearchGoogleAdsRequest

pub fn summary_row_setting(&self) -> SummaryRowSetting

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

pub fn set_summary_row_setting(&mut self, value: SummaryRowSetting)

Sets summary_row_setting to the provided enum value.

Trait Implementations

impl Clone for SearchGoogleAdsRequest

fn clone(&self) -> SearchGoogleAdsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchGoogleAdsRequest

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

Formats the value using the given formatter.

impl Default for SearchGoogleAdsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for SearchGoogleAdsRequest

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 SearchGoogleAdsRequest

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