跳轉到主要內容
廣告活動是一種不從您的貼文開始的廣告。可用於搜尋廣告等格式:由您設定預算、出價策略和定位,再由網路建立廣告。 若要推廣您已發布的貼文,請改用 推廣貼文。
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 除非您傳送 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)也接受與開始日期相同的日期。

錯誤

這些錯誤帶有 Ayrshare code: 建立請求也可能以下列其中一種 HTTP 狀態回應。其回應主體不含 code,只有 { "action": "createAdCampaign", "status": "error", "message": "..." }: