Shreni: Tutorials

CPAlead Full Campaign API: Offers Banayein aur Manage Karein

Lekhak: CPAlead
CPAlead Full Campaign API: Offers Banayein aur Manage Karein

Yeh guide CPAlead ke Full Campaign API ke baare mein hai.

Iska use aise API-capable AI agent ya integration ke saath karein jo bearer token ke saath authenticated HTTPS requests bhej sake. Agar aap normal ChatGPT ya koi doosri AI chat use kar rahe hain jisme authenticated API tools nahi hain, to iske badle surakshit campaign-draft option ka use karein.

Normal ChatGPT ya koi doosri AI chat

Temporary AI Campaign Draft Access kholein. Iske one-time prompt mein ek private link hota hai jo char ghante tak kaam karta hai. Advertiser ki pehli successful deposit se pehle, woh link zyada se zyada teen inactive campaign drafts save kar sakta hai. Successful advertiser deposit ke baad, link par campaign drafts ki koi total limit nahi hoti. Har account mein ek samay par zyada se zyada 10 adhure campaign drafts pending ho sakte hain. Yeh maujooda campaigns manage nahi kar sakta aur upload, submit, charge, start, pause ya activate nahi kar sakta. Har campaign ko aap CPAlead mein review karke poora karte hain.

Temporary AI Campaign Draft Access Kholein

API-capable AI agent ya integration

Full Campaign API ka use karein. Aap jo scopes dete hain unke hisaab se authorized client campaigns ko validate, upload, create, read, edit, start aur pause kar sakta hai. Campaign create ya activate karne se review, funding, schedule, delivery ya launch-package se jude natije ho sakte hain.

Full Campaign API Kholein

Apne agent ke saath yeh public guide share karein: https://www.cpalead.com/en/blog/tutorials/cpalead-advertiser-campaign-api-guide

Public OpenAPI schema bhi https://www.cpalead.com/api/v1/advertiser/openapi.json par share karein. Dono tarah ke private access ko secret rakhein: Full Campaign API token ko trusted client ki secret settings mein configure karein aur Temporary AI Campaign Draft Access prompt ko sirf apni chuni hui private AI conversation mein paste karein.

Campaign API dashboard access nahi hai. Campaign API token sirf un campaign permissions ko authorize karta hai jo aap select karte hain. Isse aapke CPAlead dashboard mein sign in nahi kiya ja sakta. Publisher AI Access ek alag publisher-only feature hai.

CPAlead ka Full Campaign API ek verified self-serve advertiser ko code, API-capable AI agent, MCP server, GPT Action ya plugin ke zariye CPA, CPI aur CPC campaigns par kaam karne deta hai. Di gayi permissions ke hisaab se authorized client maujooda requirements padh sakta hai, poore campaign ko save karne se pehle validate kar sakta hai, creative upload kar sakta hai, campaign create kar sakta hai, campaigns ko list aur retrieve kar sakta hai, version protection ke saath campaign edit kar sakta hai aur eligible campaign ko saaf taur par start ya pause kar sakta hai.

Yeh normal advertiser dashboard ka automation companion hai. Agar aap pehle campaign types, tracking, targeting, payouts, caps, funding, review, aur launch ka field-by-field explanation chahte hain, to How to Advertise on CPAlead in 2026: Add and Launch Your First Offer padhein. Jab aap us setup ko structured JSON aur controlled API actions mein express karne ke liye ready ho, tab yeh article use karein.

Sabse safe quick-start workflow

  1. Sirf campaigns:read aur campaigns:validate ke saath ek short-lived Campaign API token banayein.
  2. Apne trusted client ko public OpenAPI URL dein aur token ko privately bearer secret ke roop mein configure karein.
  3. Guess karne ke bajay CPA, CPI, ya CPC ke liye GET /requirements call karein.
  4. Complete campaign JSON draft karein aur POST /campaigns/validate call karein.
  5. Har error, warning, payout, budget, targeting rule, schedule, aur possible charge ko review karein.
  6. Uske baad hi image-upload aur campaign-create permissions add karein.
  7. Unique idempotency key ke saath create karein, phir returned review aur delivery state inspect karein.
  8. Task complete hone par token revoke kar dein.

Full Campaign API kya kar sakta hai

CPAlead advertiser Campaign API operations and required permissions
Action Method and path Permission Safety rule
Read OpenAPIGET /openapi.jsonPublicToken ki zarurat nahi
Read requirementsGET /requirementscampaigns:validateJSON banane se pehle read karein
Validate JSONPOST /campaigns/validatecampaigns:validateCampaign create nahi karta
Upload imagePOST /imagesassets:createTemporary, expiring, single-use ID
List campaignsGET /campaignscampaigns:readPaginated aur filterable
Create campaignPOST /campaignscampaigns:createUnique Idempotency-Key
Get one campaignGET /campaigns/{campaign}campaigns:readCurrent ETag return karta hai
Update campaignPATCH /campaigns/{campaign}campaigns:updateExact ETag If-Match mein
Start campaignPOST /campaigns/{campaign}/actions/startcampaigns:toggleBodyless aur idempotent
Pause campaignPOST /campaigns/{campaign}/actions/pausecampaigns:toggleBodyless aur idempotent

API abhi archive, delete, bulk-create, ya generic toggle operation provide nahi karta. Archive ya delete ka kaam dashboard workflow rahega. Start aur pause alag actions hain taaki koi person ya AI client delivery change karne se pehle clear confirmation maang sake.

Temporary AI Campaign Draft Access, Full Campaign API aur Offer API Import mein se chunein

  • Temporary AI Campaign Draft Access: Normal ChatGPT aur milti-julti AI chats ke liye. Advertiser ki pehli successful deposit se pehle, char ghante ka private link zyada se zyada teen inactive campaign drafts validate aur save kar sakta hai. Successful advertiser deposit ke baad, link par campaign drafts ki koi total limit nahi hoti. Har account mein ek samay par zyada se zyada 10 adhure campaign drafts pending ho sakte hain. Yeh maujooda campaigns dekh ya manage nahi kar sakta, upload nahi kar sakta, terms ya packages accept nahi kar sakta, funds spend nahi kar sakta aur submit, start, pause ya activate nahi kar sakta. Temporary AI Campaign Draft Access kholein.
  • Full Campaign API: Aise API-capable agent, GPT Action, MCP server, plugin ya integration ke liye jo bearer token ko surakshit rakh sake. Diye gaye scopes campaigns ko validate, upload, create, read, edit, start aur pause kar sakte hain. Full Campaign API kholein.
  • Offer API Import: Yeh advertiser dashboard ka ek alag workflow hai jo compatible external feed se offers fetch karta hai aur uske fields ko CPAlead mein map karta hai. Offer API Import kholein.

Jab normal AI chat aapko naya offer taiyar karne mein madad kar rahi ho, tab surakshit campaign-draft option ka use karein. Jab authenticated client ko structured campaign-management abilities chahiye hon, tab Full Campaign API ka use karein. Jab CPAlead ko compatible feed fetch karna ho, tab Offer API Import ka use karein. Kisi bhi tool ko uske kaam ki zaroorat se zyada access na dein.

Campaign API token banayein

  1. Verified self-serve advertiser account mein sign in karein.
  2. Setup → API kholen, phir Campaign API select karein.
  3. Token ko koi recognizable naam dein, jaise “Campaign validator” ya “My MCP agent.”
  4. Expiration choose karein. AI setup ke liye 48-hour option recommended hai; 30-day, 90-day, aur 365-day options bhi available hain.
  5. Sirf wahi permissions select karein jo client ko chahiye.
  6. Token create karein aur turant copy karein. Page reload hone ke baad CPAlead poora token dobara display nahi kar sakta.
  7. Isse trusted client ki secret configuration mein store karein aur task khatam hone par revoke kar dein.

Ek advertiser ke paas 10 active Campaign API tokens tak ho sakte hain. Alag integrations ke liye alag tokens use karein taaki aap permissions limit kar saken, usage review kar saken, aur ek integration revoke karke doosre ko interrupt na karein.

Apna Campaign API token kahan banayein

Campaign API token private API credential hai jo Authorization header mein bheja jata hai. Yeh aapka CPAlead password nahi hai, aur isse CPAlead dashboard mein sign in nahi kiya ja sakta. Sign in karne ke baad Setup → API kholen, Campaign API select karein, aur Create a token form use karein.

CPAlead Campaign API token form with name, expiration, permission checkboxes, and Create token button
Setup → API kholen, Campaign API select karein, phir token ka naam rakhein, expiration choose karein, aur sirf wahi permissions dein jo aapki integration ko chahiye. CPAlead finished token ek baar dikhata hai, isliye use turant copy karein aur trusted integration ki secret settings mein store karein.
Campaign API token permissions
PermissionAllowsWhen to grant it
campaigns:readApne campaigns dekheinSafe starting permission
campaigns:validateRequirements read karein aur JSON validate kareinSafe starting permission
assets:createCampaign images upload kareinJab real create ya image edit prepare kar rahe hon
campaigns:createCampaign create kareinFinal JSON review hone ke baad
campaigns:updateCampaign edit kareinSirf jab edits ki zarurat ho
campaigns:toggleCampaign start ya pause kareinSirf explicit delivery controls ke saath

Token rule: Public guide aur OpenAPI URL freely share karein. Bearer token sirf us client ke saath share karein jis par aap bharosa karte hain, uski private secret settings ke through. CPAlead secure hash store karta hai aur creation ke baad token ka sirf beginning part dikhata hai.

Base URL, authentication, aur response format

API base: https://www.cpalead.com/api/v1/advertiser
OpenAPI: https://www.cpalead.com/api/v1/advertiser/openapi.json

Authenticated requests token ko HTTP authorization header mein ek baar bhejte hain. Isse URL ya query string mein kabhi na rakhein.

Authorization: Bearer YOUR_TOKEN
Accept: application/json

Neeche diye gaye curl examples ke liye, safer setup yeh hai ki authorization header ko local curl configuration file mein store karein jo source control se exclude ho aur sirf aapke liye readable ho:

# cpalead-auth.cfg
header = "Authorization: Bearer YOUR_TOKEN"
header = "Accept: application/json"

# Restrict the file before using it:
chmod 600 cpalead-auth.cfg

Successful response mein data object ya list ke saath meta hota hai. Metadata mein request_id aur current schema version shamil hote hain, aur pagination, resource version, ya idempotent-replay flag bhi ho sakta hai. Error response mein error object ke saath meta hota hai. Troubleshooting ke liye support ke saath public request_id save karein, lekin kabhi bhi support ko apna bearer token na bhejein.

Step 1: Live requirements read karein

Requirements yeh source of truth hain ki account abhi kya submit kar sakta hai. Inmein current schema aur terms versions, account creation eligibility, supported countries aur devices, field limits, campaign-type rules, pricing ranges, schedules, launch packages, tracking requirements, image rules, aur recommended workflow shamil hain.

curl --config cpalead-auth.cfg \
  "https://www.cpalead.com/api/v1/advertiser/requirements?type=CPA"

Response ko limit karne ke liye type=CPA, type=CPI, ya type=CPC use karein. Old example se schema version, terms version, payout limit, bid, budget, launch package, country, device, ya minimum app version hard-code na karein. Jab server bataye ki koi value ya version out of date hai, requirements dobara fetch karein.

Teen campaign types

  • CPA: एक कार्रवाई या कई इवेंट के इनामों के लिए भुगतान करता है। ट्रैकिंग URL में {CLICK_ID} होना चाहिए। अभियान बनाने के डेटा में प्रीव्यू URL, दैनिक सीमा और लॉन्च पैकेज शामिल होते हैं। एक भुगतान वाले अभियान में रूपांतरण लक्ष्य ज़रूरी है; इवेंट अभियान में हर इनाम वाली कार्रवाई उसकी इवेंट सूची में तय की जाती है।
  • CPI: एक इंस्टॉल या ऐप की कार्रवाई, या कई इवेंट के इनामों के लिए भुगतान करता है। इसमें {CLICK_ID} का उपयोग होता है और डिवाइस प्लेटफ़ॉर्म, ट्रैकिंग विधि, समर्थित OS संस्करण और प्रॉक्सी प्रबंधन जैसे ऐप से जुड़े विकल्प मिलते हैं। इवेंट अभियान में इंस्टॉल के लिए भुगतान करना हो तो अलग से इंस्टॉल इवेंट जोड़ें।
  • CPC: Valid click ke liye pay karta hai. Isme conversion payout, daily cap, aur launch package ki jagah bid aur daily budget use hota hai.

Campaign API में सभी मौद्रिक मान USD में होते हैं और API के शेड्यूल UTC का उपयोग करते हैं। CPA और CPI में $10.00 से कम भुगतान के लिए दैनिक सीमा कम से कम 20 होनी चाहिए। $10.00 या अधिक भुगतान पर दैनिक सीमा 5 तक रखी जा सकती है। इवेंट अभियान में इन न्यूनतम सीमा नियमों के लिए सभी इवेंट के भुगतानों का कुल जोड़ लें। भुगतान और सीमाएँ चुनने से पहले मौजूदा आवश्यकताएँ पढ़ें।

Step 2: Campaign image upload karein

Create requests remote image URL accept nahi karte. Pehle file ko multipart form data ke roop mein upload karein, phir returned temporary image ID ko image_upload_id mein rakhein.

curl --config cpalead-auth.cfg \
  --request POST \
  --form "[email protected]" \
  "https://www.cpalead.com/api/v1/advertiser/images"
  • Accepted sources: JPG, JPEG, PNG, GIF, BMP, aur WebP.
  • Maximum file size: 2 MiB.
  • Source width aur height: har ek 200 aur 4096 pixels ke beech hona chahiye.
  • Stored result: ek non-animated, metadata-free 200×200 WebP crop.
  • Unused upload lifetime: 24 hours.
  • Outstanding-upload limit: up to 25 current unused image uploads.
  • Use: one campaign create ya image update. Different campaign ke liye dobara upload karein.

Validation yeh check kar sakta hai ki image ID aapke account ka hai aur use kiye bina usable rehta hai. Successful campaign write ise consume kar deta hai. Same idempotency key ke saath same completed create ko replay karne par stored result return hota hai; consumed image se second campaign nahi banti.

Step 3: Complete campaign JSON banayein

API strict JSON objects use karta hai. Unknown fields silently ignore karne ke bajay reject kiye jaate hain. Isse AI integration zyada safe hoti hai: misspelled ya invented property accidental campaign setting banne ke bajay visible validation issue ban jaati hai.

Neeche diya gaya CPA example ek template hai, ready-to-submit campaign nahi. Har COPY_FROM_REQUIREMENTS value, image ID, URL, payout, country, cap, aur public description ko apne real offer ke reviewed values se replace karein.

{
  "schema_version": "COPY_FROM_REQUIREMENTS",
  "external_id": "signup-campaign-us-001",
  "type": "CPA",
  "name": "US Account Signup",
  "creative": {
    "title": "Create Your Free Account",
    "description": "Register and confirm your email",
    "conversion_goal": "Create an account"
  },
  "tracking": {
    "url": "https://tracker.example.com/click?click_id={CLICK_ID}",
    "preview_url": "https://www.example.com/signup",
    "gaid_idfa_filler": false
  },
  "targeting": {
    "countries": ["US"],
    "device": "all_devices",
    "tools_only": false
  },
  "pricing": {
    "payout": "0.50",
    "daily_cap": 20,
    "currency": "USD"
  },
  "schedule": {
    "mode": "always",
    "start_time": "00:00",
    "end_time": "23:59",
    "timezone": "UTC"
  },
  "publisher_access": {
    "mode": "all",
    "publisher_ids": []
  },
  "launch_package": {
    "amount": "COPY_FROM_REQUIREMENTS"
  },
  "image_upload_id": "cimg_COPY_FROM_IMAGE_UPLOAD",
  "terms": {
    "version": "COPY_FROM_REQUIREMENTS",
    "accepted": true
  }
}

Important CPA aur CPI tracking rule

Tracking URL mein exact {CLICK_ID} macro hona chahiye. Aapka tracker ya affiliate platform wahan CPAlead jo numeric value inject karta hai use save kare aur conversion ke baad us saved click ID ko CPAlead advertiser postback par return kare. Campaign tracking URL mein CPAlead ka postback URL mat rakhein. Full click-to-postback explanation ke liye public advertiser postback guide use karein.

एक भुगतान या कई इवेंट के इनाम चुनें

CPA और CPI में conversion_mode के लिए single और events मान उपलब्ध हैं। चुनने से पहले आवश्यकताओं में conversion_modes और event_rules पढ़ें। CPC क्लिक के लिए भुगतान करता है और इवेंट इनामों का समर्थन नहीं करता।

एक भुगतान वाली कार्रवाई में भागीदार को एक रूपांतरण भुगतान मिलता है। कई इवेंट इनामों में आप हर कार्रवाई के लिए USD में अलग निश्चित भुगतान तय करते हैं। उदाहरण के लिए, खाता बनाने के लिए $0.50 और ट्यूटोरियल पूरा करने के लिए $1.25 दें। प्रति भागीदार अधिकतम कुल $1.75 है; यह अतिरिक्त भुगतान नहीं है।

ऊपर दिए उदाहरण जैसे पूर्ण CPA अनुरोध के लिए ये इवेंट फ़ील्ड और भुगतान मान इस्तेमाल करें। अभियान के अन्य आवश्यक फ़ील्ड बनाए रखें। CPI के लिए समर्थित ऐप प्लेटफ़ॉर्म और ट्रैकिंग विधि भी चुनें। उदाहरण की सभी कार्रवाइयों, भुगतानों और टार्गेटिंग को अपने जाँचे हुए विकल्पों से बदलें।

{
  "conversion_mode": "events",
  "events": [
    {"id": 1, "name": "Create an account", "description": "Finish registration.", "payout": "0.50"},
    {"id": 2, "name": "Complete the tutorial", "description": "Finish all tutorial steps.", "payout": "1.25"}
  ],
  "pricing": {"currency": "USD", "payout": "1.75", "daily_cap": 20}
}

एक सूची में 1–10 इवेंट होते हैं। हर इवेंट के लिए नाम और शून्य से अधिक भुगतान चाहिए, जिसमें दशमलव के बाद अधिकतम दो अंक हों; पूरा करने के निर्देश वैकल्पिक हैं। नए इवेंट ID छोड़े जा सकते हैं ताकि CPAlead उन्हें दे सके। लौटाए गए संख्यात्मक ID बाद के अपडेट और पोस्टबैक के लिए सुरक्षित रखें। इवेंट लिखते समय pricing.payout छोड़ा जा सकता है; यदि दिया जाए, तो वह सभी इवेंट भुगतानों के जोड़ के बराबर होना चाहिए। इवेंट अभियानों में creative.conversion_goal वैकल्पिक है और targeting.tools_only का मान false होना चाहिए।

मूल क्लिक के 30 दिनों के भीतर, किसी भी क्रम में, हर इवेंट का भुगतान प्रति भागीदार केवल एक बार हो सकता है। दैनिक सीमा में भागीदार को उसके पहले भुगतान वाले इवेंट पर गिना जाता है। बाद के इवेंट दोबारा नहीं गिने जाते। रोकने या सीमा तक पहुँचने पर नया ट्रैफ़िक रुक जाता है, लेकिन पात्र बकाया इनाम रद्द नहीं होते। उनके लिए पर्याप्त धन रखें; लंबित इवेंट पूरे होने पर किसी दिन की ट्रैफ़िक सीमा से अधिक भुगतान योग्य पूर्णताएँ हो सकती हैं।

इवेंट अभियानों को ट्रैक और अपडेट करें

स्टैंडर्ड पोस्टबैक में अपना पोस्टबैक ID, सेव किया गया मूल click_id और पूरा हुए रिवॉर्ड की पहचान करने वाला मान भेजें। अतिरिक्त सुरक्षा के लिए campaign_id शामिल करें; यह मूल क्लिक के कैंपेन से मेल खाना चाहिए। अकाउंट के लिए बनाए गए URL का उपयोग करें और कभी मन से ID न बनाएँ।

स्टैंडर्ड पोस्टबैक: इवेंट के नंबर और नाम

अपने सेव किए गए कैंपेन का Postback Setup खोलें और वहाँ दिखाए गए URL में से किसी एक का उपयोग करें। नाम वाला URL उपलब्ध होने तक इवेंट का संख्यात्मक ID भेजते रहें।

सिर्फ उदाहरण: यदि सेव किए गए रिवॉर्ड का इवेंट ID 1 और नाम 150gems है, तो ये तीनों मान उसी रिवॉर्ड की पहचान करते हैं:

  • event_id=1
  • event_name=150gems
  • event_id=150gems

नाम वाले पोस्टबैक में सेव किया गया इवेंट नाम पहले से काम करता है। यदि आपका ट्रैकर कोई अलग नाम या कोड भेजता है, तो उसे रिवॉर्ड की वैकल्पिक अतिरिक्त ट्रैकर वैल्यू के रूप में दर्ज करें। 42 जैसे संख्यात्मक ट्रैकर कोड के लिए event_name=42 भेजें; event_id में संख्यात्मक मान हमेशा CPAlead के इवेंट ID को दर्शाते हैं।

नाम बिल्कुल वैसा ही कॉपी करें, बड़े और छोटे अक्षरों का भी ध्यान रखें। एक पोस्टबैक में भेजे गए सभी इवेंट मान एक ही रिवॉर्ड की पहचान करने चाहिए। अनजान, आपस में न मिलने वाले या अस्पष्ट मानों पर रिवॉर्ड का भुगतान नहीं होता।

हर इवेंट के लिए वही मूल click_id रखें। पहले नाम भेजने और फिर उसके इवेंट ID से दोबारा कोशिश करने पर रिवॉर्ड का दोहरा भुगतान नहीं होता। campaign_id हटाने से इवेंट का मेल न होने की समस्या ठीक नहीं होती।

