Skip to main content
広告の操作は広告プラットフォームを引数として受け取るため、同じ操作が Ayrshare がサポートするすべての広告プラットフォームで動作します。現在サポートされているのは FACEBOOK と INSTAGRAM です。 各操作は対応する REST の広告エンドポイントを呼び出し、そのレスポンスを変更せずに返します。認証と制限は REST と同じです。呼び出しが失敗すると GraphQL エラーが返されます。extensions.status には REST のステータスが、REST のエラーに Ayrshare のエラーコードがある場合は extensions.code にそのコードが含まれます。エラーを参照してください。広告の操作には広告アドオンが必要です。アドオンがない場合、すべての呼び出しは extensions.status が 403、extensions.code が 399 のエラーを返します。

​
操作

すべての操作は、User Profile を操作するためのオプションの profileKey も受け取ります。いずれも REST のレスポンスを JSON として返すため、フィールドの選択は受け付けません。

​
広告アカウントを一覧表示する

まずここから始めます。操作で accountId が求められる場合は、このレスポンスに含まれる accountId の値を使用してください。

​
ターゲティングオプションを検索する

kind で検索の種類を選択します。オーディエンスのターゲティングには INTERESTS、地域には REGIONS または CITIES を使用します。各 kind は、それぞれに対応する引数のみを受け付けます。たとえば、countryCode と regionId は CITIES でのみ機能し、INTERESTS には search が必要です。

​
広告を一覧表示する

campaignId、accountId、adId、postId、socialPostId のうち少なくとも 1 つを渡してください。socialPostId はネットワーク独自の投稿 ID で、Ayrshare 経由で公開されていない投稿に使用します。

​
広告の費用を確認する

​
広告を一時停止または再開する

updateAd は実際の広告費に影響します。PAUSED は支出を停止し、ACTIVE は再開し、DELETED または ARCHIVED は広告を終了します。同じステータスは広告の広告セットとキャンペーンにも設定されるため、その広告セットまたはキャンペーン内の他の広告も同様に変更されます。attachTo でブーストを追加したキャンペーンまたは広告セットは独自のステータスを維持し、広告はその上位のキャンペーンと広告セットが有効な間のみ配信されます。

​
投稿をブーストする

boostPost は広告アカウントから実際の費用を支出します。公開済みの投稿を広告に変換します。
  • postId(Ayrshare の投稿 ID)または socialPostId(ネットワーク独自の投稿 ID)を渡してください。
  • accountId は adAccounts から取得します。
  • budget.amount は広告アカウントの通貨で指定します。budget を省略するのは、attachTo.adSetId で既存の広告セットに広告を追加する場合のみです。その広告セットは独自の予算を維持します。その場合は 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 の日付は、"2026-10-10T09:00:00Z" のような ISO 8601 の日付または日時を受け付けます。数値ではなくこの形式を使用してください。schedule.end は終了日なしを表す 0 も受け付けます。
  • 地域のキーは単一の値またはリストを受け付けます。
  • targeting.interests は ID を文字列または数値で受け付けます。
  • platformOptions はオブジェクトを受け付けます。
ブーストのたびに、UUID などの新しい idempotencyKey を送信してください。呼び出しがタイムアウトまたは失敗した場合は、同じキーと同じ引数で再試行してください。
  • 最初のブーストが完了していた場合、再試行は 2 つ目の広告を作成して費用を支払う代わりに、そのレスポンスを返します。
  • 最初のブーストがまだ処理中の場合、再試行は extensions.status が 409 のエラーを返します。しばらく待ってから、同じキーで再試行してください。新しいキーに切り替えないでください。
  • 異なる引数でキーを再利用した場合も 409 が返されます。
広告の支出を停止するには、status: PAUSED を指定して updateAd を呼び出してください。boostFacebookPost と instagramBoostPost も引き続き動作します。 facebookAdAccounts や instagramAds などのプラットフォームごとの操作も、変更なく引き続き動作します。