mcm-cli 1.4.1__tar.gz → 1.5.0__tar.gz

{mcm_cli-1.4.1/mcm_cli.egg-info → mcm_cli-1.5.0}/PKG-INFO

@@ -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 → mcm_cli-1.5.0/mcm_cli.egg-info}/PKG-INFO

@@ -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 → mcm_cli-1.5.0}/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")

{mcm_cli-1.4.1 → mcm_cli-1.5.0}/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:

{mcm_cli-1.4.1 → mcm_cli-1.5.0}/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())

{mcm_cli-1.4.1 → mcm_cli-1.5.0}/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

{mcm_cli-1.4.1 → mcm_cli-1.5.0}/setup.py

@@ -18,7 +18,7 @@ from setuptools import setup, find_packages
 
 setup(
     name='mcm-cli',
-    version='1.4.1',
+    version='1.5.0',
     description='A command-line interface for Moloco Commerde Media',
     long_description=open('README.md').read(),
     long_description_content_type='text/markdown',