プロダクト広告

警告

これらのエンドポイントは、2023年6月30日に廃止されます。今後は、スポンサープロダクト広告バージョン3プロダクト広告をご利用ください。詳細については、廃止予定のページをご覧ください。

スポンサープロダクト広告で、プロダクト広告を作成、閲覧、更新、削除するために使用します。次の表は、サービスの管理対象リソースによってサポートされる URL空間とHTTPメソッドに関するサービスの動作を示しています。

メソッド	URL	ユースケース
GET	`/productAds/{adId}`	IDを指定してプロダクト広告を取得します
GET	`/productAds/extended/{adId}`	IDを指定して、プロダクト広告およびその他のプロパティを取得します
POST	`/productAds`	1つ以上のプロダクト広告を作成します
PUT	`/productAds`	1つ以上のプロダクト広告を更新します
DELETE	`/productAds/{adId}`	単一のプロダクト広告を非表示にします。非表示にされたエンティティを再度アクティブにすることはできません。詳細については、開発者メモをご覧ください。
GET	`/productAds?startIndex={startIndex}&count={count}&campaignType={campaignType}&adGroupId={adGroupId}&sku={sku}&asin={asin}&stateFilter={stateFilter}&campaignIdFilter={campaignIdFilter}&adGroupIdFilter={adGroupIdFilter}`	指定した条件に基づいてプロダクト広告のリストを返します
GET	/productAds/extended?startIndex={startIndex}&count={count}&campaignType={campaignType}&adGroupId={adGroupId}&sku={sku}&asin={asin}&stateFilter={stateFilter}&campaignIdFilter={campaignIdFilter}&adGroupIdFilter={adGroupIdFilter}	指定した条件に基づいて、プロダクト広告とその他のプロパティのリストを返します

操作

getProductAd

GET /productAds/{adId}

IDを指定してプロダクト広告を取得します。この呼び出しは、最小限のプロダクト広告フィールドを返しますが、getProductAdExより効率的です。

パラメーター

パラメーター名	タイプ	説明
`adId`	string	リクエストされたプロダクト広告のID

レスポンス

ステータスコード	レスポンスオブジェクト
`200 - success`	ProductAdEx
`401 - unauthorized`	Error
`404 - ad not found`	Error

getProductAdEx

GET /productAds/extended/{adId}

IDを指定して、プロダクト広告とその拡張フィールドを取得します。この呼び出しは、プロダクト広告フィールドをすべて（配信ステータスおよびその他の読み取り専用フィールドを含む）返しますが、 getProductAdより非効率的です。

パラメーター

パラメーター名	タイプ	指定対象	説明
`adId`	string	URLパス	リクエストされたプロダクト広告のID

レスポンス

ステータスコード	レスポンスオブジェクト
`200 - success`	`ProductAd`
`401 - unauthorized`	`Error`
`404 - ad not found`	`Error`

createProductAds

POST /productAds

プロダクト広告を1つ以上作成します。正常に作成されたプロダクト広告には、固有のadIdが割り当てられます。

パラメーター

タイプ	指定対象	説明
`ProductAd`のリスト	本文	作成される、最大1000個のプロダクト広告のリスト。プロダクト広告の作成に必要なフィールドは、`campaignId`、`adGroupId`、`SKU`、`state`です

レスポンス

ステータスコード	レスポンスオブジェクト
`207 multi-status`	入力順に示される`AdResponse`のリスト
`401 - unauthorized`	`Error`

updateProductAds

PUT /productAds

プロダクト広告を1つ以上更新します。プロダクト広告はadIdで識別されます。

パラメーター

タイプ	指定対象	説明
`ProductAd`のリスト	本文	`adId`および変更される変更可能フィールドを含む、最大1000件の更新内容のリスト。変更可能フィールド：`state`

レスポンス

ステータスコード	レスポンスオブジェクト
`207 – multi-status`	入力順に示される`AdResponse`のリスト
`401 - unauthorized`	`Error`

archiveProductAd

DELETE /productAds/{adId}

プロダクト広告ステータスを非表示に設定します。更新によってもこの同じ操作を実行できますが、完全を期すために含めています。非表示のエンティティを再度有効化することはできません。詳細については、開発者メモをご覧ください。

パラメーター

パラメーター名	タイプ	指定対象	説明
`adId`	string	URLパス	非表示にするプロダクト広告のID。

レスポンス

ステータスコード	レスポンスオブジェクト
`200 - success`	`AdResponse`
`401 - unauthorized`	`Error`
`404 - ad not found`	`Error`

listProductAds

GET /productAds/                                                           
  ?startIndex={startIndex}              
  &count={count}                        
  &campaignType={campaignType}                                   
  &stateFilter={stateFilter}            
  &campaignIdFilter={campaignIdFilter}  
  &adGroupIdFilter={adGroupIdFilter}

オプションの条件を満たすプロダクト広告のリストを取得します。

パラメーター

パラメーター名	タイプ	指定対象	説明
`startIndex`	integer	URLクエリ	オプション。結果セットのインデックスが0のレコードオフセット。デフォルトは0です。
`count`	integer	URLクエリ	オプション。ページングされたレスポンスに含めるレコードの数。デフォルトで、最大ページサイズに設定されます。
`campaignType`	string	URLクエリ	オプション。指定されたタイプのキャンペーンに属する広告に関する結果のみを返します。指定できるのは`sponsoredProducts`のみです。

`adGroupId`	string	URLクエリ	オプション。指定された`adGroupId`を持つプロダクト広告に関する結果のみを返します。
`stateFilter`	string	URLクエリ	オプション。カンマ区切りリストで指定された状態の広告に関する結果のみを返します。`enabled`、`paused`、`archived`のいずれかにする必要があります。デフォルトの動作では、これらすべてが含められます。
`campaignIdFilter`	string	URLクエリ	オプション。カンマ区切りリストで指定されたキャンペーン内の広告に関する結果のみを返します。
`adGroupIdFilter`	string	URLクエリ	オプション。カンマ区切りリストで指定された広告グループ内の広告に関する結果のみを返します。
`adIdFilter`	string	URLクエリ	オプション。カンマ区切りリストで指定されている、特定のプロダクト`adId`を持つ広告に関する結果のみを返します。

レスポンス

ステータスコード	レスポンスオブジェクト
`200 - success`	`ProductAd`のリスト
`401 - unauthorized`	`Error`

listProductAdsEx

  GET /adGroups/extended               
    ?startIndex={startIndex}              
    &count={count}                        
    &campaignType={campaignType}
    &adGroupId={adGroupId}          
    &stateFilter={stateFilter}            
    &campaignIdFilter={campaignIdFilter}  
    &adGroupIdFilter={adGroupIdFilter}

オプションの基準を満たす拡張フィールドを持つプロダクト広告のリストを取得します。

パラメーター

パラメーター名	タイプ	指定対象	説明
`startIndex`	integer	URLクエリ	オプション。結果セットのインデックスが0のレコードオフセット。デフォルトは0です。
`count`	integer	URLクエリ	オプション。ページングされたレスポンスに含めるレコードの数。デフォルトで、最大ページサイズに設定されます。
`campaignType`	string	URLクエリ	オプション。指定されたタイプのキャンペーンに属する広告に関する結果のみを返します。指定できるのは`sponsoredProducts`のみです。
`adGroupId`	string	URLクエリ	オプション。指定された`adGroupId`を持つプロダクト広告に関する結果のみを返します。
`stateFilter`	string	URLクエリ	オプション。カンマ区切りリストで指定された状態の広告に関する結果のみを返します。`enabled`、`paused`、`archived`のいずれかにする必要があります。デフォルトの動作では、これらすべてが含められます。
`campaignIdFilter`	string	URLクエリ	オプション。カンマ区切りリストで指定されたキャンペーン内の広告に関する結果のみを返します。
`adGroupIdFilter`	string	URLクエリ	オプション。カンマ区切りリストで指定された広告グループ内の広告に関する結果のみを返します。
`adIdFilter`	string	URLクエリ	オプション。カンマ区切りリストで指定されている、特定のプロダクト広告IDを持つ広告に関する結果のみを返します。

レスポンス

ステータスコード	レスポンスオブジェクト
`200 - success`	`ProductAdEx`のリスト
`401 - unauthorized`	`Error`

リソースの表現

ProductAd

{
    "title": "ProductAd",
    "type": "object",
    "properties": {
       "adId": {
           "description": "The ID of the product ad",
           "type": "number"
       },
       "campaignId": {
           "description": "The ID of the campaign to which this product ad belongs",
           "type": "number"
       },
       "adGroupId": {
           "description": "The ID of the ad group to which this product ad belongs",
           "type": "number"
       },      
       "sku": {
           "description": "The SKU for the listed product to be advertised.Either this or the asin must be present.",
           "type": "string"
       },    
       "asin": {
           "description": "The ASIN for the listed product to be advertised",
           "type": "string"
       },       
       "state": {
           "description": "Advertiser-specified state of the product ad",
           "type": "string",
           "oneOf": ["enabled", "paused", "archived"]
       }
    }
}

ProductAdEx

{
    "title": "ProductAdEx",
    "type": "object",
    "properties": {
       "adId": {
           "description": "The ID of the product ad",
           "type": "number"
       },
       "campaignId": {
           "description": "The ID of the campaign to which this product ad belongs",
           "type": "number"
       },
       "adGroupId": {
           "description": "The ID of the ad group to which this product ad belongs",
           "type": "number"
       },
       "sku": {
           "description": "The SKU for the listed product to be advertised.Either this or the asin must be present.",
           "type": "string"
       },    
       "asin": {
           "description": "The ASIN for the listed product to be advertised",
           "type": "string"
       },       
       "state": {
           "description": "Advertiser-specified state of the product ad",
           "type": "string",
           "oneOf": ["enabled", "paused", "archived"]
       },
       "creationDate": {
           "description": "The date the ad group was created as epoch time in milliseconds",
           "type": "number"
       },
       "lastUpdatedDate": {
           "description": "The date the ad group was last updated as epoch time in milliseconds",
           "type": "number"
       },
       "servingStatus": {
           "description": "The computed status, accounting for out of budget, policy violations, etc.See developer notes for more information.",
           "type": "string",
           "oneOf": ["AD_ARCHIVED", "AD_PAUSED", "AD_STATUS_LIVE", "AD_POLICING_SUSPENDED", "CAMPAIGN_OUT_OF_BUDGET", "AD_GROUP_PAUSED", "AD_GROUP_ARCHIVED", "CAMPAIGN_PAUSED", "CAMPAIGN_ARCHIVED", "ACCOUNT_OUT_OF_BUDGET", "MISSING_DECORATION"]
       }
    }
}

AdResponse

{
    "title": "AdResponse",
    "type": "object",
    "properties": {
       "adId": {
           "description": "The ID of the ad that was created/updated, if successful",
           "type": "number"
       },
       "code": {
           "description": "An enumerated success or error code for machine use.",
           "type": "string"
       },
       "details": {
           "description": "A human-readable description of the error, if unsuccessful",
           "type": "string"
       }
    }
}

Error

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

開発者ガイドの概要

Amazon Ads APIの概要

プロダクト広告

警告

操作

getProductAd

パラメーター

レスポンス

getProductAdEx

パラメーター

レスポンス

createProductAds

パラメーター

レスポンス

updateProductAds

パラメーター

レスポンス

archiveProductAd

パラメーター

レスポンス

listProductAds

パラメーター

レスポンス

listProductAdsEx

パラメーター

レスポンス

リソースの表現

ProductAd

ProductAdEx

AdResponse

Error