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

mcmcli/data/campaign.py

@@ -0,0 +1,86 @@
+# 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 pydantic import BaseModel
+from typing import Optional
+
+#
+# API response dataclasses
+#
+class MicroPrice(BaseModel):
+    currency: str
+    amount_micro: str
+
+class Schedule(BaseModel):
+    start: str
+    end: Optional[str]
+
+class Budget(BaseModel):
+    period: str
+    amount: MicroPrice
+
+class TargetCpc(BaseModel):
+    target_cpc: MicroPrice
+
+class TargetRoas(BaseModel):
+    target_roas: int
+
+class Goal(BaseModel):
+    type: str
+    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
+    ad_account_id: str
+    creative_ids: Optional[list[str]]
+    hidden: bool
+    operation_type: str
+    ad_type: str
+    schedule: Schedule
+    daily_budget: MicroPrice
+    budget: Budget
+    targeting: Optional[Targeting]
+    managed_setting: Optional[str]
+    text_entry: str
+    goal: Goal
+    catalog_item_ids: list[str]
+    enabling_state: str
+    state: str
+    created_at: str
+    updated_at: str
+    audience_types: list[str]
+    offsite_setting: Optional[str]
+    
+class CampaignList(BaseModel):
+    campaigns: list[Campaign]
+    without_catalog_item_ids: bool

mcmcli/data/platform_user.py

@@ -0,0 +1,64 @@
+# 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 pydantic import BaseModel
+
+#
+# Platform user response dataclasses
+#
+# 
+# {
+#   "users": [
+#     {
+#       "id": "00YtNXn8PQGFPXiBS9oi",
+#       "email": "user@email.com",
+#       "name": "John Doe",
+#       "roles": [
+#         {
+#           "name": "PLATFORM_USER",
+#           "resource_type": "PLATFORM",
+#           "resource_id": "DEMO_TEST"
+#         },
+#         {
+#           "name": "AD_ACCOUNT_OWNER",
+#           "resource_type": "AD_ACCOUNT",
+#           "resource_id": "678acd3a-82b5-11e7-afa5-128878ebb8b6"
+#         }
+#       ],
+#       "status": "NOT_REGISTERED",
+#       "created_at": "2024-05-16T16:13:52Z",
+#       "updated_at": "2024-05-16T16:13:52Z"
+#     }
+#   ]
+# }
+
+class Role(BaseModel):
+    name: str
+    resource_type: str
+    resource_id: str
+
+class PlatformUser(BaseModel):
+    id: str
+    email: str
+    name: str
+    roles: list[Role]
+    status: str
+    created_at: str
+    updated_at: str
+
+class PlatformUserListWrapper(BaseModel):
+    users: list[PlatformUser]
+
+class PlatformUserWrapper(BaseModel):
+    user: PlatformUser

mcmcli/data/report.py

@@ -0,0 +1,110 @@
+# 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 pydantic import BaseModel
+from typing import Optional
+
+#
+# API response dataclasses
+#
+# The report command's example response is as below:
+#
+# {
+#   "rows": [
+#     {
+#       "date": "",
+#       "timezone": "America/New_York",
+#       "currency": "",
+#       "ad_account_id": "",
+#       "ad_account_title": "",
+#       "campaign_id": "",
+#       "campaign_title": "",
+#       "catalog_item_id": "",
+#       "catalog_item_title": "",
+#       "creative_id": "",
+#       "creative_title": "",
+#       "inventory_id": "",
+#       "audience_type": "",
+#       "imp_count": "14452078",
+#       "click_count": "271062",
+#       "money_spent": "11180060000",
+#       "purchase_count": "552",
+#       "purchase_breakdown": {
+#         "direct": "355",
+#         "indirect": "197",
+#         "total": "552"
+#       },
+#       "revenue": "54189164206",
+#       "revenue_breakdown": {
+#         "direct": "33440120100",
+#         "indirect": "20749044106",
+#         "total": "54189164206"
+#       },
+#       "roas": 484.6947530335258,
+#       "roas_breakdown": {
+#         "direct": 299.1050146421397,
+#         "indirect": 185.58973839138608,
+#         "total": 484.6947530335258
+#       },
+#       "cr": 0.20364344688669012,
+#       "ctr": 1.8755918699027225,
+#       "imp_to_purchase": 0.0038195199333964295,
+#       "num_ad_accounts": "34",
+#       "items_per_ad_account": 462.44117647058823,
+#       "cpc": 41245.397731884215,
+#       "acos": null,
+#       "cpm": 773595.3265682624
+#     }
+#   ]
+# }
+
+class NumberBreakdown(BaseModel):
+    direct: float
+    indirect: float
+    total: float
+
+class Report(BaseModel):
+    date: str
+    timezone: str
+    currency: str
+    ad_account_id: str
+    ad_account_title: str
+    campaign_id: str
+    campaign_title: str
+    catalog_item_id: str
+    catalog_item_title: str
+    creative_id: str
+    creative_title: str
+    inventory_id: str
+    audience_type: str
+    imp_count: str
+    click_count: str
+    money_spent: str
+    purchase_count: str
+    purchase_breakdown: NumberBreakdown
+    revenue: str
+    revenue_breakdown: NumberBreakdown
+    roas: float
+    roas_breakdown: NumberBreakdown
+    cr: float
+    ctr: float
+    imp_to_purchase: float
+    num_ad_accounts: str
+    items_per_ad_account: float
+    cpc: float
+    acos: Optional[float]
+    cpm: float
+
+class ReportList(BaseModel):
+    rows: list[Report]

