mcm-cli 1.4.2__tar.gz → 1.5.1__tar.gz

{mcm_cli-1.4.2/mcm_cli.egg-info → mcm_cli-1.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mcm-cli
-Version: 1.4.2
+Version: 1.5.1
 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.2 → mcm_cli-1.5.1/mcm_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mcm-cli
-Version: 1.4.2
+Version: 1.5.1
 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.2 → mcm_cli-1.5.1}/mcmcli/__main__.py

@@ -37,7 +37,7 @@ def version():
 	"""
 	Show the tool version
 	"""
-	typer.echo(f"Version: mcm-cli v1.4.2")
+	typer.echo(f"Version: mcm-cli v1.5.1")
 
 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.2 → mcm_cli-1.5.1}/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.2 → mcm_cli-1.5.1}/mcmcli/data/campaign.py

@@ -20,11 +20,11 @@ from typing import Optional
 #
 class MicroPrice(BaseModel):
     currency: str
-    amount_micro: str
+    amount_micro: int
 
 class Schedule(BaseModel):
     start: str
-    end: Optional[str]
+    end: Optional[str] = None
 
 class Budget(BaseModel):
     period: str
@@ -58,6 +58,56 @@ class Targeting(BaseModel):
     placement_setting: Optional[str]
     audience_setting: Optional[AudienceSetting]
 
+class TargetInventoryDimension(BaseModel):
+    width: int
+    height: int
+
+class BannerAsset(BaseModel):
+    creative_id: str
+    image_url: str
+    width: int
+    height: int
+    target_inventory_dimension: TargetInventoryDimension
+
+class LogoAsset(BaseModel):
+    creative_id: str
+    image_url: str
+
+class HeadlineAsset(BaseModel):
+    text: str
+
+class CTAAsset(BaseModel):
+    text: str
+
+class ReviewInformation(BaseModel):
+    status: str
+    rejection_reason: str
+    updated_at: str
+
+class Asset(BaseModel):
+    id: str
+    banner: BannerAsset
+    logo: LogoAsset
+    headline: HeadlineAsset
+    cta: CTAAsset
+    review_information: ReviewInformation
+    created_at: str
+    updated_at: str
+
+class CustomURLSetting(BaseModel):
+    url: str
+
+class LandPage(BaseModel):
+    type: str
+    custom_url_setting: CustomURLSetting
+    id: str
+    review_information: ReviewInformation
+    created_at: str
+    updated_at: str
+
+class ItemSelection(BaseModel):
+    type: str
+
 class Campaign(BaseModel):
     id: str
     title: str
@@ -80,6 +130,12 @@ class Campaign(BaseModel):
     updated_at: str
     audience_types: list[str]
     offsite_setting: Optional[str]
+    item_selection: Optional[ItemSelection]
+    assets: Optional[list[Asset]]
+    landing_pages: Optional[list[LandPage]]
+    landing_url_suffix: Optional[str]
+    catalog_brand_id: Optional[str]
+    catalog_category: Optional[str]
     
 class CampaignList(BaseModel):
     campaigns: list[Campaign]

{mcm_cli-1.4.2 → mcm_cli-1.5.1}/setup.py

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