スポンサープロダクト広告のルールに基づく入札APIの使用を開始する

ルールに基づく入札は、スポンサープロダクトAPIのcampaignOptimizationリソースによって表されます。

このAPIには、campaignOptimizationリソースを作成、読み取り、更新、削除する操作が含まれています。campaignOptimizationリソースの状態を照会したり、キャンペーンの利用資格を判断したり、ROASガードレールを取得したりすることもできます。

ルールを作成する

テーマを「ROASガードレールを維持しながらコンバージョンを増やす」に設定することでルールを作成できます。ROASガードレールは現地通貨で設定して複数のキャンペーンに適用できます。次に、ルールを一連のキャンペーンに関連付ける必要があります。

POST /sp/rules/campaignOptimization

リクエストボディ：

{
    "recurrence": "DAILY",
    "ruleAction": "ADOPT",
    "ruleCondition": [
        {
            "metricName": "ROAS",
            "comparisonOperator": "GREATER_THAN",
            "threshold": "4"
        }
    ],
    "ruleType": "BID",
    "ruleName": "RuleROAS4",
    "campaignIds": [
        "123784",
        "1223785"
    ]
}

レスポンスボディ：

{
    "campaignOptimizationId": "string",
    "code": "string",
    "details": "string"
}

注

現在、recurrenceプロパティはDAILY値のみをサポートしています。ruleActionプロパティは現在ADOPT値のみをサポートしています。comparisonOperatorは複数の値を持つ列挙型ですが、metricNameがROASに設定されている場合、サポートされる値はGREATER_THANまたはEQUAL_TOです。

ルールを取得する

識別子でルールを取得するには、パスで識別子を指定してGET操作を実行します。

GET /sp/rules/campaignOptimization/{campaignOptimizationId}/

レスポンスボディ：

{
    "CampaignOptimizationRule": {
        "recurrence": "DAILY",
        "ruleAction": "ADOPT",
        "campaignOptimizationId": "string",
        "createdDate": "2021-04-20T01:09:04.505Z",
        "ruleCondition": [
            {
                "metricName": "ROAS",
                "comparisonOperator": "EQUAL",
                "threshold": "3",
            }
        ],
        "ruleType": "BID",
        "ruleName": "string",
        "campaignIds": [
            "string"
        ],
        "ruleStatus": "ACTIVE"
    }
}

注

'ruleStatus'プロパティは、現在 [ACTIVE, ARCHIVED]という2つの値のみをサポートする列挙型です。

ルールの更新

ルールを更新するには、PUT操作を使用します。

PUT /sp/rules/campaignOptimization

リクエストボディ：

{
    "recurrence": "DAILY",
    "ruleAction": "ADOPT",
    "campaignOptimizationId": "10001",
    "ruleCondition": [
        {
        "metricName": "ROAS",
        "comparisonOperator": " EQUALS ",
        "threshold": "3"
        }
    ],
    "ruleType": "BID",
    "ruleName": "RuleROAS4",
    "campaignIds": [
        "123784",
        "1223785"
    ]
}

レスポンスボディ：

{
    "campaignOptimizationId": "string",
    "code": "string",
    "details": "string"
}

ルールの削除

識別子で指定されたルールを削除するには、パスで識別子を指定してDELETE操作を実行します。

DELETE /sp/rules/campaignOptimization/{campaignOptimizationId}/

レスポンスボディ：

{
    "campaignOptimizationId": "string",
    "code": "string",
    "details": "string"
}

ルールの状態

campaignOptimation/stateリソースのリクエストボディにcampaignIdsのリストを指定することで、キャンペーンに関連付けられたルールの状態を照会できます。

POST /sp/rules/campaignOptimization/state

リクエストボディ：

{
    "campaignIds": [
        "string"
    ]
}

レスポンスボディ：

{
    "CampaignOptimizationRecommendationsError": [
        {
            "campaignId": "string",
            "Error": {
                "code": "string",
                "details": "string"
            }
        }
    ],
    "CampaignOptimizationNotifications": [
        {
        "ruleState": "ENABLED",
        "campaignOptimizationId": "string",
        "campaignId": "string",
        "notificationString": "string"
        }
    ]
}

注

このクエリは1日に1回以上実行することをおすすめします。

利用資格

キャンペーンがルールに基づく入札の対象かどうかを判断するには、POST操作を使用してcampaignOptimization/eligibilityリソースを取得します。キャンペーンに利用資格がある場合、レスポンスには特定のキャンペーンIDに対するROASと入札のガードレールのガイドラインが含まれます。レスポンスデータは、お客様と似た広告主様の過去のキャンペーンパフォーマンスに基づいています。

POST /sp/rules/campaignOptimization/eligibility

リクエストボディ：

{
    "campaignIds": [
        "string"
    ]
}

レスポンスボディ：

{
    "CampaignOptimizationRecommendations": [
        {
            "campaignId": "string",
            "performanceMetrics": {
                "roas": 0
            }
        }
    ],
    "CampaignOptimizationRecommendationsError": [
        {
            "campaignId": "string",
            "Error": {
                "code": "string",
                "details": "string"
            }
        }
    ]
}