開発者ガイドの概要

Amazon Ads APIの概要

推奨キーワード

注： 有効なキーワード文字と制約の詳細なリストについては、制限セクションを参照してください。

広告グループおよびASINレベルの推奨キーワードをリクエストするために使用します。 推奨キーワードは、効果が最も高いものから順に並んでいます。

メソッド URL ユースケース
GET /adGroups/{adGroupId}/suggested/keywords 指定した広告グループの推奨キーワードをリクエストする
GET /adGroups/{adGroupId}/suggested/keywords/extended 広告グループの推奨キーワードが返されます。追加フィールド：各推奨キーワードのcampaignId、adGroupId、（広告の）state
GET /asins/{asinValue}/suggested/keywords 指定したASINの推奨キーワードが返されます。
POST /asins/suggested/keywords 指定したASINリストの推奨キーワードが返されます。

オペレーション

getAdGroupSuggestedKeywords

GET /adGroups/{adGroupId}/suggested/keywords

指定したadGroupIdの推奨キーワードデータを取得します。

パラメーター

パラメーター名 タイプ 指定する場所 説明
adGroupId 番号 URLパス リクエストされた広告グループのID
maxNumSuggestions 番号 URLクエリ 返される推奨キーワードの最大数。デフォルトは100、最大値は1000です。
adStateFilter 文字列 URLクエリ 広告を除外して、ASINの推奨キーワードを取得する広告ステータスフィルター（値はカンマ区切り）。有効な値は、enabled、paused、archivedです。デフォルト値はenabledおよびpausedです。

応答

ステータスコード 応答オブジェクト
200 - Success 指定されたadGroupIdの推奨キーワード
400 – Error 指定されたadGroupIdの広告グループが見つかりませんでした
404 – Error 1つ以上の不正なURLクエリパラメーター

getAdGroupSuggestedKeywordsEx

GET /adGroups/{adGroupId}/suggested/keywords/extended

指定されたadGroupIdの拡張された推奨キーワード データを取得します。

パラメーター

パラメーター名 タイプ 指定する場所 説明
adGroupId 番号 URLパス リクエストされた広告グループのID
maxNumSuggestions 番号 URLクエリ 推奨キーワードの予想最大数。デフォルトは100、最大値は1000です。
suggestBids 文字列 URLクエリ 有効な値は、「yes」と「no」です。 デフォルト値は「no」です。「yes 」の場合、推奨キーワードには追加の入札額フィールドを含めることができ、入札額には算出された推奨入札額が入力されます。 **注：**キーワードに推奨入札額がない場合、入札額フィールドは表示されません。
adStateFilter 文字列 URLクエリ 広告を除外して、ASINの推奨キーワードを取得する広告ステータスフィルター（値はカンマ区切り）。有効な値は、enabled、paused、archivedです。デフォルト値はenabledおよびpausedです。

応答

ステータスコード 応答オブジェクト
200 - Success 指定されたadGroupIdの拡張された推奨キーワード
404 – Not Found 指定されたadGroupIdの広告グループが見つかりませんでした
400 – Error 1つ以上の不正なURLクエリパラメーター

getAsinSuggestedKeywords

GET /asins/{asinValue}/suggested/keywords

指定されたASINの推奨キーワードが表示されます。推奨キーワードは、効果が最も高いものから低いものの順に並べられます。

パラメーター

パラメーター名 タイプ 指定する場所 説明
asinValue 文字列 URLパス ASIN
maxNumSuggestions 番号 URLクエリ 返される推奨キーワードの最大数。デフォルトは100、最大値は1000です。

応答

ステータスコード 応答オブジェクト
200 – Success 指定されたasinValueの推奨キーワード
400 – Error 1つ以上の不正なURLクエリパラメーターまたは不正なASIN

bulkGetAsinSuggestedKeywords

POST /asins/suggested/keywords

指定されたASINのリストのキーワード候補が表示されます。推奨キーワードは、効果が最も高いものから低いものの順に並べられます。

パラメーター

パラメータ名 タイプ 指定する場所 説明
asins 文字列のリスト 本文 推奨キーワードを取得するASINのリスト
maxNumSuggestions Number 本文 返される推奨キーワードの最大数。デフォルトは100、最大値は1000です。

応答

ステータスコード 応答オブジェクト
200 – Success 指定したASINのリストに対する推奨キーワード
400 – Error 1つ以上の不正なURLクエリパラメーターまたは不正なASIN

リソースの表現

AdGroupSuggestedKeywordsResponse

{
    "title": "AdGroupSuggestedKeywordsResponse",
    "type": "object",
    "properties": {
        "adGroupId": {
            "description": "リクエストした広告グループのID",
            "type": "number"
        },
        "suggestedKeywords": {
            "description": "推奨キーワードのリスト",
            "type": "array"
        }
    }
}

GetAdGroupSuggestedKeywordsExResponse

{
    "title": "GetAdGroupSuggestedKeywordsExResponse",
    "type": "array",
    "properties": {
        "adGroupId": {
            "description": "リクエストした広告グループのID",
            "type": "number"
        },
        "campaignId": {
            "description": "広告グループが属するキャンペーンID",
            "type": "number"
        },
        "keywordText": {
            "description": "推奨キーワード",
            "type": "string"
        },
        "matchType": {
            "description": "推奨キーワードのマッチタイプ",
            "type": "string"
        },
        "state": {
            "description": "推奨キーワードが生成された広告のステータス。有効または一時停止の状態でなければなりません",
            "type": "string"
        },
        "bid": {
            "description": "キーワードの推奨入札額。suggestBidが「yes」で、キーワードに推奨入札額がある場合にのみ表示されます。",
            "type": "number"
        }
    }
}

GetAsinSuggestedKeywordsResponse

{
    "title": "GetAsinSuggestedKeywordsResponse",
    "type": "object",
    "properties": {
        "asin": {
            "description": "推奨キーワードをリクエストしたASIN",
            "type": "string"
        },
        "suggestedKeywords": {
            "description": "推奨キーワードのリスト",
            "type": "array",
            "properties": {
                "keywordText": {
                    "description": "推奨キーワード",
                    "type": "string"
                },
                "matchType": {
                    "description": "推奨キーワードのマッチタイプ",
                    "type": "string"
                }
            }
        }
    }
}

BulkGetAsinSuggestedKeywordsResponse

{
    "title": "BulkGetAsinSuggestedKeywordsResponse",
    "type": "array",
    "properties": {
        "keywordText": {
            "description": "推奨キーワード",
            "type": "string"
        },
        "matchType": {
            "description": "推奨キーワードのマッチタイプ",
            "type": "string"
        }
    }
}

エラー

開発者メモで説明されているエラーオブジェクトの戻り値形式を参照してください。

Amazon Advertising logo