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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mcm-cli
-Version: 1.5.0
+Version: 1.6.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.5.0.dist-info → mcm_cli-1.6.0.dist-info}/RECORD

@@ -1,18 +1,18 @@
 mcmcli/__init__.py,sha256=-U6lMZ9_99IXAKwnqnYXYr6NcO6TSmG-kxewgvJjU4k,575
-mcmcli/__main__.py,sha256=yiI9lBAaJYM57lXTHPKr3teWqU_xF39ZHt52_E1hCN8,1844
+mcmcli/__main__.py,sha256=wmwII11VcYr77xnuEbOpnQyLfb2J9lPzMDta_D3djIc,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=2GC0B3oqQsT5N5mHUyezgZvzPkB4-oGtddguOWfdLJs,15980
 mcmcli/command/auth.py,sha256=Ak7ZNEskWPpMoeTJcbYlEpDBgzxn8N33Q2dNf67SsCs,2926
-mcmcli/command/campaign.py,sha256=wh6WU19dCw0NBTp521g5wK6_0GraviWZxxahIcSlD44,12364
+mcmcli/command/campaign.py,sha256=gjzCDdmwp4BlXZ8PnckkBr_JE2o6ZLFR8XKwhGIHY1o,15457
 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=rbBbLt_5qrNXr8TM4nq5NtPqB0lJmtmINEAyepS7KJ4,2284
+mcmcli/data/campaign.py,sha256=pZDeSkIMWQhcgi2seDpD8xeSP3E78-_7fV5f-ObvfW4,3557
 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.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,,
+mcm_cli-1.6.0.dist-info/LICENSE,sha256=RFhQPdSOiMTguUX7JSoIuTxA7HVzCbj_p8WU36HjUQQ,10947
+mcm_cli-1.6.0.dist-info/METADATA,sha256=n3ektTooOWWE_kxjpN7D_CEOJha7LX-GJIeng4rKYKk,3056
+mcm_cli-1.6.0.dist-info/NOTICE,sha256=Ldnl2MjRaXPxcldUdbI2NTybq60XAa2LowRhFrRTuiI,76
+mcm_cli-1.6.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+mcm_cli-1.6.0.dist-info/entry_points.txt,sha256=qTHAWZ-ejSiU4t11RYwtAU8ScqhQPDeMVTG9y4wMVLg,60
+mcm_cli-1.6.0.dist-info/top_level.txt,sha256=sh7oqIaqLQlMtKHlxHHgpV2xGMrBMPFWpSp0C6nvJ_Y,7
+mcm_cli-1.6.0.dist-info/RECORD,,

mcmcli/__main__.py

@@ -37,7 +37,7 @@ def version():
 	"""
 	Show the tool version
 	"""
-	typer.echo(f"Version: mcm-cli v1.5.0")
+	typer.echo(f"Version: mcm-cli v1.6.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/campaign.py

@@ -11,8 +11,9 @@
 # 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 enum import Enum
 from mcmcli.command.auth import AuthCommand, AuthHeaderName, AuthHeaderValue
-from mcmcli.data.campaign import Campaign, CampaignList
+from mcmcli.data.campaign import AnyCampaign, Campaign, CampaignList
 from mcmcli.data.error import Error
 from mcmcli.data.item import Item, ItemList
 from mcmcli.requests import CurlString, api_request
@@ -37,7 +38,7 @@ def list_campaigns(
     account_id: str = typer.Option(help="Ad account ID"),
     to_curl: bool = typer.Option(False, help="Generate the curl command instead of executing it."),
     to_json: bool = typer.Option(False, help="Print raw output in json"),
-    profile: str = "default", 
+    profile: str = typer.Option("default", help="Profile Name – The MCM CLI configuration profile to use."), 
     ):
     """
     List all the campaigns of an ad account.
@@ -69,8 +70,7 @@ def read_campaign(
     account_id: str = typer.Option(help="Ad account ID"),
     campaign_id: str = typer.Option(help="Campaign ID"), 
     to_curl: bool = typer.Option(False, help="Generate the curl command instead of executing it."),
-    to_json: bool = typer.Option(False, help="Print raw output in json"),
-    profile: str = "default", 
+    profile: str = typer.Option("default", help="Profile Name – The MCM CLI configuration profile to use."), 
     ):
     """
     Read the campaign information
@@ -86,28 +86,81 @@ def read_campaign(
     if error:
         print(f"ERROR: {error.message}")
         return
-    if to_json:
-        json_dumps = c.model_dump_json()
-        print(json_dumps)
+
+    json_dumps = c.model_dump_json()
+    print(json_dumps)
+    return
+
+class BudgetPeriod(Enum):
+    DAILY = "DAILY"
+    WEEKLY = 'WEEKLY'
+
+def validate_budget_period_amount(budget_period: BudgetPeriod = None, budget_amount: int = None):
+    if (budget_period is None) != (budget_amount is None): # XOR logic: One is given, the other isn't
+        raise typer.BadParameter("Both --budget-period and --budget-amount mube be provided together.")
+
+def validate_exclusive_params(target_roas: int = None, target_cpc: float = None):
+    if target_roas is not None and target_cpc is not None:
+        raise typer.BadParameter("You can only provide one of --target_roas or --target-cpc, not both.")
+
+@app.command()
+def update_campaign(
+    account_id: str = typer.Option(help="Ad account ID"),
+    campaign_id: str = typer.Option(help="Campaign ID"),
+    target_roas: int = typer.Option(None, help='Target ROAS (%) – Applies only to campaigns with the Optimize ROAS goal type.'),
+    target_cpc: float = typer.Option(None, help='Target CPC – Set in the platform currency. Applies only to campaigns with the Manual CPC goal type.'),
+    budget_period: BudgetPeriod = typer.Option(None, help='Budget Period – Choose between DAILY or WEEKLY.'),
+    budget_amount: int = typer.Option(None, help='Budget Amount – Set the spending limit for the chosen period.'),
+    profile: str = typer.Option("default", help="Profile Name – The MCM CLI configuration profile to use."), 
+    ):
+    """
+    Update the campaign information
+    """
+    command = _create_campaign_command(profile)
+    if command is None:
         return
+
+    _, error, c = command.read_campaign(account_id, campaign_id)
+    if error:
+        print(f"ERROR: {error.message}", file=sys.stderr, flush=True)
+        return
+
+    if budget_period is not None or budget_amount is not None:
+        validate_budget_period_amount(budget_period, budget_amount)
     
-    print(f"Ad Account ID = {c.ad_account_id}")
-    print(f"Campaign ID = {c.id}")
-    print(f"Campaign title = {c.title}")
-    print(f"Ad Type = {c.ad_type}")
-    print(f"Campaign begins at {c.schedule.start}")
-    print(f"Campaign ends at {c.schedule.end}")
-    print(f"Budget = {int(c.budget.amount.amount_micro) / 1000000} {c.budget.amount.currency} {c.budget.period}")
-    print(f"Goal = {c.goal.model_dump()}")
-    print(f"Registered items = {c.catalog_item_ids}")
+    if target_roas is not None or target_cpc is not None:
+        validate_exclusive_params(target_roas, target_cpc)
+
+    if budget_period is not None:
+        budget = c.root.get('budget')
+        budget['period'] = budget_period.value
+        budget['amount']['amount_micro'] = int(budget_amount * 1_000_000)
+
+    if target_roas is not None:
+        goal = c.root.get('goal')
+        if goal and goal.get('type') != 'OPTIMIZE_ROAS':
+            raise typer.BadParameter(f"The campaign goal type is not OPTIMIZE_ROAS and cannot update the target ROAS. Ad Account ID = {account_id}, Campaign ID = {campaign_id}")
+        goal['optimize_roas']['target_roas'] = target_roas
+    
+    if target_cpc is not None:
+        goal = c.root.get('goal')
+        if goal and goal.get('type') != 'FIXED_CPC':
+            raise typer.BadParameter(f"The campaign goal type is not FIXED_CPC and cannot update the target CPC. Ad Account ID = {account_id}, Campaign ID = {campaign_id}")
+        goal['optimize_fixed_cpc']['target_cpc']['amount_micro'] = int(target_cpc * 1_000_000)
+
+    _, error, c = command.update_campaign(c)
+    if error:
+        print(f"ERROR: {error.message}", file=sys.stderr, flush=True)
+        return
 
+    print(f'Successfully updated campaign ID: {campaign_id} for ad account ID: {account_id}')
     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."),
+    profile: str = typer.Option("default", help="Profile Name – The MCM CLI configuration profile to use."),
 ):
     """
     Turn off (pause and disable) the campaign and archive it.
@@ -150,7 +203,7 @@ def list_campaign_items(
     campaign_id: str = typer.Option(help="Campaign ID"), 
     to_curl: bool = typer.Option(False, help="Generate the curl command instead of executing it."),
     to_json: bool = typer.Option(False, help="Print raw output in json"),
-    profile: str = "default",
+    profile: str = typer.Option("default", help="Profile Name – The MCM CLI configuration profile to use."),
     ):
     """
     List all the items of a given campaign.
@@ -186,7 +239,7 @@ def add_items_to_campaign(
     item_ids: str = typer.Option(help="Item IDs to add separated by comma(,) like 'p123,p456"),
     to_curl: bool = typer.Option(False, help="Generate the curl command instead of executing it."),
     to_json: bool = typer.Option(False, help="Print raw output in json"),
-    profile: str = "default",
+    profile: str = typer.Option("default", help="Profile Name – The MCM CLI configuration profile to use."),
     ):
     """
     Add the item IDs to the given campaign of the account
@@ -252,7 +305,7 @@ class CampaignCommand:
         self.headers[auth_header_name] = auth_header_value
 
 
-    def read_campaign(self, account_id, campaign_id, to_curl=False) -> tuple[CurlString, Error, Campaign]:
+    def read_campaign(self, account_id, campaign_id, to_curl=False) -> tuple[CurlString, Error, AnyCampaign]:
         _api_url = f"{self.api_base_url}/ad-accounts/{account_id}/campaigns/{campaign_id}"
         curl, error, json_obj = api_request('GET', to_curl, _api_url, self.headers)
         if curl:
@@ -260,14 +313,17 @@ class CampaignCommand:
         if error:
             return None, error, None
 
-        campaign = Campaign(**json_obj['campaign'])
+        campaign = AnyCampaign(**json_obj['campaign'])
         return None, None, campaign
     
-    def update_campaign(self, campaign: Campaign, to_curl=False) -> tuple[CurlString, Error, Campaign]:
+    def update_campaign(self, campaign: AnyCampaign, to_curl=False) -> tuple[CurlString, Error, AnyCampaign]:
         if campaign is None:
             return Error(code=0, message="invalid campaign info"), None
 
-        _api_url = f"{self.api_base_url}/ad-accounts/{campaign.ad_account_id}/campaigns/{campaign.id}"
+        # Remove 'daily_budget' as it's unnecessary
+        campaign.root.pop("daily_budget", None)
+
+        _api_url = f"{self.api_base_url}/ad-accounts/{campaign.root['ad_account_id']}/campaigns/{campaign.root['id']}"
         _payload = {
             "campaign": campaign.model_dump()
         }
@@ -277,7 +333,7 @@ class CampaignCommand:
         if error:
             return None, error, None
         
-        c = Campaign(**json_obj['campaign'])
+        c = AnyCampaign(**json_obj['campaign'])
         return None, None, c 
 
     def list_campaigns(self, account_id, to_curl=False) -> tuple[CurlString, Error, list[Campaign]]:

mcmcli/data/campaign.py

@@ -12,8 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from pydantic import BaseModel
-from typing import Optional
+from pydantic import BaseModel, RootModel
+from typing import Any, Optional
+
+class AnyCampaign(RootModel[Any]):
+    pass
 
 #
 # API response dataclasses
@@ -24,7 +27,7 @@ class MicroPrice(BaseModel):
 
 class Schedule(BaseModel):
     start: str
-    end: Optional[str]
+    end: Optional[str] = None
 
 class Budget(BaseModel):
     period: str
@@ -58,6 +61,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 +133,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]