Google 接受广告活动。有关 Google 的特定内容,请参阅 Google 搜索广告活动 和 Google Performance Max 广告活动。其他网络会以
code: 101 拒绝广告活动请求,details 会说明原因。例如在 Facebook 上,它会显示 campaignCreation is not supported on facebook.端点
{platform} 是广告网络。{id} 是创建活动时返回的活动 ID。您只能读取和修改由同一用户 Profile 通过 Ayrshare 创建的活动。
请求头参数
string
必填
创建活动时必填。每创建一个新活动,请发送一个新的唯一值,例如 UUID。如果使用相同的键重复请求,Ayrshare 会返回首次的响应(标记为
idempotentReplayed: true),且不会创建任何新内容。您也可以改为在请求体中以 idempotencyKey 发送该键。如果两者都发送,它们必须一致。创建活动
POST /ads/{platform}/campaigns
除非您发送 status: "active",否则新活动以 paused 状态开始,因此在您选择启动之前不会产生任何支出。
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。当 Ayrshare 已暂停该网络上的广告时,仅发送 status: "paused" 的请求不会被阻止。但它仍需要已关联的网络,并且如果网络本身宕机,请求仍可能失败。object
{ "amount": number }:新的每日支出金额。object
{ "end": string }:新的结束日期,格式与 schedule.start 相同。必须晚于活动的开始时间。按整天排期的网络(例如 Google)也接受与开始日期相同的日期。错误
以下错误带有 Ayrsharecode:
创建请求也可能返回以下 HTTP 状态之一。其响应体不含
code,只有 { "action": "createAdCampaign", "status": "error", "message": "..." }: