mcm-cli 1.4.0__py3-none-any.whl → 1.4.2__py3-none-any.whl

mcmcli/command/campaign.py

@@ -0,0 +1,317 @@
+# 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.command.auth import AuthCommand, AuthHeaderName, AuthHeaderValue
+from mcmcli.data.campaign import Campaign, CampaignList
+from mcmcli.data.error import Error
+from mcmcli.data.item import Item, ItemList
+from mcmcli.requests import CurlString, api_request
+
+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)
+
+def _create_campaign_command(profile):
+    auth = AuthCommand(profile)
+    return CampaignCommand(profile, auth)
+
+@app.command()
+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", 
+    ):
+    """
+    List all the campaigns of an ad account.
+    """
+    c = _create_campaign_command(profile)
+    if c is None:
+        return
+    curl, error, campaigns = c.list_campaigns(account_id, to_curl)
+
+    if to_curl:
+        print(curl)
+        return
+    if error:
+        print(f"ERROR: {error.message}")
+        return
+    if to_json:
+        json_dumps = [x.model_dump_json() for x in campaigns]
+        print(f"[{','.join(json_dumps)}]")
+        return
+    
+    print("Ad Account ID, Campaign ID, Ad Type, Starts At, Ends At, Is Enabled, Is Active,  Campaign Title")
+    for c in campaigns:
+        print(f"{c.ad_account_id}, {c.id}, {c.ad_type}, {c.schedule.start}, {c.schedule.end}, {c.enabling_state}, {c.state}, {c.title}")
+    
+    return
+
+@app.command()
+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", 
+    ):
+    """
+    Read the campaign information
+    """
+    command = _create_campaign_command(profile)
+    if command is None:
+        return
+    curl, error, c = command.read_campaign(account_id, campaign_id, to_curl)
+
+    if to_curl:
+        print(curl)
+        return
+    if error:
+        print(f"ERROR: {error.message}")
+        return
+    if to_json:
+        json_dumps = c.model_dump_json()
+        print(json_dumps)
+        return
+    
+    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}")
+
+    return
+
+@app.command()
+def list_campaign_items(
+    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",
+    ):
+    """
+    List all the items of a given campaign.
+    """
+    c = _create_campaign_command(profile)
+    if c is None:
+        return
+
+
+    curl, error, items = c.list_campaign_items(account_id, campaign_id, to_curl)
+    if to_curl:
+        print(curl)
+        return
+    if error:
+        print(f"ERROR: {error.message}")
+        return   
+    if to_json:
+        json_dumps = [x.model_dump_json() for x in items]
+        print(f"[{','.join(json_dumps)}]")
+        return
+
+    print("Ad Account Id, Campaign ID, Item ID, Is Listed In Campaign, Created At, Item Title")
+    for i in items:
+        listing_status = "Listed" if i.is_active else "Not Listed"
+        print(f'{account_id}, {campaign_id}, {i.id}, {listing_status}, {i.created_timestamp}, "{i.title}"')
+
+    return
+
+@app.command()
+def add_items_to_campaign(
+    account_id: str = typer.Option(help="Ad account ID"), 
+    campaign_id: str = typer.Option(help="Campaign ID"), 
+    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",
+    ):
+    """
+    Add the item IDs to the given campaign of the account
+    """
+    c = _create_campaign_command(profile)
+    if c is None:
+        return
+
+    _, error, campaign = c.read_campaign(account_id, campaign_id)
+    if error:
+        print(f"ERROR: {error.message}")
+        return
+
+    #
+    # Add the item ID to the campaign
+    #
+    x = set(campaign.catalog_item_ids) | set(item_ids.split(','))
+    campaign.catalog_item_ids = list(x)
+
+    #
+    # Update the campaign
+    #
+    curl, error, campaign = c.update_campaign(campaign, to_curl)
+    if to_curl:
+        print(curl)
+        return
+    if error:
+        print(f"ERROR: {error.message}")
+        return
+    if to_json:
+        print(campaign.model_dump_json())
+        return
+
+    print(f"Added the item IDs ({item_ids}) to the campaign.")
+    return
+
+class CampaignCommand:
+    def __init__(self, profile, auth_command):
+        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.auth_command = auth_command
+        self.api_base_url = f"{self.config['management_api_hostname']}/rmp/mgmt/v1/platforms/{self.config['platform_id']}"
+        self.headers = {
+            "accept": "application/json",
+            "content-type": "application/json"
+        }
+    
+        self.refresh_token()
+
+
+    def refresh_token(
+        self,
+    ) -> None:
+        error, auth_header_name, auth_header_value = self.auth_command.get_auth_credential()
+        if error:
+            print(f"ERROR: {error.message}", file=sys.stderr, flush=True)
+            sys.exit()
+
+        self.headers[auth_header_name] = auth_header_value
+
+
+    def read_campaign(self, account_id, campaign_id, to_curl=False) -> tuple[CurlString, Error, Campaign]:
+        _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:
+            return curl, None, None
+        if error:
+            return None, error, None
+
+        campaign = Campaign(**json_obj['campaign'])
+        return None, None, campaign
+    
+    def update_campaign(self, campaign: Campaign, to_curl=False) -> tuple[CurlString, Error, Campaign]:
+        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}"
+        _payload = {
+            "campaign": campaign.model_dump()
+        }
+        curl, error, json_obj = api_request('PUT', to_curl, _api_url, self.headers, _payload)
+        if curl:
+            return curl, None, None
+        if error:
+            return None, error, None
+        
+        c = Campaign(**json_obj['campaign'])
+        return None, None, c 
+
+    def list_campaigns(self, account_id, to_curl=False) -> tuple[CurlString, Error, list[Campaign]]:
+        _api_url = f"{self.api_base_url}/ad-accounts/{account_id}/campaigns"
+        
+        curl, error, json_obj = api_request('GET', to_curl, _api_url, self.headers)
+        if curl:
+            return curl, None, None
+        if error:
+            return None, error, None
+
+        campaigns = CampaignList(**json_obj)
+        return None, None, campaigns.campaigns
+
+    def list_campaign_items(self, account_id, campaign_id, to_curl=False) -> tuple[CurlString, Error, list[Item]]:
+        _api_url = f"{self.api_base_url}/ad-accounts/{account_id}/campaigns/{campaign_id}/items"
+        _payload = {
+            "ad_account_id": account_id,
+            "campaign_id": campaign_id,
+            "search_keyword":[],
+            "order_by": [{
+                "column": "ID",
+                "direction": "ASC"
+            }],
+            "filter": [
+                {
+                    "column": "IS_ACTIVE",
+                    "filter_operator": "EQ",
+                    "value": "true",
+                }
+            ],
+            "page_index": 1,
+            "page_size": MAX_NUM_ITEMS_PER_PAGE,
+        }
+
+        #
+        # Get active items
+        #
+        curl, error, active_items = self.list_campaign_items_(to_curl, _api_url, self.headers, _payload, _is_active=True)
+        if curl:
+            return curl, None, None
+        if error:
+            return None, error, None
+
+        #
+        # Get inactive items
+        #
+        _, error, inactive_items = self.list_campaign_items_(to_curl, _api_url, self.headers, _payload, _is_active=False)
+        if error:
+            return None, error, None
+
+        return None, None, active_items + inactive_items
+
+
+    def list_campaign_items_(self, to_curl, _api_url, _headers, _payload, _is_active) -> tuple[CurlString, Error, list[Item]]:
+        items = []
+        num_items = 0
+        page_index = 1
+        while True:
+            _payload["page_index"] = page_index
+            _payload["filter"][0]["value"] = "true" if _is_active else "false"
+
+            curl, error, json_obj = api_request('POST', to_curl, _api_url, _headers, _payload)
+            if curl:
+                return curl, None, None
+            if error:
+                return None, error, None
+
+            item_group = ItemList(**json_obj)
+            items += item_group.rows
+            num_items += len(item_group.rows)
+
+            if num_items >= item_group.num_counts:
+                break
+            page_index += 1
+
+        return None, None, items
+

