mcm-cli 1.4.1__py3-none-any.whl → 1.5.0__py3-none-any.whl

{mcm_cli-1.4.1.dist-info → mcm_cli-1.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mcm-cli
-Version: 1.4.1
+Version: 1.5.0
 Summary: A command-line interface for Moloco Commerde Media
 Home-page: https://github.com/moloco-mcm/mcm-cli
 Author: Moloco MCM Team

{mcm_cli-1.4.1.dist-info → mcm_cli-1.5.0.dist-info}/RECORD

@@ -1,18 +1,18 @@
 mcmcli/__init__.py,sha256=-U6lMZ9_99IXAKwnqnYXYr6NcO6TSmG-kxewgvJjU4k,575
-mcmcli/__main__.py,sha256=wbiwdsy9Sq1Ebv93G6LlnH7wTb2SUT5gRxxFF9w5Hgc,1844
+mcmcli/__main__.py,sha256=yiI9lBAaJYM57lXTHPKr3teWqU_xF39ZHt52_E1hCN8,1844
 mcmcli/logging.py,sha256=xjRS5ey1ONx_d34qB1Fetb_SwPysoh2hzNDuNAaYYWQ,1739
 mcmcli/requests.py,sha256=IuySBQ8P_GoGF3f_TRysfgQNOhi2n9M84WK_eRXnoEU,2945
 mcmcli/command/account.py,sha256=FWXmzOLj4rVLVLEv-w0eDVlQVrkONvR1UewZbcTDgE4,24994
-mcmcli/command/admin.py,sha256=05Ti5nMnuL_Ppo8hy2_bMGwfNZGdN6s528Gpi-EnpDg,16036
+mcmcli/command/admin.py,sha256=2GC0B3oqQsT5N5mHUyezgZvzPkB4-oGtddguOWfdLJs,15980
 mcmcli/command/auth.py,sha256=Ak7ZNEskWPpMoeTJcbYlEpDBgzxn8N33Q2dNf67SsCs,2926
-mcmcli/command/campaign.py,sha256=SU6TrDy6YhqM0JWPzbYWLpXZrz7Ymw31pd168dK2LZk,10638
+mcmcli/command/campaign.py,sha256=wh6WU19dCw0NBTp521g5wK6_0GraviWZxxahIcSlD44,12364
 mcmcli/command/config.py,sha256=08C5ftAvdvpQ26Z329LqhP8AxTI629LS7Ou6glzrRgw,4396
 mcmcli/command/decision.py,sha256=iLvEDEa2k0LAgoXrOvcdn-HcFRo90E8Dxht_Ls9EGCY,8690
 mcmcli/command/report.py,sha256=N8IMyDZ5QpY11-KkZG-n5_ZzEeh-ME5s2s3wrAKEGjY,5387
 mcmcli/command/wallet.py,sha256=vG2rg7tPwGsV9YB7cpvkiocbqtB1reqXn7dmolFmzD4,11536
 mcmcli/data/account.py,sha256=pe7tPapP6vlUD5D5L5Nh5k2bkWdYOK01Mpt5fBYFnJs,1782
 mcmcli/data/account_user.py,sha256=27nQp52nMma5a3QszSJGqgq5Z0ivIb-nMZcZuhEgbEg,1328
-mcmcli/data/campaign.py,sha256=vUukEsZ9Lzvcqm4Pa8z7vzyt_qOpT_t6_YEXuLubVSQ,1731
+mcmcli/data/campaign.py,sha256=rbBbLt_5qrNXr8TM4nq5NtPqB0lJmtmINEAyepS7KJ4,2284
 mcmcli/data/decision.py,sha256=bQ5j_PbPRSFa0sY5g9UVqdNzl_2epchcz1lHoDVuV90,2880
 mcmcli/data/error.py,sha256=d6xa_jTXumlA0EzXy2PJQ86ajBb0Pm90fss9R3LuHUc,1094
 mcmcli/data/item.py,sha256=Z2xTRhU8T4vyJADO0l6-XPyQXvb9DX_OAjExhSXpW2A,1091
@@ -23,10 +23,10 @@ mcmcli/data/seller.py,sha256=40SA7QekM3a3svDrDYLo_QYJ68VUxDO0KeGejJMp4k4,1004
 mcmcli/data/token.py,sha256=11wtyLHCAZHu0LVbNDPa-yipcL6lenxoYIKEI58VzFs,1744
 mcmcli/data/user_join_request.py,sha256=lXMO2hE_VpRg0JofVrYAVM82S-RLFkPrZk8-drvhoDI,1251
 mcmcli/data/wallet.py,sha256=eMUi8N0vJdg_E10TPhSPoZkZtmIG7gHyqgabQ8C5Lg8,3217
-mcm_cli-1.4.1.dist-info/LICENSE,sha256=RFhQPdSOiMTguUX7JSoIuTxA7HVzCbj_p8WU36HjUQQ,10947
-mcm_cli-1.4.1.dist-info/METADATA,sha256=lwdpWx33PEgWxiCl4FBfbqM_CIflw5eLDOLtzCpjK1Y,3056
-mcm_cli-1.4.1.dist-info/NOTICE,sha256=Ldnl2MjRaXPxcldUdbI2NTybq60XAa2LowRhFrRTuiI,76
-mcm_cli-1.4.1.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-mcm_cli-1.4.1.dist-info/entry_points.txt,sha256=qTHAWZ-ejSiU4t11RYwtAU8ScqhQPDeMVTG9y4wMVLg,60
-mcm_cli-1.4.1.dist-info/top_level.txt,sha256=sh7oqIaqLQlMtKHlxHHgpV2xGMrBMPFWpSp0C6nvJ_Y,7
-mcm_cli-1.4.1.dist-info/RECORD,,
+mcm_cli-1.5.0.dist-info/LICENSE,sha256=RFhQPdSOiMTguUX7JSoIuTxA7HVzCbj_p8WU36HjUQQ,10947
+mcm_cli-1.5.0.dist-info/METADATA,sha256=M_x0K3WbDKcyEmyXUI7dqa5VFHTH2rKSeT0VTrtFTxc,3056
+mcm_cli-1.5.0.dist-info/NOTICE,sha256=Ldnl2MjRaXPxcldUdbI2NTybq60XAa2LowRhFrRTuiI,76
+mcm_cli-1.5.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+mcm_cli-1.5.0.dist-info/entry_points.txt,sha256=qTHAWZ-ejSiU4t11RYwtAU8ScqhQPDeMVTG9y4wMVLg,60
+mcm_cli-1.5.0.dist-info/top_level.txt,sha256=sh7oqIaqLQlMtKHlxHHgpV2xGMrBMPFWpSp0C6nvJ_Y,7
+mcm_cli-1.5.0.dist-info/RECORD,,

mcmcli/__main__.py

@@ -37,7 +37,7 @@ def version():
 	"""
 	Show the tool version
 	"""
-	typer.echo(f"Version: mcm-cli v1.4.1")
+	typer.echo(f"Version: mcm-cli v1.5.0")
 
 app.add_typer(mcmcli.command.account.app, name="account", help="Ad account management")
 app.add_typer(mcmcli.command.admin.app, name="admin", help="Platform administration")

mcmcli/command/admin.py

@@ -68,7 +68,7 @@ def list_all_campaigns(
         print(error, file=sys.stderr, flush=True)
         return
 
-    print("Account IDAccount Title,Campaign ID,Campaign Title,Ad Type,Start,End,Budget Period,Budget Amount,Enabling State,State,Created At,Updated At,Item IDs")
+    print("Account ID,Account Title,Campaign ID,Campaign Title,Ad Type,Start,End,Budget Period,Budget Amount,Enabling State,State,Created At,Updated At")
     for account_campaign in account_campaigns:
         a, c = account_campaign
 
@@ -78,7 +78,8 @@ def list_all_campaigns(
         print(f'"{c.budget.period}","{int(c.budget.amount.amount_micro) / 1000000}",', end="", flush=True)
         print(f'"{c.enabling_state}","{c.state}",', end="", flush=True)
         print(f'"{c.created_at}","{c.updated_at}",', end="", flush=True)
-        print(f'"{";".join(c.catalog_item_ids)}"')
+        # print(f'"{";".join(c.catalog_item_ids)}"')
+        print("", flush=True)
 
 @app.command()
 def list_platform_users(
@@ -404,8 +405,6 @@ class AdminCommand:
         for id in accounts:
             account = accounts[id]
             echo('.')
-            if account.state_info.state == "INACTIVE":
-                continue
             # print(f'{account.id}, \"{account.title}\"')
             _, error, campaigns = cc.list_campaigns(account.id)
             if error:

mcmcli/command/campaign.py

@@ -51,7 +51,7 @@ def list_campaigns(
         print(curl)
         return
     if error:
-        print(f"ERROR: {error.message}")
+        print(f"ERROR: {error.message}", file=sys.stderr, flush=True)
         return
     if to_json:
         json_dumps = [x.model_dump_json() for x in campaigns]
@@ -103,6 +103,47 @@ def read_campaign(
 
     return
 
+@app.command()
+def archive_campaign(
+    account_id: str = typer.Option(help="Ad account ID"),
+    campaign_id: str = typer.Option(help="Campaign ID"), 
+    profile: str = typer.Option("default", help="Profile name of the MCM CLI."),
+):
+    """
+    Turn off (pause and disable) the campaign and archive it.
+    """
+    c = _create_campaign_command(profile)
+    if c is None:
+        return
+
+    _, error, campaign = c.read_campaign(account_id, campaign_id)
+    if error:
+        print(f"ERROR: Failed to read the campaign {campaign_id} of the ad account {account_id}: {error.message}", file=sys.stderr, flush=True)
+        return
+    
+    if campaign.state == 'ARCHIVED':
+        print(f"The campaign {campaign_id} of the ad account {account_id} is already archived.")
+        return
+
+    # Turn off the campaign
+    campaign.enabling_state = 'DISABLED'
+    campaign.state = 'PAUSED'
+    #campaign.daily_budget.amount_micro = (campaign.daily_budget.amount_micro // 10000) * 10000
+    _, error, campaign = c.update_campaign(campaign)
+    if error:
+        print(f"ERROR: Failed to turn off the campaign {campaign_id} of the ad account {account_id}: {error.message}", file=sys.stderr, flush=True)
+        return
+
+    # Archive the campaign
+    campaign.hidden = True
+    campaign.state = 'ARCHIVED'
+    _, error, campaign = c.update_campaign(campaign)
+    if error:
+        print(f"ERROR: Failed to archive the campaign {campaign_id} of the ad account {account_id}: {error.message}", file=sys.stderr, flush=True)
+        return
+
+    print(f"Archived the campaign {campaign_id} of the ad account {account_id}.")
+
 @app.command()
 def list_campaign_items(
     account_id: str = typer.Option(help="Ad account ID"), 
@@ -124,7 +165,7 @@ def list_campaign_items(
         print(curl)
         return
     if error:
-        print(f"ERROR: {error.message}")
+        print(f"ERROR: {error.message}", file=sys.stderr, flush=True)
         return   
     if to_json:
         json_dumps = [x.model_dump_json() for x in items]
@@ -156,7 +197,7 @@ def add_items_to_campaign(
 
     _, error, campaign = c.read_campaign(account_id, campaign_id)
     if error:
-        print(f"ERROR: {error.message}")
+        print(f"ERROR: {error.message}", file=sys.stderr, flush=True)
         return
 
     #
@@ -173,7 +214,7 @@ def add_items_to_campaign(
         print(curl)
         return
     if error:
-        print(f"ERROR: {error.message}")
+        print(f"ERROR: {error.message}", file=sys.stderr, flush=True)
         return
     if to_json:
         print(campaign.model_dump_json())

mcmcli/data/campaign.py

@@ -20,7 +20,7 @@ from typing import Optional
 #
 class MicroPrice(BaseModel):
     currency: str
-    amount_micro: str
+    amount_micro: int
 
 class Schedule(BaseModel):
     start: str
@@ -41,6 +41,23 @@ class Goal(BaseModel):
     optimize_fixed_cpc: Optional[TargetCpc] = None
     optimize_roas: Optional[TargetRoas] = None
 
+class TargetingEvent(BaseModel):
+    event_type: str
+    matching_param: Optional[str] = None
+    negative: bool
+    matching_date: Optional[str] = None
+
+class AudienceSetting(BaseModel):
+    event_based: Optional[list[TargetingEvent]] = None
+    label: Optional[str] = None
+    event_based_include_list: Optional[list[str]] = None
+    event_based_exclude_list: Optional[list[str]] = None
+
+class Targeting(BaseModel):
+    campaign_targeting_placement_type: str
+    placement_setting: Optional[str]
+    audience_setting: Optional[AudienceSetting]
+
 class Campaign(BaseModel):
     id: str
     title: str
@@ -52,7 +69,7 @@ class Campaign(BaseModel):
     schedule: Schedule
     daily_budget: MicroPrice
     budget: Budget
-    targeting: Optional[str]
+    targeting: Optional[Targeting]
     managed_setting: Optional[str]
     text_entry: str
     goal: Goal