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
必須
キャンペーンが EU における政治広告かどうか。常に送信する必要があります。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}
以下のフィールドのうち少なくとも1つを送信してください。キャンペーンの作成後に type、accountId、euPoliticalAdvertising を変更することはできません。
string
新しいキャンペーン名。
string
active または paused。status: "paused" のみを送信するリクエストは、Ayrshare がそのネットワークの広告を一時停止している場合でもブロックされません。ただし、ネットワークがリンクされている必要があり、ネットワーク自体がダウンしている場合は失敗する可能性があります。object
{ "amount": number }: 1日あたりの新しい費用。object
{ "end": string }: 新しい終了日。schedule.start と同じ形式です。キャンペーンの開始日時より後である必要があります。Google のように日単位でスケジュールするネットワークでは、開始日と同じ日も受け付けます。エラー
以下のエラーには Ayrshare のcode が含まれます:
作成時には、以下のいずれかの HTTP ステータスが返されることもあります。そのボディには
code は含まれず、{ "action": "createAdCampaign", "status": "error", "message": "..." } のみが含まれます: