> ## Documentation Index
> Fetch the complete documentation index at: https://www.ayrshare.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# 投稿をブースト
> 投稿をFacebookの広告プラットフォームに送信してブーストします
export const PlansAvailable = ({plans = [], maxPackRequired}) => {
let displayPlans = plans;
if (plans && plans.length === 1) {
const lowerCasePlan = plans[0].toLowerCase();
if (lowerCasePlan === "business") {
displayPlans = ["Launch", "Business", "Enterprise"];
} else if (lowerCasePlan === "premium") {
displayPlans = ["Premium", "Launch", "Business", "Enterprise"];
}
}
return
Available on {displayPlans.length === 1 ? "the " : ""}
{displayPlans.join(", ").replace(/\b\w/g, l => l.toUpperCase())}{" "}
{displayPlans.length > 1 ? "plans" : "plan"}.
{maxPackRequired && window.open('https://www.ayrshare.com/docs/additional/maxpack', '_self')} className="flex items-center mt-2 cursor-pointer">
Max Pack required
}
;
};
export const HeaderAPI = ({noProfileKey, profileKeyRequired}) => <>
API Key of the Primary Profile.
Format: Authorization: Bearer API_KEY
{!noProfileKey && (profileKeyRequired ?
Profile Key of a User Profile.
Format: Profile-Key: PROFILE_KEY
:
Profile Key of a User Profile.
Format: Profile-Key: PROFILE_KEY
)}
;
既存のFacebook投稿をブーストして広告を作成します。
このエンドポイントを使用すると、オーガニック投稿をカスタムターゲティング、予算、スケジュールパラメータを持つ有料広告に変換できます。
- 予算と入札額は、小数点以下2桁までのUSDで指定する必要があります。
- Facebookの要件に対応するため、広告は少なくとも30時間実行する必要があります。
-
ターゲティング用の関心IDを見つけるには、[関心エンドポイント](/apis/ads/facebook/get-ad-interests)を使用できます。
- Facebookがブースト投稿を確認・承認するまでに最大24時間かかることがあります。
-
`fbPostId`を直接使用する場合(Ayrshareの`postId`の代わりに)、有効なFacebook投稿IDであることを確認してください。
### 広告の目標
各広告には目標が必要です。目標は、広告がどのように表示に最適化されるかを決定します。
-
`engagement`: この目標は、広告が最大数のユニークユーザーに到達することを保証しながらエンゲージメントを向上させます。可視性とエンゲージメントのバランスを取り、広告に反応する可能性のあるできるだけ多くの人々に広告を表示します。
-
`interactions`: いいね、コメント、シェアなど、広告へのインタラクションを促進するように設計されています。Facebookは広告に最も関わりそうなユーザーに広告を表示することを優先します。
-
`awareness_views`: 広告が表示される回数を最大化することで、ブランド認知度を高めることに重点を置きます。ユニークリーチに関係なく、予算内でできるだけ多くの回数広告を表示することを優先します。
-
`awareness_audience`: 広告を見るユニークユーザー数を最大化することで、ブランド認知度を向上させることを目指します。広告ができるだけ多くの異なるユーザーに到達することを保証し、同じオーディエンスに複数回表示するのではなく、ユニークオーディエンスのサイズを最大化します。
AyrshareとFacebook Marketing APIの統合について詳しくは、[Facebook Marketing API統合ガイド](https://www.ayrshare.com/blog/facebook-ads-api-boosting-with-the-marketing-api/)をご覧ください。
## ヘッダーパラメータ
## ボディパラメータ
投稿をブーストするFacebook広告アカウントのID。アカウントIDは[広告アカウントエンドポイント](/apis/ads/facebook/get-ad-accounts)から取得できます。
広告の名前(Facebook広告マネージャーに表示されます)。形式は`{adName} - {postId or fbPostId} - {current date}`となります。
最大入札額(USD)。最小入札額は\$1.00です。
日次予算(USD)。最小予算は\$1.00です。
ブーストする投稿の[Facebookソーシャル投稿ID](/apis/overview#social-post-id)。Facebookで直接作成された投稿から広告を作成できます。これは[Facebook上の投稿](/apis/history/history-platform)のIDであり、AyrshareのIDではありません。`postId`が設定されていない場合は必須です。
広告の目標。値: `engagement`、`interactions`、`awareness_views`、`awareness_audience`。詳細については上記の[広告の目標の詳細](/apis/ads/facebook/boost-post#ad-goals)をご覧ください。
配列のオブジェクトでターゲット広告の場所を指定します: `countries`、`regions`、`cities`。
国コードのリスト。
```json theme={"system"}
{
"countries": ["US", "CA"]
}
```
地域にはFacebookの地域`key`値が必要です。詳細については[地域エンドポイント](/apis/ads/facebook/get-ad-regions)をご覧ください。
```json theme={"system"}
{
"regions": [{ "key": "3886" }]
}
```
都市には以下が必要です: `key`(Facebookから)、`radius`、`distance_unit`。
`radius`は都市周辺の距離: 10〜50マイルまたは17〜80キロメートル。
`distance_unit`は`mile`または`kilometer`です。
詳細については[都市エンドポイント](/apis/ads/facebook/get-ad-cities)をご覧ください。
```json theme={"system"}
{
"cities": [
{ "key": "2420605", "radius": 25, "distance_unit": "mile" }
]
}
```
ブーストする投稿の[Ayrshare投稿ID](/apis/overview#ayrshare-post-id)。`fbPostId`が設定されていない場合は必須です。
広告のステータス。値: `active`および`paused`。
後で[広告更新エンドポイント](/apis/ads/facebook/put-ad-update)を使用して広告のステータスを変更できます。
Metaのキャンペーンレベルの広告セット予算共有を制御します。
Metaは現在、キャンペーンレベルの予算なしで作成されたすべてのキャンペーンでこのワイヤーフィールドを必須としているため、Ayrshareは常にこれを送信します — 後方互換性のためデフォルトは`false`です。
全体的なパフォーマンスを最適化するために、同じキャンペーン内の他の広告セット間で広告セットの予算の約20%までをMetaが共有できるようにするには、`true`に設定します。詳細については、Metaの[広告キャンペーングループリファレンス](https://developers.facebook.com/docs/marketing-api/reference/ad-campaign-group/)をご覧ください。
Facebook Pixelを使用して広告を追跡します。
広告を追跡するFacebook PixelのID。
```json theme={"system"}
{
"pixelId": 1234567890
}
```
広告URLにUTMタグを追加します。
```json theme={"system"}
{
"urlTags": ["utm_source=ayrshare", "utm_medium=social", "utm_campaign=ayrshare-social"]
}
```
例えば、リンクURLが`https://www.mysite.com/my-post`で、追加されたURLタグが次のとおりの場合:
`utm_source=ayrshare`、`utm_medium=social`、`utm_campaign=ayrshare-social`。
広告URLは次のようになります:
`https://www.mysite.com/my-post?utm_source=ayrshare&utm_medium=social&utm_campaign=ayrshare-social`。
Metaは、[特別広告カテゴリ](https://www.facebook.com/business/help/298000447747885?helpref=faq_content)の広告主に対して、キャンペーンカテゴリを自己識別するよう要求します。
あなたのビジネスがこれらのカテゴリの1つに該当する場合、投稿をブーストする際に適切なカテゴリを選択する必要があります。
以下の値がサポートされています:
-
`housing`: 住宅の機会または関連サービスを宣伝または直接リンクする広告(住宅またはアパートの売買・賃貸のリスト、住宅所有者保険、住宅ローン保険、住宅ローン、住宅修理、住宅担保または鑑定サービスなどを含むがこれらに限定されない)。
-
`financial_product_services`: クレジットを含む金融商品およびサービスの提供を宣伝または直接リンクする広告。
-
`employment`: 雇用機会を宣伝または直接リンクする広告(パートタイムまたはフルタイムの仕事、インターンシップ、または専門資格プログラムを含むがこれらに限定されない)。このカテゴリに該当する関連広告には、求人掲示板や求人フェアの宣伝、集約サービス、または特定の求人提供に関係なく企業が提供する福利厚生を詳述する広告が含まれます。
-
`issues_elections_politics`: 公職候補者、政治家、政党について、またはそれらのために作成された広告、または公職選挙の結果を主張する広告。これには、選挙、国民投票、または住民投票イニシアチブに関する広告も含まれ、「投票に行こう」選挙キャンペーンも含まれます。広告が掲載される場所での政治広告または社会問題に関する広告として規制される広告。問題、選挙、または政治を選択する場合、これらの広告を実行したい国を選択する必要があります。指定された国で社会問題、選挙、または政治に関する広告を実行するには、認証を受ける必要があります。
Metaは、キャンペーンカテゴリを自己識別した広告主を要求します。
Metaは人間のレビュアーと機械学習を使用して、これらの種類の広告を識別します。
誤った`specialAdCategory`を送信した場合、キャンペーンが調整されるまで広告が一時停止されるリスクがあります。
ISO 8601形式の終了日時(開始から少なくとも30時間後である必要があります)。例: `2025-03-01T00:00:00Z`。
設定されていない場合、広告は無期限に実行され、終了日は`ongoing`となります。
`countries`、`regions`、`cities`の配列を持つオブジェクトを使用して場所を除外します。
除外する国コードのリスト。
```json theme={"system"}
{
"countries": ["US", "CA"]
}
```
地域にはFacebookの地域`key`値が必要です。詳細については[地域エンドポイント](/apis/ads/facebook/get-ad-regions)をご覧ください。
```json theme={"system"}
{
"regions": [{ "key": "3886" }]
}
```
都市には以下が必要です: `key`(Facebookから)、`radius`、`distance_unit`。
`radius`は都市周辺の距離: 10〜50マイルまたは17〜80キロメートル。
`distance_unit`は`mile`または`kilometer`です。
詳細については[都市エンドポイント](/apis/ads/facebook/get-ad-cities)をご覧ください。
```json theme={"system"}
{
"cities": [
{ "key": "2420605", "radius": 25, "distance_unit": "mile" }
]
}
```
オーディエンスの性別。値: `all`、`male`、`female`。
Facebook [関心ID](/apis/ads/facebook/get-ad-interests)の配列としての広告のターゲット関心。
広告のターゲティングの最大年齢(デフォルト: 65)。
広告のターゲティングの最小年齢(デフォルト: 18)。
ISO 8601形式の開始日時。例: `2025-03-01T00:00:00Z`。
設定されていない場合、広告はすぐに開始されます。
EU諸国向けのデジタルサービス法(DSA)コンプライアンスのための広告の受益者。いずれかが提供されている場合、`dsaPayor`と共に設定する必要があります。詳細については[DSAガイド](/apis/ads/facebook/get-dsa-recommendations)をご覧ください。
EU諸国向けのデジタルサービス法(DSA)コンプライアンスのための広告の支払者。いずれかが提供されている場合、`dsaBeneficiary`と共に設定する必要があります。
```bash cURL theme={"system"}
curl -X POST https://api.ayrshare.com/api/ads/facebook/boost \
-H "Authorization: Bearer API_KEY" \
-H "Content-Type: application/json" \
-d '{
"postId": "1234567890",
"accountId": "1234567890",
"adName": "My Ad",
"status": "active",
"goal": "engagement",
"minAge": 18,
"maxAge": 65,
"locations": { "countries": ["US"] },
"budget": 100,
"bidAmount": 1,
"startDate": "2025-03-01T00:00:00Z",
"endDate": "2025-03-07T23:59:59Z",
"interests": [1234567890, 1234567891]
}'
```
```javascript JavaScript theme={"system"}
const API_KEY = "API_KEY";
fetch("https://api.ayrshare.com/api/ads/facebook/boost", {
method: "POST",
headers: {
"Content-Type": "application/json",
Authorization: `Bearer ${API_KEY}`
},
body: JSON.stringify({
postId: "1234567890",
accountId: "1234567890",
adName: "My Ad",
status: "active",
goal: "engagement",
minAge: 18,
maxAge: 65,
locations: { countries: ["US"] },
budget: 100,
bidAmount: 1,
startDate: "2025-03-01T00:00:00Z",
endDate: "2025-03-07T23:59:59Z",
interests: [1234567890, 1234567891]
})
})
.then((res) => res.json())
.then((json) => console.log(json))
.catch(console.error);
```
```python Python theme={"system"}
import requests
API_KEY = "API_KEY"
url = "https://api.ayrshare.com/api/ads/facebook/boost"
payload = {
"postId": "1234567890",
"accountId": "1234567890",
"adName": "My Ad",
"status": "active",
"goal": "engagement",
"minAge": 18,
"maxAge": 65,
"locations": {"countries": ["US"]},
"budget": 100,
"bidAmount": 1,
"startDate": "2025-03-01T00:00:00Z",
"endDate": "2025-03-07T23:59:59Z",
"interests": [1234567890, 1234567891]
}
response = requests.post(url, headers={"Authorization": f"Bearer {API_KEY}", "Content-Type": "application/json"}, json=payload)
print(response.json())
```
```php PHP theme={"system"}
"1234567890",
"accountId" => "1234567890",
"adName" => "My Ad",
"status" => "active",
"goal" => "engagement",
"minAge" => 18,
"maxAge" => 65,
"locations" => ["countries" => ["US"]],
"budget" => 100,
"bidAmount" => 1,
"startDate" => "2025-03-01T00:00:00Z",
"endDate" => "2025-03-07T23:59:59Z",
"interests" => [1234567890, 1234567891]
];
$ch = curl_init("https://api.ayrshare.com/api/ads/facebook/boost");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Content-Type: application/json",
"Authorization: Bearer " . $API_KEY
]);
$response = curl_exec($ch);
$result = json_decode($response, true);
print_r($result);
curl_close($ch);
```
```csharp C# theme={"system"}
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Text.Json;
using System.Threading.Tasks;
class Program
{
static async Task Main()
{
string API_KEY = "API_KEY";
var payload = new
{
postId = "1234567890",
accountId = "1234567890",
adName = "My Ad",
status = "active",
goal = "engagement",
minAge = 18,
maxAge = 65,
locations = new { countries = new[] { "US" } },
budget = 100,
bidAmount = 1,
startDate = "2025-03-01T00:00:00Z",
endDate = "2025-03-07T23:59:59Z",
interests = new[] { 1234567890, 1234567891 }
};
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", API_KEY);
var content = new StringContent(
JsonSerializer.Serialize(payload),
Encoding.UTF8,
"application/json"
);
var response = await client.PostAsync("https://api.ayrshare.com/api/ads/facebook/boost", content);
var responseBody = await response.Content.ReadAsStringAsync();
Console.WriteLine(responseBody);
}
}
```
```go Go theme={"system"}
package main
import (
"bytes"
"encoding/json"
"fmt"
"io/ioutil"
"net/http"
)
func main() {
apiKey := "API_KEY"
payload := map[string]interface{}{
"postId": "1234567890",
"accountId": "1234567890",
"adName": "My Ad",
"status": "active",
"goal": "engagement",
"minAge": 18,
"maxAge": 65,
"locations": map[string]interface{}{"countries": []string{"US"}},
"budget": 100,
"bidAmount": 1,
"startDate": "2025-03-01T00:00:00Z",
"endDate": "2025-03-07T23:59:59Z",
"interests": []int{1234567890, 1234567891},
}
jsonData, err := json.Marshal(payload)
if err != nil {
fmt.Println("Error marshaling JSON:", err)
return
}
req, err := http.NewRequest("POST", "https://api.ayrshare.com/api/ads/facebook/boost", bytes.NewBuffer(jsonData))
if err != nil {
fmt.Println("Error creating request:", err)
return
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer "+apiKey)
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
fmt.Println("Error sending request:", err)
return
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
fmt.Println("Error reading response:", err)
return
}
fmt.Println(string(body))
}
```
```java Java theme={"system"}
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
import com.fasterxml.jackson.databind.ObjectMapper;
public class BoostPost {
public static void main(String[] args) {
String API_KEY = "API_KEY";
String url = "https://api.ayrshare.com/api/ads/facebook/boost";
Map payload = new HashMap<>();
payload.put("postId", "1234567890");
payload.put("accountId", "1234567890");
payload.put("adName", "My Ad");
payload.put("status", "active");
payload.put("goal", "engagement");
payload.put("minAge", 18);
payload.put("maxAge", 65);
Map locations = new HashMap<>();
locations.put("countries", Arrays.asList("US"));
payload.put("locations", locations);
payload.put("budget", 100);
payload.put("bidAmount", 1);
payload.put("startDate", "2025-03-01T00:00:00Z");
payload.put("endDate", "2025-03-07T23:59:59Z");
payload.put("interests", Arrays.asList(1234567890, 1234567891));
try {
ObjectMapper objectMapper = new ObjectMapper();
String requestBody = objectMapper.writeValueAsString(payload);
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(url))
.header("Content-Type", "application/json")
.header("Authorization", "Bearer " + API_KEY)
.POST(HttpRequest.BodyPublishers.ofString(requestBody))
.build();
HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
} catch (IOException | InterruptedException e) {
e.printStackTrace();
}
}
}
```
```ruby Ruby theme={"system"}
require 'net/http'
require 'uri'
require 'json'
API_KEY = "API_KEY"
uri = URI.parse("https://api.ayrshare.com/api/ads/facebook/boost")
payload = {
postId: "1234567890",
accountId: "1234567890",
adName: "My Ad",
status: "active",
goal: "engagement",
minAge: 18,
maxAge: 65,
locations: { countries: ["US"] },
budget: 100,
bidAmount: 1,
startDate: "2025-03-01T00:00:00Z",
endDate: "2025-03-07T23:59:59Z",
interests: [1234567890, 1234567891]
}
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri.request_uri)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer #{API_KEY}"
request.body = payload.to_json
response = http.request(request)
puts response.body
```
```json 200: Post Boosted theme={"system"}
{
"status": "success",
"adId": "120217670757750410",
"adName": "API Post - DE6gpw8kxlonHy2b7Lo - 2025-03-26T23:42:43",
"adStatus": "active",
"bidAmount": 10,
"budget": 100,
"endDate": "2026-03-28T22:30:00Z",
"goal": {
"title": "Get More Engagement",
"description": "This goal seeks to increase engagement...",
"type": "engagement"
},
"interests": [
"6003195554098"
],
"locations": { "countries": ["US"] },
"maxAge": 65,
"minAge": 18,
"postId": "DE6gpw8kxlonHy2b7Lo",
"startDate": "2026-03-26T22:30:00Z"
}
```
```json 400: Invalid Account ID theme={"system"}
{
"action": "boost post",
"status": "error",
"code": 369,
"message": "Unable to boost post. Please try again or contact us if the issue persists.",
"details": "The accountId likely does not exist. Please check the accountId and try again."
}
```
```json 400: Missing Required Parameters theme={"system"}
{
"action": "request",
"status": "error",
"code": 101,
"message": "Missing or incorrect parameters. Please verify with the docs. https://www.ayrshare.com/docs/apis",
"details": "Missing required fields: budget"
}
```