ट्रैफिक शुरू होने के बाद आप अतिरिक्त ट्रैकर वैल्यू सुधार सकते हैं। सेव किए गए इवेंट के ID, नाम, क्रम, निर्देश और भुगतान लॉक रहते हैं।

स्पेस और विराम चिह्नों के लिए URL एन्कोडिंग का उपयोग करें, जैसे event_name=Reach%20level%205। नाम से बनाया गया URL यह काम अपने आप करता है।

बैलेंस कम होने पर HTTP 503 के साथ low_balance मिलता है। पैसे जोड़ें और Retry-After में बताए समय के बाद उसी इवेंट को फिर भेजें। ट्रैफिक भेजने से पहले Guided Test करें।

स्टैंडर्ड ट्रैकर के लिए Full Campaign API और Temporary AI Campaign Draft Access वैकल्पिक इवेंट फ़ील्ड postback_event_value स्वीकार करते हैं, जब वह event_rules.event_fields में मौजूद हो। उदाहरण के लिए, "postback_event_value": "tutorial_complete" उस रिवॉर्ड के लिए ट्रैकर कोड जोड़ता है। इवेंट का नाम भी काम करता रहता है। AppsFlyer का अलग फ़ील्ड appsflyer_event_name बना रहता है।

AppsFlyer CPI में CPAlead का Integrated Partner सेटअप इस्तेमाल होता है। सामान्य विज्ञापनदाता पोस्टबैक को AppsFlyer में पेस्ट न करें। हर सुरक्षित संख्यात्मक इवेंट ID को पार्टनर इवेंट पहचानकर्ता के रूप में मैप करें। वैकल्पिक appsflyer_event_name SDK के नाम से बिल्कुल मेल खाना चाहिए; दोहराए गए नामों में इनाम पहचानने के लिए पार्टनर ID ज़रूरी हैं। केवल एक इनाम install का उपयोग कर सकता है और उसके कॉलबैक को स्पष्ट रूप से event_type=install भेजना चाहिए। Postback Setup में दिए विशेष टेम्पलेट देखें। API से अभियान सुरक्षित करने पर AppsFlyer कॉन्फ़िगर नहीं होता।

events वाला PATCH पूरी सूची बदल देता है; इसे न भेजने पर सूची वैसी ही रहती है। हर सेव किया गया इवेंट ID रखें, मौजूदा ETag लें और If-Match भेजें। असली भागीदारी या लीड आने के बाद भुगतान का तरीका, ट्रैकिंग का तरीका, AppsFlyer ऐप की पहचान और रिवॉर्ड के विवरण लॉक रहते हैं। केवल अतिरिक्त स्टैंडर्ड ट्रैकर वैल्यू सुधारी जा सकती है; यह बदलाव रिकॉर्ड होता है और रिवॉर्ड नहीं बदलता। रिवॉर्ड बदलने के लिए कैंपेन की कॉपी बनाएँ। सिर्फ Guided Test क्लिक इवेंट सेटअप को लॉक नहीं करते।

इवेंट अभियान Offerwall V2, Publisher Offers API और सीधे लिंक से चल सकते हैं। Offerwall V2 को subid में प्रकाशक का स्थिर यूज़र ID चाहिए। लौटने वाले भागीदार अपना मूल क्लिक और अंतिम समय बनाए रखते हैं। पुराने ऑफ़रवॉल, लॉकर और ट्रैकिंग पिक्सेल इन इवेंट अभियानों का समर्थन नहीं करते।

AI या ऑफ़र फ़ीड से इवेंट अभियान तैयार करें

Temporary AI Campaign Draft Access सामान्य CPA/CPI फ़ॉर्म में समीक्षा के लिए पूरी इवेंट सूची तैयार कर सकता है। यह लाइव अभियान नहीं बना सकता, ट्रैकिंग कॉन्फ़िगर नहीं कर सकता, नियम या लॉन्च पैकेज स्वीकार नहीं कर सकता, चित्र अपलोड नहीं कर सकता और धन खर्च नहीं कर सकता। निजी लिंक चार घंटे तक मान्य रहता है। विज्ञापनदाता की सफल जमा राशि से पहले इससे अधिकतम तीन अभियान ड्राफ़्ट सुरक्षित किए जा सकते हैं; सफल जमा के बाद प्रति लिंक कुल संख्या की सीमा नहीं रहती। हर खाते में अधिकतम 10 अधूरे अभियान ड्राफ़्ट लंबित हो सकते हैं और अधूरे अभियान ड्राफ़्ट सात दिनों बाद समाप्त हो जाते हैं।

Offer API Import, events, event_payouts या goals से इवेंट सूची तैयार कर सकता है; कस्टम मैपिंग दूसरे पाथ स्वीकार करती है। स्रोत के सही संख्यात्मक ID रखे जाते हैं। टेक्स्ट या नाम वाले स्रोतों के लिए सेव की गई ट्रैकर वैल्यू और CPAlead द्वारा दिया गया संख्यात्मक इवेंट ID चाहिए। हर रिवॉर्ड में एक नाम और USD में तय भुगतान होना चाहिए। प्रीव्यू में ID, ट्रैकर वैल्यू और पूरी रिवॉर्ड सूची जाँचें। यदि प्रीव्यू पूरी सूची तैयार नहीं कर सकता, तो आगे बढ़ने से पहले मैपिंग सुधारें। फ़ीड लाने से नया फ़ॉर्म तैयार होता है; पुराने कैंपेन अपडेट नहीं होते।

Step 4: Create karne se pehle validate karein

