Struct gapi_grpc::google::ads::admob::v1::NetworkReportSpec

pub struct NetworkReportSpec {
    pub date_range: Option<DateRange>,
    pub dimensions: Vec<i32>,
    pub metrics: Vec<i32>,
    pub dimension_filters: Vec<DimensionFilter>,
    pub sort_conditions: Vec<SortCondition>,
    pub localization_settings: Option<LocalizationSettings>,
    pub max_report_rows: i32,
    pub time_zone: String,
}

The specification for generating an AdMob Network report. For example, the specification to get clicks and estimated earnings for only the ‘US’ and ‘CN’ countries can look like the following example:

{
  'date_range': {
    'start_date': {'year': 2018, 'month': 9, 'day': 1},
    'end_date': {'year': 2018, 'month': 9, 'day': 30}
  },
  'dimensions': ['DATE', 'APP', 'COUNTRY'],
  'metrics': ['CLICKS', 'ESTIMATED_EARNINGS'],
  'dimension_filters': [
    {
      'dimension': 'COUNTRY',
      'matches_any': {'values': [{'value': 'US', 'value': 'CN'}]}
    }
  ],
  'sort_conditions': [
    {'dimension':'APP', order: 'ASCENDING'},
    {'metric':'CLICKS', order: 'DESCENDING'}
  ],
  'localization_settings': {
    'currency_code': 'USD',
    'language_code': 'en-US'
  }
}

For a better understanding, you can treat the preceding specification like the following pseudo SQL:

SELECT DATE, APP, COUNTRY, CLICKS, ESTIMATED_EARNINGS
FROM NETWORK_REPORT
WHERE DATE >= '2018-09-01' AND DATE <= '2018-09-30'
    AND COUNTRY IN ('US', 'CN')
GROUP BY DATE, APP, COUNTRY
ORDER BY APP ASC, CLICKS DESC;

Fields

date_range: Option<DateRange>

The date range for which the report is generated.

dimensions: Vec<i32>

List of dimensions of the report. The value combination of these dimensions determines the row of the report. If no dimensions are specified, the report returns a single row of requested metrics for the entire account.

metrics: Vec<i32>

List of metrics of the report. A report must specify at least one metric.

dimension_filters: Vec<DimensionFilter>

Describes which report rows to match based on their dimension values.

sort_conditions: Vec<SortCondition>

Describes the sorting of report rows. The order of the condition in the list defines its precedence; the earlier the condition, the higher its precedence. If no sort conditions are specified, the row ordering is undefined.

localization_settings: Option<LocalizationSettings>

Localization settings of the report.

max_report_rows: i32

Maximum number of report data rows to return. If the value is not set, the API returns as many rows as possible, up to 100000. Acceptable values are 1-100000, inclusive. Any other values are treated as 100000.

time_zone: String

A report time zone. Accepts an IANA TZ name values, such as “America/Los_Angeles.” If no time zone is defined, the account default takes effect. Check default value by the get account action.

Warning: The “America/Los_Angeles” is the only supported value at the moment.

Implementations

impl NetworkReportSpec

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

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

pub fn push_dimensions(&mut self, value: Dimension)

Appends the provided enum value to dimensions.

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

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

pub fn push_metrics(&mut self, value: Metric)

Appends the provided enum value to metrics.

Trait Implementations

impl Clone for NetworkReportSpec

fn clone(&self) -> NetworkReportSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NetworkReportSpec

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

Formats the value using the given formatter.

impl Default for NetworkReportSpec

fn default() -> NetworkReportSpec

Returns the “default value” for a type.

impl Message for NetworkReportSpec

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

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

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

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

This method tests for !=.

impl StructuralPartialEq for NetworkReportSpec