strique-proto-schema 31.8.1rc412__tar.gz → 32.0.0__tar.gz

{strique_proto_schema-31.8.1rc412 → strique_proto_schema-32.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: strique-proto-schema
-Version: 31.8.1rc412
+Version: 32.0.0
 Summary: API contracts and Data Transfer Objects (DTO) in the form of Protocol Buffers for Strique binaries.
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown

{strique_proto_schema-31.8.1rc412 → strique_proto_schema-32.0.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "strique-proto-schema"
-version = "31.8.1-rc.412"
+version = "32.0.0"
 readme = "README.md"
 description = "API contracts and Data Transfer Objects (DTO) in the form of Protocol Buffers for Strique binaries."
 requires-python = ">=3.7"

{strique_proto_schema-31.8.1rc412 → strique_proto_schema-32.0.0}/src/protos/options/strique_enum_options.proto

@@ -3,6 +3,7 @@ syntax = "proto3";
 package strique.options;
 
 import "google/protobuf/descriptor.proto";
+import "db/platform/platform_type.proto";
 
 // Extend EnumValueOptions to include custom options
 extend google.protobuf.EnumValueOptions {
@@ -58,4 +59,7 @@ extend google.protobuf.EnumValueOptions {
   // in the table under any circumstances. It will be included in the dataset to enable 
   // users to apply filters based on its values, but it will remain hidden from the table's visible columns.
   optional bool is_permanently_hidden = 10011;
+
+  // Defines the platform type for which this enum value is applicable.
+  optional strique.model.db.platform.PlatformType platform_type = 10012;
 }

strique_proto_schema-32.0.0/src/protos/widget/analytics/product_analytics.proto

@@ -0,0 +1,404 @@
+syntax = "proto3";
+
+package strique.model.widget.analytics;
+
+import "constants/ui/render_type.proto";
+import "constants/ui/sorting_direction.proto";
+import "options/strique_enum_options.proto";
+import "types/currency/currency.proto";
+import "types/filter_predicate/filters.proto";
+import "types/media/media.proto";
+import "db/platform/platform_type.proto";
+
+option java_outer_classname = "ProductAnalyticsProto";
+option java_package = "com.strique.model.widget.analytics";
+
+// Next Id: 3
+// Proto definition for Product Analytics Data.
+message ProductAnalyticsData {
+  // Title for this widget.
+  string widget_title = 1;
+
+  // List of records for this widget.
+  repeated ProductAnalyticsRecord records = 2;
+}
+
+// next Id: 35
+// Proto definition for a single record in the product Analytics Data.
+message ProductAnalyticsRecord {
+    // product id
+    string product_id = 1 [json_name = "productId"];
+
+    // Product details like name, URL, etc.
+    types.Media productDetails = 2 [json_name = "productDetails"];
+
+    // impressions of the product from google merchant center
+    optional uint64 gmc_impressions = 3 [json_name = "gmcImpressions"];
+
+    // clicks of the product from google merchant center
+    optional uint64 gmc_clicks = 4 [json_name = "gmcClicks"];
+
+    // conversions of the product from google merchant center
+    optional double gmc_conversions = 5 [json_name = "gmcConversions"];
+
+    // conversion value of the product from google merchant center
+    optional types.Currency gmc_conversion_value = 6 [json_name = "gmcConversionValue"];
+
+    // click through rate of the product from google merchant center
+    optional float gmc_click_through_rate = 7 [json_name = "gmcClickThroughRate"];
+
+    // conversion rate of the product from google merchant center
+    optional float gmc_conversion_rate = 8 [json_name = "gmcConversionRate"];
+
+    // price of the product from google merchant center
+    optional types.Currency gmc_price = 9 [json_name = "gmcPrice"];
+
+    // benchmark price of the product from google merchant center
+    optional types.Currency gmc_benchmark_price = 10 [json_name = "gmcBenchmarkPrice"];
+
+    // Ads spend for the product from google ads
+    optional types.Currency google_ads_spend = 11 [json_name = "googleAdsSpend"];
+
+    // Ads impressions for the product from google ads
+    optional uint64 google_ads_impressions = 12 [json_name = "googleAdsImpressions"];
+
+    // Ads clicks for the product from google ads
+    optional uint64 google_ads_clicks = 13 [json_name = "googleAdsClicks"];
+
+    // Ads purchases for the product from google ads
+    optional double google_ads_purchases = 14 [json_name = "googleAdsPurchases"];
+
+    // Ads purchase value for the product from google ads
+    optional types.Currency google_ads_purchase_value = 15 [json_name = "googleAdsPurchaseValue"];
+
+    // Ads click through rate for the product from google ads
+    optional float google_ads_click_through_rate = 16 [json_name = "googleAdsClickThroughRate"];
+
+    // Ads return on ad spend for the product from google ads
+    optional float google_ads_return_on_ad_spend = 17 [json_name = "googleAdsReturnOnAdSpend"];
+
+    // Product page views for the product from google analytics
+    optional uint64 ga_product_page_views = 18 [json_name = "gaProductPageViews"];
+
+    // Add to carts for the product from google analytics
+    optional uint64 ga_add_to_carts = 19 [json_name = "gaAddToCarts"];
+
+    // Checkouts for the product from google analytics
+    optional uint64 ga_checkouts = 20 [json_name = "gaCheckouts"];
+
+    // Purchases for the product from google analytics
+    optional uint64 ga_purchases = 21 [json_name = "gaPurchases"];
+
+    // Revenue for the product from google analytics
+    optional types.Currency ga_revenue = 22 [json_name = "gaRevenue"];
+
+    // Conversion rate for the product from google analytics
+    optional float ga_conversion_rate = 23 [json_name = "gaConversionRate"];
+
+    // Add to cart rate for the product from google analytics
+    optional float ga_add_to_cart_rate = 24 [json_name = "gaAddToCartRate"];
+
+    // spends for the product from meta ads
+    optional types.Currency meta_spends = 25 [json_name = "metaSpends"];
+
+    // impressions for the product from meta ads
+    optional uint64 meta_impressions = 26 [json_name = "metaImpressions"];
+
+    // clicks for the product from meta ads
+    optional uint64 meta_clicks = 27 [json_name = "metaClicks"];
+
+    // link clicks for the product from meta ads
+    optional uint64 meta_link_clicks = 28 [json_name = "metaLinkClicks"];
+
+    // click through rate for the product from meta ads
+    optional float meta_click_through_rate = 29 [json_name = "metaClickThroughRate"];
+
+    // cost per click for the product from meta ads
+    optional types.Currency meta_cost_per_click = 30 [json_name = "metaCostPerClick"];
+
+    // cost per mile for the product from meta ads
+    optional types.Currency meta_cost_per_mille = 31 [json_name = "metaCostPerMille"];
+
+    // quantity sold from shopify
+    optional uint64 shopify_quantity_sold = 32 [json_name = "shopifyQuantitySold"];
+
+    // total sales from shopify
+    optional types.Currency shopify_total_sales = 33 [json_name = "shopifyTotalSales"];
+
+    // List of zero or more sub rows for a record.
+    repeated ProductAnalyticsRecord subrows = 34 [json_name = "subrows"];
+}
+
+// Next Id: 3
+// Proto definition for the configuration of the Analytics Table widget.
+message ProductAnalyticsConfig {
+  // Next Id: 34
+  // Enumeration of possible columns in the Analytics Table.
+  enum Column {
+    COLUMN_UNKNOWN = 0 [
+      (options.label) = 'Unknown',
+      (options.accessor_key) = '',
+      (options.is_sortable) = false,
+      (options.is_filterable) = false,
+      (options.is_dropdown_not_support) = true,
+      (options.platform_type) = PLATFORM_UNKNOWN
+    ];
+    COLUMN_PRODUCT_ID = 1 [
+      (options.label) = 'Product ID',
+      (options.accessor_key) = 'productId',
+      (options.is_sortable) = false,
+      (options.is_filterable) = true
+    ];
+    COLUMN_PRODUCT_DETAILS = 2 [
+      (options.label) = 'Product details',
+      (options.accessor_key) = 'productDetails',
+      (options.is_sortable) = false,
+      (options.is_filterable) = true
+    ];
+    COLUMN_GMC_IMPRESSIONS = 3 [
+      (options.label) = 'Impressions',
+      (options.accessor_key) = 'gmcImpressions',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = GOOGLE_MERCHANT_CENTER
+    ];
+    COLUMN_GMC_CLICKS = 4 [
+      (options.label) = 'Clicks',
+      (options.accessor_key) = 'gmcClicks',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = GOOGLE_MERCHANT_CENTER
+    ];
+    COLUMN_GMC_CONVERSIONS = 5 [
+      (options.label) = 'Conversions',
+      (options.accessor_key) = 'gmcConversions',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = GOOGLE_MERCHANT_CENTER
+    ];
+    COLUMN_GMC_CONVERSION_VALUE = 6 [
+      (options.label) = 'Conversion value',
+      (options.accessor_key) = 'gmcConversionValue',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = GOOGLE_MERCHANT_CENTER
+    ];
+    COLUMN_GMC_CLICK_THROUGH_RATE = 7 [
+      (options.label) = 'Click through rate',
+      (options.accessor_key) = 'gmcClickThroughRate',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = GOOGLE_MERCHANT_CENTER
+    ];
+    COLUMN_GMC_CONVERSION_RATE = 8 [
+      (options.label) = 'Conversion rate',
+      (options.accessor_key) = 'gmcConversionRate',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = GOOGLE_MERCHANT_CENTER
+    ];
+    COLUMN_GMC_PRICE = 9 [
+      (options.label) = 'Price',
+      (options.accessor_key) = 'gmcPrice',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = GOOGLE_MERCHANT_CENTER
+    ];
+    COLUMN_GMC_BENCHMARK_PRICE = 10 [
+      (options.label) = 'Benchmark price',
+      (options.accessor_key) = 'gmcBenchmarkPrice',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = GOOGLE_MERCHANT_CENTER
+    ];
+    COLUMN_GOOGLE_ADS_SPEND = 11 [
+      (options.label) = 'Spend',
+      (options.accessor_key) = 'googleAdsSpend',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = GOOGLE_ADS
+    ];
+    COLUMN_GOOGLE_ADS_IMPRESSIONS = 12 [
+      (options.label) = 'Impressions',
+      (options.accessor_key) = 'googleAdsImpressions',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = GOOGLE_ADS
+    ];
+    COLUMN_GOOGLE_ADS_CLICKS = 13 [
+      (options.label) = 'Clicks',
+      (options.accessor_key) = 'googleAdsClicks',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = GOOGLE_ADS
+    ];
+    COLUMN_GOOGLE_ADS_PURCHASES = 14 [
+      (options.label) = 'Purchases',
+      (options.accessor_key) = 'googleAdsPurchases',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = GOOGLE_ADS
+    ];
+    COLUMN_GOOGLE_ADS_PURCHASE_VALUE = 15 [
+      (options.label) = 'Purchase value',
+      (options.accessor_key) = 'googleAdsPurchaseValue',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = GOOGLE_ADS
+    ];
+    COLUMN_GOOGLE_ADS_CLICK_THROUGH_RATE = 16 [
+      (options.label) = 'Click through rate',
+      (options.accessor_key) = 'googleAdsClickThroughRate',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = GOOGLE_ADS
+    ];
+    COLUMN_GOOGLE_ADS_RETURN_ON_AD_SPEND = 17 [
+      (options.label) = 'ROAS',
+      (options.accessor_key) = 'googleAdsReturnOnAdSpend',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.suffix) = 'X',
+      (options.platform_type) = GOOGLE_ADS
+    ];
+    COLUMN_GA_PRODUCT_PAGE_VIEWS = 18 [
+      (options.label) = 'Page views',
+      (options.accessor_key) = 'gaProductPageViews',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = GOOGLE_ANALYTICS
+    ];
+    COLUMN_GA_ADD_TO_CARTS = 19 [
+      (options.label) = 'Add to cart',
+      (options.accessor_key) = 'gaAddToCarts',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = GOOGLE_ANALYTICS
+    ];
+    COLUMN_GA_CHECKOUTS = 20 [
+      (options.label) = 'Checkouts',
+      (options.accessor_key) = 'gaCheckouts',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = GOOGLE_ANALYTICS
+    ];
+    COLUMN_GA_PURCHASES = 21 [
+      (options.label) = 'Purchases',
+      (options.accessor_key) = 'gaPurchases',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = GOOGLE_ANALYTICS
+    ];
+    COLUMN_GA_REVENUE = 22 [
+      (options.label) = 'Revenue',
+      (options.accessor_key) = 'gaRevenue',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = GOOGLE_ANALYTICS
+    ];
+    COLUMN_GA_CONVERSION_RATE = 23 [
+      (options.label) = 'Conversion rate',
+      (options.accessor_key) = 'gaConversionRate',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = GOOGLE_ANALYTICS
+    ];
+    COLUMN_GA_ADD_TO_CART_RATE = 24 [
+      (options.label) = 'Add to cart rate',
+      (options.accessor_key) = 'gaAddToCartRate',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.suffix) = '%',
+      (options.platform_type) = GOOGLE_ANALYTICS
+    ];
+    COLUMN_META_SPENDS = 25 [
+      (options.label) = 'Spends',
+      (options.accessor_key) = 'metaSpends',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = META_ADS
+    ];
+    COLUMN_META_IMPRESSIONS = 26 [
+      (options.label) = 'Impressions',
+      (options.accessor_key) = 'metaImpressions',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = META_ADS
+    ];
+    COLUMN_META_CLICKS = 27 [
+      (options.label) = 'Clicks',
+      (options.accessor_key) = 'metaClicks',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = META_ADS
+    ];
+    COLUMN_META_LINK_CLICKS = 28 [
+      (options.label) = 'Link clicks',
+      (options.accessor_key) = 'metaLinkClicks',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = META_ADS
+    ];
+    COLUMN_META_CLICK_THROUGH_RATE = 29 [
+      (options.label) = 'Click through rate',
+      (options.accessor_key) = 'metaClickThroughRate',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.suffix) = '%',
+      (options.platform_type) = META_ADS
+    ];
+    COLUMN_META_COST_PER_CLICK = 30 [
+      (options.label) = 'Cost per click',
+      (options.accessor_key) = 'metaCostPerClick',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = META_ADS
+    ];
+    COLUMN_META_COST_PER_MILLE = 31 [
+      (options.label) = 'Cost per mille',
+      (options.accessor_key) = 'metaCostPerMille',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = META_ADS
+    ];
+    COLUMN_SHOPIFY_QUANTITY_SOLD = 32 [
+      (options.label) = 'Quantity sold',
+      (options.accessor_key) = 'shopifyQuantitySold',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = SHOPIFY
+    ];
+    COLUMN_SHOPIFY_TOTAL_SALES = 33 [
+      (options.label) = 'Total sales',
+      (options.accessor_key) = 'shopifyTotalSales',
+      (options.is_sortable) = true,
+      (options.is_filterable) = true,
+      (options.platform_type) = SHOPIFY
+    ];
+  }
+
+  // Next Id: 6
+  // Configuration for the table displayed in the Products analytics Data.
+  message TableConfig {
+    // Specifies the order of columns in the table.
+    repeated Column column_order = 1;
+
+    // Specifies columns to be hidden in the table.
+    repeated Column column_hidden = 2;
+
+    // Specifies the default column used for sorting.
+    Column default_sorted_column = 3;
+
+    // Specifies the sorting direction.
+    constants.ui.SortingDirection sorting_direction = 4;
+    
+    // Filter expression to filter the records in the table.
+    types.Expression filter_expression = 5;
+  }
+
+  // Specifies the type of rendering for the widget.
+  constants.ui.RenderType render_type = 1;
+
+  // Configuration for the table displayed in the widget.
+  TableConfig table_config = 2;
+}

{strique_proto_schema-31.8.1rc412 → strique_proto_schema-32.0.0}/strique_proto_schema.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: strique-proto-schema
-Version: 31.8.1rc412
+Version: 32.0.0
 Summary: API contracts and Data Transfer Objects (DTO) in the form of Protocol Buffers for Strique binaries.
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown

{strique_proto_schema-31.8.1rc412 → strique_proto_schema-32.0.0}/strique_proto_schema.egg-info/SOURCES.txt

@@ -180,6 +180,7 @@ src/protos/widget/amazon_seller/top_performing_cities.proto
 src/protos/widget/amazon_seller/top_performing_products.proto
 src/protos/widget/amazon_seller/top_performing_regions.proto
 src/protos/widget/amazon_seller/top_returned_products.proto
+src/protos/widget/analytics/product_analytics.proto
 src/protos/widget/catalog/automated_rule_removecutsize_filter.proto
 src/protos/widget/catalog/automated_rule_seo_title.proto
 src/protos/widget/catalog/automated_rule_set_conditions.proto