mcmcli/command/config.py

@@ -88,6 +88,8 @@ def init(profile: str = "default"):
         "decision_api_key_name":   typer.prompt("Friendly name of the decision API key", default="unknown"),
         "event_api_key":           typer.prompt("Event API key", default="unknown"),
         "event_api_key_name":      typer.prompt("Friendly name of the event API key", default="unknown"),
+        "management_api_key":      typer.prompt("Management API key", default="unknown"),
+        "management_api_key_name": typer.prompt("Friendly name of the management API key", default="unknown"),
     }
     print(f"The profile [{profile}] has been created.")
 

mcmcli/command/decision.py

@@ -123,6 +123,10 @@ class DecisionCommand:
         if (self.config is None):
             print(f"ERROR: Failed to load the CLI profile", file=sys.stderr, flush=True)
             sys.exit()
+        
+        if 'decision_api_key' not in self.config or self.config['decision_api_key'] is None or self.config['decision_api_key'] == "":
+            print(f"ERROR: Decision API key is not set in the profile [{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']}"

mcmcli/command/report.py

@@ -0,0 +1,150 @@
+# 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.command.auth import AuthCommand, AuthHeaderName, AuthHeaderValue
+from mcmcli.data.error import Error
+from mcmcli.data.report import Report, ReportList
+from mcmcli.requests import CurlString, api_request
+
+import json
+import mcmcli.command.auth
+import mcmcli.command.config
+import mcmcli.logging
+import mcmcli.requests
+import shortuuid
+import sys
+import typer
+
+app = typer.Typer(add_completion=False)
+
+def _create_report_command(profile):
+    auth = AuthCommand(profile)
+    return ReportCommand(profile, auth)
+
+@app.command()
+def platform_summary(
+    start_date: str = typer.Option(help="Start date of the report window (YYYY-MM-DD)."),
+    end_date: str = typer.Option(help="End date of the report window (YYYY-MM-DD)."),
+    group_by: str = typer.Option(False, help="Group it by DATE, AD_ACCOUNT, or CAMPAIGN"),
+    to_curl: bool = typer.Option(False, help="Generate the curl command instead of executing it."),
+    profile: str = "default",
+    ):
+    """
+    Retrive the Platform-wide summary report.
+    """
+    c = _create_report_command(profile)
+    if c is None:
+        return
+
+    curl, error, ReportList = c.report_platform_summary(start_date, end_date, group_by, to_curl)
+    if error:
+        print(f"ERROR: {error.message}")
+        return
+    if to_curl:
+        print(curl)
+        return
+    
+    print(ReportList.model_dump_json(indent=4))
+    return
+
+@app.command()
+def account_summary(
+    account_id: str = typer.Option(help="Ad account ID"), 
+    start_date: str = typer.Option(help="Start date of the report window."),
+    end_date: str = typer.Option(help="End date of the report window."),
+    group_by: str = typer.Option(False, help="Group it by DATE, AD_ACCOUNT, or CAMPAIGN"),
+    to_curl: bool = typer.Option(False, help="Generate the curl command instead of executing it."),
+    profile: str = "default",
+    ):
+    """
+    Retrive the ad account summary report.
+    """
+    c = _create_report_command(profile)
+    if c is None:
+        return
+
+    curl, error, ReportList = c.report_account_summary(account_id, start_date, end_date, group_by, to_curl)
+    if to_curl:
+        print(curl)
+        return
+    if error:
+        print(f"ERROR: {error.message}")
+        return    
+
+    print(ReportList.model_dump_json(indent=4))
+    return
+
+class ReportCommand:
+    def __init__(self, profile, auth_command):
+        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.auth_command = auth_command
+        self.api_base_url = f"{self.config['management_api_hostname']}/rmp/mgmt/v1/platforms/{self.config['platform_id']}"
+        self.headers = {
+            "accept": "application/json",
+            "content-type": "application/json",
+        }
+
+        self.refresh_token()
+
+    def refresh_token(
+        self,
+    ) -> None:
+        error, auth_header_name, auth_header_value = self.auth_command.get_auth_credential()
+        if error:
+            print(f"ERROR: {error.message}", file=sys.stderr, flush=True)
+            sys.exit()
+
+        self.headers[auth_header_name] = auth_header_value
+
+
+    def report_platform_summary(self, start_date, end_date, group_by, to_curl) -> tuple[CurlString, Error, ReportList]:
+        _api_url = f"{self.api_base_url}/report"
+        return self._report_summary(_api_url, start_date, end_date, group_by, to_curl)
+
+    def report_account_summary(self, account_id, start_date, end_date, group_by, to_curl) -> tuple[CurlString, Error, ReportList]:
+        _api_url = f"{self.api_base_url}/ad-accounts/{account_id}/report"
+        return self._report_summary(_api_url, start_date, end_date, group_by, to_curl)
+
+    def _report_summary(self, url, start_date, end_date, group_by, to_curl) -> tuple[CurlString, Error, ReportList]:
+        if group_by and group_by != 'DATE' and group_by != 'AD_ACCOUNT' and group_by != 'CAMPAIGN':
+            error = Error(code=0, message="Invalid --group-by value. It should be 'DATE', 'AD_ACCOUNT', or 'CAMPAIGN'")
+            return None, error, None
+
+        _payload = {
+            "timezone": self.config['timezone'],
+            "date_start": start_date,
+            "date_end": end_date
+        }
+        if group_by:
+            _payload['group_by'] = [
+                group_by
+            ]
+
+        curl, error, json_obj = api_request('POST', to_curl, url, self.headers, _payload)
+        if curl:
+            return curl, None, None
+        if error:
+            return None, error, None
+        
+        report_list = ReportList(**json_obj)
+        if not report_list.rows:
+            return None, Error(code=0, message="No reports generated"), None
+
+        return None, None, report_list
+
+

mcmcli/command/wallet.py

@@ -11,8 +11,8 @@
 # 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 datetime import datetime
+from mcmcli.command.auth import AuthCommand, AuthHeaderName, AuthHeaderValue
+from datetime import datetime, UTC
 from enum import Enum
 from mcmcli.data.error import Error
 from mcmcli.data.wallet import Wallet, WalletsWrapper, PlatformWalletsWrapper
@@ -48,6 +48,9 @@ def _get_wallet_balance(wallet: Wallet):
 
     return (credit_balance, prepaid_balance)
 
+def _create_wallet_command(profile):
+    auth = AuthCommand(profile)
+    return WalletCommand(profile, auth)
 
 @app.command()
 def platform_balance(
@@ -57,17 +60,11 @@ def platform_balance(
     """
     Get the current balances of all ad accounts in CSV format.
     """
-    auth = mcmcli.command.auth.AuthCommand(profile)
-    curl, error, token = auth.get_token()
-    if error:
-        print(f"ERROR: {error.message}", file=sys.stderr, flush=True)
+    c = _create_wallet_command(profile)
+    if c is None:
         return
 
-    # Get current UTC timestamp and format it as an ISO 8601 string with microseconds
-    current_timestamp = datetime.utcnow().isoformat(timespec='microseconds') + "Z"
-
-    wc = WalletCommand(profile, auth, token.token)
-    curl, error, platform_wallets = wc.get_platform_balance(to_curl)
+    curl, error, platform_wallets = c.get_platform_balance(to_curl)
     if to_curl:
         print(curl)
         return
@@ -78,6 +75,9 @@ def platform_balance(
         print(f"ERROR: Cannot find the wallets", file=sys.stderr, flush=True)
         return
 
+    # Get current UTC timestamp and format it as an ISO 8601 string with microseconds
+    current_timestamp = datetime.now(UTC).isoformat(timespec='microseconds') + "Z"
+
     print("ad_account_id,credit_balance,prepaid_balance,got_balance_info_at_utc")
     for account_id, account_data in platform_wallets.items():
         wallet = account_data.wallets[0]
@@ -95,14 +95,11 @@ def balance(
     """
     Retrive the current balance of the given ad account's wallet.
     """
-    auth = mcmcli.command.auth.AuthCommand(profile)
-    curl, error, token = auth.get_token()
-    if error:
-        print(f"ERROR: {error.message}", file=sys.stderr, flush=True)
+    c = _create_wallet_command(profile)
+    if c is None:
         return
 
-    wc = WalletCommand(profile, auth, token.token)
-    curl, error, wallet = wc.get_balance(account_id, to_curl)
+    curl, error, wallet = c.get_balance(account_id, to_curl)
     if to_curl:
         print(curl)
         return
@@ -136,16 +133,12 @@ def deposit(
     """
     Add or top up the money amount to the current balance of the given ad account's wallet.
     """
-    auth = mcmcli.command.auth.AuthCommand(profile)
-    curl, error, token = auth.get_token()
-    if error:
-        print(f"ERROR: {error.message}")
+    c = _create_wallet_command(profile)
+    if c is None:
         return
 
-    wc = WalletCommand(profile, auth, token.token)
-
     # Check the wallet first
-    curl, error, wallet = wc.get_balance(account_id, to_curl=False)
+    curl, error, wallet = c.get_balance(account_id, to_curl=False)
     if curl:
         print(curl)
         return
@@ -154,7 +147,7 @@ def deposit(
         return
 
     # Deposit funds
-    curl, error, wallet = wc.update_balance(OperationType.DEPOSIT, account_id, wallet.id, fund_type, fund_amount, to_curl)
+    curl, error, wallet = c.update_balance(OperationType.DEPOSIT, account_id, wallet.id, fund_type, fund_amount, to_curl)
     if curl:
         print(curl)
         return
@@ -187,16 +180,12 @@ def withdraw(
     """
     Withdraws the money amount from the current balance of the given ad account's wallet.
     """
-    auth = mcmcli.command.auth.AuthCommand(profile)
-    curl, error, token = auth.get_token()
-    if error:
-        print(f"ERROR: {error.message}")
+    c = _create_wallet_command(profile)
+    if c is None:
         return
 
-    wc = WalletCommand(profile, auth, token.token)
-
     # Check the wallet first
-    curl, error, wallet = wc.get_balance(account_id, to_curl=False)
+    curl, error, wallet = c.get_balance(account_id, to_curl=False)
     if to_curl:
         print(curl)
         return
@@ -205,7 +194,7 @@ def withdraw(
         return
 
     # Withdraw funds
-    curl, error, wallet = wc.update_balance(OperationType.WITHDRAW, account_id, wallet.id, fund_type, fund_amount, to_curl)
+    curl, error, wallet = c.update_balance(OperationType.WITHDRAW, account_id, wallet.id, fund_type, fund_amount, to_curl)
     if to_curl:
         print(curl)
         return
@@ -230,8 +219,7 @@ class WalletCommand:
     def __init__(
         self,
         profile,
-        auth_command: mcmcli.command.auth.AuthCommand,
-        token
+        auth_command: AuthCommand,
     ):
         self.config = mcmcli.command.config.get_config(profile)
         if (self.config is None):
@@ -244,9 +232,22 @@ class WalletCommand:
         self.headers = {
             "accept": "application/json",
             "content-type": "application/json",
-            "Authorization": f"Bearer {token}"
         }
 
+        self.refresh_token()
+
+
+    def refresh_token(
+        self,
+    ) -> None:
+        error, auth_header_name, auth_header_value = self.auth_command.get_auth_credential()
+        if error:
+            print(f"ERROR: {error.message}", file=sys.stderr, flush=True)
+            sys.exit()
+
+        self.headers[auth_header_name] = auth_header_value
+
+
     def get_platform_balance(
         self,
         to_curl: bool,