開発者ガイドの概要

Amazon Ads APIの概要

ラインアイテムのクリエイティブ追加または削除方法

前提条件

まだ完了していない場合は、このチュートリアルの前提条件を完了する必要があります。

このチュートリアルでは、以下が必要になります。

ラインアイテムへのクリエイティブの紐づける

クリエイティブをラインアイテムに紐づけるには、以下のフィールドの値が必要です。

ラインアイテム識別子

ラインアイテムリソースGET操作を使用して、ラインアイテム識別子を取得します。

クリエイティブ識別子

Amazon DSP APIでクリエイティブを操作する前に、Amazon DSPユーザーインターフェイスを使用してクリエイティブを作成しておく必要があります。クリエイティブを作成したら、クリエイティブリソースGET操作を使用してクリエイティブ識別子を取得します。

これらのフィールドの値を取得したら、ラインアイテムとクリエイティブの紐づけリソースPOST操作を使用して、クリエイティブとラインアイテムを紐づけます。以下のフィールドは必須です。

POST操作では、1つのクリエイティブと1つのラインアイテムの紐づけのみがサポートされることに注意してください。複数のクリエイティブを1つのラインアイテムに紐づける場合には、まずクリエイティブリソースGET操作を使用してクリエイティブのリストを取得する必要があります。次に、クリエイティブのリストをループし、各クリエイティブに対して上記で説明したようにラインアイテムとクリエイティブの紐づけリソースPOST操作を使用します。

ラインアイテムに紐づけられているクリエイティブの属性の更新

ラインアイテムに紐づけられているクリエイティブの属性を更新するには、以下のフィールドの値が必要です。

LineItemCreativeAssociation

ラインアイテムとクリエイティブの紐づけリソースGET操作を使用し、目的のラインアイテムの識別子を使用してLineItemCreativeAssociationオブジェクトのリストを取得します。リスト内の各オブジェクトを確認して、更新する属性を持つオブジェクトを見つけます。

次に、各オブジェクトの次のフィールドを更新できます。

最後に、ラインアイテムとクリエイティブの紐づけリソースPUT操作を使用して、更新されたオブジェクトをリクエストボディに含めて属性を更新します。

PUT操作では、1つのクリエイティブの属性の更新のみがサポートされることに注意してください。複数のクリエイティブの属性を更新するには、まずラインアイテムとクリエイティブの関連付けリソースGET操作を使用して、ラインアイテムとクリエイティブの紐づけリストを取得する必要があります。次に、クリエイティブのリストをループし、上記で説明したようにラインアイテムとクリエイティブの紐づけリソースPUT操作を使用します。

ラインアイテムからのクリエイティブの紐づけの解除

クリエイティブとラインアイテムの紐づけを削除するには、以下のフィールドの値が必要です。

LineItemCreativeAssociation

ラインアイテムとクリエイティブの紐づけリソースGET操作を使用し、目的のラインアイテムの識別子を使用してLineItemCreativeAssociationオブジェクトのリストを取得します。リスト内の各オブジェクトを確認して、紐づけを解除するオブジェクトを見つけます。

次に、ラインアイテムとクリエイティブの紐づけリソースPOST操作を使用して、クリエイティブとラインアイテムの紐づけを解除します。この操作のリクエストボディで、以下を指定します。

POST操作では、1つのクリエイティブと1つのラインアイテムの紐づけ解除のみがサポートされることに注意してください。複数のクリエイティブとラインアイテムの紐づけを解除するには、まずラインアイテムとクリエイティブの紐づけリソースGET操作を使用して、ラインアイテムとクリエイティブの紐づけリストを取得する必要があります。次に、クリエイティブのリストをループし、各クリエイティブに対して上記で説明したようにラインアイテムとクリエイティブの紐づけリソースPOST操作を使用します。