mcm-cli 0.471__py3-none-any.whl → 1.0.1__py3-none-any.whl

{mcm_cli-0.471.dist-info → mcm_cli-1.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mcm-cli
-Version: 0.471
+Version: 1.0.1
 Summary: A command-line interface for Moloco Commerde Media
 Home-page: https://github.com/moloco-mcm/mcm-cli
 Author: Moloco MCM Team
@@ -81,6 +81,7 @@ $ mcm --help
 │ account    Ad account management                                 │
 │ auth       Authentication management                             │
 │ config     Configurations                                        │
+│ decision   Decision command                                      │
 │ version    Show the tool version                                 │
 │ wallet     Wallet management                                     │
 ╰──────────────────────────────────────────────────────────────────╯

{mcm_cli-0.471.dist-info → mcm_cli-1.0.1.dist-info}/RECORD

@@ -1,21 +1,23 @@
 mcmcli/__init__.py,sha256=-U6lMZ9_99IXAKwnqnYXYr6NcO6TSmG-kxewgvJjU4k,575
-mcmcli/__main__.py,sha256=XCMJhGalbQkBsQrBBEcI_CN-3uPuMLdWYT6I8ROyITM,1357
+mcmcli/__main__.py,sha256=Ky33jkUC1pB1BELZU1BQY2_7G_MfAkXaewQb1Z1Zaw0,1473
 mcmcli/logging.py,sha256=xjRS5ey1ONx_d34qB1Fetb_SwPysoh2hzNDuNAaYYWQ,1739
 mcmcli/requests.py,sha256=50N_LiWIWr8-3EPs_yR9f4uEQf8rQ68s_FoMYRhgjzI,2343
 mcmcli/command/account.py,sha256=EtcYZsC5LL5ue-hKsZZl3_0oZ09nJdVi774yqiTykl8,14712
 mcmcli/command/auth.py,sha256=QLdr_XFW5BVw9r4a7Kjj5BTBXpSux3AWI9eI03S8aiA,2480
 mcmcli/command/config.py,sha256=sdzge-l_Yi2P_TlTgSLqShcGyPCzpW3QJzctpIvc-g4,4195
-mcmcli/command/wallet.py,sha256=TB3WrmniREsDk0ui20p3ha6OZMwA2wAJaxQ9QDGtKnA,8968
+mcmcli/command/decision.py,sha256=Zjbmt71OVU-oL8Itt9O-SvwT9Lbxw-PAgRZaIgiXi-E,8411
+mcmcli/command/wallet.py,sha256=0h09ccx0lgmQUdAdaAdvjMvXCJ4qyeJXjovZMGZWcbg,8984
 mcmcli/data/account.py,sha256=pe7tPapP6vlUD5D5L5Nh5k2bkWdYOK01Mpt5fBYFnJs,1782
 mcmcli/data/account_user.py,sha256=27nQp52nMma5a3QszSJGqgq5Z0ivIb-nMZcZuhEgbEg,1328
+mcmcli/data/decision.py,sha256=bQ5j_PbPRSFa0sY5g9UVqdNzl_2epchcz1lHoDVuV90,2880
 mcmcli/data/error.py,sha256=d6xa_jTXumlA0EzXy2PJQ86ajBb0Pm90fss9R3LuHUc,1094
 mcmcli/data/seller.py,sha256=40SA7QekM3a3svDrDYLo_QYJ68VUxDO0KeGejJMp4k4,1004
 mcmcli/data/token.py,sha256=11wtyLHCAZHu0LVbNDPa-yipcL6lenxoYIKEI58VzFs,1744
 mcmcli/data/wallet.py,sha256=W-CksF9SPqiv3jZg07Wy8ehVUP5Ot1Gbq2LEGNQCOC8,1906
-mcm_cli-0.471.dist-info/LICENSE,sha256=RFhQPdSOiMTguUX7JSoIuTxA7HVzCbj_p8WU36HjUQQ,10947
-mcm_cli-0.471.dist-info/METADATA,sha256=vWG49igEdd1cL-zRp4QbUOVb02qpsEQUwQfhFdpTWfI,2945
-mcm_cli-0.471.dist-info/NOTICE,sha256=Ldnl2MjRaXPxcldUdbI2NTybq60XAa2LowRhFrRTuiI,76
-mcm_cli-0.471.dist-info/WHEEL,sha256=Wyh-_nZ0DJYolHNn1_hMa4lM7uDedD_RGVwbmTjyItk,91
-mcm_cli-0.471.dist-info/entry_points.txt,sha256=qTHAWZ-ejSiU4t11RYwtAU8ScqhQPDeMVTG9y4wMVLg,60
-mcm_cli-0.471.dist-info/top_level.txt,sha256=sh7oqIaqLQlMtKHlxHHgpV2xGMrBMPFWpSp0C6nvJ_Y,7
-mcm_cli-0.471.dist-info/RECORD,,
+mcm_cli-1.0.1.dist-info/LICENSE,sha256=RFhQPdSOiMTguUX7JSoIuTxA7HVzCbj_p8WU36HjUQQ,10947
+mcm_cli-1.0.1.dist-info/METADATA,sha256=YK3oZIzaU9UjXZ-bq1IWqEpd2-oc3p9MHNkv5Le6cTc,3018
+mcm_cli-1.0.1.dist-info/NOTICE,sha256=Ldnl2MjRaXPxcldUdbI2NTybq60XAa2LowRhFrRTuiI,76
+mcm_cli-1.0.1.dist-info/WHEEL,sha256=Wyh-_nZ0DJYolHNn1_hMa4lM7uDedD_RGVwbmTjyItk,91
+mcm_cli-1.0.1.dist-info/entry_points.txt,sha256=qTHAWZ-ejSiU4t11RYwtAU8ScqhQPDeMVTG9y4wMVLg,60
+mcm_cli-1.0.1.dist-info/top_level.txt,sha256=sh7oqIaqLQlMtKHlxHHgpV2xGMrBMPFWpSp0C6nvJ_Y,7
+mcm_cli-1.0.1.dist-info/RECORD,,

mcmcli/__main__.py

@@ -20,6 +20,7 @@
 import mcmcli.command.account
 import mcmcli.command.auth
 import mcmcli.command.config
+import mcmcli.command.decision
 import mcmcli.command.wallet
 import mcmcli.logging
 import typer
@@ -31,11 +32,12 @@ def version():
 	"""
 	Show the tool version
 	"""
-	typer.echo(f"Version: mcm-cli v0.471")
+	typer.echo(f"Version: mcm-cli v1.0.1")
 
 app.add_typer(mcmcli.command.account.app, name="account", help="Ad account management")
 app.add_typer(mcmcli.command.auth.app, name="auth", help="Authentication management")
 app.add_typer(mcmcli.command.config.app, name="config", help="Configurations")
+app.add_typer(mcmcli.command.decision.app, name="decision", help="Decision command")
 app.add_typer(mcmcli.command.wallet.app, name="wallet", help="Wallet management")
 
 if __name__ == "__main__":

mcmcli/command/decision.py

@@ -0,0 +1,265 @@
+# Copyright 2023 Moloco, Inc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from mcmcli.data.error import Error
+from mcmcli.data.decision import DecidedCreative, DecidedCreativeBulkList, DecidedItemList
+from mcmcli.requests import CurlString, api_request
+from typing import Any, Callable, Dict, Optional, Tuple, TypeVar
+
+import json
+import mcmcli.command.auth
+import mcmcli.command.config
+import mcmcli.logging
+import sys
+import typer
+
+MAX_NUM_ITEMS_PER_PAGE = 5000
+
+app = typer.Typer(add_completion=False)
+
+@app.command()
+def decide_items(
+    inventory_id: str = typer.Option(help="Ad inventory ID"),
+    num_items: int = typer.Option(help="Number of items requested for the inventory."),
+    items: str = typer.Option(None, help="The main item ids of the page. For example, homepage inventories don't have any main items, and product-detail-page inventories have one main item."),
+    location_filter: str = typer.Option(None, help="Location filter value"),
+    to_curl: bool = typer.Option(False, help="Generate the curl command instead of executing it."),
+    profile: str = typer.Option("default", help="profile name of the MCM CLI."),
+):
+    """
+    Request item decision by auction.
+    """
+    d = DecisionCommand(profile)
+
+    curl, error, ret = d.decide_items(inventory_id, num_items, items, location_filter, to_curl)
+    if to_curl:
+        print(curl)
+        return
+    if error:
+        print(f"ERROR: {error.message}")
+        return
+    if ret is None:
+        print(f"ERROR: Unknown error")
+        return
+
+    print(ret.model_dump_json())
+    return
+
+
+@app.command()
+def decide_creative(
+    inventory_id: str = typer.Option(help="Ad inventory ID"),
+    items: str = typer.Option(None, help="The main item ids of the page. For example, homepage inventories don't have any main items, and product-detail-page inventories have one main item."),
+    location_filter: str = typer.Option(None, help="Location filter value"),
+    to_curl: bool = typer.Option(False, help="Generate the curl command instead of executing it."),
+    profile: str = typer.Option("default", help="profile name of the MCM CLI."),
+):
+    """
+    Request item decision by creative auction.
+    """
+    d = DecisionCommand(profile)
+
+    curl, error, ret = d.decide_creative(inventory_id, items, location_filter, to_curl)
+    if to_curl:
+        print(curl)
+        return
+    if error:
+        print(f"ERROR: {error.message}")
+        return
+    if ret is None:
+        print(f"ERROR: Unknown error")
+        return
+
+    print(ret.model_dump_json())
+    return
+
+
+@app.command()
+def decide_creative_bulk(
+    inventory_id_list: str = typer.Option(help="Ad inventory IDs separated by comma(,)"),
+    items: str = typer.Option(None, help="The main item ids of the page. For example, homepage inventories don't have any main items, and product-detail-page inventories have one main item."),
+    location_filter: str = typer.Option(None, help="Location filter value"),
+    to_curl: bool = typer.Option(False, help="Generate the curl command instead of executing it."),
+    profile: str = typer.Option("default", help="profile name of the MCM CLI."),
+):
+    """
+    Request item decision by creative auction for multiple inventories.
+    """
+    d = DecisionCommand(profile)
+
+    curl, error, ret = d.decide_creative_bulk(inventory_id_list, items, location_filter, to_curl)
+    if to_curl:
+        print(curl)
+        return
+    if error:
+        print(f"ERROR: {error.message}")
+        return
+    if ret is None:
+        print(f"ERROR: Unknown error")
+        return
+
+    print(ret.model_dump_json())
+    return
+    
+
+
+class DecisionCommand:
+    def __init__(
+        self,
+        profile,
+    ):
+        self.config = mcmcli.command.config.get_config(profile)
+        if (self.config is None):
+            print(f"ERROR: Failed to load the CLI profile", file=sys.stderr, flush=True)
+            sys.exit()
+
+        self.profile = profile
+        self.api_base_url = f"{self.config['decision_api_hostname']}/rmp/decision/v1/platforms/{self.config['platform_id']}"
+        self.headers = {
+            "accept": "application/json",
+            "content-type": "application/json",
+            "x-api-key": self.config['decision_api_key']
+        }
+    
+    def decide_items(
+        self, 
+        inventory_id, 
+        num_items, 
+        items,
+        location_filter, 
+        to_curl,
+    ) -> tuple[
+        Optional[CurlString],
+        Optional[Error],
+        Optional[DecidedItemList],
+    ]:
+        _api_url = f"{self.api_base_url}/auction"
+        _payload = {
+            "request_id": "request-1",
+            "inventory": {
+                "inventory_id": inventory_id,
+                "num_items": num_items
+            },
+            "user": {
+                "user_id": "user-1"
+            },
+            "device": {
+                "persistent_id": "persistent-device-1"
+            },
+        }
+        if items:
+            _payload["inventory"]["items"] = items.split(',')
+
+        if location_filter:
+            _payload["filtering"] = {
+                "location": {
+                    "locations": location_filter.split(',')
+                }
+            }
+        
+        curl, error, json_obj = api_request('POST', to_curl, _api_url, self.headers, _payload)
+        if curl:
+            return curl, None, None
+        if error:
+            return None, error, None
+
+        decided_items = DecidedItemList(**json_obj)
+        return None, None, decided_items
+
+
+    def decide_creative(
+        self,
+        inventory_id,
+        items,
+        location_filter,
+        to_curl
+    ) -> tuple[
+        Optional[CurlString],
+        Optional[Error],
+        Optional[DecidedCreative],
+    ]:
+        _api_url = f"{self.api_base_url}/creative-auction"
+        _payload = {
+            "request_id": "request-1",
+            "inventory": {
+                "inventory_id": inventory_id
+            },
+            "user": {
+                "user_id": "user-1"
+            },
+            "device": {
+                "persistent_id": "persistent-device-1"
+            },
+        }
+        if items:
+            _payload["inventory"]["items"] = items.split(',')
+
+        if location_filter:
+            _payload["filtering"] = {
+                "location": {
+                    "locations": location_filter.split(',')
+                }
+            }
+        
+        curl, error, json_obj = api_request('POST', to_curl, _api_url, self.headers, _payload)
+        if curl:
+            return curl, None, None
+        if error:
+            return None, error, None
+
+        decided_creative = DecidedCreative(**json_obj)
+        return None, None, decided_creative
+
+
+    def decide_creative_bulk(
+        self, 
+        inventory_id_list, 
+        items,
+        location_filter, 
+        to_curl
+    ) -> tuple[
+        Optional[CurlString],
+        Optional[Error], 
+        Optional[DecidedCreativeBulkList],
+    ]:
+        _api_url = f"{self.api_base_url}/creative-auction-bulk"
+        _payload = {
+            "request_id": "request-1",
+            "inventories": list(map(lambda x: { "inventory_id": x }, inventory_id_list.split(','))),
+            "user": {
+                "user_id": "user-1"
+            },
+            "device": {
+                "persistent_id": "persistent-device-1"
+            },
+        }
+        if items:
+            for inventory in _payload["inventories"]:
+                inventory["items"] = items.split(',')
+
+        if location_filter:
+            _payload["filtering"] = {
+                "location": {
+                    "locations": location_filter.split(',')
+                }
+            }
+
+        curl, error, json_obj = api_request('POST', to_curl, _api_url, self.headers, _payload)
+        if curl:
+            return curl, None, None
+        if error:
+            return None, error, None
+
+        return None, None, DecidedCreativeBulkList(**json_obj)
+

mcmcli/command/wallet.py

@@ -127,7 +127,7 @@ def deposit(
     credits_amount  = float(credits_amount_micro)  / float(1000000)
     pre_paid_amount = float(pre_paid_amount_micro) / float(1000000)
 
-    print(f"Deposited to the wallet. Currence balance of the ad account id {account_id} is {pre_paid_amount} for PRE_PAID and {credits_amount} for CREDITS.")
+    print(f"Funds have been deposited into the wallet. The current balance for ad account ID {account_id} is {pre_paid_amount} in PRE_PAID and {credits_amount} in CREDITS.")
     return
 
 @app.command()
@@ -178,7 +178,7 @@ def withdraw(
     credits_amount  = float(credits_amount_micro)  / float(1000000)
     pre_paid_amount = float(pre_paid_amount_micro) / float(1000000)
 
-    print(f"Withdrew the funds from to the wallet. Currence balance of the ad account id {account_id} is {pre_paid_amount} for PRE_PAID and {credits_amount} for CREDITS.")
+    print(f"Funds were withdrawn out of the wallet. The current balance of ad account ID {account_id} is {pre_paid_amount} for PRE_PAID and {credits_amount} for CREDITS.")
     return
 
 class WalletCommand:

mcmcli/data/decision.py

@@ -0,0 +1,104 @@
+# Copyright 2023 Moloco, Inc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from pydantic import BaseModel
+from typing import Optional
+
+#
+# API response dataclasses
+#
+# Item decision API's response example:
+#
+# {
+#     "request_id": "request-1",
+#     "decided_items": [
+#         {
+#             "item_id": "1111833",
+#             "auction_result": {
+#                 "ad_account_id": "2444",
+#                 "campaign_id": "zWHhpyNbzYcy5FAy",
+#                 "win_price": {
+#                     "currency": "USD",
+#                     "amount_micro": "500000000"
+#                 },
+#                 "campaign_text_entry": ""
+#             },
+#             "imp_trackers": [
+#                 "https://myplatform-evt.rmp-api.moloco.com/t/i/MYPLATFORM_TEST?source=2X0op"
+#             ],
+#             "click_trackers": [
+#                 "https://myplatform-evt.rmp-api.moloco.com/t/c/MYPLATFORM_TEST?source=2X0opp"
+#             ],
+#             "track_id": "2X0op"
+#         }
+#     ]
+# }
+
+class MicroPrice(BaseModel):
+    currency: str
+    amount_micro: str
+
+class AuctionResult(BaseModel):
+    ad_account_id: str
+    campaign_id: str
+    win_price: Optional[MicroPrice]
+    campaign_text_entry: Optional[str]
+
+class DecidedItem(BaseModel):
+    item_id: str
+    auction_result: Optional[AuctionResult]
+    imp_trackers: list[str]
+    click_trackers: list[str]
+    track_id: Optional[str]
+
+class DecidedItemList(BaseModel):
+    request_id: str
+    decided_items: list[DecidedItem]
+
+class CreativeBanner(BaseModel):
+    creative_id: str
+    image_url: str
+    imp_trackers: list[str]
+    click_trackers: list[str]
+
+class CreativeItem(BaseModel):
+    item_id: str
+    imp_trackers: list[str]
+    click_trackers: list[str] 
+
+class LandingUrl(BaseModel):
+    id: str
+    url: str
+
+class DecidedCreative(BaseModel):
+    request_id: str
+    auction_result: Optional[AuctionResult]
+    banner: Optional[CreativeBanner]
+    items: list[CreativeItem]
+    landing_url:Optional[LandingUrl]
+
+class CreativeBannerWrapper(BaseModel):
+    banner: CreativeBanner
+
+class DecidedCreativeBulk(BaseModel):
+    inventory_id: str
+    auction_result: Optional[AuctionResult]
+    creatives: list[CreativeBannerWrapper]
+    items: list[DecidedItem]
+    landing_url: Optional[LandingUrl]
+
+class DecidedCreativeBulkList(BaseModel):
+    request_id: str
+    results: list[DecidedCreativeBulk]
+