Skip to main content
廣告操作以廣告平台作為引數,因此同一個操作適用於 Ayrshare 支援的所有廣告平台。目前支援 FACEBOOK 與 INSTAGRAM。 每個操作都會呼叫對應的 REST 廣告端點,並原封不動地傳回其回應。驗證與限制皆與 REST 相同。呼叫失敗時會傳回 GraphQL 錯誤:extensions.status 帶有 REST 狀態碼,若 REST 錯誤含有 Ayrshare 錯誤碼,則 extensions.code 會帶有該錯誤碼。請參閱錯誤。廣告操作需要 Ads 附加元件。若未啟用,每次呼叫都會傳回 extensions.status 為 403、extensions.code 為 399 的錯誤。

操作

每個操作也都接受選用的 profileKey,以針對某個 User Profile(使用者設定檔)執行。所有操作都以 JSON 傳回 REST 回應,因此不需要選取欄位。

列出廣告帳戶

從這裡開始。凡是操作要求提供 accountId 時,請使用此回應中的 accountId 值。

搜尋目標設定選項

kind 決定搜尋類型:INTERESTS 用於受眾目標設定,REGIONS 或 CITIES 用於地點。每種類型只接受各自的引數。例如,countryCode 與 regionId 僅適用於 CITIES,而 INTERESTS 需要 search。

列出廣告

請至少傳入 campaignId、accountId、adId、postId 或 socialPostId 其中之一。socialPostId 是社群網路本身的貼文 id,適用於非透過 Ayrshare 發布的貼文。

查看廣告的花費

暫停或恢復廣告

updateAd 會影響實際的廣告支出。PAUSED 會停止支出,ACTIVE 會恢復支出,而 DELETED 或 ARCHIVED 會停用廣告。相同的狀態也會套用到該廣告所屬的廣告集與活動,因此該廣告集或活動中的其他廣告也會隨之變更。透過 attachTo 附加推廣的活動或廣告集會保留自己的狀態,且只有在其上層的活動與廣告集皆為啟用狀態時,廣告才會投放。

推廣貼文

boostPost 會花費廣告帳戶中的真實資金。它會將已發布的貼文轉為廣告。
  • 傳入 postId(Ayrshare 貼文 ID)或 socialPostId(社群網路本身的貼文 ID)。
  • 從 adAccounts 取得 accountId。
  • budget.amount 以廣告帳戶的幣別計價。只有在 attachTo.adSetId 將廣告新增至您已在執行的廣告集時(該廣告集會保留自己的預算),才可省略 budget。此時也請省略 targeting:廣告集會保留自己的設定。請參閱推廣至現有的活動或廣告集。
  • schedule、targeting、callToAction、attachTo 與 status 皆為選用。若省略 status 與 schedule,廣告將處於啟用狀態、立即開始且沒有結束日期,因此會持續花費,直到您將其暫停。設定 status: PAUSED 或 schedule.end 即可加以限制。
  • 將只有某個平台才有的設定放在 platformOptions 下,並以平台作為鍵。在 Facebook 與 Instagram 上,adName 與 bidAmount 在此處為必填,例如 platformOptions: { facebook: { adName: "Autumn sale", bidAmount: 2 } }。缺少這些設定時,推廣會傳回缺少欄位的錯誤。使用 attachTo.adSetId 時,請省略 bidAmount:廣告集會保留自己的出價。
部分引數接受多種形式,因此使用 JSON 類型:
  • accountId 接受字串或數字。
  • schedule 日期接受 ISO 8601 日期或日期時間,例如 "2026-10-10T09:00:00Z"。請使用此形式,而非數字。schedule.end 也接受 0,表示沒有結束日期。
  • 地點鍵接受單一值或清單。
  • targeting.interests 接受字串或數字形式的 ID。
  • platformOptions 接受一個物件。
每次推廣時都傳送一個新的 idempotencyKey,例如 UUID。若呼叫逾時或失敗,請使用相同的鍵與相同的引數重試。
  • 若第一次推廣已完成,重試會傳回其回應,而不會建立並支付第二個廣告。
  • 若第一次推廣仍在進行中,重試會傳回 extensions.status 為 409 的錯誤。請稍候,再使用相同的鍵重試。請勿改用新的鍵。
  • 以不同的引數重複使用某個鍵也會傳回 409。
若要停止廣告支出,請呼叫 updateAd 並傳入 status: PAUSED。boostFacebookPost 與 instagramBoostPost 仍可使用。 各平台專屬的操作(例如 facebookAdAccounts 與 instagramAds)仍可正常使用,且維持不變。