@cesteral/snapchat-mcp 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +201 -0
- package/README.md +336 -0
- package/dist/auth/index.d.ts +3 -0
- package/dist/auth/index.d.ts.map +1 -0
- package/dist/auth/index.js +3 -0
- package/dist/auth/index.js.map +1 -0
- package/dist/auth/snapchat-auth-adapter.d.ts +44 -0
- package/dist/auth/snapchat-auth-adapter.d.ts.map +1 -0
- package/dist/auth/snapchat-auth-adapter.js +127 -0
- package/dist/auth/snapchat-auth-adapter.js.map +1 -0
- package/dist/auth/snapchat-auth-strategy.d.ts +13 -0
- package/dist/auth/snapchat-auth-strategy.d.ts.map +1 -0
- package/dist/auth/snapchat-auth-strategy.js +54 -0
- package/dist/auth/snapchat-auth-strategy.js.map +1 -0
- package/dist/config/index.d.ts +124 -0
- package/dist/config/index.d.ts.map +1 -0
- package/dist/config/index.js +57 -0
- package/dist/config/index.js.map +1 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +46 -0
- package/dist/index.js.map +1 -0
- package/dist/mcp-server/prompts/definitions/bulk-operations-workflow.prompt.d.ts +4 -0
- package/dist/mcp-server/prompts/definitions/bulk-operations-workflow.prompt.d.ts.map +1 -0
- package/dist/mcp-server/prompts/definitions/bulk-operations-workflow.prompt.js +127 -0
- package/dist/mcp-server/prompts/definitions/bulk-operations-workflow.prompt.js.map +1 -0
- package/dist/mcp-server/prompts/definitions/campaign-setup-workflow.prompt.d.ts +4 -0
- package/dist/mcp-server/prompts/definitions/campaign-setup-workflow.prompt.d.ts.map +1 -0
- package/dist/mcp-server/prompts/definitions/campaign-setup-workflow.prompt.js +121 -0
- package/dist/mcp-server/prompts/definitions/campaign-setup-workflow.prompt.js.map +1 -0
- package/dist/mcp-server/prompts/definitions/creative-upload-workflow.prompt.d.ts +4 -0
- package/dist/mcp-server/prompts/definitions/creative-upload-workflow.prompt.d.ts.map +1 -0
- package/dist/mcp-server/prompts/definitions/creative-upload-workflow.prompt.js +121 -0
- package/dist/mcp-server/prompts/definitions/creative-upload-workflow.prompt.js.map +1 -0
- package/dist/mcp-server/prompts/definitions/cross-platform-campaign-setup.prompt.d.ts +4 -0
- package/dist/mcp-server/prompts/definitions/cross-platform-campaign-setup.prompt.d.ts.map +1 -0
- package/dist/mcp-server/prompts/definitions/cross-platform-campaign-setup.prompt.js +299 -0
- package/dist/mcp-server/prompts/definitions/cross-platform-campaign-setup.prompt.js.map +1 -0
- package/dist/mcp-server/prompts/definitions/cross-platform-performance.prompt.d.ts +4 -0
- package/dist/mcp-server/prompts/definitions/cross-platform-performance.prompt.d.ts.map +1 -0
- package/dist/mcp-server/prompts/definitions/cross-platform-performance.prompt.js +170 -0
- package/dist/mcp-server/prompts/definitions/cross-platform-performance.prompt.js.map +1 -0
- package/dist/mcp-server/prompts/definitions/entity-duplication-workflow.prompt.d.ts +4 -0
- package/dist/mcp-server/prompts/definitions/entity-duplication-workflow.prompt.d.ts.map +1 -0
- package/dist/mcp-server/prompts/definitions/entity-duplication-workflow.prompt.js +198 -0
- package/dist/mcp-server/prompts/definitions/entity-duplication-workflow.prompt.js.map +1 -0
- package/dist/mcp-server/prompts/definitions/entity-update-workflow.prompt.d.ts +4 -0
- package/dist/mcp-server/prompts/definitions/entity-update-workflow.prompt.d.ts.map +1 -0
- package/dist/mcp-server/prompts/definitions/entity-update-workflow.prompt.js +189 -0
- package/dist/mcp-server/prompts/definitions/entity-update-workflow.prompt.js.map +1 -0
- package/dist/mcp-server/prompts/definitions/reporting-workflow.prompt.d.ts +4 -0
- package/dist/mcp-server/prompts/definitions/reporting-workflow.prompt.d.ts.map +1 -0
- package/dist/mcp-server/prompts/definitions/reporting-workflow.prompt.js +126 -0
- package/dist/mcp-server/prompts/definitions/reporting-workflow.prompt.js.map +1 -0
- package/dist/mcp-server/prompts/definitions/targeting-discovery-workflow.prompt.d.ts +4 -0
- package/dist/mcp-server/prompts/definitions/targeting-discovery-workflow.prompt.d.ts.map +1 -0
- package/dist/mcp-server/prompts/definitions/targeting-discovery-workflow.prompt.js +198 -0
- package/dist/mcp-server/prompts/definitions/targeting-discovery-workflow.prompt.js.map +1 -0
- package/dist/mcp-server/prompts/definitions/tool-schema-exploration.prompt.d.ts +4 -0
- package/dist/mcp-server/prompts/definitions/tool-schema-exploration.prompt.d.ts.map +1 -0
- package/dist/mcp-server/prompts/definitions/tool-schema-exploration.prompt.js +91 -0
- package/dist/mcp-server/prompts/definitions/tool-schema-exploration.prompt.js.map +1 -0
- package/dist/mcp-server/prompts/definitions/troubleshoot-entity.prompt.d.ts +4 -0
- package/dist/mcp-server/prompts/definitions/troubleshoot-entity.prompt.d.ts.map +1 -0
- package/dist/mcp-server/prompts/definitions/troubleshoot-entity.prompt.js +111 -0
- package/dist/mcp-server/prompts/definitions/troubleshoot-entity.prompt.js.map +1 -0
- package/dist/mcp-server/prompts/index.d.ts +9 -0
- package/dist/mcp-server/prompts/index.d.ts.map +1 -0
- package/dist/mcp-server/prompts/index.js +89 -0
- package/dist/mcp-server/prompts/index.js.map +1 -0
- package/dist/mcp-server/resources/definitions/entity-examples.resource.d.ts +4 -0
- package/dist/mcp-server/resources/definitions/entity-examples.resource.d.ts.map +1 -0
- package/dist/mcp-server/resources/definitions/entity-examples.resource.js +177 -0
- package/dist/mcp-server/resources/definitions/entity-examples.resource.js.map +1 -0
- package/dist/mcp-server/resources/definitions/entity-hierarchy.resource.d.ts +3 -0
- package/dist/mcp-server/resources/definitions/entity-hierarchy.resource.d.ts.map +1 -0
- package/dist/mcp-server/resources/definitions/entity-hierarchy.resource.js +194 -0
- package/dist/mcp-server/resources/definitions/entity-hierarchy.resource.js.map +1 -0
- package/dist/mcp-server/resources/definitions/entity-schemas.resource.d.ts +4 -0
- package/dist/mcp-server/resources/definitions/entity-schemas.resource.d.ts.map +1 -0
- package/dist/mcp-server/resources/definitions/entity-schemas.resource.js +117 -0
- package/dist/mcp-server/resources/definitions/entity-schemas.resource.js.map +1 -0
- package/dist/mcp-server/resources/definitions/index.d.ts +7 -0
- package/dist/mcp-server/resources/definitions/index.d.ts.map +1 -0
- package/dist/mcp-server/resources/definitions/index.js +54 -0
- package/dist/mcp-server/resources/definitions/index.js.map +1 -0
- package/dist/mcp-server/resources/definitions/reporting-reference.resource.d.ts +3 -0
- package/dist/mcp-server/resources/definitions/reporting-reference.resource.d.ts.map +1 -0
- package/dist/mcp-server/resources/definitions/reporting-reference.resource.js +148 -0
- package/dist/mcp-server/resources/definitions/reporting-reference.resource.js.map +1 -0
- package/dist/mcp-server/resources/index.d.ts +3 -0
- package/dist/mcp-server/resources/index.d.ts.map +1 -0
- package/dist/mcp-server/resources/index.js +2 -0
- package/dist/mcp-server/resources/index.js.map +1 -0
- package/dist/mcp-server/resources/types.d.ts +8 -0
- package/dist/mcp-server/resources/types.d.ts.map +1 -0
- package/dist/mcp-server/resources/types.js +2 -0
- package/dist/mcp-server/resources/types.js.map +1 -0
- package/dist/mcp-server/server.d.ts +5 -0
- package/dist/mcp-server/server.d.ts.map +1 -0
- package/dist/mcp-server/server.js +134 -0
- package/dist/mcp-server/server.js.map +1 -0
- package/dist/mcp-server/tools/definitions/adjust-bids.tool.d.ts +209 -0
- package/dist/mcp-server/tools/definitions/adjust-bids.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/adjust-bids.tool.js +141 -0
- package/dist/mcp-server/tools/definitions/adjust-bids.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/bulk-create-entities.tool.d.ts +163 -0
- package/dist/mcp-server/tools/definitions/bulk-create-entities.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/bulk-create-entities.tool.js +119 -0
- package/dist/mcp-server/tools/definitions/bulk-create-entities.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/bulk-update-entities.tool.d.ts +241 -0
- package/dist/mcp-server/tools/definitions/bulk-update-entities.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/bulk-update-entities.tool.js +149 -0
- package/dist/mcp-server/tools/definitions/bulk-update-entities.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/bulk-update-status.tool.d.ts +203 -0
- package/dist/mcp-server/tools/definitions/bulk-update-status.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/bulk-update-status.tool.js +154 -0
- package/dist/mcp-server/tools/definitions/bulk-update-status.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/check-report-status.tool.d.ts +119 -0
- package/dist/mcp-server/tools/definitions/check-report-status.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/check-report-status.tool.js +89 -0
- package/dist/mcp-server/tools/definitions/check-report-status.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/create-entity.tool.d.ts +131 -0
- package/dist/mcp-server/tools/definitions/create-entity.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/create-entity.tool.js +116 -0
- package/dist/mcp-server/tools/definitions/create-entity.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/delete-entity.tool.d.ts +100 -0
- package/dist/mcp-server/tools/definitions/delete-entity.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/delete-entity.tool.js +110 -0
- package/dist/mcp-server/tools/definitions/delete-entity.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/download-report.tool.d.ts +297 -0
- package/dist/mcp-server/tools/definitions/download-report.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/download-report.tool.js +103 -0
- package/dist/mcp-server/tools/definitions/download-report.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/duplicate-entity.tool.d.ts +105 -0
- package/dist/mcp-server/tools/definitions/duplicate-entity.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/duplicate-entity.tool.js +93 -0
- package/dist/mcp-server/tools/definitions/duplicate-entity.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/get-ad-preview.tool.d.ts +68 -0
- package/dist/mcp-server/tools/definitions/get-ad-preview.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/get-ad-preview.tool.js +61 -0
- package/dist/mcp-server/tools/definitions/get-ad-preview.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/get-audience-estimate.tool.d.ts +104 -0
- package/dist/mcp-server/tools/definitions/get-audience-estimate.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/get-audience-estimate.tool.js +107 -0
- package/dist/mcp-server/tools/definitions/get-audience-estimate.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/get-entity.tool.d.ts +76 -0
- package/dist/mcp-server/tools/definitions/get-entity.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/get-entity.tool.js +71 -0
- package/dist/mcp-server/tools/definitions/get-entity.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/get-report-breakdowns.tool.d.ts +295 -0
- package/dist/mcp-server/tools/definitions/get-report-breakdowns.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/get-report-breakdowns.tool.js +172 -0
- package/dist/mcp-server/tools/definitions/get-report-breakdowns.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/get-report.tool.d.ts +279 -0
- package/dist/mcp-server/tools/definitions/get-report.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/get-report.tool.js +166 -0
- package/dist/mcp-server/tools/definitions/get-report.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/get-targeting-options.tool.d.ts +89 -0
- package/dist/mcp-server/tools/definitions/get-targeting-options.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/get-targeting-options.tool.js +99 -0
- package/dist/mcp-server/tools/definitions/get-targeting-options.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/index.d.ts +25 -0
- package/dist/mcp-server/tools/definitions/index.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/index.js +75 -0
- package/dist/mcp-server/tools/definitions/index.js.map +1 -0
- package/dist/mcp-server/tools/definitions/list-advertisers.tool.d.ts +54 -0
- package/dist/mcp-server/tools/definitions/list-advertisers.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/list-advertisers.tool.js +61 -0
- package/dist/mcp-server/tools/definitions/list-advertisers.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/list-entities.tool.d.ts +161 -0
- package/dist/mcp-server/tools/definitions/list-entities.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/list-entities.tool.js +94 -0
- package/dist/mcp-server/tools/definitions/list-entities.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/search-targeting.tool.d.ts +103 -0
- package/dist/mcp-server/tools/definitions/search-targeting.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/search-targeting.tool.js +108 -0
- package/dist/mcp-server/tools/definitions/search-targeting.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/submit-report.tool.d.ts +134 -0
- package/dist/mcp-server/tools/definitions/submit-report.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/submit-report.tool.js +110 -0
- package/dist/mcp-server/tools/definitions/submit-report.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/update-entity.tool.d.ts +155 -0
- package/dist/mcp-server/tools/definitions/update-entity.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/update-entity.tool.js +115 -0
- package/dist/mcp-server/tools/definitions/update-entity.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/upload-image.tool.d.ts +82 -0
- package/dist/mcp-server/tools/definitions/upload-image.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/upload-image.tool.js +111 -0
- package/dist/mcp-server/tools/definitions/upload-image.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/upload-video.tool.d.ts +82 -0
- package/dist/mcp-server/tools/definitions/upload-video.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/upload-video.tool.js +109 -0
- package/dist/mcp-server/tools/definitions/upload-video.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/validate-entity.tool.d.ts +169 -0
- package/dist/mcp-server/tools/definitions/validate-entity.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/validate-entity.tool.js +204 -0
- package/dist/mcp-server/tools/definitions/validate-entity.tool.js.map +1 -0
- package/dist/mcp-server/tools/index.d.ts +2 -0
- package/dist/mcp-server/tools/index.d.ts.map +1 -0
- package/dist/mcp-server/tools/index.js +2 -0
- package/dist/mcp-server/tools/index.js.map +1 -0
- package/dist/mcp-server/tools/utils/entity-mapping.d.ts +18 -0
- package/dist/mcp-server/tools/utils/entity-mapping.d.ts.map +1 -0
- package/dist/mcp-server/tools/utils/entity-mapping.js +96 -0
- package/dist/mcp-server/tools/utils/entity-mapping.js.map +1 -0
- package/dist/mcp-server/tools/utils/media-types.d.ts +19 -0
- package/dist/mcp-server/tools/utils/media-types.d.ts.map +1 -0
- package/dist/mcp-server/tools/utils/media-types.js +2 -0
- package/dist/mcp-server/tools/utils/media-types.js.map +1 -0
- package/dist/mcp-server/tools/utils/resolve-session.d.ts +4 -0
- package/dist/mcp-server/tools/utils/resolve-session.d.ts.map +1 -0
- package/dist/mcp-server/tools/utils/resolve-session.js +6 -0
- package/dist/mcp-server/tools/utils/resolve-session.js.map +1 -0
- package/dist/mcp-server/transports/streamable-http-transport.d.ts +61 -0
- package/dist/mcp-server/transports/streamable-http-transport.d.ts.map +1 -0
- package/dist/mcp-server/transports/streamable-http-transport.js +105 -0
- package/dist/mcp-server/transports/streamable-http-transport.js.map +1 -0
- package/dist/services/session-services.d.ts +20 -0
- package/dist/services/session-services.d.ts.map +1 -0
- package/dist/services/session-services.js +23 -0
- package/dist/services/session-services.js.map +1 -0
- package/dist/services/snapchat/snapchat-http-client.d.ts +16 -0
- package/dist/services/snapchat/snapchat-http-client.d.ts.map +1 -0
- package/dist/services/snapchat/snapchat-http-client.js +153 -0
- package/dist/services/snapchat/snapchat-http-client.js.map +1 -0
- package/dist/services/snapchat/snapchat-reporting-service.d.ts +64 -0
- package/dist/services/snapchat/snapchat-reporting-service.d.ts.map +1 -0
- package/dist/services/snapchat/snapchat-reporting-service.js +172 -0
- package/dist/services/snapchat/snapchat-reporting-service.js.map +1 -0
- package/dist/services/snapchat/snapchat-service.d.ts +82 -0
- package/dist/services/snapchat/snapchat-service.d.ts.map +1 -0
- package/dist/services/snapchat/snapchat-service.js +321 -0
- package/dist/services/snapchat/snapchat-service.js.map +1 -0
- package/dist/services/snapchat/types.d.ts +136 -0
- package/dist/services/snapchat/types.d.ts.map +1 -0
- package/dist/services/snapchat/types.js +59 -0
- package/dist/services/snapchat/types.js.map +1 -0
- package/dist/types-global/mcp.d.ts +2 -0
- package/dist/types-global/mcp.d.ts.map +1 -0
- package/dist/types-global/mcp.js +2 -0
- package/dist/types-global/mcp.js.map +1 -0
- package/dist/utils/errors/index.d.ts +2 -0
- package/dist/utils/errors/index.d.ts.map +1 -0
- package/dist/utils/errors/index.js +2 -0
- package/dist/utils/errors/index.js.map +1 -0
- package/dist/utils/platform.d.ts +3 -0
- package/dist/utils/platform.d.ts.map +1 -0
- package/dist/utils/platform.js +5 -0
- package/dist/utils/platform.js.map +1 -0
- package/dist/utils/security/rate-limiter.d.ts +3 -0
- package/dist/utils/security/rate-limiter.d.ts.map +1 -0
- package/dist/utils/security/rate-limiter.js +5 -0
- package/dist/utils/security/rate-limiter.js.map +1 -0
- package/dist/utils/telemetry/index.d.ts +2 -0
- package/dist/utils/telemetry/index.d.ts.map +1 -0
- package/dist/utils/telemetry/index.js +2 -0
- package/dist/utils/telemetry/index.js.map +1 -0
- package/dist/utils/telemetry/tracing.d.ts +3 -0
- package/dist/utils/telemetry/tracing.d.ts.map +1 -0
- package/dist/utils/telemetry/tracing.js +4 -0
- package/dist/utils/telemetry/tracing.js.map +1 -0
- package/package.json +55 -0
|
@@ -0,0 +1,279 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import type { RequestContext, McpTextContent } from "@cesteral/shared";
|
|
3
|
+
import type { SdkContext } from "@cesteral/shared";
|
|
4
|
+
export declare const GetReportInputSchema: z.ZodEffects<z.ZodObject<{
|
|
5
|
+
adAccountId: z.ZodString;
|
|
6
|
+
fields: z.ZodArray<z.ZodString, "many">;
|
|
7
|
+
datePreset: z.ZodOptional<z.ZodEnum<["TODAY", "YESTERDAY", "LAST_7_DAYS", "LAST_14_DAYS", "LAST_30_DAYS", "THIS_MONTH", "LAST_MONTH", "LAST_90_DAYS"]>>;
|
|
8
|
+
startTime: z.ZodOptional<z.ZodString>;
|
|
9
|
+
endTime: z.ZodOptional<z.ZodString>;
|
|
10
|
+
granularity: z.ZodDefault<z.ZodOptional<z.ZodEnum<["TOTAL", "DAY", "HOUR", "LIFETIME"]>>>;
|
|
11
|
+
dimensionType: z.ZodOptional<z.ZodEnum<["CAMPAIGN", "AD_SQUAD", "AD"]>>;
|
|
12
|
+
includeComputedMetrics: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
13
|
+
} & {
|
|
14
|
+
mode: z.ZodDefault<z.ZodOptional<z.ZodEnum<["summary", "rows"]>>>;
|
|
15
|
+
columns: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
16
|
+
offset: z.ZodOptional<z.ZodNumber>;
|
|
17
|
+
maxRows: z.ZodOptional<z.ZodNumber>;
|
|
18
|
+
aggregateBy: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
19
|
+
aggregateMetrics: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodEnum<["sum", "avg", "count", "min", "max"]>>>;
|
|
20
|
+
}, "strip", z.ZodTypeAny, {
|
|
21
|
+
adAccountId: string;
|
|
22
|
+
fields: string[];
|
|
23
|
+
granularity: "TOTAL" | "DAY" | "HOUR" | "LIFETIME";
|
|
24
|
+
includeComputedMetrics: boolean;
|
|
25
|
+
mode: "rows" | "summary";
|
|
26
|
+
datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
|
|
27
|
+
startTime?: string | undefined;
|
|
28
|
+
endTime?: string | undefined;
|
|
29
|
+
dimensionType?: "CAMPAIGN" | "AD_SQUAD" | "AD" | undefined;
|
|
30
|
+
columns?: string[] | undefined;
|
|
31
|
+
offset?: number | undefined;
|
|
32
|
+
maxRows?: number | undefined;
|
|
33
|
+
aggregateBy?: string[] | undefined;
|
|
34
|
+
aggregateMetrics?: Record<string, "count" | "sum" | "avg" | "min" | "max"> | undefined;
|
|
35
|
+
}, {
|
|
36
|
+
adAccountId: string;
|
|
37
|
+
fields: string[];
|
|
38
|
+
granularity?: "TOTAL" | "DAY" | "HOUR" | "LIFETIME" | undefined;
|
|
39
|
+
datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
|
|
40
|
+
startTime?: string | undefined;
|
|
41
|
+
endTime?: string | undefined;
|
|
42
|
+
dimensionType?: "CAMPAIGN" | "AD_SQUAD" | "AD" | undefined;
|
|
43
|
+
includeComputedMetrics?: boolean | undefined;
|
|
44
|
+
mode?: "rows" | "summary" | undefined;
|
|
45
|
+
columns?: string[] | undefined;
|
|
46
|
+
offset?: number | undefined;
|
|
47
|
+
maxRows?: number | undefined;
|
|
48
|
+
aggregateBy?: string[] | undefined;
|
|
49
|
+
aggregateMetrics?: Record<string, "count" | "sum" | "avg" | "min" | "max"> | undefined;
|
|
50
|
+
}>, {
|
|
51
|
+
adAccountId: string;
|
|
52
|
+
fields: string[];
|
|
53
|
+
granularity: "TOTAL" | "DAY" | "HOUR" | "LIFETIME";
|
|
54
|
+
includeComputedMetrics: boolean;
|
|
55
|
+
mode: "rows" | "summary";
|
|
56
|
+
datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
|
|
57
|
+
startTime?: string | undefined;
|
|
58
|
+
endTime?: string | undefined;
|
|
59
|
+
dimensionType?: "CAMPAIGN" | "AD_SQUAD" | "AD" | undefined;
|
|
60
|
+
columns?: string[] | undefined;
|
|
61
|
+
offset?: number | undefined;
|
|
62
|
+
maxRows?: number | undefined;
|
|
63
|
+
aggregateBy?: string[] | undefined;
|
|
64
|
+
aggregateMetrics?: Record<string, "count" | "sum" | "avg" | "min" | "max"> | undefined;
|
|
65
|
+
}, {
|
|
66
|
+
adAccountId: string;
|
|
67
|
+
fields: string[];
|
|
68
|
+
granularity?: "TOTAL" | "DAY" | "HOUR" | "LIFETIME" | undefined;
|
|
69
|
+
datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
|
|
70
|
+
startTime?: string | undefined;
|
|
71
|
+
endTime?: string | undefined;
|
|
72
|
+
dimensionType?: "CAMPAIGN" | "AD_SQUAD" | "AD" | undefined;
|
|
73
|
+
includeComputedMetrics?: boolean | undefined;
|
|
74
|
+
mode?: "rows" | "summary" | undefined;
|
|
75
|
+
columns?: string[] | undefined;
|
|
76
|
+
offset?: number | undefined;
|
|
77
|
+
maxRows?: number | undefined;
|
|
78
|
+
aggregateBy?: string[] | undefined;
|
|
79
|
+
aggregateMetrics?: Record<string, "count" | "sum" | "avg" | "min" | "max"> | undefined;
|
|
80
|
+
}>;
|
|
81
|
+
export declare const GetReportOutputSchema: z.ZodObject<{
|
|
82
|
+
timestamp: z.ZodString;
|
|
83
|
+
totalRows: z.ZodNumber;
|
|
84
|
+
returnedRows: z.ZodNumber;
|
|
85
|
+
truncated: z.ZodBoolean;
|
|
86
|
+
nextOffset: z.ZodNullable<z.ZodNumber>;
|
|
87
|
+
headers: z.ZodArray<z.ZodString, "many">;
|
|
88
|
+
selectedColumns: z.ZodArray<z.ZodString, "many">;
|
|
89
|
+
mode: z.ZodEnum<["summary", "rows"]>;
|
|
90
|
+
previewRows: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodAny>, "many">>;
|
|
91
|
+
rows: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodAny>, "many">>;
|
|
92
|
+
warnings: z.ZodArray<z.ZodString, "many">;
|
|
93
|
+
taskId: z.ZodString;
|
|
94
|
+
}, "strip", z.ZodTypeAny, {
|
|
95
|
+
taskId: string;
|
|
96
|
+
totalRows: number;
|
|
97
|
+
headers: string[];
|
|
98
|
+
timestamp: string;
|
|
99
|
+
mode: "rows" | "summary";
|
|
100
|
+
returnedRows: number;
|
|
101
|
+
truncated: boolean;
|
|
102
|
+
nextOffset: number | null;
|
|
103
|
+
selectedColumns: string[];
|
|
104
|
+
warnings: string[];
|
|
105
|
+
rows?: Record<string, any>[] | undefined;
|
|
106
|
+
previewRows?: Record<string, any>[] | undefined;
|
|
107
|
+
}, {
|
|
108
|
+
taskId: string;
|
|
109
|
+
totalRows: number;
|
|
110
|
+
headers: string[];
|
|
111
|
+
timestamp: string;
|
|
112
|
+
mode: "rows" | "summary";
|
|
113
|
+
returnedRows: number;
|
|
114
|
+
truncated: boolean;
|
|
115
|
+
nextOffset: number | null;
|
|
116
|
+
selectedColumns: string[];
|
|
117
|
+
warnings: string[];
|
|
118
|
+
rows?: Record<string, any>[] | undefined;
|
|
119
|
+
previewRows?: Record<string, any>[] | undefined;
|
|
120
|
+
}>;
|
|
121
|
+
type GetReportInput = z.infer<typeof GetReportInputSchema>;
|
|
122
|
+
type GetReportOutput = z.infer<typeof GetReportOutputSchema>;
|
|
123
|
+
export declare function getReportLogic(input: GetReportInput, context: RequestContext, sdkContext?: SdkContext): Promise<GetReportOutput>;
|
|
124
|
+
export declare function getReportResponseFormatter(result: GetReportOutput): McpTextContent[];
|
|
125
|
+
export declare const getReportTool: {
|
|
126
|
+
name: string;
|
|
127
|
+
title: string;
|
|
128
|
+
description: string;
|
|
129
|
+
inputSchema: z.ZodEffects<z.ZodObject<{
|
|
130
|
+
adAccountId: z.ZodString;
|
|
131
|
+
fields: z.ZodArray<z.ZodString, "many">;
|
|
132
|
+
datePreset: z.ZodOptional<z.ZodEnum<["TODAY", "YESTERDAY", "LAST_7_DAYS", "LAST_14_DAYS", "LAST_30_DAYS", "THIS_MONTH", "LAST_MONTH", "LAST_90_DAYS"]>>;
|
|
133
|
+
startTime: z.ZodOptional<z.ZodString>;
|
|
134
|
+
endTime: z.ZodOptional<z.ZodString>;
|
|
135
|
+
granularity: z.ZodDefault<z.ZodOptional<z.ZodEnum<["TOTAL", "DAY", "HOUR", "LIFETIME"]>>>;
|
|
136
|
+
dimensionType: z.ZodOptional<z.ZodEnum<["CAMPAIGN", "AD_SQUAD", "AD"]>>;
|
|
137
|
+
includeComputedMetrics: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
138
|
+
} & {
|
|
139
|
+
mode: z.ZodDefault<z.ZodOptional<z.ZodEnum<["summary", "rows"]>>>;
|
|
140
|
+
columns: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
141
|
+
offset: z.ZodOptional<z.ZodNumber>;
|
|
142
|
+
maxRows: z.ZodOptional<z.ZodNumber>;
|
|
143
|
+
aggregateBy: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
144
|
+
aggregateMetrics: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodEnum<["sum", "avg", "count", "min", "max"]>>>;
|
|
145
|
+
}, "strip", z.ZodTypeAny, {
|
|
146
|
+
adAccountId: string;
|
|
147
|
+
fields: string[];
|
|
148
|
+
granularity: "TOTAL" | "DAY" | "HOUR" | "LIFETIME";
|
|
149
|
+
includeComputedMetrics: boolean;
|
|
150
|
+
mode: "rows" | "summary";
|
|
151
|
+
datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
|
|
152
|
+
startTime?: string | undefined;
|
|
153
|
+
endTime?: string | undefined;
|
|
154
|
+
dimensionType?: "CAMPAIGN" | "AD_SQUAD" | "AD" | undefined;
|
|
155
|
+
columns?: string[] | undefined;
|
|
156
|
+
offset?: number | undefined;
|
|
157
|
+
maxRows?: number | undefined;
|
|
158
|
+
aggregateBy?: string[] | undefined;
|
|
159
|
+
aggregateMetrics?: Record<string, "count" | "sum" | "avg" | "min" | "max"> | undefined;
|
|
160
|
+
}, {
|
|
161
|
+
adAccountId: string;
|
|
162
|
+
fields: string[];
|
|
163
|
+
granularity?: "TOTAL" | "DAY" | "HOUR" | "LIFETIME" | undefined;
|
|
164
|
+
datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
|
|
165
|
+
startTime?: string | undefined;
|
|
166
|
+
endTime?: string | undefined;
|
|
167
|
+
dimensionType?: "CAMPAIGN" | "AD_SQUAD" | "AD" | undefined;
|
|
168
|
+
includeComputedMetrics?: boolean | undefined;
|
|
169
|
+
mode?: "rows" | "summary" | undefined;
|
|
170
|
+
columns?: string[] | undefined;
|
|
171
|
+
offset?: number | undefined;
|
|
172
|
+
maxRows?: number | undefined;
|
|
173
|
+
aggregateBy?: string[] | undefined;
|
|
174
|
+
aggregateMetrics?: Record<string, "count" | "sum" | "avg" | "min" | "max"> | undefined;
|
|
175
|
+
}>, {
|
|
176
|
+
adAccountId: string;
|
|
177
|
+
fields: string[];
|
|
178
|
+
granularity: "TOTAL" | "DAY" | "HOUR" | "LIFETIME";
|
|
179
|
+
includeComputedMetrics: boolean;
|
|
180
|
+
mode: "rows" | "summary";
|
|
181
|
+
datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
|
|
182
|
+
startTime?: string | undefined;
|
|
183
|
+
endTime?: string | undefined;
|
|
184
|
+
dimensionType?: "CAMPAIGN" | "AD_SQUAD" | "AD" | undefined;
|
|
185
|
+
columns?: string[] | undefined;
|
|
186
|
+
offset?: number | undefined;
|
|
187
|
+
maxRows?: number | undefined;
|
|
188
|
+
aggregateBy?: string[] | undefined;
|
|
189
|
+
aggregateMetrics?: Record<string, "count" | "sum" | "avg" | "min" | "max"> | undefined;
|
|
190
|
+
}, {
|
|
191
|
+
adAccountId: string;
|
|
192
|
+
fields: string[];
|
|
193
|
+
granularity?: "TOTAL" | "DAY" | "HOUR" | "LIFETIME" | undefined;
|
|
194
|
+
datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
|
|
195
|
+
startTime?: string | undefined;
|
|
196
|
+
endTime?: string | undefined;
|
|
197
|
+
dimensionType?: "CAMPAIGN" | "AD_SQUAD" | "AD" | undefined;
|
|
198
|
+
includeComputedMetrics?: boolean | undefined;
|
|
199
|
+
mode?: "rows" | "summary" | undefined;
|
|
200
|
+
columns?: string[] | undefined;
|
|
201
|
+
offset?: number | undefined;
|
|
202
|
+
maxRows?: number | undefined;
|
|
203
|
+
aggregateBy?: string[] | undefined;
|
|
204
|
+
aggregateMetrics?: Record<string, "count" | "sum" | "avg" | "min" | "max"> | undefined;
|
|
205
|
+
}>;
|
|
206
|
+
outputSchema: z.ZodObject<{
|
|
207
|
+
timestamp: z.ZodString;
|
|
208
|
+
totalRows: z.ZodNumber;
|
|
209
|
+
returnedRows: z.ZodNumber;
|
|
210
|
+
truncated: z.ZodBoolean;
|
|
211
|
+
nextOffset: z.ZodNullable<z.ZodNumber>;
|
|
212
|
+
headers: z.ZodArray<z.ZodString, "many">;
|
|
213
|
+
selectedColumns: z.ZodArray<z.ZodString, "many">;
|
|
214
|
+
mode: z.ZodEnum<["summary", "rows"]>;
|
|
215
|
+
previewRows: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodAny>, "many">>;
|
|
216
|
+
rows: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodAny>, "many">>;
|
|
217
|
+
warnings: z.ZodArray<z.ZodString, "many">;
|
|
218
|
+
taskId: z.ZodString;
|
|
219
|
+
}, "strip", z.ZodTypeAny, {
|
|
220
|
+
taskId: string;
|
|
221
|
+
totalRows: number;
|
|
222
|
+
headers: string[];
|
|
223
|
+
timestamp: string;
|
|
224
|
+
mode: "rows" | "summary";
|
|
225
|
+
returnedRows: number;
|
|
226
|
+
truncated: boolean;
|
|
227
|
+
nextOffset: number | null;
|
|
228
|
+
selectedColumns: string[];
|
|
229
|
+
warnings: string[];
|
|
230
|
+
rows?: Record<string, any>[] | undefined;
|
|
231
|
+
previewRows?: Record<string, any>[] | undefined;
|
|
232
|
+
}, {
|
|
233
|
+
taskId: string;
|
|
234
|
+
totalRows: number;
|
|
235
|
+
headers: string[];
|
|
236
|
+
timestamp: string;
|
|
237
|
+
mode: "rows" | "summary";
|
|
238
|
+
returnedRows: number;
|
|
239
|
+
truncated: boolean;
|
|
240
|
+
nextOffset: number | null;
|
|
241
|
+
selectedColumns: string[];
|
|
242
|
+
warnings: string[];
|
|
243
|
+
rows?: Record<string, any>[] | undefined;
|
|
244
|
+
previewRows?: Record<string, any>[] | undefined;
|
|
245
|
+
}>;
|
|
246
|
+
annotations: {
|
|
247
|
+
readOnlyHint: boolean;
|
|
248
|
+
openWorldHint: boolean;
|
|
249
|
+
idempotentHint: boolean;
|
|
250
|
+
destructiveHint: boolean;
|
|
251
|
+
};
|
|
252
|
+
inputExamples: ({
|
|
253
|
+
label: string;
|
|
254
|
+
input: {
|
|
255
|
+
adAccountId: string;
|
|
256
|
+
fields: string[];
|
|
257
|
+
datePreset: string;
|
|
258
|
+
granularity: string;
|
|
259
|
+
dimensionType: string;
|
|
260
|
+
startTime?: undefined;
|
|
261
|
+
endTime?: undefined;
|
|
262
|
+
};
|
|
263
|
+
} | {
|
|
264
|
+
label: string;
|
|
265
|
+
input: {
|
|
266
|
+
adAccountId: string;
|
|
267
|
+
fields: string[];
|
|
268
|
+
startTime: string;
|
|
269
|
+
endTime: string;
|
|
270
|
+
granularity: string;
|
|
271
|
+
datePreset?: undefined;
|
|
272
|
+
dimensionType?: undefined;
|
|
273
|
+
};
|
|
274
|
+
})[];
|
|
275
|
+
logic: typeof getReportLogic;
|
|
276
|
+
responseFormatter: typeof getReportResponseFormatter;
|
|
277
|
+
};
|
|
278
|
+
export {};
|
|
279
|
+
//# sourceMappingURL=get-report.tool.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"get-report.tool.d.ts","sourceRoot":"","sources":["../../../../src/mcp-server/tools/definitions/get-report.tool.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAaxB,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAanD,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA8C6B,CAAC;AAE/D,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAMN,CAAC;AAE7B,KAAK,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAC3D,KAAK,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAsC7D,wBAAsB,cAAc,CAClC,KAAK,EAAE,cAAc,EACrB,OAAO,EAAE,cAAc,EACvB,UAAU,CAAC,EAAE,UAAU,GACtB,OAAO,CAAC,eAAe,CAAC,CAwC1B;AAED,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,eAAe,GAAG,cAAc,EAAE,CAOpF;AAED,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoCzB,CAAC"}
|
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import { resolveSessionServices } from "../utils/resolve-session.js";
|
|
3
|
+
import { arrayRowsToRecords, computeMetrics, createReportView, formatReportViewResponse, getReportViewFetchLimit, resolveDatePreset, DATE_PRESET_VALUES, ReportViewInputSchema, ReportViewOutputSchema, } from "@cesteral/shared";
|
|
4
|
+
const TOOL_NAME = "snapchat_get_report";
|
|
5
|
+
const TOOL_TITLE = "Get Snapchat Ads Report";
|
|
6
|
+
const TOOL_DESCRIPTION = `Submit and retrieve an async Snapchat Ads performance report.
|
|
7
|
+
|
|
8
|
+
Follows the async polling pattern: submit task → poll until COMPLETE → download CSV.
|
|
9
|
+
This may take 30s–5 minutes depending on the data volume.
|
|
10
|
+
|
|
11
|
+
**Common fields:** impressions, swipes, spend, video_views, conversion_purchases, reach, frequency, cpm, cpsu
|
|
12
|
+
**Granularity:** TOTAL, DAY (default), HOUR, LIFETIME
|
|
13
|
+
**start_time/end_time:** ISO 8601 format (e.g. 2024-01-01T00:00:00Z)`;
|
|
14
|
+
export const GetReportInputSchema = z
|
|
15
|
+
.object({
|
|
16
|
+
adAccountId: z.string().min(1).describe("Snapchat Ad Account ID"),
|
|
17
|
+
fields: z
|
|
18
|
+
.array(z.string())
|
|
19
|
+
.min(1)
|
|
20
|
+
.describe("Metric fields to include (e.g. ['impressions', 'swipes', 'spend'])"),
|
|
21
|
+
datePreset: z
|
|
22
|
+
.enum(DATE_PRESET_VALUES)
|
|
23
|
+
.optional()
|
|
24
|
+
.describe("Preset date range. Use this OR startTime+endTime (not both). Converted to ISO 8601 timestamps automatically"),
|
|
25
|
+
startTime: z
|
|
26
|
+
.string()
|
|
27
|
+
.optional()
|
|
28
|
+
.describe("Start time in ISO 8601 format (e.g. 2024-01-01T00:00:00Z, required if datePreset not provided)"),
|
|
29
|
+
endTime: z
|
|
30
|
+
.string()
|
|
31
|
+
.optional()
|
|
32
|
+
.describe("End time in ISO 8601 format (e.g. 2024-01-31T23:59:59Z, required if datePreset not provided)"),
|
|
33
|
+
granularity: z
|
|
34
|
+
.enum(["TOTAL", "DAY", "HOUR", "LIFETIME"])
|
|
35
|
+
.optional()
|
|
36
|
+
.default("DAY")
|
|
37
|
+
.describe("Time granularity (default: DAY)"),
|
|
38
|
+
dimensionType: z
|
|
39
|
+
.enum(["CAMPAIGN", "AD_SQUAD", "AD"])
|
|
40
|
+
.optional()
|
|
41
|
+
.describe("Entity level for stats breakdown (default: account-level aggregate)"),
|
|
42
|
+
includeComputedMetrics: z
|
|
43
|
+
.boolean()
|
|
44
|
+
.optional()
|
|
45
|
+
.default(false)
|
|
46
|
+
.describe("Include computed CPA, ROAS, CPM, CTR, CPC derived from raw metrics"),
|
|
47
|
+
})
|
|
48
|
+
.merge(ReportViewInputSchema)
|
|
49
|
+
.refine((data) => data.datePreset !== undefined || (data.startTime !== undefined && data.endTime !== undefined), { message: "Provide either datePreset or both startTime and endTime" })
|
|
50
|
+
.describe("Parameters for generating a Snapchat Ads report");
|
|
51
|
+
export const GetReportOutputSchema = z
|
|
52
|
+
.object({
|
|
53
|
+
taskId: z.string().describe("Report task ID"),
|
|
54
|
+
...ReportViewOutputSchema.shape,
|
|
55
|
+
timestamp: z.string().datetime(),
|
|
56
|
+
})
|
|
57
|
+
.describe("Report result");
|
|
58
|
+
function appendComputedMetricsToRows(headers, rows) {
|
|
59
|
+
const idx = (name) => headers.findIndex((h) => h.toLowerCase() === name.toLowerCase());
|
|
60
|
+
const spendIdx = idx("spend");
|
|
61
|
+
const impIdx = idx("impressions");
|
|
62
|
+
const clickIdx = idx("swipes");
|
|
63
|
+
const convIdx = idx("conversion_purchases");
|
|
64
|
+
const newHeaders = [
|
|
65
|
+
...headers,
|
|
66
|
+
"computed_cpa",
|
|
67
|
+
"computed_roas",
|
|
68
|
+
"computed_cpm",
|
|
69
|
+
"computed_ctr",
|
|
70
|
+
"computed_cpc",
|
|
71
|
+
];
|
|
72
|
+
const newRows = rows.map((row) => {
|
|
73
|
+
const cost = spendIdx >= 0 ? Number(row[spendIdx] || 0) : 0;
|
|
74
|
+
const impressions = impIdx >= 0 ? Number(row[impIdx] || 0) : 0;
|
|
75
|
+
const clicks = clickIdx >= 0 ? Number(row[clickIdx] || 0) : 0;
|
|
76
|
+
const conversions = convIdx >= 0 ? Number(row[convIdx] || 0) : 0;
|
|
77
|
+
const m = computeMetrics({ cost, impressions, clicks, conversions, conversionValue: 0 });
|
|
78
|
+
return [
|
|
79
|
+
...row,
|
|
80
|
+
m.cpa !== null ? String(m.cpa) : "",
|
|
81
|
+
m.roas !== null ? String(m.roas) : "",
|
|
82
|
+
m.cpm !== null ? String(m.cpm) : "",
|
|
83
|
+
m.ctr !== null ? String(m.ctr) : "",
|
|
84
|
+
m.cpc !== null ? String(m.cpc) : "",
|
|
85
|
+
];
|
|
86
|
+
});
|
|
87
|
+
return { headers: newHeaders, rows: newRows };
|
|
88
|
+
}
|
|
89
|
+
export async function getReportLogic(input, context, sdkContext) {
|
|
90
|
+
const { snapchatReportingService } = resolveSessionServices(sdkContext);
|
|
91
|
+
let resolvedStartTime = input.startTime;
|
|
92
|
+
let resolvedEndTime = input.endTime;
|
|
93
|
+
if (input.datePreset) {
|
|
94
|
+
const { startDate, endDate } = resolveDatePreset(input.datePreset);
|
|
95
|
+
resolvedStartTime = `${startDate}T00:00:00Z`;
|
|
96
|
+
resolvedEndTime = `${endDate}T23:59:59Z`;
|
|
97
|
+
}
|
|
98
|
+
const result = await snapchatReportingService.getReport({
|
|
99
|
+
fields: input.fields,
|
|
100
|
+
granularity: input.granularity,
|
|
101
|
+
start_time: resolvedStartTime,
|
|
102
|
+
end_time: resolvedEndTime,
|
|
103
|
+
...(input.dimensionType ? { dimension_type: input.dimensionType } : {}),
|
|
104
|
+
}, getReportViewFetchLimit(input), context);
|
|
105
|
+
let headers = result.headers;
|
|
106
|
+
let rows = result.rows;
|
|
107
|
+
if (input.includeComputedMetrics) {
|
|
108
|
+
({ headers, rows } = appendComputedMetricsToRows(headers, rows));
|
|
109
|
+
}
|
|
110
|
+
return {
|
|
111
|
+
taskId: result.taskId,
|
|
112
|
+
...createReportView({
|
|
113
|
+
headers,
|
|
114
|
+
rows: arrayRowsToRecords(headers, rows),
|
|
115
|
+
totalRows: result.totalRows,
|
|
116
|
+
input,
|
|
117
|
+
}),
|
|
118
|
+
timestamp: new Date().toISOString(),
|
|
119
|
+
};
|
|
120
|
+
}
|
|
121
|
+
export function getReportResponseFormatter(result) {
|
|
122
|
+
return [
|
|
123
|
+
{
|
|
124
|
+
type: "text",
|
|
125
|
+
text: `Report task: ${result.taskId}\n\n${formatReportViewResponse(result, "Report data")}`,
|
|
126
|
+
},
|
|
127
|
+
];
|
|
128
|
+
}
|
|
129
|
+
export const getReportTool = {
|
|
130
|
+
name: TOOL_NAME,
|
|
131
|
+
title: TOOL_TITLE,
|
|
132
|
+
description: TOOL_DESCRIPTION,
|
|
133
|
+
inputSchema: GetReportInputSchema,
|
|
134
|
+
outputSchema: GetReportOutputSchema,
|
|
135
|
+
annotations: {
|
|
136
|
+
readOnlyHint: true,
|
|
137
|
+
openWorldHint: false,
|
|
138
|
+
idempotentHint: false,
|
|
139
|
+
destructiveHint: false,
|
|
140
|
+
},
|
|
141
|
+
inputExamples: [
|
|
142
|
+
{
|
|
143
|
+
label: "Campaign delivery report for last 7 days",
|
|
144
|
+
input: {
|
|
145
|
+
adAccountId: "1234567890",
|
|
146
|
+
fields: ["impressions", "swipes", "spend"],
|
|
147
|
+
datePreset: "LAST_7_DAYS",
|
|
148
|
+
granularity: "DAY",
|
|
149
|
+
dimensionType: "CAMPAIGN",
|
|
150
|
+
},
|
|
151
|
+
},
|
|
152
|
+
{
|
|
153
|
+
label: "Ad squad performance report",
|
|
154
|
+
input: {
|
|
155
|
+
adAccountId: "1234567890",
|
|
156
|
+
fields: ["impressions", "swipes", "spend", "conversion_purchases"],
|
|
157
|
+
startTime: "2026-03-01T00:00:00Z",
|
|
158
|
+
endTime: "2026-03-04T23:59:59Z",
|
|
159
|
+
granularity: "DAY",
|
|
160
|
+
},
|
|
161
|
+
},
|
|
162
|
+
],
|
|
163
|
+
logic: getReportLogic,
|
|
164
|
+
responseFormatter: getReportResponseFormatter,
|
|
165
|
+
};
|
|
166
|
+
//# sourceMappingURL=get-report.tool.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"get-report.tool.js","sourceRoot":"","sources":["../../../../src/mcp-server/tools/definitions/get-report.tool.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,gBAAgB,EAChB,wBAAwB,EACxB,uBAAuB,EACvB,iBAAiB,EACjB,kBAAkB,EAClB,qBAAqB,EACrB,sBAAsB,GACvB,MAAM,kBAAkB,CAAC;AAI1B,MAAM,SAAS,GAAG,qBAAqB,CAAC;AACxC,MAAM,UAAU,GAAG,yBAAyB,CAAC;AAC7C,MAAM,gBAAgB,GAAG;;;;;;;qEAO4C,CAAC;AAEtE,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,MAAM,CAAC;IACN,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,wBAAwB,CAAC;IACjE,MAAM,EAAE,CAAC;SACN,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CAAC,oEAAoE,CAAC;IACjF,UAAU,EAAE,CAAC;SACV,IAAI,CAAC,kBAAkB,CAAC;SACxB,QAAQ,EAAE;SACV,QAAQ,CACP,6GAA6G,CAC9G;IACH,SAAS,EAAE,CAAC;SACT,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,gGAAgG,CACjG;IACH,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,8FAA8F,CAC/F;IACH,WAAW,EAAE,CAAC;SACX,IAAI,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;SAC1C,QAAQ,EAAE;SACV,OAAO,CAAC,KAAK,CAAC;SACd,QAAQ,CAAC,iCAAiC,CAAC;IAC9C,aAAa,EAAE,CAAC;SACb,IAAI,CAAC,CAAC,UAAU,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;SACpC,QAAQ,EAAE;SACV,QAAQ,CAAC,qEAAqE,CAAC;IAClF,sBAAsB,EAAE,CAAC;SACtB,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,OAAO,CAAC,KAAK,CAAC;SACd,QAAQ,CAAC,oEAAoE,CAAC;CAClF,CAAC;KACD,KAAK,CAAC,qBAAqB,CAAC;KAC5B,MAAM,CACL,CAAC,IAAI,EAAE,EAAE,CACP,IAAI,CAAC,UAAU,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,EAC/F,EAAE,OAAO,EAAE,yDAAyD,EAAE,CACvE;KACA,QAAQ,CAAC,iDAAiD,CAAC,CAAC;AAE/D,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC;KACnC,MAAM,CAAC;IACN,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IAC7C,GAAG,sBAAsB,CAAC,KAAK;IAC/B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC;KACD,QAAQ,CAAC,eAAe,CAAC,CAAC;AAK7B,SAAS,2BAA2B,CAClC,OAAiB,EACjB,IAAgB;IAEhB,MAAM,GAAG,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAC/F,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC;IAC9B,MAAM,MAAM,GAAG,GAAG,CAAC,aAAa,CAAC,CAAC;IAClC,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC/B,MAAM,OAAO,GAAG,GAAG,CAAC,sBAAsB,CAAC,CAAC;IAE5C,MAAM,UAAU,GAAG;QACjB,GAAG,OAAO;QACV,cAAc;QACd,eAAe;QACf,cAAc;QACd,cAAc;QACd,cAAc;KACf,CAAC;IACF,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QAC/B,MAAM,IAAI,GAAG,QAAQ,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5D,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/D,MAAM,MAAM,GAAG,QAAQ,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9D,MAAM,WAAW,GAAG,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACjE,MAAM,CAAC,GAAG,cAAc,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC,EAAE,CAAC,CAAC;QACzF,OAAO;YACL,GAAG,GAAG;YACN,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE;YACnC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE;YACrC,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE;YACnC,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE;YACnC,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE;SACpC,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;AAChD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,KAAqB,EACrB,OAAuB,EACvB,UAAuB;IAEvB,MAAM,EAAE,wBAAwB,EAAE,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAExE,IAAI,iBAAiB,GAAG,KAAK,CAAC,SAAS,CAAC;IACxC,IAAI,eAAe,GAAG,KAAK,CAAC,OAAO,CAAC;IACpC,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;QACrB,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,iBAAiB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACnE,iBAAiB,GAAG,GAAG,SAAS,YAAY,CAAC;QAC7C,eAAe,GAAG,GAAG,OAAO,YAAY,CAAC;IAC3C,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,wBAAwB,CAAC,SAAS,CACrD;QACE,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,WAAW,EAAE,KAAK,CAAC,WAAW;QAC9B,UAAU,EAAE,iBAAkB;QAC9B,QAAQ,EAAE,eAAgB;QAC1B,GAAG,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,KAAK,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACxE,EACD,uBAAuB,CAAC,KAAK,CAAC,EAC9B,OAAO,CACR,CAAC;IAEF,IAAI,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;IAC7B,IAAI,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;IAEvB,IAAI,KAAK,CAAC,sBAAsB,EAAE,CAAC;QACjC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,2BAA2B,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;IACnE,CAAC;IAED,OAAO;QACL,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,GAAG,gBAAgB,CAAC;YAClB,OAAO;YACP,IAAI,EAAE,kBAAkB,CAAC,OAAO,EAAE,IAAI,CAAC;YACvC,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,KAAK;SACN,CAAC;QACF,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;KACpC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,MAAuB;IAChE,OAAO;QACL;YACE,IAAI,EAAE,MAAe;YACrB,IAAI,EAAE,gBAAgB,MAAM,CAAC,MAAM,OAAO,wBAAwB,CAAC,MAAM,EAAE,aAAa,CAAC,EAAE;SAC5F;KACF,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,IAAI,EAAE,SAAS;IACf,KAAK,EAAE,UAAU;IACjB,WAAW,EAAE,gBAAgB;IAC7B,WAAW,EAAE,oBAAoB;IACjC,YAAY,EAAE,qBAAqB;IACnC,WAAW,EAAE;QACX,YAAY,EAAE,IAAI;QAClB,aAAa,EAAE,KAAK;QACpB,cAAc,EAAE,KAAK;QACrB,eAAe,EAAE,KAAK;KACvB;IACD,aAAa,EAAE;QACb;YACE,KAAK,EAAE,0CAA0C;YACjD,KAAK,EAAE;gBACL,WAAW,EAAE,YAAY;gBACzB,MAAM,EAAE,CAAC,aAAa,EAAE,QAAQ,EAAE,OAAO,CAAC;gBAC1C,UAAU,EAAE,aAAa;gBACzB,WAAW,EAAE,KAAK;gBAClB,aAAa,EAAE,UAAU;aAC1B;SACF;QACD;YACE,KAAK,EAAE,6BAA6B;YACpC,KAAK,EAAE;gBACL,WAAW,EAAE,YAAY;gBACzB,MAAM,EAAE,CAAC,aAAa,EAAE,QAAQ,EAAE,OAAO,EAAE,sBAAsB,CAAC;gBAClE,SAAS,EAAE,sBAAsB;gBACjC,OAAO,EAAE,sBAAsB;gBAC/B,WAAW,EAAE,KAAK;aACnB;SACF;KACF;IACD,KAAK,EAAE,cAAc;IACrB,iBAAiB,EAAE,0BAA0B;CAC9C,CAAC"}
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import type { RequestContext, McpTextContent } from "@cesteral/shared";
|
|
3
|
+
import type { SdkContext } from "@cesteral/shared";
|
|
4
|
+
export declare const GetTargetingOptionsInputSchema: z.ZodObject<{
|
|
5
|
+
targetingType: z.ZodDefault<z.ZodOptional<z.ZodEnum<["country_support", "geo_country", "geo_region", "geo_metro", "geo_postal_code", "interests_slc", "interests_vac", "interests_shp"]>>>;
|
|
6
|
+
countryCode: z.ZodOptional<z.ZodString>;
|
|
7
|
+
limit: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
|
|
8
|
+
}, "strip", z.ZodTypeAny, {
|
|
9
|
+
limit: number;
|
|
10
|
+
targetingType: "country_support" | "geo_country" | "geo_region" | "geo_metro" | "geo_postal_code" | "interests_slc" | "interests_vac" | "interests_shp";
|
|
11
|
+
countryCode?: string | undefined;
|
|
12
|
+
}, {
|
|
13
|
+
countryCode?: string | undefined;
|
|
14
|
+
limit?: number | undefined;
|
|
15
|
+
targetingType?: "country_support" | "geo_country" | "geo_region" | "geo_metro" | "geo_postal_code" | "interests_slc" | "interests_vac" | "interests_shp" | undefined;
|
|
16
|
+
}>;
|
|
17
|
+
export declare const GetTargetingOptionsOutputSchema: z.ZodObject<{
|
|
18
|
+
options: z.ZodRecord<z.ZodString, z.ZodAny>;
|
|
19
|
+
nextCursor: z.ZodOptional<z.ZodString>;
|
|
20
|
+
timestamp: z.ZodString;
|
|
21
|
+
}, "strip", z.ZodTypeAny, {
|
|
22
|
+
options: Record<string, any>;
|
|
23
|
+
timestamp: string;
|
|
24
|
+
nextCursor?: string | undefined;
|
|
25
|
+
}, {
|
|
26
|
+
options: Record<string, any>;
|
|
27
|
+
timestamp: string;
|
|
28
|
+
nextCursor?: string | undefined;
|
|
29
|
+
}>;
|
|
30
|
+
type GetTargetingOptionsInput = z.infer<typeof GetTargetingOptionsInputSchema>;
|
|
31
|
+
type GetTargetingOptionsOutput = z.infer<typeof GetTargetingOptionsOutputSchema>;
|
|
32
|
+
export declare function getTargetingOptionsLogic(input: GetTargetingOptionsInput, context: RequestContext, sdkContext?: SdkContext): Promise<GetTargetingOptionsOutput>;
|
|
33
|
+
export declare function getTargetingOptionsResponseFormatter(result: GetTargetingOptionsOutput): McpTextContent[];
|
|
34
|
+
export declare const getTargetingOptionsTool: {
|
|
35
|
+
name: string;
|
|
36
|
+
title: string;
|
|
37
|
+
description: string;
|
|
38
|
+
inputSchema: z.ZodObject<{
|
|
39
|
+
targetingType: z.ZodDefault<z.ZodOptional<z.ZodEnum<["country_support", "geo_country", "geo_region", "geo_metro", "geo_postal_code", "interests_slc", "interests_vac", "interests_shp"]>>>;
|
|
40
|
+
countryCode: z.ZodOptional<z.ZodString>;
|
|
41
|
+
limit: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
|
|
42
|
+
}, "strip", z.ZodTypeAny, {
|
|
43
|
+
limit: number;
|
|
44
|
+
targetingType: "country_support" | "geo_country" | "geo_region" | "geo_metro" | "geo_postal_code" | "interests_slc" | "interests_vac" | "interests_shp";
|
|
45
|
+
countryCode?: string | undefined;
|
|
46
|
+
}, {
|
|
47
|
+
countryCode?: string | undefined;
|
|
48
|
+
limit?: number | undefined;
|
|
49
|
+
targetingType?: "country_support" | "geo_country" | "geo_region" | "geo_metro" | "geo_postal_code" | "interests_slc" | "interests_vac" | "interests_shp" | undefined;
|
|
50
|
+
}>;
|
|
51
|
+
outputSchema: z.ZodObject<{
|
|
52
|
+
options: z.ZodRecord<z.ZodString, z.ZodAny>;
|
|
53
|
+
nextCursor: z.ZodOptional<z.ZodString>;
|
|
54
|
+
timestamp: z.ZodString;
|
|
55
|
+
}, "strip", z.ZodTypeAny, {
|
|
56
|
+
options: Record<string, any>;
|
|
57
|
+
timestamp: string;
|
|
58
|
+
nextCursor?: string | undefined;
|
|
59
|
+
}, {
|
|
60
|
+
options: Record<string, any>;
|
|
61
|
+
timestamp: string;
|
|
62
|
+
nextCursor?: string | undefined;
|
|
63
|
+
}>;
|
|
64
|
+
annotations: {
|
|
65
|
+
readOnlyHint: boolean;
|
|
66
|
+
openWorldHint: boolean;
|
|
67
|
+
idempotentHint: boolean;
|
|
68
|
+
destructiveHint: boolean;
|
|
69
|
+
};
|
|
70
|
+
inputExamples: ({
|
|
71
|
+
label: string;
|
|
72
|
+
input: {
|
|
73
|
+
targetingType: string;
|
|
74
|
+
countryCode: string;
|
|
75
|
+
limit?: undefined;
|
|
76
|
+
};
|
|
77
|
+
} | {
|
|
78
|
+
label: string;
|
|
79
|
+
input: {
|
|
80
|
+
targetingType: string;
|
|
81
|
+
countryCode: string;
|
|
82
|
+
limit: number;
|
|
83
|
+
};
|
|
84
|
+
})[];
|
|
85
|
+
logic: typeof getTargetingOptionsLogic;
|
|
86
|
+
responseFormatter: typeof getTargetingOptionsResponseFormatter;
|
|
87
|
+
};
|
|
88
|
+
export {};
|
|
89
|
+
//# sourceMappingURL=get-targeting-options.tool.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"get-targeting-options.tool.d.ts","sourceRoot":"","sources":["../../../../src/mcp-server/tools/definitions/get-targeting-options.tool.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAUnD,eAAO,MAAM,8BAA8B;;;;;;;;;;;;EA6BsB,CAAC;AAElE,eAAO,MAAM,+BAA+B;;;;;;;;;;;;EASL,CAAC;AAExC,KAAK,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AAC/E,KAAK,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC;AAEjF,wBAAsB,wBAAwB,CAC5C,KAAK,EAAE,wBAAwB,EAC/B,OAAO,EAAE,cAAc,EACvB,UAAU,CAAC,EAAE,UAAU,GACtB,OAAO,CAAC,yBAAyB,CAAC,CAepC;AAED,wBAAgB,oCAAoC,CAClD,MAAM,EAAE,yBAAyB,GAChC,cAAc,EAAE,CAOlB;AAED,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+BnC,CAAC"}
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import { resolveSessionServices } from "../utils/resolve-session.js";
|
|
3
|
+
const TOOL_NAME = "snapchat_get_targeting_options";
|
|
4
|
+
const TOOL_TITLE = "Get Snapchat Targeting Options";
|
|
5
|
+
const TOOL_DESCRIPTION = `Browse available Snapchat targeting options from documented targeting endpoints.
|
|
6
|
+
|
|
7
|
+
Use this to discover valid country support, geo, and interest values before creating or updating ad groups.
|
|
8
|
+
|
|
9
|
+
**Supported targeting types:** country_support, geo_country, geo_region, geo_metro, geo_postal_code, interests_slc, interests_vac, interests_shp`;
|
|
10
|
+
export const GetTargetingOptionsInputSchema = z
|
|
11
|
+
.object({
|
|
12
|
+
targetingType: z
|
|
13
|
+
.enum([
|
|
14
|
+
"country_support",
|
|
15
|
+
"geo_country",
|
|
16
|
+
"geo_region",
|
|
17
|
+
"geo_metro",
|
|
18
|
+
"geo_postal_code",
|
|
19
|
+
"interests_slc",
|
|
20
|
+
"interests_vac",
|
|
21
|
+
"interests_shp",
|
|
22
|
+
])
|
|
23
|
+
.optional()
|
|
24
|
+
.default("country_support")
|
|
25
|
+
.describe("Documented Snapchat targeting endpoint to query"),
|
|
26
|
+
countryCode: z
|
|
27
|
+
.string()
|
|
28
|
+
.optional()
|
|
29
|
+
.describe("ISO alpha-2 country code required for country-specific targeting types"),
|
|
30
|
+
limit: z
|
|
31
|
+
.number()
|
|
32
|
+
.int()
|
|
33
|
+
.min(1)
|
|
34
|
+
.max(10000)
|
|
35
|
+
.optional()
|
|
36
|
+
.default(50)
|
|
37
|
+
.describe("Maximum number of options to request where Snapchat supports limits"),
|
|
38
|
+
})
|
|
39
|
+
.describe("Parameters for browsing Snapchat targeting options");
|
|
40
|
+
export const GetTargetingOptionsOutputSchema = z
|
|
41
|
+
.object({
|
|
42
|
+
options: z.record(z.any()).describe("Available targeting options"),
|
|
43
|
+
nextCursor: z
|
|
44
|
+
.string()
|
|
45
|
+
.optional()
|
|
46
|
+
.describe("Next page URL when Snapchat pagination is available"),
|
|
47
|
+
timestamp: z.string().datetime(),
|
|
48
|
+
})
|
|
49
|
+
.describe("Targeting options result");
|
|
50
|
+
export async function getTargetingOptionsLogic(input, context, sdkContext) {
|
|
51
|
+
const { snapchatService } = resolveSessionServices(sdkContext);
|
|
52
|
+
const options = (await snapchatService.getTargetingOptions(input.targetingType, input.countryCode, input.limit, context));
|
|
53
|
+
return {
|
|
54
|
+
options: { results: options.results },
|
|
55
|
+
nextCursor: options.nextCursor,
|
|
56
|
+
timestamp: new Date().toISOString(),
|
|
57
|
+
};
|
|
58
|
+
}
|
|
59
|
+
export function getTargetingOptionsResponseFormatter(result) {
|
|
60
|
+
return [
|
|
61
|
+
{
|
|
62
|
+
type: "text",
|
|
63
|
+
text: `Snapchat targeting options:\n${JSON.stringify(result.options, null, 2)}${result.nextCursor ? `\n\nNext page: ${result.nextCursor}` : ""}\n\nTimestamp: ${result.timestamp}`,
|
|
64
|
+
},
|
|
65
|
+
];
|
|
66
|
+
}
|
|
67
|
+
export const getTargetingOptionsTool = {
|
|
68
|
+
name: TOOL_NAME,
|
|
69
|
+
title: TOOL_TITLE,
|
|
70
|
+
description: TOOL_DESCRIPTION,
|
|
71
|
+
inputSchema: GetTargetingOptionsInputSchema,
|
|
72
|
+
outputSchema: GetTargetingOptionsOutputSchema,
|
|
73
|
+
annotations: {
|
|
74
|
+
readOnlyHint: true,
|
|
75
|
+
openWorldHint: false,
|
|
76
|
+
idempotentHint: true,
|
|
77
|
+
destructiveHint: false,
|
|
78
|
+
},
|
|
79
|
+
inputExamples: [
|
|
80
|
+
{
|
|
81
|
+
label: "Get all targeting options",
|
|
82
|
+
input: {
|
|
83
|
+
targetingType: "country_support",
|
|
84
|
+
countryCode: "us",
|
|
85
|
+
},
|
|
86
|
+
},
|
|
87
|
+
{
|
|
88
|
+
label: "Get US Snap Lifestyle Categories",
|
|
89
|
+
input: {
|
|
90
|
+
targetingType: "interests_slc",
|
|
91
|
+
countryCode: "us",
|
|
92
|
+
limit: 100,
|
|
93
|
+
},
|
|
94
|
+
},
|
|
95
|
+
],
|
|
96
|
+
logic: getTargetingOptionsLogic,
|
|
97
|
+
responseFormatter: getTargetingOptionsResponseFormatter,
|
|
98
|
+
};
|
|
99
|
+
//# sourceMappingURL=get-targeting-options.tool.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"get-targeting-options.tool.js","sourceRoot":"","sources":["../../../../src/mcp-server/tools/definitions/get-targeting-options.tool.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAIrE,MAAM,SAAS,GAAG,gCAAgC,CAAC;AACnD,MAAM,UAAU,GAAG,gCAAgC,CAAC;AACpD,MAAM,gBAAgB,GAAG;;;;iJAIwH,CAAC;AAElJ,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC;KAC5C,MAAM,CAAC;IACN,aAAa,EAAE,CAAC;SACb,IAAI,CAAC;QACJ,iBAAiB;QACjB,aAAa;QACb,YAAY;QACZ,WAAW;QACX,iBAAiB;QACjB,eAAe;QACf,eAAe;QACf,eAAe;KAChB,CAAC;SACD,QAAQ,EAAE;SACV,OAAO,CAAC,iBAAiB,CAAC;SAC1B,QAAQ,CAAC,iDAAiD,CAAC;IAC9D,WAAW,EAAE,CAAC;SACX,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,wEAAwE,CAAC;IACrF,KAAK,EAAE,CAAC;SACL,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,KAAK,CAAC;SACV,QAAQ,EAAE;SACV,OAAO,CAAC,EAAE,CAAC;SACX,QAAQ,CAAC,qEAAqE,CAAC;CACnF,CAAC;KACD,QAAQ,CAAC,oDAAoD,CAAC,CAAC;AAElE,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC;KAC7C,MAAM,CAAC;IACN,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,CAAC,6BAA6B,CAAC;IAClE,UAAU,EAAE,CAAC;SACV,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,qDAAqD,CAAC;IAClE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC;KACD,QAAQ,CAAC,0BAA0B,CAAC,CAAC;AAKxC,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,KAA+B,EAC/B,OAAuB,EACvB,UAAuB;IAEvB,MAAM,EAAE,eAAe,EAAE,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAE/D,MAAM,OAAO,GAAG,CAAC,MAAM,eAAe,CAAC,mBAAmB,CACxD,KAAK,CAAC,aAAa,EACnB,KAAK,CAAC,WAAW,EACjB,KAAK,CAAC,KAAK,EACX,OAAO,CACR,CAAgE,CAAC;IAElE,OAAO;QACL,OAAO,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE;QACrC,UAAU,EAAE,OAAO,CAAC,UAAU;QAC9B,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;KACpC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oCAAoC,CAClD,MAAiC;IAEjC,OAAO;QACL;YACE,IAAI,EAAE,MAAe;YACrB,IAAI,EAAE,gCAAgC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,kBAAkB,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,kBAAkB,MAAM,CAAC,SAAS,EAAE;SACnL;KACF,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,IAAI,EAAE,SAAS;IACf,KAAK,EAAE,UAAU;IACjB,WAAW,EAAE,gBAAgB;IAC7B,WAAW,EAAE,8BAA8B;IAC3C,YAAY,EAAE,+BAA+B;IAC7C,WAAW,EAAE;QACX,YAAY,EAAE,IAAI;QAClB,aAAa,EAAE,KAAK;QACpB,cAAc,EAAE,IAAI;QACpB,eAAe,EAAE,KAAK;KACvB;IACD,aAAa,EAAE;QACb;YACE,KAAK,EAAE,2BAA2B;YAClC,KAAK,EAAE;gBACL,aAAa,EAAE,iBAAiB;gBAChC,WAAW,EAAE,IAAI;aAClB;SACF;QACD;YACE,KAAK,EAAE,kCAAkC;YACzC,KAAK,EAAE;gBACL,aAAa,EAAE,eAAe;gBAC9B,WAAW,EAAE,IAAI;gBACjB,KAAK,EAAE,GAAG;aACX;SACF;KACF;IACD,KAAK,EAAE,wBAAwB;IAC/B,iBAAiB,EAAE,oCAAoC;CACxD,CAAC"}
|