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

pub struct GoogleAdsField {
    pub resource_name: String,
    pub name: String,
    pub category: i32,
    pub selectable: bool,
    pub filterable: bool,
    pub sortable: bool,
    pub selectable_with: Vec<String>,
    pub attribute_resources: Vec<String>,
    pub metrics: Vec<String>,
    pub segments: Vec<String>,
    pub enum_values: Vec<String>,
    pub data_type: i32,
    pub type_url: String,
    pub is_repeated: bool,
}

A field or resource (artifact) used by GoogleAdsService.

Fields

resource_name: String

Output only. The resource name of the artifact. Artifact resource names have the form:

googleAdsFields/{name}

name: String

Output only. The name of the artifact.

category: i32

Output only. The category of the artifact.

selectable: bool

Output only. Whether the artifact can be used in a SELECT clause in search queries.

filterable: bool

Output only. Whether the artifact can be used in a WHERE clause in search queries.

sortable: bool

Output only. Whether the artifact can be used in a ORDER BY clause in search queries.

selectable_with: Vec<String>

Output only. The names of all resources, segments, and metrics that are selectable with the described artifact.

attribute_resources: Vec<String>

Output only. The names of all resources that are selectable with the described artifact. Fields from these resources do not segment metrics when included in search queries.

This field is only set for artifacts whose category is RESOURCE.

metrics: Vec<String>

Output only. At and beyond version V1 this field lists the names of all metrics that are selectable with the described artifact when it is used in the FROM clause. It is only set for artifacts whose category is RESOURCE.

Before version V1 this field lists the names of all metrics that are selectable with the described artifact. It is only set for artifacts whose category is either RESOURCE or SEGMENT

segments: Vec<String>

Output only. At and beyond version V1 this field lists the names of all artifacts, whether a segment or another resource, that segment metrics when included in search queries and when the described artifact is used in the FROM clause. It is only set for artifacts whose category is RESOURCE.

Before version V1 this field lists the names of all artifacts, whether a segment or another resource, that segment metrics when included in search queries. It is only set for artifacts of category RESOURCE, SEGMENT or METRIC.

enum_values: Vec<String>

Output only. Values the artifact can assume if it is a field of type ENUM.

This field is only set for artifacts of category SEGMENT or ATTRIBUTE.

data_type: i32

Output only. This field determines the operators that can be used with the artifact in WHERE clauses.

type_url: String

Output only. The URL of proto describing the artifact’s data type.

is_repeated: bool

Output only. Whether the field artifact is repeated.

Implementations

impl GoogleAdsField

pub fn category(&self) -> GoogleAdsFieldCategory

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

pub fn set_category(&mut self, value: GoogleAdsFieldCategory)

Sets category to the provided enum value.

pub fn data_type(&self) -> GoogleAdsFieldDataType

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

pub fn set_data_type(&mut self, value: GoogleAdsFieldDataType)

Sets data_type to the provided enum value.

Trait Implementations

impl Clone for GoogleAdsField

fn clone(&self) -> GoogleAdsField

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GoogleAdsField

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

Formats the value using the given formatter.

impl Default for GoogleAdsField

fn default() -> GoogleAdsField

Returns the “default value” for a type.

impl Message for GoogleAdsField

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<GoogleAdsField> for GoogleAdsField

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

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

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

This method tests for !=.

impl StructuralPartialEq for GoogleAdsField