Google приймає кампанії. Що стосується саме Google, дивіться в Пошукові кампанії Google і Кампанії Google Performance Max. Інші мережі відхиляють запит на кампанію з
code: 101, а details пояснює причину. Наприклад, для Facebook там буде campaignCreation is not supported on facebook.Ендпоінти
{platform} — це рекламна мережа. {id} — ID кампанії, повернений під час її створення. Ви можете отримувати й змінювати лише кампанії, створені через Ayrshare тим самим профілем користувача.
Параметри заголовка
string
обов'язково
Обов’язковий для створення кампанії. Надсилайте нове унікальне значення, наприклад UUID, для кожної нової кампанії. Якщо ви повторите запит із тим самим ключем, Ayrshare поверне першу відповідь із позначкою
idempotentReplayed: true і нічого нового не створить. Натомість ключ можна надіслати в тілі як idempotencyKey. Якщо ви надсилаєте обидва, вони мають збігатися.Створення кампанії
POST /ads/{platform}/campaigns
Нові кампанії створюються зі статусом paused, якщо ви не надішлете status: "active", тож нічого не витрачається, доки ви самі не вирішите запустити кампанію.
string
обов'язково
Рекламний обліковий запис, у якому потрібно створити кампанію.
string
обов'язково
Назва кампанії, від 1 до 255 символів.
string
обов'язково
Тип кампанії:
search або performanceMax. Кожна мережа підтримує лише деякі типи. Тип, який мережа не підтримує, повертає code: 101 із переліком підтримуваних типів.object
обов'язково
object
обов'язково
boolean
обов'язково
Чи є кампанія політичною рекламою в ЄС. Його потрібно надсилати завжди. Ayrshare ніколи не заповнює його за вас.
object
object
Кожна мережа підтримує лише деякі параметри таргетингу. Поле, яке мережа не підтримує, повертає
code: 101.string
за замовчуванням:"paused"
active або paused.object
Параметри лише для однієї мережі, вкладені під назвою цієї мережі, наприклад
{ "facebook": { ... } }. Параметри для будь-якої іншої мережі повертають code: 101.status: "success", campaignId і власний стан кампанії як campaignStatus (active або paused). Отримання й оновлення відповідають так само.
Отримання кампанії
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, також приймає той самий день, що й день початку.Помилки
Ці помилки містятьcode Ayrshare:
Створення також може повернути один із цих HTTP-статусів. Його тіло не містить
code, лише { "action": "createAdCampaign", "status": "error", "message": "..." }: