開発者ガイドの概要

Amazon Ads APIの概要

マネージャーアカウント

マネージャーアカウントを使用して、広告主様と代理店は、複数の広告アカウントを紐づけることができます。つまり、広告コンソールで、1つのダッシュボードから、ユーザーの管理、請求の処理、アカウントレベルのアラート、インサイト、パフォーマンス指標の表示を行えます。

マネージャーアカウントは、コンソールまたはAmazon Ads APIのPOST /managerAccountsエンドポイントで作成できます。どのAmazonユーザーアカウントでもマネージャーアカウントを作成できます。1つのAmazonユーザーアカウントで、複数のマネージャーアカウントを作成することができます。

認可

Amazon Ads APIでマネージャーアカウントを使用するには、クライアントアプリケーションが、マネージャーアカウントへのアクセス権を持っているAmazonユーザーアカウントからの許可を表すアクセストークンを渡します。このアクセストークンによって、クライアントアプリケーションは、マネージャーアカウントのリンクアカウントの代わりとしてAPIにリクエストを行うことを許可されます。

権限

サードパーティが所有するスポンサー広告リンクアカウントは、マネージャーアカウントに対して編集者または閲覧者のどちらの権限を有効にするかをコンソールで選択できます。リンクアカウントの編集者の権限を持つマネージャーアカウントは、そのアカウントの代わりとしてAPIであらゆる操作を実行できます。

閲覧者の権限を持つマネージャーアカウントは、データにアクセスしてレポートを生成することができますが、編集者の権限を必要とするリクエストを行うと、401 Unauthorized応答が返されます。

プロフィール

APIへのリクエストで特定のリンクアカウントのプロフィールIDを使用して、そのアカウントのデータやサービスにアクセスすることができます。GET /managerAccountsエンドポイントからの応答に、スポンサー広告の各リンクアカウントのプロフィールIDが含まれます。

さらに、GET /profilesエンドポイントでは、認可されたユーザーが所有するマネージャーアカウントに編集者の権限を与えたすべてのスポンサー広告の広告アカウントと、ユーザーアカウントが直接所有するプロフィールが返されます。

マネージャーアカウントはグローバルで使用されていますか?

マネージャーアカウントは、いかなるマーケットプレイス、またはマーケットプレイスの組み合わせであってもリンクアカウントを受け入れることが可能です。

APIで、マネージャーアカウントが特定のリンクアカウントにアクセスできるのは、そのリンクアカウントの地域のAPIホストを呼び出す場合に限られます。マネージャーアカウントによるGET /profilesおよびGET /managerAccountsのリクエストで返されるのは、呼び出したAPIホストで対応している地域内にマーケットプレイスがあるプロフィールのみとなります。

マネージドDSPアカウント

マネージドサービスDSPの広告主は、マネージャーアカウントを使用してレポーティングAPIを呼び出す必要があります。このプロセスにより、エンティティ管理者は、そのエンティティ内の1社以上の広告主用のマネージャーアカウントに読み取り専用の権限を付与できます。

DSPリンクアカウントは、「DSP_ADVERTISING_ACCOUNT」のaccountTypeGET /managerAccountsエンドポイントから返されます。リンクアカウントのdspAdvertiserIdフィールドをDSPレポートリクエストのアカウントIDとして使用します。

マネージャーアカウントは他にどこで使用できますか?

マネージャーアカウントでアクセス可能なのは、Amazon AdsのAPIまたはコンソールを使用してAmazon Adsのデータとサービスにアクセスする場合のみとなります。Amazonユーザーアカウントの他のサービス(セリングパートナーAPIなど)にアクセスするには、それらのサービスについて文書化されている認証方法を使用してください。

API操作

マネージャーアカウントを作成する

認可する側のユーザーアカウントで新しいマネージャーアカウントを作成するには、POST /managerAccountsへのリクエストを作成し、リクエスト本文にmanagerAccountNamemanagerAccountType(「Advertiser」または「Agency」のいずれか)の値を指定します。

{
    "managerAccountName": "string",
    "managerAccountType": "Advertiser"
}

各マネージャーアカウントが、リンクアカウントなしで作成されます。

マネージャーアカウントを一覧表示する

GET /managerAccountsからの応答には、認可する側のユーザーアカウントのすべてのマネージャーアカウントの一覧が含まれています。マネージャーアカウントごとに、最大50件のリンクアカウントが載ったリストが含まれます。

1つのマネージャーアカウントと1つのスポンサー広告リンクアカウントを持つユーザーの応答例:

{
    "managerAccounts": [
        {
            "linkedAccounts": [
                {
                    "accountId": "ENTITYxxxxxxxxxxx",
                    "accountName": "AdsCustomer, Inc.",
                    "accountType": "SELLER",
                    "dspAdvertiserId": "",
                    "marketplaceId": "ATVPDKIKX0DER",
                    "profileId": "xxxxxxxxxxxxxxxx"
                }
            ],
            "managerAccountId": "amzn1.ads1.ma1.xxxxxxxxxxxxxxxxxxxxxx",
            "managerAccountName": "my_manager_account"
        }
    ]
}

ヒント:マネージャーアカウントの管理

このAPIでは、マネージャーアカウントごとに最大50個のリンクアカウントが返されます。APIで50件以上のリンクアカウントを管理するために、同じユーザーアカウントで追加のマネージャーアカウントを作成することができます。

リンクアカウントの紐づけまたは紐づけの解除

広告コンソールを使用すると、手軽にマネージャーアカウントをリンクアカウントに紐づけることができます。アカウントをマネージャーアカウントにリンクする手順については、コンソールサポートセンターの「マネージャーアカウントにアカウントを追加する」をご覧ください。

APIにも、アカウントの紐づけを管理できるエンドポイントが2つあります。

POST /managerAccounts/{managerAccountId}/associateエンドポイントを使用するには、アクセストークンに紐づけられたユーザーアカウントに、広告主アカウントとマネージャーアカウントの両方に対する管理者アクセス権がなければなりません。

ヒント

このエンドポイントから紐づけることができるアカウントは、コンソールの「アカウントをリンク」の下にあるマネージャーアカウントの「アカウント」ビューに対応しています。

POST /managerAccounts/{managerAccountId}/disassociateエンドポイントの場合、必要な権限はマネージャーアカウントの権限だけです。