1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784
// This file is @generated by prost-build.
/// Request message for the `ReportService.Search` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SearchRequest {
/// Required. Id of the account making the call. Must be a standalone account
/// or an MCA subaccount. Format: accounts/{account}
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. Query that defines a report to be retrieved.
///
/// For details on how to construct your query, see the Query Language
/// guide. For the full list of available tables and fields, see the Available
/// fields.
#[prost(string, tag = "2")]
pub query: ::prost::alloc::string::String,
/// Optional. Number of `ReportRows` to retrieve in a single page. Defaults to
/// 1000. Values above 5000 are coerced to 5000.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// Optional. Token of the page to retrieve. If not specified, the first page
/// of results is returned. In order to request the next page of results, the
/// value obtained from `next_page_token` in the previous response should be
/// used.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
}
/// Response message for the `ReportService.Search` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SearchResponse {
/// Rows that matched the search query.
#[prost(message, repeated, tag = "1")]
pub results: ::prost::alloc::vec::Vec<ReportRow>,
/// Token which can be sent as `page_token` to retrieve the next page. If
/// omitted, there are no subsequent pages.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Result row returned from the search query.
///
/// Only the message corresponding to the queried table is populated in the
/// response. Within the populated message, only the fields requested explicitly
/// in the query are populated.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReportRow {
/// Fields available for query in `product_performance_view` table.
#[prost(message, optional, tag = "1")]
pub product_performance_view: ::core::option::Option<ProductPerformanceView>,
/// Fields available for query in `non_product_performance_view` table.
#[prost(message, optional, tag = "7")]
pub non_product_performance_view: ::core::option::Option<NonProductPerformanceView>,
/// Fields available for query in `product_view` table.
#[prost(message, optional, tag = "2")]
pub product_view: ::core::option::Option<ProductView>,
/// Fields available for query in `price_competitiveness_product_view` table.
#[prost(message, optional, tag = "3")]
pub price_competitiveness_product_view: ::core::option::Option<
PriceCompetitivenessProductView,
>,
/// Fields available for query in `price_insights_product_view` table.
#[prost(message, optional, tag = "4")]
pub price_insights_product_view: ::core::option::Option<PriceInsightsProductView>,
/// Fields available for query in `best_sellers_product_cluster_view` table.
#[prost(message, optional, tag = "5")]
pub best_sellers_product_cluster_view: ::core::option::Option<
BestSellersProductClusterView,
>,
/// Fields available for query in `best_sellers_brand_view` table.
#[prost(message, optional, tag = "6")]
pub best_sellers_brand_view: ::core::option::Option<BestSellersBrandView>,
/// Fields available for query in `competitive_visibility_competitor_view`
/// table.
#[prost(message, optional, tag = "8")]
pub competitive_visibility_competitor_view: ::core::option::Option<
CompetitiveVisibilityCompetitorView,
>,
/// Fields available for query in `competitive_visibility_top_merchant_view`
/// table.
#[prost(message, optional, tag = "9")]
pub competitive_visibility_top_merchant_view: ::core::option::Option<
CompetitiveVisibilityTopMerchantView,
>,
/// Fields available for query in `competitive_visibility_benchmark_view`
/// table.
#[prost(message, optional, tag = "10")]
pub competitive_visibility_benchmark_view: ::core::option::Option<
CompetitiveVisibilityBenchmarkView,
>,
}
/// Fields available for query in `product_performance_view` table.
///
/// Product performance data for your account, including performance metrics (for
/// example, `clicks`) and dimensions according to which performance metrics are
/// segmented (for example, `offer_id`). Values of product dimensions, such as
/// `offer_id`, reflect the state of a product at the time of the impression.
///
/// Segment fields cannot be selected in queries without also selecting at least
/// one metric field.
///
/// Values are only set for fields requested explicitly in the request's search
/// query.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ProductPerformanceView {
/// Marketing method to which metrics apply. Segment.
#[prost(enumeration = "marketing_method::MarketingMethodEnum", optional, tag = "1")]
pub marketing_method: ::core::option::Option<i32>,
/// Date in the merchant timezone to which metrics apply. Segment.
///
/// Condition on `date` is required in the `WHERE` clause.
#[prost(message, optional, tag = "2")]
pub date: ::core::option::Option<super::super::super::super::r#type::Date>,
/// First day of the week (Monday) of the metrics date in the merchant
/// timezone. Segment.
#[prost(message, optional, tag = "3")]
pub week: ::core::option::Option<super::super::super::super::r#type::Date>,
/// Code of the country where the customer is located at the time of the event.
/// Represented in the ISO 3166 format. Segment.
///
/// If the customer country cannot be determined, a special 'ZZ' code is
/// returned.
#[prost(string, optional, tag = "4")]
pub customer_country_code: ::core::option::Option<::prost::alloc::string::String>,
/// Merchant-provided id of the product. Segment.
#[prost(string, optional, tag = "5")]
pub offer_id: ::core::option::Option<::prost::alloc::string::String>,
/// Title of the product. Segment.
#[prost(string, optional, tag = "6")]
pub title: ::core::option::Option<::prost::alloc::string::String>,
/// Brand of the product. Segment.
#[prost(string, optional, tag = "7")]
pub brand: ::core::option::Option<::prost::alloc::string::String>,
/// [Product category (1st
/// level)](<https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type>)
/// in Google's product taxonomy. Segment.
#[prost(string, optional, tag = "8")]
pub category_l1: ::core::option::Option<::prost::alloc::string::String>,
/// [Product category (2nd
/// level)](<https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type>)
/// in Google's product taxonomy. Segment.
#[prost(string, optional, tag = "9")]
pub category_l2: ::core::option::Option<::prost::alloc::string::String>,
/// [Product category (3rd
/// level)](<https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type>)
/// in Google's product taxonomy. Segment.
#[prost(string, optional, tag = "10")]
pub category_l3: ::core::option::Option<::prost::alloc::string::String>,
/// [Product category (4th
/// level)](<https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type>)
/// in Google's product taxonomy. Segment.
#[prost(string, optional, tag = "11")]
pub category_l4: ::core::option::Option<::prost::alloc::string::String>,
/// [Product category (5th
/// level)](<https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type>)
/// in Google's product taxonomy. Segment.
#[prost(string, optional, tag = "12")]
pub category_l5: ::core::option::Option<::prost::alloc::string::String>,
/// [Product type (1st
/// level)](<https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type>)
/// in merchant's own product taxonomy. Segment.
#[prost(string, optional, tag = "13")]
pub product_type_l1: ::core::option::Option<::prost::alloc::string::String>,
/// [Product type (2nd
/// level)](<https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type>)
/// in merchant's own product taxonomy. Segment.
#[prost(string, optional, tag = "14")]
pub product_type_l2: ::core::option::Option<::prost::alloc::string::String>,
/// [Product type (3rd
/// level)](<https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type>)
/// in merchant's own product taxonomy. Segment.
#[prost(string, optional, tag = "15")]
pub product_type_l3: ::core::option::Option<::prost::alloc::string::String>,
/// [Product type (4th
/// level)](<https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type>)
/// in merchant's own product taxonomy. Segment.
#[prost(string, optional, tag = "16")]
pub product_type_l4: ::core::option::Option<::prost::alloc::string::String>,
/// [Product type (5th
/// level)](<https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type>)
/// in merchant's own product taxonomy. Segment.
#[prost(string, optional, tag = "17")]
pub product_type_l5: ::core::option::Option<::prost::alloc::string::String>,
/// Custom label 0 for custom grouping of products. Segment.
#[prost(string, optional, tag = "18")]
pub custom_label0: ::core::option::Option<::prost::alloc::string::String>,
/// Custom label 1 for custom grouping of products. Segment.
#[prost(string, optional, tag = "19")]
pub custom_label1: ::core::option::Option<::prost::alloc::string::String>,
/// Custom label 2 for custom grouping of products. Segment.
#[prost(string, optional, tag = "20")]
pub custom_label2: ::core::option::Option<::prost::alloc::string::String>,
/// Custom label 3 for custom grouping of products. Segment.
#[prost(string, optional, tag = "21")]
pub custom_label3: ::core::option::Option<::prost::alloc::string::String>,
/// Custom label 4 for custom grouping of products. Segment.
#[prost(string, optional, tag = "22")]
pub custom_label4: ::core::option::Option<::prost::alloc::string::String>,
/// Number of clicks. Metric.
#[prost(int64, optional, tag = "23")]
pub clicks: ::core::option::Option<i64>,
/// Number of times merchant's products are shown. Metric.
#[prost(int64, optional, tag = "24")]
pub impressions: ::core::option::Option<i64>,
/// Click-through rate - the number of clicks merchant's products receive
/// (clicks) divided by the number of times the products are shown
/// (impressions). Metric.
#[prost(double, optional, tag = "25")]
pub click_through_rate: ::core::option::Option<f64>,
/// Number of conversions attributed to the product, reported on the conversion
/// date. Depending on the attribution model, a conversion might be distributed
/// across multiple clicks, where each click gets its own credit assigned. This
/// metric is a sum of all such credits. Metric.
///
/// Available only for the `FREE` traffic source.
#[prost(double, optional, tag = "26")]
pub conversions: ::core::option::Option<f64>,
/// Value of conversions attributed to the product, reported on the conversion
/// date. Metric.
///
/// Available only for the `FREE` traffic source.
#[prost(message, optional, tag = "27")]
pub conversion_value: ::core::option::Option<super::super::super::r#type::Price>,
/// Number of conversions divided by the number of clicks, reported on the
/// impression date. Metric.
///
/// Available only for the `FREE` traffic source.
#[prost(double, optional, tag = "28")]
pub conversion_rate: ::core::option::Option<f64>,
}
/// Fields available for query in `product_view` table.
///
/// Products in the current inventory. Products in this table are the same as in
/// Products sub-API but not all product attributes from Products sub-API are
/// available for query in this table. In contrast to Products sub-API, this
/// table allows to filter the returned list of products by product attributes.
/// To retrieve a single product by `id` or list all products, Products sub-API
/// should be used.
///
/// Values are only set for fields requested explicitly in the request's search
/// query.
///
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ProductView {
/// REST ID of the product, in the form of
/// `channel~languageCode~feedLabel~offerId`. Merchant API methods that operate
/// on products take this as their `name` parameter.
///
/// Required in the `SELECT` clause.
#[prost(string, optional, tag = "1")]
pub id: ::core::option::Option<::prost::alloc::string::String>,
/// Channel of the product. Can be `ONLINE` or `LOCAL`.
#[prost(
enumeration = "super::super::super::r#type::channel::ChannelEnum",
optional,
tag = "28"
)]
pub channel: ::core::option::Option<i32>,
/// Language code of the product in BCP 47 format.
#[prost(string, optional, tag = "2")]
pub language_code: ::core::option::Option<::prost::alloc::string::String>,
/// Feed label of the product.
#[prost(string, optional, tag = "3")]
pub feed_label: ::core::option::Option<::prost::alloc::string::String>,
/// Merchant-provided id of the product.
#[prost(string, optional, tag = "4")]
pub offer_id: ::core::option::Option<::prost::alloc::string::String>,
/// Title of the product.
#[prost(string, optional, tag = "5")]
pub title: ::core::option::Option<::prost::alloc::string::String>,
/// Brand of the product.
#[prost(string, optional, tag = "6")]
pub brand: ::core::option::Option<::prost::alloc::string::String>,
/// Product category (1st level) in [Google's product
/// taxonomy](<https://support.google.com/merchants/answer/6324436>).
#[prost(string, optional, tag = "7")]
pub category_l1: ::core::option::Option<::prost::alloc::string::String>,
/// Product category (2nd level) in [Google's product
/// taxonomy](<https://support.google.com/merchants/answer/6324436>).
#[prost(string, optional, tag = "8")]
pub category_l2: ::core::option::Option<::prost::alloc::string::String>,
/// Product category (3rd level) in [Google's product
/// taxonomy](<https://support.google.com/merchants/answer/6324436>).
#[prost(string, optional, tag = "9")]
pub category_l3: ::core::option::Option<::prost::alloc::string::String>,
/// Product category (4th level) in [Google's product
/// taxonomy](<https://support.google.com/merchants/answer/6324436>).
#[prost(string, optional, tag = "10")]
pub category_l4: ::core::option::Option<::prost::alloc::string::String>,
/// Product category (5th level) in [Google's product
/// taxonomy](<https://support.google.com/merchants/answer/6324436>).
#[prost(string, optional, tag = "11")]
pub category_l5: ::core::option::Option<::prost::alloc::string::String>,
/// Product type (1st level) in merchant's own [product
/// taxonomy](<https://support.google.com/merchants/answer/6324406>).
#[prost(string, optional, tag = "12")]
pub product_type_l1: ::core::option::Option<::prost::alloc::string::String>,
/// Product type (2nd level) in merchant's own [product
/// taxonomy](<https://support.google.com/merchants/answer/6324406>).
#[prost(string, optional, tag = "13")]
pub product_type_l2: ::core::option::Option<::prost::alloc::string::String>,
/// Product type (3rd level) in merchant's own [product
/// taxonomy](<https://support.google.com/merchants/answer/6324406>).
#[prost(string, optional, tag = "14")]
pub product_type_l3: ::core::option::Option<::prost::alloc::string::String>,
/// Product type (4th level) in merchant's own [product
/// taxonomy](<https://support.google.com/merchants/answer/6324406>).
#[prost(string, optional, tag = "15")]
pub product_type_l4: ::core::option::Option<::prost::alloc::string::String>,
/// Product type (5th level) in merchant's own [product
/// taxonomy](<https://support.google.com/merchants/answer/6324406>).
#[prost(string, optional, tag = "16")]
pub product_type_l5: ::core::option::Option<::prost::alloc::string::String>,
/// Product price. Absent if the information about the price of the product is
/// not available.
#[prost(message, optional, tag = "17")]
pub price: ::core::option::Option<super::super::super::r#type::Price>,
/// [Condition](<https://support.google.com/merchants/answer/6324469>) of the
/// product.
#[prost(string, optional, tag = "18")]
pub condition: ::core::option::Option<::prost::alloc::string::String>,
/// [Availability](<https://support.google.com/merchants/answer/6324448>) of the
/// product.
#[prost(string, optional, tag = "19")]
pub availability: ::core::option::Option<::prost::alloc::string::String>,
/// Normalized [shipping
/// label](<https://support.google.com/merchants/answer/6324504>) specified in
/// the data source.
#[prost(string, optional, tag = "20")]
pub shipping_label: ::core::option::Option<::prost::alloc::string::String>,
/// List of Global Trade Item Numbers (GTINs) of the product.
#[prost(string, repeated, tag = "21")]
pub gtin: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Item group id provided by the merchant for grouping variants together.
#[prost(string, optional, tag = "22")]
pub item_group_id: ::core::option::Option<::prost::alloc::string::String>,
/// Link to the processed image of the product, hosted on the Google
/// infrastructure.
#[prost(string, optional, tag = "23")]
pub thumbnail_link: ::core::option::Option<::prost::alloc::string::String>,
/// The time the merchant created the product in timestamp seconds.
#[prost(message, optional, tag = "24")]
pub creation_time: ::core::option::Option<::prost_types::Timestamp>,
/// Expiration date for the product, specified on insertion.
#[prost(message, optional, tag = "25")]
pub expiration_date: ::core::option::Option<
super::super::super::super::r#type::Date,
>,
/// Aggregated status.
#[prost(
enumeration = "product_view::AggregatedReportingContextStatus",
optional,
tag = "26"
)]
pub aggregated_reporting_context_status: ::core::option::Option<i32>,
/// List of item issues for the product.
///
/// **This field cannot be used for sorting the results.**
///
/// **Only selected attributes of this field (for example,
/// `item_issues.severity.aggregated_severity`) can be used for filtering the
/// results.**
#[prost(message, repeated, tag = "27")]
pub item_issues: ::prost::alloc::vec::Vec<product_view::ItemIssue>,
/// Estimated performance potential compared to highest performing products of
/// the merchant.
#[prost(enumeration = "product_view::ClickPotential", tag = "29")]
pub click_potential: i32,
/// Rank of the product based on its click potential. A product with
/// `click_potential_rank` 1 has the highest click potential among the
/// merchant's products that fulfill the search query conditions.
#[prost(int64, optional, tag = "30")]
pub click_potential_rank: ::core::option::Option<i64>,
}
/// Nested message and enum types in `ProductView`.
pub mod product_view {
/// Item issue associated with the product.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ItemIssue {
/// Item issue type.
#[prost(message, optional, tag = "1")]
pub r#type: ::core::option::Option<item_issue::ItemIssueType>,
/// Item issue severity.
#[prost(message, optional, tag = "2")]
pub severity: ::core::option::Option<item_issue::ItemIssueSeverity>,
/// Item issue resolution.
#[prost(enumeration = "item_issue::ItemIssueResolution", optional, tag = "3")]
pub resolution: ::core::option::Option<i32>,
}
/// Nested message and enum types in `ItemIssue`.
pub mod item_issue {
/// Issue type.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ItemIssueType {
/// Error code of the issue, equivalent to the `code` of [Product
/// issues](<https://developers.google.com/shopping-content/guides/product-issues>).
#[prost(string, optional, tag = "1")]
pub code: ::core::option::Option<::prost::alloc::string::String>,
/// Canonical attribute name for attribute-specific issues.
#[prost(string, optional, tag = "2")]
pub canonical_attribute: ::core::option::Option<
::prost::alloc::string::String,
>,
}
/// How the issue affects the serving of the product.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ItemIssueSeverity {
/// Issue severity per reporting context.
#[prost(message, repeated, tag = "1")]
pub severity_per_reporting_context: ::prost::alloc::vec::Vec<
item_issue_severity::IssueSeverityPerReportingContext,
>,
/// Aggregated severity of the issue for all reporting contexts it affects.
///
/// **This field can be used for filtering the results.**
#[prost(
enumeration = "item_issue_severity::AggregatedIssueSeverity",
optional,
tag = "2"
)]
pub aggregated_severity: ::core::option::Option<i32>,
}
/// Nested message and enum types in `ItemIssueSeverity`.
pub mod item_issue_severity {
/// Issue severity per reporting context.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct IssueSeverityPerReportingContext {
/// Reporting context the issue applies to.
#[prost(
enumeration = "super::super::super::super::super::super::r#type::reporting_context::ReportingContextEnum",
optional,
tag = "1"
)]
pub reporting_context: ::core::option::Option<i32>,
/// List of disapproved countries in the reporting context, represented
/// in ISO 3166 format.
#[prost(string, repeated, tag = "2")]
pub disapproved_countries: ::prost::alloc::vec::Vec<
::prost::alloc::string::String,
>,
/// List of demoted countries in the reporting context, represented in
/// ISO 3166 format.
#[prost(string, repeated, tag = "3")]
pub demoted_countries: ::prost::alloc::vec::Vec<
::prost::alloc::string::String,
>,
}
/// Issue severity aggregated for all reporting contexts.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum AggregatedIssueSeverity {
/// Not specified.
Unspecified = 0,
/// Issue disapproves the product in at least one reporting context.
Disapproved = 1,
/// Issue demotes the product in all reporting contexts it affects.
Demoted = 2,
/// Issue resolution is `PENDING_PROCESSING`.
Pending = 3,
}
impl AggregatedIssueSeverity {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
AggregatedIssueSeverity::Unspecified => {
"AGGREGATED_ISSUE_SEVERITY_UNSPECIFIED"
}
AggregatedIssueSeverity::Disapproved => "DISAPPROVED",
AggregatedIssueSeverity::Demoted => "DEMOTED",
AggregatedIssueSeverity::Pending => "PENDING",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"AGGREGATED_ISSUE_SEVERITY_UNSPECIFIED" => {
Some(Self::Unspecified)
}
"DISAPPROVED" => Some(Self::Disapproved),
"DEMOTED" => Some(Self::Demoted),
"PENDING" => Some(Self::Pending),
_ => None,
}
}
}
}
/// How to resolve the issue.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ItemIssueResolution {
/// Not specified.
Unspecified = 0,
/// The merchant has to fix the issue.
MerchantAction = 1,
/// The issue will be resolved automatically (for example, image crawl) or
/// through a Google review. No merchant action is required now. Resolution
/// might lead to another issue (for example, if crawl fails).
PendingProcessing = 2,
}
impl ItemIssueResolution {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
ItemIssueResolution::Unspecified => {
"ITEM_ISSUE_RESOLUTION_UNSPECIFIED"
}
ItemIssueResolution::MerchantAction => "MERCHANT_ACTION",
ItemIssueResolution::PendingProcessing => "PENDING_PROCESSING",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"ITEM_ISSUE_RESOLUTION_UNSPECIFIED" => Some(Self::Unspecified),
"MERCHANT_ACTION" => Some(Self::MerchantAction),
"PENDING_PROCESSING" => Some(Self::PendingProcessing),
_ => None,
}
}
}
}
/// Status of the product aggregated for all reporting contexts.
///
/// Here's an example of how the aggregated status is computed:
///
/// Free listings | Shopping ads | Status
/// --------------|--------------|------------------------------
/// Approved | Approved | ELIGIBLE
/// Approved | Pending | ELIGIBLE
/// Approved | Disapproved | ELIGIBLE_LIMITED
/// Pending | Pending | PENDING
/// Disapproved | Disapproved | NOT_ELIGIBLE_OR_DISAPPROVED
///
///
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum AggregatedReportingContextStatus {
/// Not specified.
Unspecified = 0,
/// Product is not eligible or is disapproved for all reporting contexts.
NotEligibleOrDisapproved = 1,
/// Product's status is pending in all reporting contexts.
Pending = 2,
/// Product is eligible for some (but not all) reporting contexts.
EligibleLimited = 3,
/// Product is eligible for all reporting contexts.
Eligible = 4,
}
impl AggregatedReportingContextStatus {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
AggregatedReportingContextStatus::Unspecified => {
"AGGREGATED_REPORTING_CONTEXT_STATUS_UNSPECIFIED"
}
AggregatedReportingContextStatus::NotEligibleOrDisapproved => {
"NOT_ELIGIBLE_OR_DISAPPROVED"
}
AggregatedReportingContextStatus::Pending => "PENDING",
AggregatedReportingContextStatus::EligibleLimited => "ELIGIBLE_LIMITED",
AggregatedReportingContextStatus::Eligible => "ELIGIBLE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"AGGREGATED_REPORTING_CONTEXT_STATUS_UNSPECIFIED" => {
Some(Self::Unspecified)
}
"NOT_ELIGIBLE_OR_DISAPPROVED" => Some(Self::NotEligibleOrDisapproved),
"PENDING" => Some(Self::Pending),
"ELIGIBLE_LIMITED" => Some(Self::EligibleLimited),
"ELIGIBLE" => Some(Self::Eligible),
_ => None,
}
}
}
/// A product's [click
/// potential](<https://support.google.com/merchants/answer/188488>) estimates
/// its performance potential compared to highest performing products of the
/// merchant. Click potential of a product helps merchants to prioritize which
/// products to fix and helps them understand how products are performing
/// against their potential.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ClickPotential {
/// Unknown predicted clicks impact.
Unspecified = 0,
/// Potential to receive a low number of clicks compared to the highest
/// performing products of the merchant.
Low = 1,
/// Potential to receive a moderate number of clicks compared to the highest
/// performing products of the merchant.
Medium = 2,
/// Potential to receive a similar number of clicks as the highest performing
/// products of the merchant.
High = 3,
}
impl ClickPotential {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
ClickPotential::Unspecified => "CLICK_POTENTIAL_UNSPECIFIED",
ClickPotential::Low => "LOW",
ClickPotential::Medium => "MEDIUM",
ClickPotential::High => "HIGH",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"CLICK_POTENTIAL_UNSPECIFIED" => Some(Self::Unspecified),
"LOW" => Some(Self::Low),
"MEDIUM" => Some(Self::Medium),
"HIGH" => Some(Self::High),
_ => None,
}
}
}
}
/// Fields available for query in `price_competitiveness_product_view` table.
///
/// [Price competitiveness](<https://support.google.com/merchants/answer/9626903>)
/// report.
///
/// Values are only set for fields requested explicitly in the request's search
/// query.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PriceCompetitivenessProductView {
/// Country of the price benchmark. Represented in the ISO 3166 format.
///
/// Required in the `SELECT` clause.
#[prost(string, optional, tag = "1")]
pub report_country_code: ::core::option::Option<::prost::alloc::string::String>,
/// REST ID of the product, in the form of
/// `channel~languageCode~feedLabel~offerId`. Can be used to join data with the
/// `product_view` table.
///
/// Required in the `SELECT` clause.
#[prost(string, optional, tag = "2")]
pub id: ::core::option::Option<::prost::alloc::string::String>,
/// Merchant-provided id of the product.
#[prost(string, optional, tag = "3")]
pub offer_id: ::core::option::Option<::prost::alloc::string::String>,
/// Title of the product.
#[prost(string, optional, tag = "4")]
pub title: ::core::option::Option<::prost::alloc::string::String>,
/// Brand of the product.
#[prost(string, optional, tag = "5")]
pub brand: ::core::option::Option<::prost::alloc::string::String>,
/// Product category (1st level) in [Google's product
/// taxonomy](<https://support.google.com/merchants/answer/6324436>).
#[prost(string, optional, tag = "6")]
pub category_l1: ::core::option::Option<::prost::alloc::string::String>,
/// Product category (2nd level) in [Google's product
/// taxonomy](<https://support.google.com/merchants/answer/6324436>).
#[prost(string, optional, tag = "7")]
pub category_l2: ::core::option::Option<::prost::alloc::string::String>,
/// Product category (3rd level) in [Google's product
/// taxonomy](<https://support.google.com/merchants/answer/6324436>).
#[prost(string, optional, tag = "8")]
pub category_l3: ::core::option::Option<::prost::alloc::string::String>,
/// Product category (4th level) in [Google's product
/// taxonomy](<https://support.google.com/merchants/answer/6324436>).
#[prost(string, optional, tag = "9")]
pub category_l4: ::core::option::Option<::prost::alloc::string::String>,
/// Product category (5th level) in [Google's product
/// taxonomy](<https://support.google.com/merchants/answer/6324436>).
#[prost(string, optional, tag = "10")]
pub category_l5: ::core::option::Option<::prost::alloc::string::String>,
/// Product type (1st level) in merchant's own [product
/// taxonomy](<https://support.google.com/merchants/answer/6324406>).
#[prost(string, optional, tag = "11")]
pub product_type_l1: ::core::option::Option<::prost::alloc::string::String>,
/// Product type (2nd level) in merchant's own [product
/// taxonomy](<https://support.google.com/merchants/answer/6324406>).
#[prost(string, optional, tag = "12")]
pub product_type_l2: ::core::option::Option<::prost::alloc::string::String>,
/// Product type (3rd level) in merchant's own [product
/// taxonomy](<https://support.google.com/merchants/answer/6324406>).
#[prost(string, optional, tag = "13")]
pub product_type_l3: ::core::option::Option<::prost::alloc::string::String>,
/// Product type (4th level) in merchant's own [product
/// taxonomy](<https://support.google.com/merchants/answer/6324406>).
#[prost(string, optional, tag = "14")]
pub product_type_l4: ::core::option::Option<::prost::alloc::string::String>,
/// Product type (5th level) in merchant's own [product
/// taxonomy](<https://support.google.com/merchants/answer/6324406>).
#[prost(string, optional, tag = "15")]
pub product_type_l5: ::core::option::Option<::prost::alloc::string::String>,
/// Current price of the product.
#[prost(message, optional, tag = "16")]
pub price: ::core::option::Option<super::super::super::r#type::Price>,
/// Latest available price benchmark for the product's catalog in the benchmark
/// country.
#[prost(message, optional, tag = "17")]
pub benchmark_price: ::core::option::Option<super::super::super::r#type::Price>,
}
/// Fields available for query in `price_insights_product_view` table.
///
/// [Price insights](<https://support.google.com/merchants/answer/11916926>)
/// report.
///
/// Values are only set for fields requested explicitly in the request's search
/// query.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PriceInsightsProductView {
/// REST ID of the product, in the form of
/// `channel~languageCode~feedLabel~offerId`. Can be used to join data with the
/// `product_view` table.
///
/// Required in the `SELECT` clause.
#[prost(string, optional, tag = "1")]
pub id: ::core::option::Option<::prost::alloc::string::String>,
/// Merchant-provided id of the product.
#[prost(string, optional, tag = "2")]
pub offer_id: ::core::option::Option<::prost::alloc::string::String>,
/// Title of the product.
#[prost(string, optional, tag = "3")]
pub title: ::core::option::Option<::prost::alloc::string::String>,
/// Brand of the product.
#[prost(string, optional, tag = "4")]
pub brand: ::core::option::Option<::prost::alloc::string::String>,
/// Product category (1st level) in [Google's product
/// taxonomy](<https://support.google.com/merchants/answer/6324436>).
#[prost(string, optional, tag = "5")]
pub category_l1: ::core::option::Option<::prost::alloc::string::String>,
/// Product category (2nd level) in [Google's product
/// taxonomy](<https://support.google.com/merchants/answer/6324436>).
#[prost(string, optional, tag = "6")]
pub category_l2: ::core::option::Option<::prost::alloc::string::String>,
/// Product category (3rd level) in [Google's product
/// taxonomy](<https://support.google.com/merchants/answer/6324436>).
#[prost(string, optional, tag = "7")]
pub category_l3: ::core::option::Option<::prost::alloc::string::String>,
/// Product category (4th level) in [Google's product
/// taxonomy](<https://support.google.com/merchants/answer/6324436>).
#[prost(string, optional, tag = "8")]
pub category_l4: ::core::option::Option<::prost::alloc::string::String>,
/// Product category (5th level) in [Google's product
/// taxonomy](<https://support.google.com/merchants/answer/6324436>).
#[prost(string, optional, tag = "9")]
pub category_l5: ::core::option::Option<::prost::alloc::string::String>,
/// Product type (1st level) in merchant's own [product
/// taxonomy](<https://support.google.com/merchants/answer/6324406>).
#[prost(string, optional, tag = "10")]
pub product_type_l1: ::core::option::Option<::prost::alloc::string::String>,
/// Product type (2nd level) in merchant's own [product
/// taxonomy](<https://support.google.com/merchants/answer/6324406>).
#[prost(string, optional, tag = "11")]
pub product_type_l2: ::core::option::Option<::prost::alloc::string::String>,
/// Product type (3rd level) in merchant's own [product
/// taxonomy](<https://support.google.com/merchants/answer/6324406>).
#[prost(string, optional, tag = "12")]
pub product_type_l3: ::core::option::Option<::prost::alloc::string::String>,
/// Product type (4th level) in merchant's own [product
/// taxonomy](<https://support.google.com/merchants/answer/6324406>).
#[prost(string, optional, tag = "13")]
pub product_type_l4: ::core::option::Option<::prost::alloc::string::String>,
/// Product type (5th level) in merchant's own [product
/// taxonomy](<https://support.google.com/merchants/answer/6324406>).
#[prost(string, optional, tag = "14")]
pub product_type_l5: ::core::option::Option<::prost::alloc::string::String>,
/// Current price of the product.
#[prost(message, optional, tag = "15")]
pub price: ::core::option::Option<super::super::super::r#type::Price>,
/// Latest suggested price for the product.
#[prost(message, optional, tag = "16")]
pub suggested_price: ::core::option::Option<super::super::super::r#type::Price>,
/// Predicted change in impressions as a fraction after introducing the
/// suggested price compared to current active price. For example, 0.05 is a 5%
/// predicted increase in impressions.
#[prost(double, optional, tag = "17")]
pub predicted_impressions_change_fraction: ::core::option::Option<f64>,
/// Predicted change in clicks as a fraction after introducing the
/// suggested price compared to current active price. For example, 0.05 is a 5%
/// predicted increase in clicks.
#[prost(double, optional, tag = "18")]
pub predicted_clicks_change_fraction: ::core::option::Option<f64>,
/// Predicted change in conversions as a fraction after introducing the
/// suggested price compared to current active price. For example, 0.05 is a 5%
/// predicted increase in conversions).
#[prost(double, optional, tag = "19")]
pub predicted_conversions_change_fraction: ::core::option::Option<f64>,
/// The predicted effectiveness of applying the price suggestion, bucketed.
#[prost(enumeration = "price_insights_product_view::Effectiveness", tag = "22")]
pub effectiveness: i32,
}
/// Nested message and enum types in `PriceInsightsProductView`.
pub mod price_insights_product_view {
/// Predicted effectiveness bucket.
///
/// Effectiveness indicates which products would benefit most from price
/// changes. This rating takes into consideration the performance boost
/// predicted by adjusting the sale price and the difference between your
/// current price and the suggested price. Price suggestions with `HIGH`
/// effectiveness are predicted to drive the largest increase in performance.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Effectiveness {
/// Effectiveness is unknown.
Unspecified = 0,
/// Effectiveness is low.
Low = 1,
/// Effectiveness is medium.
Medium = 2,
/// Effectiveness is high.
High = 3,
}
impl Effectiveness {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Effectiveness::Unspecified => "EFFECTIVENESS_UNSPECIFIED",
Effectiveness::Low => "LOW",
Effectiveness::Medium => "MEDIUM",
Effectiveness::High => "HIGH",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"EFFECTIVENESS_UNSPECIFIED" => Some(Self::Unspecified),
"LOW" => Some(Self::Low),
"MEDIUM" => Some(Self::Medium),
"HIGH" => Some(Self::High),
_ => None,
}
}
}
}
/// Fields available for query in `best_sellers_product_cluster_view` table.
///
/// [Best sellers](<https://support.google.com/merchants/answer/9488679>) report
/// with top product clusters. A product cluster is a grouping for different
/// offers and variants that represent the same product, for example, Google
/// Pixel 7.
///
/// Values are only set for fields requested explicitly in the request's search
/// query.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BestSellersProductClusterView {
/// Report date. The value of this field can only be one of the following:
///
/// * The first day of the week (Monday) for weekly reports,
/// * The first day of the month for monthly reports.
///
/// Required in the `SELECT` clause. If a `WHERE` condition on `report_date` is
/// not specified in the query, the latest available weekly or monthly report
/// is returned.
#[prost(message, optional, tag = "1")]
pub report_date: ::core::option::Option<super::super::super::super::r#type::Date>,
/// Granularity of the report. The ranking can be done over a week or a month
/// timeframe.
///
/// Required in the `SELECT` clause. Condition on `report_granularity` is
/// required in the `WHERE` clause.
#[prost(
enumeration = "report_granularity::ReportGranularityEnum",
optional,
tag = "2"
)]
pub report_granularity: ::core::option::Option<i32>,
/// Country where the ranking is calculated. Represented in the ISO 3166
/// format.
///
/// Required in the `SELECT` clause. Condition on `report_country_code` is
/// required in the `WHERE` clause.
#[prost(string, optional, tag = "3")]
pub report_country_code: ::core::option::Option<::prost::alloc::string::String>,
/// Google product category ID to calculate the ranking for, represented in
/// [Google's product
/// taxonomy](<https://support.google.com/merchants/answer/6324436>).
///
/// Required in the `SELECT` clause. If a `WHERE` condition on
/// `report_category_id` is not specified in the query, rankings for all
/// top-level categories are returned.
#[prost(int64, optional, tag = "4")]
pub report_category_id: ::core::option::Option<i64>,
/// Title of the product cluster.
#[prost(string, optional, tag = "6")]
pub title: ::core::option::Option<::prost::alloc::string::String>,
/// Brand of the product cluster.
#[prost(string, optional, tag = "7")]
pub brand: ::core::option::Option<::prost::alloc::string::String>,
/// Product category (1st level) of the product cluster, represented in
/// [Google's product
/// taxonomy](<https://support.google.com/merchants/answer/6324436>).
#[prost(string, optional, tag = "8")]
pub category_l1: ::core::option::Option<::prost::alloc::string::String>,
/// Product category (2nd level) of the product cluster, represented in
/// [Google's product
/// taxonomy](<https://support.google.com/merchants/answer/6324436>).
#[prost(string, optional, tag = "9")]
pub category_l2: ::core::option::Option<::prost::alloc::string::String>,
/// Product category (3rd level) of the product cluster, represented in
/// [Google's product
/// taxonomy](<https://support.google.com/merchants/answer/6324436>).
#[prost(string, optional, tag = "10")]
pub category_l3: ::core::option::Option<::prost::alloc::string::String>,
/// Product category (4th level) of the product cluster, represented in
/// [Google's product
/// taxonomy](<https://support.google.com/merchants/answer/6324436>).
#[prost(string, optional, tag = "11")]
pub category_l4: ::core::option::Option<::prost::alloc::string::String>,
/// Product category (5th level) of the product cluster, represented in
/// [Google's product
/// taxonomy](<https://support.google.com/merchants/answer/6324436>).
#[prost(string, optional, tag = "12")]
pub category_l5: ::core::option::Option<::prost::alloc::string::String>,
/// GTINs of example variants of the product cluster.
#[prost(string, repeated, tag = "13")]
pub variant_gtins: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Whether the product cluster is `IN_STOCK` in your product data source in at
/// least one of the countries, `OUT_OF_STOCK` in your product data source in
/// all countries, or `NOT_IN_INVENTORY` at all.
///
/// The field doesn't take the Best sellers report country filter into account.
#[prost(
enumeration = "best_sellers_product_cluster_view::InventoryStatus",
optional,
tag = "14"
)]
pub inventory_status: ::core::option::Option<i32>,
/// Whether there is at least one product of the brand currently `IN_STOCK` in
/// your product data source in at least one of the countries, all products are
/// `OUT_OF_STOCK` in your product data source in all countries, or
/// `NOT_IN_INVENTORY`.
///
/// The field doesn't take the Best sellers report country filter into account.
#[prost(
enumeration = "best_sellers_product_cluster_view::InventoryStatus",
optional,
tag = "15"
)]
pub brand_inventory_status: ::core::option::Option<i32>,
/// Popularity of the product cluster on Ads and organic surfaces, in the
/// selected category and country, based on the estimated number of units sold.
#[prost(int64, optional, tag = "16")]
pub rank: ::core::option::Option<i64>,
/// Popularity rank in the previous week or month.
#[prost(int64, optional, tag = "17")]
pub previous_rank: ::core::option::Option<i64>,
/// Estimated demand in relation to the product cluster with the highest
/// popularity rank in the same category and country.
#[prost(enumeration = "relative_demand::RelativeDemandEnum", optional, tag = "18")]
pub relative_demand: ::core::option::Option<i32>,
/// Estimated demand in relation to the product cluster with the highest
/// popularity rank in the same category and country in the previous week or
/// month.
#[prost(enumeration = "relative_demand::RelativeDemandEnum", optional, tag = "19")]
pub previous_relative_demand: ::core::option::Option<i32>,
/// Change in the estimated demand. Whether it rose, sank or remained flat.
#[prost(
enumeration = "relative_demand_change_type::RelativeDemandChangeTypeEnum",
optional,
tag = "20"
)]
pub relative_demand_change: ::core::option::Option<i32>,
}
/// Nested message and enum types in `BestSellersProductClusterView`.
pub mod best_sellers_product_cluster_view {
/// Status of the product cluster or brand in your inventory.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum InventoryStatus {
/// Not specified.
Unspecified = 0,
/// You have a product for this product cluster or brand in stock.
InStock = 1,
/// You have a product for this product cluster or brand in inventory but it
/// is currently out of stock.
OutOfStock = 2,
/// You do not have a product for this product cluster or brand in inventory.
NotInInventory = 3,
}
impl InventoryStatus {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
InventoryStatus::Unspecified => "INVENTORY_STATUS_UNSPECIFIED",
InventoryStatus::InStock => "IN_STOCK",
InventoryStatus::OutOfStock => "OUT_OF_STOCK",
InventoryStatus::NotInInventory => "NOT_IN_INVENTORY",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"INVENTORY_STATUS_UNSPECIFIED" => Some(Self::Unspecified),
"IN_STOCK" => Some(Self::InStock),
"OUT_OF_STOCK" => Some(Self::OutOfStock),
"NOT_IN_INVENTORY" => Some(Self::NotInInventory),
_ => None,
}
}
}
}
/// Fields available for query in `best_sellers_brand_view` table.
///
/// [Best sellers](<https://support.google.com/merchants/answer/9488679>) report
/// with top brands.
///
/// Values are only set for fields requested explicitly in the request's search
/// query.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BestSellersBrandView {
/// Report date. The value of this field can only be one of the following:
///
/// * The first day of the week (Monday) for weekly reports,
/// * The first day of the month for monthly reports.
///
/// Required in the `SELECT` clause. If a `WHERE` condition on `report_date` is
/// not specified in the query, the latest available weekly or monthly report
/// is returned.
#[prost(message, optional, tag = "1")]
pub report_date: ::core::option::Option<super::super::super::super::r#type::Date>,
/// Granularity of the report. The ranking can be done over a week or a month
/// timeframe.
///
/// Required in the `SELECT` clause. Condition on `report_granularity` is
/// required in the `WHERE` clause.
#[prost(
enumeration = "report_granularity::ReportGranularityEnum",
optional,
tag = "2"
)]
pub report_granularity: ::core::option::Option<i32>,
/// Country where the ranking is calculated. Represented in the ISO 3166
/// format.
///
/// Required in the `SELECT` clause. Condition on `report_country_code` is
/// required in the `WHERE` clause.
#[prost(string, optional, tag = "3")]
pub report_country_code: ::core::option::Option<::prost::alloc::string::String>,
/// Google product category ID to calculate the ranking for, represented in
/// [Google's product
/// taxonomy](<https://support.google.com/merchants/answer/6324436>).
///
/// Required in the `SELECT` clause. If a `WHERE` condition on
/// `report_category_id` is not specified in the query, rankings for all
/// top-level categories are returned.
#[prost(int64, optional, tag = "4")]
pub report_category_id: ::core::option::Option<i64>,
/// Name of the brand.
#[prost(string, optional, tag = "6")]
pub brand: ::core::option::Option<::prost::alloc::string::String>,
/// Popularity of the brand on Ads and organic surfaces, in the selected
/// category and country, based on the estimated number of units sold.
#[prost(int64, optional, tag = "7")]
pub rank: ::core::option::Option<i64>,
/// Popularity rank in the previous week or month.
#[prost(int64, optional, tag = "8")]
pub previous_rank: ::core::option::Option<i64>,
/// Estimated demand in relation to the brand with the highest popularity rank
/// in the same category and country.
#[prost(enumeration = "relative_demand::RelativeDemandEnum", optional, tag = "9")]
pub relative_demand: ::core::option::Option<i32>,
/// Estimated demand in relation to the brand with the highest popularity rank
/// in the same category and country in the previous week or month.
#[prost(enumeration = "relative_demand::RelativeDemandEnum", optional, tag = "10")]
pub previous_relative_demand: ::core::option::Option<i32>,
/// Change in the estimated demand. Whether it rose, sank or remained flat.
#[prost(
enumeration = "relative_demand_change_type::RelativeDemandChangeTypeEnum",
optional,
tag = "11"
)]
pub relative_demand_change: ::core::option::Option<i32>,
}
/// Fields available for query in `non_product_performance_view` table.
///
/// Performance data on images and online store links leading to your non-product
/// pages. This includes performance metrics (for example, `clicks`)
/// and dimensions according to which performance metrics are segmented (for
/// example, `date`).
///
/// Segment fields cannot be selected in queries without also selecting at least
/// one metric field.
///
/// Values are only set for fields requested explicitly in the request's search
/// query.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct NonProductPerformanceView {
/// Date in the merchant timezone to which metrics apply. Segment.
///
/// Condition on `date` is required in the `WHERE` clause.
#[prost(message, optional, tag = "1")]
pub date: ::core::option::Option<super::super::super::super::r#type::Date>,
/// First day of the week (Monday) of the metrics date in the merchant
/// timezone. Segment.
#[prost(message, optional, tag = "2")]
pub week: ::core::option::Option<super::super::super::super::r#type::Date>,
/// Number of clicks on images and online store links leading to your
/// non-product pages. Metric.
#[prost(int64, optional, tag = "3")]
pub clicks: ::core::option::Option<i64>,
/// Number of times images and online store links leading to your non-product
/// pages were shown. Metric.
#[prost(int64, optional, tag = "4")]
pub impressions: ::core::option::Option<i64>,
/// Click-through rate - the number of clicks (`clicks`) divided by the number
/// of impressions (`impressions`) of images and online store links leading to
/// your non-product pages. Metric.
#[prost(double, optional, tag = "5")]
pub click_through_rate: ::core::option::Option<f64>,
}
/// Fields available for query in `competitive_visibility_competitor_view` table.
///
/// [Competitive
/// visibility](<https://support.google.com/merchants/answer/11366442>) report with
/// businesses with similar visibility.
///
/// Values are only set for fields requested explicitly in the request's search
/// query.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CompetitiveVisibilityCompetitorView {
/// Date of this row.
///
/// A condition on `date` is required in the `WHERE` clause.
#[prost(message, optional, tag = "1")]
pub date: ::core::option::Option<super::super::super::super::r#type::Date>,
/// Domain of your competitor or your domain, if 'is_your_domain' is true.
///
/// Required in the `SELECT` clause. Cannot be filtered on in the 'WHERE'
/// clause.
#[prost(string, optional, tag = "2")]
pub domain: ::core::option::Option<::prost::alloc::string::String>,
/// True if this row contains data for your domain.
///
/// Cannot be filtered on in the 'WHERE' clause.
#[prost(bool, optional, tag = "3")]
pub is_your_domain: ::core::option::Option<bool>,
/// Country where impressions appeared.
///
/// Required in the `SELECT` clause. A condition on `report_country_code` is
/// required in the `WHERE` clause.
#[prost(string, optional, tag = "4")]
pub report_country_code: ::core::option::Option<::prost::alloc::string::String>,
/// Google product category ID to calculate the report for, represented in
/// [Google's product
/// taxonomy](<https://support.google.com/merchants/answer/6324436>).
///
/// Required in the `SELECT` clause. A condition on `report_category_id` is
/// required in the `WHERE` clause.
#[prost(int64, optional, tag = "5")]
pub report_category_id: ::core::option::Option<i64>,
/// Traffic source of impressions.
///
/// Required in the `SELECT` clause.
#[prost(enumeration = "traffic_source::TrafficSourceEnum", optional, tag = "6")]
pub traffic_source: ::core::option::Option<i32>,
/// Position of the domain in the similar businesses ranking for the selected
/// keys (`date`, `report_category_id`, `report_country_code`,
/// `traffic_source`) based on impressions. 1 is the highest.
///
/// Cannot be filtered on in the 'WHERE' clause.
#[prost(int64, optional, tag = "7")]
pub rank: ::core::option::Option<i64>,
/// \[Ads / organic ratio\]
/// (<https://support.google.com/merchants/answer/11366442#zippy=%2Cads-free-ratio>)
/// shows how often the domain receives impressions from Shopping ads compared
/// to organic traffic. The number is rounded and bucketed.
///
/// Cannot be filtered on in the 'WHERE' clause.
#[prost(double, optional, tag = "8")]
pub ads_organic_ratio: ::core::option::Option<f64>,
/// \[Page overlap rate\]
/// (<https://support.google.com/merchants/answer/11366442#zippy=%2Cpage-overlap-rate>)
/// shows how frequently competing retailers’ offers are shown together with
/// your offers on the same page.
///
/// Cannot be filtered on in the 'WHERE' clause.
#[prost(double, optional, tag = "9")]
pub page_overlap_rate: ::core::option::Option<f64>,
/// \[Higher position rate\]
/// (<https://support.google.com/merchants/answer/11366442#zippy=%2Chigher-position-rate>)
/// shows how often a competitor’s offer got placed in a higher position on the
/// page than your offer.
///
/// Cannot be filtered on in the 'WHERE' clause.
#[prost(double, optional, tag = "10")]
pub higher_position_rate: ::core::option::Option<f64>,
/// \[Relative visibility\]
/// (<https://support.google.com/merchants/answer/11366442#zippy=%2Crelative-visibility>)
/// shows how often your competitors’ offers are shown compared to your offers.
/// In other words, this is the number of displayed impressions of a competitor
/// retailer divided by the number of your displayed impressions during a
/// selected time range for a selected product category and country.
///
/// Cannot be filtered on in the 'WHERE' clause.
#[prost(double, optional, tag = "11")]
pub relative_visibility: ::core::option::Option<f64>,
}
/// Fields available for query in `competitive_visibility_top_merchant_view`
/// table.
///
/// [Competitive
/// visibility](<https://support.google.com/merchants/answer/11366442>) report with
/// business with highest visibility.
///
/// Values are only set for fields requested explicitly in the request's search
/// query.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CompetitiveVisibilityTopMerchantView {
/// Date of this row.
///
/// Cannot be selected in the `SELECT` clause. A condition on `date` is
/// required in the `WHERE` clause.
#[prost(message, optional, tag = "1")]
pub date: ::core::option::Option<super::super::super::super::r#type::Date>,
/// Domain of your competitor or your domain, if 'is_your_domain' is true.
///
/// Required in the `SELECT` clause. Cannot be filtered on in the 'WHERE'
/// clause.
#[prost(string, optional, tag = "2")]
pub domain: ::core::option::Option<::prost::alloc::string::String>,
/// True if this row contains data for your domain.
///
/// Cannot be filtered on in the 'WHERE' clause.
#[prost(bool, optional, tag = "3")]
pub is_your_domain: ::core::option::Option<bool>,
/// Country where impressions appeared.
///
/// Required in the `SELECT` clause. A condition on `report_country_code` is
/// required in the `WHERE` clause.
#[prost(string, optional, tag = "4")]
pub report_country_code: ::core::option::Option<::prost::alloc::string::String>,
/// Google product category ID to calculate the report for, represented in
/// [Google's product
/// taxonomy](<https://support.google.com/merchants/answer/6324436>).
///
/// Required in the `SELECT` clause. A condition on `report_category_id` is
/// required in the `WHERE` clause.
#[prost(int64, optional, tag = "5")]
pub report_category_id: ::core::option::Option<i64>,
/// Traffic source of impressions.
///
/// Required in the `SELECT` clause.
#[prost(enumeration = "traffic_source::TrafficSourceEnum", optional, tag = "6")]
pub traffic_source: ::core::option::Option<i32>,
/// Position of the domain in the top merchants ranking for the selected keys
/// (`date`, `report_category_id`, `report_country_code`, `traffic_source`)
/// based on impressions. 1 is the highest.
///
/// Cannot be filtered on in the 'WHERE' clause.
#[prost(int64, optional, tag = "7")]
pub rank: ::core::option::Option<i64>,
/// \[Ads / organic ratio\]
/// (<https://support.google.com/merchants/answer/11366442#zippy=%2Cads-free-ratio>)
/// shows how often the domain receives impressions from Shopping ads compared
/// to organic traffic. The number is rounded and bucketed.
///
/// Cannot be filtered on in the 'WHERE' clause.
#[prost(double, optional, tag = "8")]
pub ads_organic_ratio: ::core::option::Option<f64>,
/// \[Page overlap rate\]
/// (<https://support.google.com/merchants/answer/11366442#zippy=%2Cpage-overlap-rate>)
/// shows how frequently competing retailers’ offers are shown together with
/// your offers on the same page.
///
/// Cannot be filtered on in the 'WHERE' clause.
#[prost(double, optional, tag = "9")]
pub page_overlap_rate: ::core::option::Option<f64>,
/// \[Higher position rate\]
/// (<https://support.google.com/merchants/answer/11366442#zippy=%2Chigher-position-rate>)
/// shows how often a competitor’s offer got placed in a higher position on the
/// page than your offer.
///
/// Cannot be filtered on in the 'WHERE' clause.
#[prost(double, optional, tag = "10")]
pub higher_position_rate: ::core::option::Option<f64>,
}
/// Fields available for query in `competitive_visibility_benchmark_view` table.
///
/// [Competitive
/// visibility](<https://support.google.com/merchants/answer/11366442>) report with
/// the category benchmark.
///
/// Values are only set for fields requested explicitly in the request's search
/// query.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CompetitiveVisibilityBenchmarkView {
/// Date of this row.
///
/// Required in the `SELECT` clause. A condition on `date` is required in the
/// `WHERE` clause.
#[prost(message, optional, tag = "1")]
pub date: ::core::option::Option<super::super::super::super::r#type::Date>,
/// Country where impressions appeared.
///
/// Required in the `SELECT` clause. A condition on `report_country_code` is
/// required in the `WHERE` clause.
#[prost(string, optional, tag = "2")]
pub report_country_code: ::core::option::Option<::prost::alloc::string::String>,
/// Google product category ID to calculate the report for, represented in
/// [Google's product
/// taxonomy](<https://support.google.com/merchants/answer/6324436>).
///
/// Required in the `SELECT` clause. A condition on `report_category_id` is
/// required in the `WHERE` clause.
#[prost(int64, optional, tag = "3")]
pub report_category_id: ::core::option::Option<i64>,
/// Traffic source of impressions.
///
/// Required in the `SELECT` clause.
#[prost(enumeration = "traffic_source::TrafficSourceEnum", optional, tag = "4")]
pub traffic_source: ::core::option::Option<i32>,
/// Change in visibility based on impressions for your domain with respect to
/// the start of the selected time range (or first day with non-zero
/// impressions).
///
/// Cannot be filtered on in the 'WHERE' clause.
#[prost(double, optional, tag = "5")]
pub your_domain_visibility_trend: ::core::option::Option<f64>,
/// Change in visibility based on impressions with respect to the start of the
/// selected time range (or first day with non-zero impressions) for a
/// combined set of merchants with highest visibility approximating the
/// market.
///
/// Cannot be filtered on in the 'WHERE' clause.
#[prost(double, optional, tag = "6")]
pub category_benchmark_visibility_trend: ::core::option::Option<f64>,
}
/// Marketing method used to promote your products on Google (organic versus
/// ads).
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct MarketingMethod {}
/// Nested message and enum types in `MarketingMethod`.
pub mod marketing_method {
/// Marketing method values.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum MarketingMethodEnum {
/// Not specified.
Unspecified = 0,
/// Organic marketing.
Organic = 1,
/// Ads-based marketing.
Ads = 2,
}
impl MarketingMethodEnum {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
MarketingMethodEnum::Unspecified => "MARKETING_METHOD_ENUM_UNSPECIFIED",
MarketingMethodEnum::Organic => "ORGANIC",
MarketingMethodEnum::Ads => "ADS",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"MARKETING_METHOD_ENUM_UNSPECIFIED" => Some(Self::Unspecified),
"ORGANIC" => Some(Self::Organic),
"ADS" => Some(Self::Ads),
_ => None,
}
}
}
}
/// Granularity of the Best sellers report. Best sellers reports are computed
/// over a week and a month timeframe.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ReportGranularity {}
/// Nested message and enum types in `ReportGranularity`.
pub mod report_granularity {
/// Report granularity values.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ReportGranularityEnum {
/// Not specified.
Unspecified = 0,
/// Report is computed over a week timeframe.
Weekly = 1,
/// Report is computed over a month timeframe.
Monthly = 2,
}
impl ReportGranularityEnum {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
ReportGranularityEnum::Unspecified => {
"REPORT_GRANULARITY_ENUM_UNSPECIFIED"
}
ReportGranularityEnum::Weekly => "WEEKLY",
ReportGranularityEnum::Monthly => "MONTHLY",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"REPORT_GRANULARITY_ENUM_UNSPECIFIED" => Some(Self::Unspecified),
"WEEKLY" => Some(Self::Weekly),
"MONTHLY" => Some(Self::Monthly),
_ => None,
}
}
}
}
/// Relative demand of a product cluster or brand in the Best sellers report.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct RelativeDemand {}
/// Nested message and enum types in `RelativeDemand`.
pub mod relative_demand {
/// Relative demand values.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum RelativeDemandEnum {
/// Not specified.
Unspecified = 0,
/// Demand is 0-5% of the demand of the highest ranked product cluster or
/// brand.
VeryLow = 10,
/// Demand is 6-10% of the demand of the highest ranked product cluster or
/// brand.
Low = 20,
/// Demand is 11-20% of the demand of the highest ranked product cluster or
/// brand.
Medium = 30,
/// Demand is 21-50% of the demand of the highest ranked product cluster or
/// brand.
High = 40,
/// Demand is 51-100% of the demand of the highest ranked product cluster or
/// brand.
VeryHigh = 50,
}
impl RelativeDemandEnum {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
RelativeDemandEnum::Unspecified => "RELATIVE_DEMAND_ENUM_UNSPECIFIED",
RelativeDemandEnum::VeryLow => "VERY_LOW",
RelativeDemandEnum::Low => "LOW",
RelativeDemandEnum::Medium => "MEDIUM",
RelativeDemandEnum::High => "HIGH",
RelativeDemandEnum::VeryHigh => "VERY_HIGH",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"RELATIVE_DEMAND_ENUM_UNSPECIFIED" => Some(Self::Unspecified),
"VERY_LOW" => Some(Self::VeryLow),
"LOW" => Some(Self::Low),
"MEDIUM" => Some(Self::Medium),
"HIGH" => Some(Self::High),
"VERY_HIGH" => Some(Self::VeryHigh),
_ => None,
}
}
}
}
/// Relative demand of a product cluster or brand in the Best sellers report
/// compared to the previous time period.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct RelativeDemandChangeType {}
/// Nested message and enum types in `RelativeDemandChangeType`.
pub mod relative_demand_change_type {
/// Relative demand change type values.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum RelativeDemandChangeTypeEnum {
/// Not specified.
Unspecified = 0,
/// Relative demand is lower than the previous time period.
Sinker = 1,
/// Relative demand is equal to the previous time period.
Flat = 2,
/// Relative demand is higher than the previous time period.
Riser = 3,
}
impl RelativeDemandChangeTypeEnum {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
RelativeDemandChangeTypeEnum::Unspecified => {
"RELATIVE_DEMAND_CHANGE_TYPE_ENUM_UNSPECIFIED"
}
RelativeDemandChangeTypeEnum::Sinker => "SINKER",
RelativeDemandChangeTypeEnum::Flat => "FLAT",
RelativeDemandChangeTypeEnum::Riser => "RISER",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"RELATIVE_DEMAND_CHANGE_TYPE_ENUM_UNSPECIFIED" => Some(Self::Unspecified),
"SINKER" => Some(Self::Sinker),
"FLAT" => Some(Self::Flat),
"RISER" => Some(Self::Riser),
_ => None,
}
}
}
}
/// Traffic source of impressions in the Competitive visibility report.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct TrafficSource {}
/// Nested message and enum types in `TrafficSource`.
pub mod traffic_source {
/// Traffic source values.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum TrafficSourceEnum {
/// Not specified.
Unspecified = 0,
/// Organic traffic.
Organic = 1,
/// Traffic from ads.
Ads = 2,
/// Organic and ads traffic.
All = 3,
}
impl TrafficSourceEnum {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
TrafficSourceEnum::Unspecified => "TRAFFIC_SOURCE_ENUM_UNSPECIFIED",
TrafficSourceEnum::Organic => "ORGANIC",
TrafficSourceEnum::Ads => "ADS",
TrafficSourceEnum::All => "ALL",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"TRAFFIC_SOURCE_ENUM_UNSPECIFIED" => Some(Self::Unspecified),
"ORGANIC" => Some(Self::Organic),
"ADS" => Some(Self::Ads),
"ALL" => Some(Self::All),
_ => None,
}
}
}
}
/// Generated client implementations.
pub mod report_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// Service for retrieving reports and insights about your products, their
/// performance, and their competitive environment on Google.
#[derive(Debug, Clone)]
pub struct ReportServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> ReportServiceClient<T>
where
T: tonic::client::GrpcService<tonic::body::BoxBody>,
T::Error: Into<StdError>,
T::ResponseBody: Body<Data = Bytes> + std::marker::Send + 'static,
<T::ResponseBody as Body>::Error: Into<StdError> + std::marker::Send,
{
pub fn new(inner: T) -> Self {
let inner = tonic::client::Grpc::new(inner);
Self { inner }
}
pub fn with_origin(inner: T, origin: Uri) -> Self {
let inner = tonic::client::Grpc::with_origin(inner, origin);
Self { inner }
}
pub fn with_interceptor<F>(
inner: T,
interceptor: F,
) -> ReportServiceClient<InterceptedService<T, F>>
where
F: tonic::service::Interceptor,
T::ResponseBody: Default,
T: tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
Response = http::Response<
<T as tonic::client::GrpcService<tonic::body::BoxBody>>::ResponseBody,
>,
>,
<T as tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
>>::Error: Into<StdError> + std::marker::Send + std::marker::Sync,
{
ReportServiceClient::new(InterceptedService::new(inner, interceptor))
}
/// Compress requests with the given encoding.
///
/// This requires the server to support it otherwise it might respond with an
/// error.
#[must_use]
pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.send_compressed(encoding);
self
}
/// Enable decompressing responses.
#[must_use]
pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.accept_compressed(encoding);
self
}
/// Limits the maximum size of a decoded message.
///
/// Default: `4MB`
#[must_use]
pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_decoding_message_size(limit);
self
}
/// Limits the maximum size of an encoded message.
///
/// Default: `usize::MAX`
#[must_use]
pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_encoding_message_size(limit);
self
}
/// Retrieves a report defined by a search query. The response might contain
/// fewer rows than specified by `page_size`. Rely on `next_page_token` to
/// determine if there are more rows to be requested.
pub async fn search(
&mut self,
request: impl tonic::IntoRequest<super::SearchRequest>,
) -> std::result::Result<tonic::Response<super::SearchResponse>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.shopping.merchant.reports.v1beta.ReportService/Search",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.shopping.merchant.reports.v1beta.ReportService",
"Search",
),
);
self.inner.unary(req, path, codec).await
}
}
}