Amazon Ads API MCP

{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"Account":{"description":"Object representation of an Amazon Advertising account.","properties":{"accountId":{"description":"Id of the Amazon Advertising account.","type":"string"},"accountName":{"description":"The name given to the Amazon Advertising account.","type":"string"},"accountType":{"$ref":"#/components/schemas/AccountType"},"dspAdvertiserId":{"description":"The identifier of a DSP advertiser. Note that this value is only populated for accounts with type `DSP_ADVERTISING_ACCOUNT`. It will be `null` for accounts of other types.","type":"string"},"marketplaceId":{"description":"The identifier of the marketplace to which the account is associated. See [this table](https://docs.developer.amazonservices.com/en_US/dev_guide/DG_Endpoints.html) for `marketplaceId` mappings.","type":"string"},"profileId":{"description":"The identifier of a profile associated with the advertiser account. Note that this value is only populated for a subset of account types: `[ SELLER, VENDOR, MARKETING_CLOUD ]`. It will be `null` for accounts of other types.","type":"string"}},"type":"object"},"AccountRelationshipRole":{"description":"The type of a role used in account relationships.","enum":["ENTITY_OWNER","ENTITY_USER","ENTITY_VIEWER","SELLER_USER"],"type":"string"},"AccountToUpdate":{"description":"String identifier for an Amazon Advertising account or advertiser. `ACCOUNT_ID` is an identifier that is returned by the [Profiles resource](https://advertising.amazon.","properties":{"id":{"description":"Id of the Amazon Advertising account.","type":"string"},"roles":{"description":"The types of role that will exist with the Amazon Advertising account. Depending on account type, the default role will be ENTITY_USER or SELLER_USER. Only one role at a time is currently supported","items":{"$ref":"#/components/schemas/AccountRelationshipRole"},"type":"array"},"type":{"description":"The type of the Id","enum":["ACCOUNT_ID","DSP_ADVERTISER_ID"],"type":"string"}},"type":"object"},"AccountToUpdateFailure":{"description":"Object representation of an Amazon Advertising account or [DSP advertiser](https://advertising.amazon.com/API/docs/en-us/dsp-advertiser/#/) that failed to update.","properties":{"account":{"$ref":"#/components/schemas/AccountToUpdate"},"error":{"$ref":"#/components/schemas/ErrorDetail"}},"type":"object"},"AccountType":{"description":"Type of the Amazon Advertising account.","enum":["DSP_ADVERTISING_ACCOUNT","MARKETING_CLOUD","SELLER","VENDOR"],"type":"string"},"CreateManagerAccountRequest":{"description":"Request object that defines the fields required to create a Manager account.","properties":{"managerAccountName":{"description":"Name of the Manager account.","type":"string"},"managerAccountType":{"description":"Type of the Manager account, which indicates how the Manager account will be used. Use `Advertiser` if the Manager account will be used for **your own** products and services, or `Agency` if you are managing accounts **on behalf of your clients**.","enum":["Advertiser","Agency"],"type":"string"}},"type":"object"},"ErrorDetail":{"description":"The error response object.","properties":{"code":{"enum":["BAD_REQUEST","FORBIDDEN","INTERNAL_SERVICE_ERROR","TOO_MANY_REQUESTS","UNAUTHORIZED"],"type":"string"},"message":{"description":"A human-readable description of the error.","type":"string"}},"type":"object"},"GetManagerAccountsResponse":{"description":"Response containing a list of Manager Accounts that a given user has access to.","properties":{"managerAccounts":{"description":"List of Manager Accounts that the user has access to","items":{"$ref":"#/components/schemas/ManagerAccount","properties":{}},"type":"array"}},"type":"object"},"ManagerAccount":{"description":"Object representation of an Amazon Advertising Manager Account.","properties":{"linkedAccounts":{"items":{"$ref":"#/components/schemas/Account","properties":{}},"maxItems":50,"type":"array"},"managerAccountId":{"description":"Id of the Manager Account.","type":"string"},"managerAccountName":{"description":"The name given to a Manager Account.","type":"string"}},"type":"object"},"UpdateAdvertisingAccountsInManagerAccountRequest":{"description":"A list of Advertising accounts or advertisers to link/unlink with [Manager Account](https://advertising.amazon.com/help?ref_=a20m_us_blog_whtsnewfb2020_040120#GU3YDB26FR7XT3C8). User can pass a list with a maximum of 20 accounts/advertisers using any mix of identifiers.","properties":{"accounts":{"description":"List of Advertising accounts or advertisers to link/unlink with [Manager Account](https://advertising.amazon.com/help?ref_=a20m_us_blog_whtsnewfb2020_040120#GU3YDB26FR7XT3C8). User can pass a list with a maximum of 20 accounts/advertisers using any mix of identifiers.","items":{"$ref":"#/components/schemas/AccountToUpdate"},"type":"array"}},"type":"object"},"UpdateAdvertisingAccountsInManagerAccountResponse":{"description":"Link/Unlink Advertising account or advertiser Response","properties":{"failedAccounts":{"description":"List of Advertising accounts or advertisers failed to Link/Unlink with [Manager Account](https://advertising.amazon.com/help?ref_=a20m_us_blog_whtsnewfb2020_040120#GU3YDB26FR7XT3C8).","items":{"$ref":"#/components/schemas/AccountToUpdateFailure","properties":{}},"type":"array"},"succeedAccounts":{"description":"List of Advertising accounts or advertisers successfully Link/Unlink with [Manager Account](https://advertising.amazon.com/help?ref_=a20m_us_blog_whtsnewfb2020_040120#GU3YDB26FR7XT3C8).","items":{"$ref":"#/components/schemas/AccountToUpdate","properties":{}},"type":"array"}},"type":"object"}},"securitySchemes":{}},"info":{"title":"Manager Account","version":"3.0"},"openapi":"3.0.1","paths":{"/managerAccounts":{"get":{"description":"Returns all [manager accounts](https://advertising.amazon.com/help?ref_=a20m_us_blog_whtsnewfb2020_040120#GU3YDB26FR7XT3C8) that a user has access to, along with metadata for the Amazon Ads accounts t...","operationId":"getManagerAccountsForUser","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.getmanageraccountsresponse.v1+json":{"schema":{"$ref":"#/components/schemas/GetManagerAccountsResponse"}}},"description":"**Success** - operation succeeded."},"400":{"content":{},"description":"**Bad Request** - request failed because invalid parameters were provided. Ensure that all required parameters were provided."},"401":{"content":{},"description":"**Unauthorized** - request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{},"description":"**Forbidden** - request failed because user does not have access to a specified resource"},"429":{"content":{},"description":"**Too Many Requests** - request was rate-limited. Retry later."},"500":{"content":{},"description":"**Internal Service Error** - something failed in the server. Please try again later. If the issue persists, report an error."}},"summary":"Returns all manager accounts that a given Amazon Ads user has access to.","tags":["Manager Accounts"]},"post":{"description":"Creates a new Amazon Advertising [Manager account](https://advertising.amazon.com/help?ref_=a20m_us_blog_whtsnewfb2020_040120#GU3YDB26FR7XT3C8).","operationId":"createManagerAccount","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.createmanageraccountrequest.v1+json":{"schema":{"$ref":"#/components/schemas/CreateManagerAccountRequest"}}},"description":"Request object required to create a new Manager account.","required":true},"responses":{"200":{"content":{"application/vnd.manageraccount.v1+json":{"schema":{"$ref":"#/components/schemas/ManagerAccount"}}},"description":"**Success** - operation succeeded."},"400":{"content":{"application/vnd.manageraccount.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorDetail"}}},"description":"**Bad Request** - request failed because invalid parameters were provided. Ensure that all required parameters were provided."},"403":{"content":{"application/vnd.manageraccount.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorDetail"}}},"description":"**Forbidden** - request failed because the caller was not authorized to create a Manager account."},"429":{"content":{"application/vnd.manageraccount.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorDetail"}}},"description":"**Too Many Requests** - request was rate-limited. Retry later."},"500":{"content":{"application/vnd.manageraccount.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorDetail"}}},"description":"**Internal Service Error** - something failed in the server. Please try again later. If the issue persists, report an error."}},"summary":"Creates a new Amazon Advertising Manager account.","tags":["Manager Accounts"]}},"/managerAccounts/{managerAccountId}/associate":{"post":{"description":"Link Amazon Advertising accounts or advertisers with a [Manager Account](https://advertising.amazon.com/help?ref_=a20m_us_blog_whtsnewfb2020_040120#GU3YDB26FR7XT3C8).","operationId":"LinkAdvertisingAccountsToManagerAccountPublicAPI","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"Id of the Manager Account.","in":"path","name":"managerAccountId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.updateadvertisingaccountsinmanageraccountrequest.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateAdvertisingAccountsInManagerAccountRequest"}}},"required":true},"responses":{"207":{"content":{"application/vnd.updateadvertisingaccountsinmanageraccountresponse.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateAdvertisingAccountsInManagerAccountResponse"}}},"description":"**Multi-Status** - Some Advertising accounts or advertisers may not have been linked successfully."},"400":{"content":{"application/vnd.updateadvertisingaccountsinmanageraccountresponse.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorDetail"}}},"description":"**Bad Request** - request failed because invalid parameters were provided. Ensure that all required parameters were provided."},"401":{"content":{"application/vnd.updateadvertisingaccountsinmanageraccountresponse.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorDetail"}}},"description":"**Unauthorized** - request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.updateadvertisingaccountsinmanageraccountresponse.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorDetail"}}},"description":"**Forbidden** - request failed because user does not have access to a specified resource."},"429":{"content":{"application/vnd.updateadvertisingaccountsinmanageraccountresponse.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorDetail"}}},"description":"**Too Many Requests** - request was rate-limited. Retry later."},"500":{"content":{"application/vnd.updateadvertisingaccountsinmanageraccountresponse.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorDetail"}}},"description":"**Internal Service Error** - something failed in the server. Please try again later. If the issue persists, report an error."}},"summary":"Link Amazon Advertising accounts or advertisers with a Manager Account.","tags":["Manager Accounts"]}},"/managerAccounts/{managerAccountId}/disassociate":{"post":{"description":"Unlink Amazon Advertising accounts or advertisers with a [Manager Account](https://advertising.amazon.com/help?ref_=a20m_us_blog_whtsnewfb2020_040120#GU3YDB26FR7XT3C8).","operationId":"UnlinkAdvertisingAccountsToManagerAccountPublicAPI","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"Id of the Manager Account.","in":"path","name":"managerAccountId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.updateadvertisingaccountsinmanageraccountrequest.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateAdvertisingAccountsInManagerAccountRequest"}}},"required":true},"responses":{"207":{"content":{"application/vnd.updateadvertisingaccountsinmanageraccountresponse.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateAdvertisingAccountsInManagerAccountResponse"}}},"description":"**Multi-Status** - Some Advertising accounts or advertisers may not have been linked successfully."},"400":{"content":{"application/vnd.updateadvertisingaccountsinmanageraccountresponse.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorDetail"}}},"description":"**Bad Request** - request failed because invalid parameters were provided. Ensure that all required parameters were provided."},"401":{"content":{"application/vnd.updateadvertisingaccountsinmanageraccountresponse.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorDetail"}}},"description":"**Unauthorized** - request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.updateadvertisingaccountsinmanageraccountresponse.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorDetail"}}},"description":"**Forbidden** - request failed because user does not have access to a specified resource."},"429":{"content":{"application/vnd.updateadvertisingaccountsinmanageraccountresponse.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorDetail"}}},"description":"**Too Many Requests** - request was rate-limited. Retry later."},"500":{"content":{"application/vnd.updateadvertisingaccountsinmanageraccountresponse.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorDetail"}}},"description":"**Internal Service Error** - something failed in the server. Please try again later. If the issue persists, report an error."}},"summary":"Unlink Amazon Advertising accounts or advertisers with a Manager Account.","tags":["Manager Accounts"]}}}}