mcmcli/data/user_join_request.py

@@ -0,0 +1,44 @@
+# 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 pydantic import BaseModel
+
+#
+# API error response dataclasses
+#
+# invite-user command's example response is as below:
+#
+# {
+# 	'user_join_request': {
+# 		'id': 'I6QpJhsvb2iswMN3', 
+# 		'ad_account_id': 'test', 
+# 		'user_email': 'a@b.com', 
+# 		'user_name': 'asfds', 
+# 		'role': 'AD_ACCOUNT_OWNER', 
+# 		'created_at': '2024-05-13T00:54:49.874934Z', 
+# 		'updated_at': '2024-05-13T00:54:49.874934Z'
+# 	}
+# }
+
+class UserJoinRequest(BaseModel):
+    id: str # join request ID
+    ad_account_id: str
+    user_email: str
+    user_name: str
+    role: str
+    created_at: str
+    updated_at: str
+
+class UserJoinRequestWrapper(BaseModel):
+    user_join_request: UserJoinRequest

mcm_cli-1.4.0.dist-info/RECORD

@@ -1,26 +0,0 @@
-mcmcli/__init__.py,sha256=-U6lMZ9_99IXAKwnqnYXYr6NcO6TSmG-kxewgvJjU4k,575
-mcmcli/__main__.py,sha256=eoXcJ-YvL7VS-qI3tzWEm2Zz9Mc3aKMC2WRgr8nxDAY,1616
-mcmcli/logging.py,sha256=xjRS5ey1ONx_d34qB1Fetb_SwPysoh2hzNDuNAaYYWQ,1739
-mcmcli/requests.py,sha256=IuySBQ8P_GoGF3f_TRysfgQNOhi2n9M84WK_eRXnoEU,2945
-mcmcli/command/account.py,sha256=kxJbBKYrw6OyCdaNZ0K0BEvKgZEAjj5azO-lNSeYLTM,25107
-mcmcli/command/admin.py,sha256=mDngighzQZPWlq0hOex2qzW8GNcZmvzVOTWre5RTJRE,5520
-mcmcli/command/auth.py,sha256=QLdr_XFW5BVw9r4a7Kjj5BTBXpSux3AWI9eI03S8aiA,2480
-mcmcli/command/config.py,sha256=sdzge-l_Yi2P_TlTgSLqShcGyPCzpW3QJzctpIvc-g4,4195
-mcmcli/command/decision.py,sha256=Zjbmt71OVU-oL8Itt9O-SvwT9Lbxw-PAgRZaIgiXi-E,8411
-mcmcli/command/wallet.py,sha256=giPDktndwh-NSIZbCvBzCQ6_MttZsqOkCW1wJ-fFJ8Y,11708
-mcmcli/data/account.py,sha256=pe7tPapP6vlUD5D5L5Nh5k2bkWdYOK01Mpt5fBYFnJs,1782
-mcmcli/data/account_user.py,sha256=27nQp52nMma5a3QszSJGqgq5Z0ivIb-nMZcZuhEgbEg,1328
-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
-mcmcli/data/item_blocking_result.py,sha256=daK4c8--aCe2vRsnTzLBjgKQo0C-zcDH09dC0GgrN7E,1429
-mcmcli/data/seller.py,sha256=40SA7QekM3a3svDrDYLo_QYJ68VUxDO0KeGejJMp4k4,1004
-mcmcli/data/token.py,sha256=11wtyLHCAZHu0LVbNDPa-yipcL6lenxoYIKEI58VzFs,1744
-mcmcli/data/wallet.py,sha256=eMUi8N0vJdg_E10TPhSPoZkZtmIG7gHyqgabQ8C5Lg8,3217
-mcm_cli-1.4.0.dist-info/LICENSE,sha256=RFhQPdSOiMTguUX7JSoIuTxA7HVzCbj_p8WU36HjUQQ,10947
-mcm_cli-1.4.0.dist-info/METADATA,sha256=qRht0jD47cuF5FQN1JwCZPlVWsIWNrsMl_sdY4VF7Rs,3018
-mcm_cli-1.4.0.dist-info/NOTICE,sha256=Ldnl2MjRaXPxcldUdbI2NTybq60XAa2LowRhFrRTuiI,76
-mcm_cli-1.4.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-mcm_cli-1.4.0.dist-info/entry_points.txt,sha256=qTHAWZ-ejSiU4t11RYwtAU8ScqhQPDeMVTG9y4wMVLg,60
-mcm_cli-1.4.0.dist-info/top_level.txt,sha256=sh7oqIaqLQlMtKHlxHHgpV2xGMrBMPFWpSp0C6nvJ_Y,7
-mcm_cli-1.4.0.dist-info/RECORD,,