curl --config cpalead-auth.cfg \
  --request POST \
  --header "Content-Type: application/json" \
  --data-binary @campaign.json \
  "https://www.cpalead.com/api/v1/advertiser/campaigns/validate"

Validation HTTP 200 ke saath data.valid, ek errors list, aur ek warnings list return karta hai. 200 response mein bhi valid: false ho sakta hai, isliye client ko sirf HTTP status ko approval samajhne ke bajay us value ko inspect karna chahiye. Har issue JSON Pointer path ka use karta hai, jaise /tracking/url, /pricing/payout, ya /image_upload_id. AI agent ko sirf indicated field repair karni chahiye, phir dobara validate karna chahiye, aur create permission maangne se pehle final JSON account owner ko dikhana chahiye.

Valid response ka matlab hai payload current validation aur persistence preflight pass kar gaya. Yeh approval, activation, traffic, conversions, ya future eligibility ka promise nahi hai. Writes aur lifecycle actions par real-time review, funding, account access, holds, schedule, cap, aur state checks abhi bhi apply hote hain.

Step 5: Idempotency ke saath safely create karein

curl --config cpalead-auth.cfg \
  --request POST \
  --header "Content-Type: application/json" \
  --header "Idempotency-Key: create-signup-campaign-us-001" \
  --data-binary @campaign.json \
  "https://www.cpalead.com/api/v1/advertiser/campaigns"

Create, start, aur pause ke liye Idempotency-Key chahiye jo 8 se 200 visible ASCII characters ke beech ho. Har intended action ke liye naya key use karein. Agar connection fail ho jaye aur aapko na pata ho ki action complete hua ya nahi, to same key ke saath identical action retry karein. CPAlead do baar create ya charge karne ke bajay completed response replay kar sakta hai.

  • Same key aur same intent: Completed response meta.idempotent_replay=true ke saath replay ho sakta hai.
  • Same key lekin changed details: API idempotency conflict return karta hai.
  • Same external ID lekin changed details: API bhi conflict return karta hai.
  • Previous request abhi process ho rahi hai: Reported interval ka wait karein, phir same key ke saath same intent retry karein.

Optional external_id create operation ke liye aapka apna stable reference hai. Yeh reconciliation ko easier bana sakta hai, lekin ise different intended campaign ke liye reuse nahi karna chahiye.

Creation ka real effect ho sakta hai. Account settings, review, balance, schedule, aur campaign type par depend karke, naya campaign review ke liye submit ho sakta hai ya run karne ke liye eligible ho sakta hai. CPA aur CPI campaigns ko start ya activate karne par unpaid selected launch package charge ho sakta hai. Hamesha returned public state aur financial requirements inspect karein, yeh assume na karein ki create ka matlab “save draft” hai.

Deposit se pehle teen campaigns

Ek advertiser account pehle successful advertiser deposit se pehle total teen self-serve CPA, CPI, ya CPC campaigns create kar sakta hai. Paused, denied, aur archived campaigns bhi count hote hain, kyunki throwaway campaigns create aur archive karke limit bypass nahi karni chahiye. Successful deposit ke baad yeh specific creation limit apply nahi hoti; normal review, balance, payout, budget, aur activation rules phir bhi lagu rehte hain.

Campaigns read aur filter karein

curl --config cpalead-auth.cfg \
  "https://www.cpalead.com/api/v1/advertiser/campaigns?type=CPA&state=paused&page=1&per_page=25"

List endpoint campaign type, public state, updated_since timestamp, page, aur per-page filters support karta hai. Pagination by default 25 campaigns par hoti hai aur per page up to 100 allow karti hai. Public state choices hain active, paused, pending_review, paused_for_funding, cap_reached, outside_schedule, denied, archived, aur unavailable. Archived campaigns sirf tab dikhte hain jab aap explicitly state=archived filter karein.

Campaign resource mein uska ID, optional external ID, version, type, name, creative, tracking, targeting, pricing, schedule, publisher-access setting, image URL, timestamps, aur public state shamil hote hain. State mein review, desired-delivery, delivery-reason, aur capability hints bhi hote hain. Capability hints advisory hain: latest campaign retrieve karein aur real operation response handle karein, kyunki account, funding, review, hold, aur schedule conditions change ho sakti hain.

ETag version protection ke saath update karein

Campaign edits optimistic concurrency use karte hain. Pehle campaign retrieve karein aur exact quoted ETag response header save karein. Phir PATCH request ke saath If-Match mein wahi value bhejein. Yeh kisi ek browser, agent, ya integration ko kahin aur ki gayi newer change ko silently overwrite karne se roakta hai.

# First retrieve the latest campaign and its ETag.
curl --config cpalead-auth.cfg \
  --dump-header campaign-headers.txt \
  "https://www.cpalead.com/api/v1/advertiser/campaigns/12345"

# Then send a reviewed partial update with that exact quoted ETag.
curl --config cpalead-auth.cfg \
  --request PATCH \
  --header "Content-Type: application/json" \
  --header 'If-Match: "COPY_THE_LATEST_ETAG"' \
  --data-binary '{"creative":{"description":"Updated public description"}}' \
  "https://www.cpalead.com/api/v1/advertiser/campaigns/12345"
  • No If-Match: API HTTP 428 return karta hai.
  • Stale If-Match: API current version metadata ke saath HTTP 412 return karta hai.
  • 412 ke baad: Campaign dobara retrieve karein, changes compare karein, approval maangein, aur new ETag ke saath retry karein.
  • Unclear network result ke baad: Next update bhejne se pehle campaign retrieve karein.

PATCH sirf public campaign fields accept karta hai. Yeh supplied partial object ko current campaign ke saath merge karta hai aur complete result validate karta hai. Kuch edits ke liye dobara review ya delivery change ki zarurat ho sakti hai, isliye har baar response state padhein.

Start aur pause explicit, bodyless actions hain

# Start an eligible campaign.
curl --config cpalead-auth.cfg \
  --request POST \
  --header "Idempotency-Key: start-campaign-12345-001" \
  "https://www.cpalead.com/api/v1/advertiser/campaigns/12345/actions/start"

# Pause an eligible campaign.
curl --config cpalead-auth.cfg \
  --request POST \
  --header "Idempotency-Key: pause-campaign-12345-001" \
  "https://www.cpalead.com/api/v1/advertiser/campaigns/12345/actions/pause"

Start ya pause karne ke liye JSON body na bhejein—{} bhi nahi. Start karne se pehle campaign, balance, payout ya bid, launch-package effect, countries, devices, schedule, cap ya budget, landing page, aur tracking confirm karein. Response ke baad public state inspect karein; campaign enabled ho sakta hai lekin apni daily schedule ke bahar, funding ke liye paused, cap par, ya delivery ke liye otherwise unable ho sakta hai.

HTTP statuses aur errors jo integration ko samajhne chahiye

Common Campaign API HTTP statuses
StatusMeaningClient action
200 / 201Read/update successful ya resource createddata, meta, state, ETag, aur Location inspect karein
400Malformed request ya missing/invalid idempotency keyRequest correct karein; blind-retry na karein
401Missing, invalid, expired, ya revoked tokenSecret fix ya replace karein
403Token ke paas required permission ya account access nahi haiLeast-privilege scope aur account eligibility review karein
404Campaign is advertiser ke liye unavailable haiID check karein; kisi aur account ka data infer na karein
409State, funding, hold, creation-limit, ya idempotency conflictStable error code aur recommended action padhein
412Stale ETagRetrieve, review, aur update rebase karein
415JSON endpoint ko galat content type milaapplication/json bhejein
422Validation failedJSON Pointer issues repair karein aur dobara validate karein
428Update mein If-Match missing haiCampaign retrieve karein aur uska ETag bhejein
429Rate limit reachedRetry-After ka respect karein
503Required API storage ya service temporarily unavailable haiIdempotent intent change kiye bina baad mein retry karein

HTTP status aur stable error.code ke against automate karein, sirf message wording ke against nahi. Validation details mein path, code, aur plain-English message hota hai. Support se baat karte waqt response request_id include karein.

Rate limits aur responsible retries

Campaign API requests aur authentication rate limited hain taaki advertisers aur service protect ho sakein. Limits change ho sakte hain, isliye request count hard-code karne ke bajay live OpenAPI schema aur response headers use karein. Jab API HTTP 429 return kare, to requests ko immediately repeat karne ke bajay Retry-After ka wait karein. Unchanged public requirements ki pagination, updated_since, aur local caching use karke unnecessary calls avoid karein.

API-capable AI agent ya integration ke liye prompt

Yeh prompt maanta hai ki client authenticated HTTPS requests ke saath private bearer token attach kar sakta hai. Pehle guide aur OpenAPI URL share karein, phir client platform ki private secret settings mein token configure karein. Is public prompt mein asli token na daalein. Agar normal AI chat kahe ki woh authenticated requests nahi bhej sakti, to bina zaroorat wala token revoke karein aur uske badle Temporary AI Campaign Draft Access ka use karein.

Read this CPAlead Campaign API guide and the public OpenAPI schema.

Do not ask me to paste a bearer token into chat. Use only the token configured
privately in the integration. Begin with read and validate operations.

1. Ask whether I am creating CPA, CPI, or CPC.
2. Call the matching requirements endpoint.
3. Ask me for every missing business value and explain any financial,
   tracking, targeting, schedule, review, or delivery effect.
4. Draft strict campaign JSON and validate it.
5. Repair validation errors by their JSON Pointer paths.
6. Show me the final normalized intent and ask for confirmation before
   uploading, creating, updating, starting, or pausing anything.
7. Use a unique idempotency key for create, start, and pause.
8. Retrieve the latest campaign and ETag before an update.
9. After every write, report the campaign ID, public state, request ID,
   warnings, and recommended next step.
10. Never attempt archive or delete because those operations are not in
    the Campaign API.

AI, MCP, plugins, aur code ke liye security checklist

  • Least privilege: Read aur validate se shuru karein. Sirf zarurat par ek write permission add karein.
  • Short expiry: One-time AI setup task ke liye 48-hour option prefer karein.
  • Separate tokens: Har agent ya integration ko uska apna named token dein.
  • Private storage: Tokens ko secret settings mein rakhein, URLs, prompts, logs, analytics, screenshots, ya repositories mein nahi.
  • Human confirmation: Create, update, start, ya pause se pehle summary required rakhein.
  • Safe retries: Uncertain idempotent result ke baad same key aur payload preserve karein.
  • Version checks: Latest ETag retrieve kiye bina kabhi update na karein.
  • Response checks: Har write ke baad public state aur request ID padhein.
  • Revoke promptly: Jab kaam ho jaye ya token leak ho sakta ho to Advertising API page se access remove karein.

Frequently asked questions

Kya main normal ChatGPT mein Full Campaign API ka use kar sakta hoon?

Sirf tab, jab ChatGPT mein configured GPT Action ya koi doosri authenticated integration ho jo Authorization header mein bearer token bhej sake. Normal chat aam taur par aisa nahi kar sakti. Iske badle Temporary AI Campaign Draft Access ka use karein. Yeh sirf inactive campaign drafts taiyar aur save kar sakta hai; aap unhe CPAlead mein review karke poora karte hain.

Mujhe apna CPAlead API key kahan milega?

Campaign API ke liye credential ko Campaign API token kaha jata hai. Sign in karein aur Advertising → Setup → API kholen, phir Create a token use karein. Token ko turant copy karein kyunki CPAlead poori value sirf ek baar dikhata hai.

Kya API CPA, CPI, aur CPC campaigns create kar sakti hai?

Haan. Har type ka JSON shape strict hota hai lekin alag hota hai. Build karne se pehle us type ke requirements fetch karein.

Kya main AI ko kuch create karne diye bina validate kar sakta hoon?

Haan. Token mein sirf campaigns:validate, aur optionally campaigns:read dein. Requirements aur validation ko create permission ki zarurat nahi hoti.

Kya valid response ka matlab campaign approved hai?

Nahi. Iska matlab current payload validation aur preflight pass karta hai. Review, funding, account access, holds, caps, schedules, aur real-time state abhi bhi apply hote hain.

Kya create se campaign immediately start ho sakta hai?

Haan, account aur campaign par depend karke. Yeh review mein bhi ja sakta hai. Hamesha returned public state inspect karein. CPA ya CPI activation unpaid selected launch package charge bhi kar sakta hai.

Kya main remote URL se image upload kar sakta hoon?

Nahi. Image file ko POST /images ke through upload karein. CPAlead temporary single-use image ID return karta hai.

Kya main ek saath bahut saare offers create kar sakta hoon?

Koi bulk-create operation nahi hai. Har request par ek campaign validate aur create karein, distinct external ID aur idempotency key use karein, aur rate limits aur account creation rules ka respect karein.

Kya API campaign archive ya delete kar sakti hai?

Nahi. Current public API eligible campaigns start aur pause kar sakti hai, lekin archive ya delete expose nahi karti. Archival ke liye advertiser dashboard use karein.

Mere update ko HTTP 412 kyun mila?

Jab aapne ise retrieve kiya tha uske baad campaign change ho gaya. Use dobara lein, newest data review karein, apna intended change merge karein, aur new ETag ke saath retry karein.

Create ne HTTP 409 kyun return kiya?

Stable error code padhein. Possible public reasons mein different data ke saath reused idempotency key ya external ID, koi pehla request abhi process ho raha hona, three-campaign pre-deposit limit, funding ya account restrictions, hold, ya state conflict shamil hain.

Kya meri application ko is article se field limits copy karni chahiye?

Nahi. Yeh article workflow explain karta hai. Aapki application ko live requirements aur OpenAPI schema read karna chahiye taaki current values authoritative rahen.

Machine-friendly Campaign API fact sheet

  • Purpose: Self-serve advertiser campaigns create aur manage karna.
  • Base URL: https://www.cpalead.com/api/v1/advertiser
  • OpenAPI: https://www.cpalead.com/api/v1/advertiser/openapi.json
  • Article ka scope: API-capable clients ke liye Full Campaign API; Temporary AI Campaign Draft Access nahi.
  • Full Campaign API token setup: https://www.cpalead.com/en/advertising/api/campaigns kholein.
  • Normal AI chat ka alternative: https://www.cpalead.com/en/advertising/api/ai-drafts kholein aur iska one-time prompt copy karein.
  • Temporary access ki seema: Char ghante; advertiser ki pehli successful deposit se pehle har link par zyada se zyada teen inactive campaign drafts; successful advertiser deposit ke baad har link par campaign drafts ki koi total limit nahi; har account mein ek samay par zyada se zyada 10 adhure campaign drafts pending ho sakte hain; campaigns dekhne ya manage karne, uploads, terms ya package acceptance, spending, submission, starting, pausing ya activation ki permission nahi.
  • Supported campaign types: CPA, CPI, CPC.
  • Currency: USD.
  • Schedule timezone: UTC.
  • Recommended AI token: pehle read aur validate ke saath 48 hours.
  • Maximum active tokens: 10.
  • Image input: JPG/JPEG/PNG/GIF/BMP/WebP, up to 2 MiB, 200–4096 pixels per side.
  • Image output: 200×200 metadata-free WebP; temporary ID 24 hours baad expire hoti hai aur single-use hai.
  • Create/start/pause retry safety: Idempotency-Key.
  • Update concurrency: strong ETag plus If-Match.
  • CPA/CPI click macro: {CLICK_ID}.
  • Pre-deposit creation allowance: three total self-serve campaigns.
  • Not available: archive, delete, bulk create, generic toggle, remote-image create.

Read aur validate se shuru karein

Campaign API is tarah design ki gayi hai ki advertiser cautiously shuru kar sake. Trusted agent ko public guide aur schema dein, read aur validation access grant karein, aur use account badle bina request prepare karne dein. Jab JSON sahi ho aur owner review, delivery, aur financial effects ko samajh chuka ho, tab next confirmed action ke liye sirf required write permission add karein.

Token banane ke liye Campaign API in the Advertiser API Center kholen, ya current contract inspect karne ke liye public Campaign API OpenAPI schema kholen. Publisher API documentation alag hai aur publishers ke offers retrieve karne aur reporting ko cover karti hai. Agar response unclear ho, token private rakhein aur public request ID aur campaign ID ke saath Advertiser Support se contact karein.

Kya aapne kisi truti ya is post mein sudhaar ki zarurat dekhi hai? Kripya post link pradaan karein aur humein sampark karein. Hum aapki pratikriya ki saraha karate hain aur samasya ko jald hi sulajhaenge.