@appsyogi/adsense-mcp-server 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,342 @@
+import { Server } from '@modelcontextprotocol/sdk/server/index.js';
+import * as google_auth_library from 'google-auth-library';
+import { OAuth2Client } from 'google-auth-library';
+
+/**
+ * MCP Server - Main setup
+ */
+
+/**
+ * Create and configure the MCP server
+ */
+declare function createServer(): Server<{
+    method: string;
+    params?: {
+        [x: string]: unknown;
+        _meta?: {
+            [x: string]: unknown;
+            progressToken?: string | number | undefined;
+            "io.modelcontextprotocol/related-task"?: {
+                taskId: string;
+            } | undefined;
+        } | undefined;
+    } | undefined;
+}, {
+    method: string;
+    params?: {
+        [x: string]: unknown;
+        _meta?: {
+            [x: string]: unknown;
+            progressToken?: string | number | undefined;
+            "io.modelcontextprotocol/related-task"?: {
+                taskId: string;
+            } | undefined;
+        } | undefined;
+    } | undefined;
+}, {
+    [x: string]: unknown;
+    _meta?: {
+        [x: string]: unknown;
+        progressToken?: string | number | undefined;
+        "io.modelcontextprotocol/related-task"?: {
+            taskId: string;
+        } | undefined;
+    } | undefined;
+}>;
+/**
+ * Start the MCP server with stdio transport
+ */
+declare function startServer(accountId?: string): Promise<void>;
+
+/**
+ * AdSense MCP Server - Type Definitions
+ */
+declare const ADSENSE_SCOPES: Record<string, string[]>;
+type ScopeType = 'readonly';
+interface Config {
+    authType: 'oauth' | 'service-account';
+    clientId?: string;
+    clientSecret?: string;
+    serviceAccountPath?: string;
+    defaultAccountId?: string;
+    scope: ScopeType;
+}
+interface StoredTokens {
+    accessToken: string;
+    refreshToken?: string;
+    expiryDate?: number;
+}
+interface AdSenseAccount {
+    name: string;
+    displayName?: string;
+    timeZone?: {
+        id: string;
+    };
+    createTime?: string;
+    premium?: boolean;
+    pendingTasks?: string[];
+}
+interface AdSenseSite {
+    name: string;
+    reportingDimensionId?: string;
+    domain: string;
+    state: 'REQUIRES_REVIEW' | 'GETTING_READY' | 'READY' | 'NEEDS_ATTENTION' | 'STATE_UNSPECIFIED';
+    autoAdsEnabled?: boolean;
+}
+interface AdSenseAlert {
+    name: string;
+    severity: 'SEVERITY_UNSPECIFIED' | 'INFO' | 'WARNING' | 'SEVERE';
+    message: string;
+    type: string;
+}
+interface AdSensePolicyIssue {
+    name: string;
+    site?: string;
+    siteSection?: string;
+    uri?: string;
+    adRequestCount?: string;
+    entityType?: 'ENTITY_TYPE_UNSPECIFIED' | 'SITE' | 'SITE_SECTION' | 'PAGE';
+    action?: 'ENFORCEMENT_ACTION_UNSPECIFIED' | 'WARNED' | 'AD_SERVING_RESTRICTED' | 'AD_SERVING_DISABLED' | 'AD_SERVED_WITH_CLICK_CONFIRMATION' | 'AD_PERSONALIZATION_RESTRICTED';
+    warningEscalationDate?: {
+        year: number;
+        month: number;
+        day: number;
+    };
+}
+interface AdSensePayment {
+    name: string;
+    amount?: string;
+    date?: {
+        year: number;
+        month: number;
+        day: number;
+    };
+}
+interface AdSenseAdClient {
+    name: string;
+    reportingDimensionId?: string;
+    productCode?: 'AFC' | 'AFG' | 'AFMC' | 'AFS' | 'AFV' | 'AFVH';
+    state?: 'READY' | 'GETTING_READY' | 'REQUIRES_REVIEW' | 'STATE_UNSPECIFIED';
+}
+interface AdSenseAdUnit {
+    name: string;
+    reportingDimensionId?: string;
+    displayName: string;
+    state: 'ACTIVE' | 'ARCHIVED' | 'STATE_UNSPECIFIED';
+    contentAdsSettings?: {
+        type?: 'DISPLAY' | 'FEED' | 'ARTICLE' | 'MATCHED_CONTENT' | 'LINK';
+        size?: string;
+    };
+}
+type ReportDimension = 'DATE' | 'WEEK' | 'MONTH' | 'DOMAIN_CODE' | 'DOMAIN_NAME' | 'PAGE_URL' | 'AD_UNIT_ID' | 'AD_UNIT_NAME' | 'AD_UNIT_SIZE_CODE' | 'AD_UNIT_SIZE_NAME' | 'AD_FORMAT_CODE' | 'AD_FORMAT_NAME' | 'AD_PLACEMENT_CODE' | 'AD_PLACEMENT_NAME' | 'COUNTRY_CODE' | 'COUNTRY_NAME' | 'PLATFORM_TYPE_CODE' | 'PLATFORM_TYPE_NAME' | 'CONTENT_PLATFORM_CODE' | 'CONTENT_PLATFORM_NAME' | 'TRAFFIC_SOURCE_CODE' | 'TRAFFIC_SOURCE_NAME' | 'BUYER_NETWORK_ID' | 'BUYER_NETWORK_NAME' | 'BID_TYPE_CODE' | 'BID_TYPE_NAME' | 'TARGETING_TYPE_CODE' | 'TARGETING_TYPE_NAME' | 'CUSTOM_CHANNEL_ID' | 'CUSTOM_CHANNEL_NAME' | 'URL_CHANNEL_ID' | 'URL_CHANNEL_NAME' | 'OWNED_SITE_ID' | 'OWNED_SITE_DOMAIN_NAME';
+type ReportMetric = 'ESTIMATED_EARNINGS' | 'TOTAL_EARNINGS' | 'COST_PER_CLICK' | 'PAGE_VIEWS' | 'AD_REQUESTS' | 'MATCHED_AD_REQUESTS' | 'IMPRESSIONS' | 'INDIVIDUAL_AD_IMPRESSIONS' | 'CLICKS' | 'AD_REQUESTS_COVERAGE' | 'PAGE_VIEWS_CTR' | 'AD_REQUESTS_CTR' | 'IMPRESSIONS_CTR' | 'PAGE_VIEWS_RPM' | 'AD_REQUESTS_RPM' | 'IMPRESSIONS_RPM' | 'ACTIVE_VIEW_MEASURABILITY' | 'ACTIVE_VIEW_VIEWABILITY' | 'ACTIVE_VIEW_TIME' | 'PAGE_VIEWS_SPAM_RATIO' | 'AD_REQUESTS_SPAM_RATIO' | 'CLICKS_SPAM_RATIO' | 'IMPRESSIONS_SPAM_RATIO';
+interface ReportQuery {
+    accountId: string;
+    startDate: string;
+    endDate: string;
+    dimensions?: ReportDimension[];
+    metrics?: ReportMetric[];
+    orderBy?: string;
+    limit?: number;
+    filters?: string[];
+    currencyCode?: string;
+    dateRange?: 'CUSTOM' | 'TODAY' | 'YESTERDAY' | 'MONTH_TO_DATE' | 'YEAR_TO_DATE' | 'LAST_7_DAYS' | 'LAST_30_DAYS';
+}
+interface ReportRow {
+    cells: Array<{
+        value: string;
+    }>;
+}
+interface ReportResponse {
+    headers: Array<{
+        name: string;
+        type: 'DIMENSION' | 'METRIC_TALLY' | 'METRIC_RATIO' | 'METRIC_CURRENCY' | 'METRIC_MILLISECONDS' | 'METRIC_DECIMAL';
+        currencyCode?: string;
+    }>;
+    rows: ReportRow[];
+    totals?: ReportRow;
+    averages?: ReportRow;
+    startDate?: {
+        year: number;
+        month: number;
+        day: number;
+    };
+    endDate?: {
+        year: number;
+        month: number;
+        day: number;
+    };
+    totalMatchedRows?: string;
+}
+interface EarningsSummary {
+    today: EarningsPeriod;
+    yesterday: EarningsPeriod;
+    last7Days: EarningsPeriod;
+    thisMonth: EarningsPeriod;
+    lastMonth: EarningsPeriod;
+}
+interface EarningsPeriod {
+    earnings: number;
+    impressions: number;
+    clicks: number;
+    ctr: number;
+    rpm: number;
+    pageViews: number;
+}
+interface CacheEntry {
+    id?: number;
+    cacheKey: string;
+    accountId: string;
+    queryHash: string;
+    responseData: string;
+    createdAt: number;
+    expiresAt: number;
+}
+interface ListAccountsInput {
+}
+interface EarningsSummaryInput {
+    accountId?: string;
+}
+interface GenerateReportInput {
+    accountId?: string;
+    startDate?: string;
+    endDate?: string;
+    dimensions?: string[];
+    metrics?: string[];
+    orderBy?: string;
+    limit?: number;
+}
+interface ComparePeriodsInput {
+    accountId?: string;
+    period1Start: string;
+    period1End: string;
+    period2Start: string;
+    period2End: string;
+    dimensions?: string[];
+}
+interface ListSitesInput {
+    accountId?: string;
+}
+interface ListAlertsInput {
+    accountId?: string;
+}
+interface ListPolicyIssuesInput {
+    accountId?: string;
+}
+interface ListPaymentsInput {
+    accountId?: string;
+}
+interface ListAdUnitsInput {
+    accountId?: string;
+}
+interface GetAdCodeInput {
+    accountId?: string;
+    adClientId: string;
+    adUnitId: string;
+}
+interface ExportCsvInput {
+    accountId?: string;
+    startDate: string;
+    endDate: string;
+    dimensions?: string[];
+    metrics?: string[];
+}
+
+/**
+ * AdSense API Client
+ *
+ * Wraps the googleapis client with:
+ * - Automatic authentication (OAuth or service account)
+ * - Rate limiting with exponential backoff
+ * - Response caching for performance
+ * - Pagination handling
+ */
+
+/**
+ * AdSense API Client
+ */
+declare class AdSenseClient {
+    private adsense;
+    private defaultAccountId?;
+    private constructor();
+    /**
+     * Create an authenticated AdSense client
+     */
+    static create(accountIdOverride?: string): Promise<AdSenseClient>;
+    /**
+     * Get the account ID to use (explicit > default > first available)
+     */
+    private resolveAccountId;
+    /**
+     * Extract publisher ID from account name
+     */
+    private extractPubId;
+    /**
+     * List all AdSense accounts
+     */
+    listAccounts(): Promise<AdSenseAccount[]>;
+    /**
+     * Get a specific account
+     */
+    getAccount(accountId?: string): Promise<AdSenseAccount | null>;
+    /**
+     * List all sites for an account
+     */
+    listSites(accountId?: string): Promise<AdSenseSite[]>;
+    /**
+     * List alerts for an account
+     */
+    listAlerts(accountId?: string): Promise<AdSenseAlert[]>;
+    /**
+     * List policy issues for an account
+     */
+    listPolicyIssues(accountId?: string): Promise<AdSensePolicyIssue[]>;
+    /**
+     * List payments for an account
+     */
+    listPayments(accountId?: string): Promise<AdSensePayment[]>;
+    /**
+     * List ad clients for an account
+     */
+    listAdClients(accountId?: string): Promise<AdSenseAdClient[]>;
+    /**
+     * List ad units for an account (across all ad clients)
+     */
+    listAdUnits(accountId?: string): Promise<AdSenseAdUnit[]>;
+    /**
+     * Get ad code for an ad unit
+     */
+    getAdCode(adClientId: string, adUnitId: string, accountId?: string): Promise<string>;
+    /**
+     * Generate a report
+     */
+    generateReport(query: ReportQuery): Promise<ReportResponse>;
+    /**
+     * Generate a CSV report
+     */
+    generateCsvReport(query: ReportQuery): Promise<string>;
+    /**
+     * Get earnings summary (today, yesterday, last 7 days, this month, last month)
+     */
+    getEarningsSummary(accountId?: string): Promise<EarningsSummary>;
+    /**
+     * Extract earnings data from a report response
+     */
+    private extractEarningsPeriod;
+    /**
+     * Determine appropriate cache TTL based on date range
+     */
+    private getReportTTL;
+}
+
+/**
+ * Create an authenticated OAuth2 client
+ */
+declare function createOAuthClient(): Promise<OAuth2Client>;
+
+/**
+ * Create an authenticated client using service account credentials
+ */
+declare function createServiceAccountClient(): Promise<google_auth_library.JWT>;
+
+export { ADSENSE_SCOPES, type AdSenseAccount, type AdSenseAdClient, type AdSenseAdUnit, type AdSenseAlert, AdSenseClient, type AdSensePayment, type AdSensePolicyIssue, type AdSenseSite, type CacheEntry, type ComparePeriodsInput, type Config, type EarningsPeriod, type EarningsSummary, type EarningsSummaryInput, type ExportCsvInput, type GenerateReportInput, type GetAdCodeInput, type ListAccountsInput, type ListAdUnitsInput, type ListAlertsInput, type ListPaymentsInput, type ListPolicyIssuesInput, type ListSitesInput, type ReportDimension, type ReportMetric, type ReportQuery, type ReportResponse, type ReportRow, type ScopeType, type StoredTokens, createOAuthClient, createServer, createServiceAccountClient, startServer };