Google कैंपेन स्वीकार करता है। Google से जुड़ी खास बातों के लिए Google सर्च अभियान और Google Performance Max अभियान देखें। अन्य नेटवर्क कैंपेन अनुरोध को
code: 101 के साथ अस्वीकार करते हैं, और details कारण बताता है। उदाहरण के लिए, Facebook पर यह campaignCreation is not supported on facebook. बताता है।एंडपॉइंट
{platform} विज्ञापन नेटवर्क है। {id} वह अभियान id है जो अभियान बनाते समय लौटाई गई थी। आप केवल वही अभियान पढ़ और बदल सकते हैं जो उसी यूज़र प्रोफ़ाइल द्वारा Ayrshare के माध्यम से बनाए गए हों।
हेडर पैरामीटर
string
आवश्यक
अभियान बनाने के लिए आवश्यक। प्रत्येक नए अभियान के लिए एक नया यूनिक मान भेजें, जैसे UUID। यदि आप उसी key के साथ कोई अनुरोध दोहराते हैं, तो Ayrshare पहला रिस्पॉन्स
idempotentReplayed: true के साथ चिह्नित करके लौटाता है, और कुछ भी नया नहीं बनाता। आप इसके बजाय key को body में idempotencyKey के रूप में भेज सकते हैं। यदि आप दोनों भेजते हैं, तो वे मेल खाने चाहिए।अभियान बनाएँ
POST /ads/{platform}/campaigns
नए अभियान paused स्थिति में शुरू होते हैं, जब तक आप status: "active" नहीं भेजते, इसलिए जब तक आप शुरू करने का निर्णय नहीं लेते, कुछ भी खर्च नहीं होता।
string
आवश्यक
वह विज्ञापन खाता जिसमें अभियान बनाना है।
string
आवश्यक
अभियान का नाम, 1 से 255 अक्षर।
string
आवश्यक
अभियान का प्रकार:
search या performanceMax। प्रत्येक नेटवर्क केवल कुछ प्रकारों का समर्थन करता है। जिस प्रकार का नेटवर्क समर्थन नहीं करता, वह code: 101 लौटाता है और समर्थित प्रकारों की सूची देता है।object
आवश्यक
object
आवश्यक
boolean
आवश्यक
क्या अभियान EU में राजनीतिक विज्ञापन है। आपको इसे हमेशा भेजना होगा। Ayrshare इसे आपके लिए कभी नहीं भरता।
object
object
प्रत्येक नेटवर्क केवल कुछ टार्गेटिंग का समर्थन करता है। जिस फ़ील्ड का नेटवर्क समर्थन नहीं करता, वह
code: 101 लौटाता है।string
डिफ़ॉल्ट:"paused"
active या paused।object
केवल एक नेटवर्क के लिए विकल्प, उस नेटवर्क के नाम के अंतर्गत, उदाहरण के लिए
{ "facebook": { ... } }। किसी अन्य नेटवर्क के विकल्प code: 101 लौटाते हैं।status: "success", campaignId, और अभियान की अपनी स्थिति campaignStatus (active या paused) के रूप में लौटाता है। Get और update भी इसी तरह लौटाते हैं।
अभियान प्राप्त करें
GET /ads/{platform}/campaigns/{id}
अभियान को वैसे ही लौटाता है जैसे नेटवर्क उसकी रिपोर्ट करता है। जो अभियान आपका नहीं है, या मौजूद नहीं है, वह code: 400 लौटाता है।
अभियान अपडेट करें
PUT /ads/{platform}/campaigns/{id}
इनमें से कम से कम एक फ़ील्ड भेजें। अभियान बनाने के बाद आप type, accountId, या euPoliticalAdvertising नहीं बदल सकते।
string
अभियान का नया नाम।
string
active या paused। जो अनुरोध केवल status: "paused" भेजता है, उसे तब ब्लॉक नहीं किया जाता जब Ayrshare ने उस नेटवर्क पर विज्ञापन रोक दिए हों। इसके लिए फिर भी एक लिंक किया गया नेटवर्क आवश्यक है, और यदि नेटवर्क स्वयं डाउन है तो यह फिर भी विफल हो सकता है।object
{ "amount": number }: प्रति दिन खर्च करने के लिए नई राशि।object
{ "end": string }: नई समाप्ति तिथि, schedule.start के समान फ़ॉर्मैट में। यह अभियान की शुरुआत के बाद होनी चाहिए। जो नेटवर्क पूरे दिनों का शेड्यूल बनाता है, जैसे Google, वह शुरुआत वाला दिन भी स्वीकार करता है।त्रुटियाँ
इन त्रुटियों में एक Ayrsharecode होता है:
कोई create इनमें से किसी HTTP स्टेटस के साथ भी जवाब दे सकता है। इसके body में कोई
code नहीं होता, केवल { "action": "createAdCampaign", "status": "error", "message": "..." }: