تقبل Google الحملات. راجع حملات بحث Google وحملات Google Performance Max لمعرفة ما يخص Google. وترفض الشبكات الأخرى طلب الحملة مع
code: 101، ويوضح details السبب. على Facebook مثلًا، تكون الرسالة campaignCreation is not supported on facebook.نقاط النهاية
{platform} هي الشبكة الإعلانية. و{id} هو معرّف الحملة الذي أُعيد عند إنشائها. لا يمكنك قراءة وتعديل سوى الحملات التي أُنشئت عبر Ayrshare بواسطة الملف الشخصي للمستخدم نفسه.
معاملات الترويسة
مطلوب لإنشاء حملة. أرسل قيمة فريدة جديدة، مثل UUID، لكل حملة جديدة. إذا كررت طلبًا بالمفتاح نفسه، يُعيد Ayrshare الاستجابة الأولى مع العلامة
idempotentReplayed: true، ولا يُنشئ شيئًا جديدًا. يمكنك بدلًا من ذلك إرسال المفتاح في الجسم باسم idempotencyKey. وإذا أرسلتهما معًا، فيجب أن يتطابقا.إنشاء حملة
POST /ads/{platform}/campaigns
تبدأ الحملات الجديدة بالحالة paused ما لم ترسل status: "active"، لذا لا يُنفق أي مبلغ حتى تختار البدء.
نوع الحملة:
search أو performanceMax. تدعم كل شبكة بعض الأنواع فقط. يُعيد النوع الذي لا تدعمه الشبكة الرمز code: 101 مع قائمة بالأنواع المدعومة.ما إذا كانت الحملة إعلانًا سياسيًا في الاتحاد الأوروبي. يجب عليك إرساله دائمًا. لا يملؤه Ayrshare نيابةً عنك أبدًا.
خيارات لشبكة واحدة فقط، تحت اسم تلك الشبكة، مثل
{ "facebook": { ... } }. تُعيد الخيارات الخاصة بأي شبكة أخرى الرمز code: 101.status: "success" وcampaignId وحالة الحملة نفسها في campaignStatus (active أو paused). ويُعيد الحصول والتحديث الاستجابة بالطريقة نفسها.
الحصول على حملة
GET /ads/{platform}/campaigns/{id}
يُعيد الحملة كما تُبلغ عنها الشبكة. تُعيد الحملة التي لا تخصك، أو غير الموجودة، الرمز code: 400.
تحديث حملة
PUT /ads/{platform}/campaigns/{id}
أرسل حقلًا واحدًا على الأقل من هذه الحقول. لا يمكنك تغيير type أو accountId أو euPoliticalAdvertising بعد إنشاء الحملة.
active أو paused. لا يُحظر الطلب الذي يرسل status: "paused" فقط عندما يكون Ayrshare قد أوقف الإعلانات مؤقتًا على تلك الشبكة. لكنه لا يزال يتطلب شبكة مرتبطة، وقد يفشل إذا كانت الشبكة نفسها معطّلة.{ "end": string }: تاريخ الانتهاء الجديد، بالتنسيق نفسه المستخدم في schedule.start. يجب أن يكون بعد تاريخ بدء الحملة. وتقبل الشبكة التي تجدول أيامًا كاملة، مثل Google، أيضًا اليوم نفسه الذي تبدأ فيه الحملة.الأخطاء
تحمل هذه الأخطاء رمزcode من Ayrshare:
قد يُعيد الإنشاء أيضًا إحدى حالات HTTP التالية. لا يحتوي جسمها على
code، بل على { "action": "createAdCampaign", "status": "error", "message": "..." } فقط: