hermes_ebay_sell_analytics/models/definition.rs
1/*
2 * Analytics API
3 *
4 * The <i>Analytics API</i> provides data and information about a seller and their eBay business. <br><br>The resources and methods in this API let sellers review information on their listing performance, metrics on their customer service performance, and details on their eBay seller performance rating. <br><br>The three resources in the Analytics API provide the following data and information: <ul><li><b>Customer Service Metric</b> – Returns benchmark data and a metric rating pertaining to a seller's customer service performance as compared to other seller's in the same peer group.</li> <li><b>Traffic Report</b> – Returns data and information that shows how buyers are engaging with a seller's listings.</li> <li><b>Seller Standards Profile</b> – Returns information pertaining to a seller's profile rating.</li></ul> Sellers can use the data and information returned by the various Analytics API methods to determine where they can make improvements to increase sales and how they might improve their seller status as viewed by eBay buyers. <br><br>For details on using this API, see <a href=\"/api-docs/sell/static/performance/analyzing-performance.html\" title=\"Selling Integration Guide\">Analyzing seller performance</a>.
5 *
6 * The version of the OpenAPI document: 1.3.2
7 * Contact: your-email@example.com
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14/// Definition : A complex type that defines a dimension key and metrics in a traffic report.
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct Definition {
17 /// Indicates the data type of the returned dimension. For example, if the <b>dimension</b> is <code>day</code>, the data type is <code>DATE</code>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/analytics/types/ssp:DataTypeEnum'>eBay API documentation</a>
18 #[serde(rename = "dataType", skip_serializing_if = "Option::is_none")]
19 pub data_type: Option<String>,
20 /// The value the <b>dimension</b> or <b>metric</b> parameter as submitted in the request.
21 #[serde(rename = "key", skip_serializing_if = "Option::is_none")]
22 pub key: Option<String>,
23 /// The localized name of the metric or dimension (translated into the language specified in the <b>Accept-Language</b> HTTP request header). For example, if <b>Accept-Language</b> is set to <code>de-DE</code>, the value \"day\" in the <b>dimension</b> container is returned as \"tag\", and a metric of TRANSACTION is returned as \"Transaktionsanzahl\".
24 #[serde(rename = "localizedName", skip_serializing_if = "Option::is_none")]
25 pub localized_name: Option<String>,
26}
27
28impl Definition {
29 /// A complex type that defines a dimension key and metrics in a traffic report.
30 pub fn new() -> Definition {
31 Definition {
32 data_type: None,
33 key: None,
34 localized_name: None,
35 }
36 }
37}
38