From fa744729274ebabb1297989fae33f31bfec1fc4e Mon Sep 17 00:00:00 2001 From: James Andrews Date: Wed, 25 Oct 2023 19:44:09 +0900 Subject: [PATCH 1/3] Amazon Advertising Profiles endpoint documented. --- README.md | 102 ++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 99 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e84df7e..757964d 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,8 @@ Welcome to the Openbridge API documentation. This guide is designed to help deve - [Authorization API](#authorization-api) - [Account API](#account-api) - [Service API](#service-api) + - [Amazon Advertising Profiles](#amazon-advertising-profiles) + - [Amazon Advertising Profile Brands](#amazon-advertising-profiles-brands) - [History](#history-transaction-creation) - [Remote Identity API](#remote-identity-api) - [Subscription API](#subscription-api) @@ -364,12 +366,106 @@ From the example response, the `accountId` is `data.id` and the `userId` is `dat ## Service API -### History Transaction Creatio +### Amazon Advertising Profiles
- POST https://service.api.openbridge.io/service/history/production/history/{{subscriptionId}} -The History endpoint is used for generating history requests for subscriptions where history is allowed. Not all products can generate history requests. + GET https://localhost:4300/api/service/service/amzadv/profiles-only/{{remoteIdentityId}}?profile_types={{profileType(s)}} + + The Amazon Advertising Profiles service endpoint is use to get a list of profiles based on type(s) of profile that you need. + +###### Payload Schema + +> ```json +> { +> data: { +> id: number +> type: 'AmazonAdvertisingProfile', +> attributes: { +> country_code: string; +> currency_code: string, +> daily_budget: number, +> timezone: string, +> account_info: { +> id: string, +> type: string, +> attributes: { +> marketplace_country: string, +> marketplace_string_id: string, +> name: string, +> type: string, +> subType: string, +> valid_payment_method: boolean +> } +> } +> } +> } +> } +> ``` + + +The request endpoint of the AmazonAdvertisingProfile will require the remote identity id, and the profile types you are quering. Depending on the product you are creating a subscription for you will need to request the correct profile types. The profile types parameter is comma separated list of valid types. The table below will show what types for which products. + +> | product name | profile types | +> |-|-| +> | `Amazon Advertising (SB/SD)` | seller,vendor | +> | `Amazon Advertising (SP)` | seller,vendor | +> | `Amazon Advertising Ads Recommendations` | seller,vendor | +> | `Amazon Advertising Brand Metrics` | seller,vendor | +> | `Amazon Attribution` | attribution | +> | `Amazon DSP` | dsp | + +##### Headers + +> | name | data type | description | +> |-|-|-| +> | Content-Type | string | application/json +> | Authorization | string | Openbridge JWT, passed as a authorization bearer type + + +##### Parameters +> | name | data type | description | +> |-|-|-| +> | profile_types | string | Amazon advertising profile type(s). (see the list above) + + +##### Responses + +> | http code | content-type | response | +> |-|-|-| +> | `200` | `application/json` | `OK` | + +##### Example cURL + +This example is for an Amazon Selling Partner Sales & Traffic product. + +> ```curl +> curl -H "Content-Type: application/json" -X GET https://service.api.openbridge.io/service/amzadv/profiles-only/{{remoteIdentityId}}?profile_types={{profileTypes}} +> ``` + +
+ +### Amazon Advertising Profile Brands + + + + + + + + + + + + + + +### History Transaction Creation + +
+ POST https://service.api.openbridge.io/service/history/production/history/{{subscriptionId}} + + The History endpoint is used for generating history requests for subscriptions where history is allowed. Not all products can generate history requests. ###### Payload Schema From 02a2ee870946d394cfd451175bfb6d29ae099eb9 Mon Sep 17 00:00:00 2001 From: James Andrews Date: Wed, 25 Oct 2023 21:28:50 +0900 Subject: [PATCH 2/3] profile brands update --- README.md | 99 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 71 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 757964d..70c567d 100644 --- a/README.md +++ b/README.md @@ -370,11 +370,52 @@ From the example response, the `accountId` is `data.id` and the `userId` is `dat
- GET https://localhost:4300/api/service/service/amzadv/profiles-only/{{remoteIdentityId}}?profile_types={{profileType(s)}} + GET https://service.api.openbridge.io/service/amzadv/profiles-only/{{remoteIdentityId}}?profile_types={{profileType(s)}} The Amazon Advertising Profiles service endpoint is use to get a list of profiles based on type(s) of profile that you need. -###### Payload Schema + + + The request endpoint of the AmazonAdvertisingProfile will require the remote identity id, and the profile types you are quering. Depending on the product you are creating a subscription for you will need to request the correct profile types. The profile types parameter is comma separated list of valid types. The table below will show what types for which products. + +> | product name | profile types | +> |-|-| +> | `Amazon Advertising (SB/SD)` | seller,vendor | +> | `Amazon Advertising (SP)` | seller,vendor | +> | `Amazon Advertising Ads Recommendations` | seller,vendor | +> | `Amazon Advertising Brand Metrics` | seller,vendor | +> | `Amazon Attribution` | attribution | +> | `Amazon DSP` | dsp | + +##### Headers + +> | name | data type | description | +> |-|-|-| +> | Content-Type | string | application/json +> | Authorization | string | Openbridge JWT, passed as a authorization bearer type + + +##### Parameters +> | name | data type | description | +> |-|-|-| +> | profile_types | string | Amazon advertising profile type(s). (see the list above) + + +##### Responses + +> | http code | content-type | response | +> |-|-|-| +> | `200` | `application/json` | `OK` | + +##### Example cURL + +This example is for retrieving Amazon Advertising Profiles. + +> ```curl +> curl -H "Content-Type: application/json" -X GET https://service.api.openbridge.io/service/amzadv/profiles-only/{{remoteIdentityId}}?profile_types={{profileTypes}} +> ``` + +###### Example Response > ```json > { @@ -404,16 +445,17 @@ From the example response, the `accountId` is `data.id` and the `userId` is `dat > ``` -The request endpoint of the AmazonAdvertisingProfile will require the remote identity id, and the profile types you are quering. Depending on the product you are creating a subscription for you will need to request the correct profile types. The profile types parameter is comma separated list of valid types. The table below will show what types for which products. +
-> | product name | profile types | -> |-|-| -> | `Amazon Advertising (SB/SD)` | seller,vendor | -> | `Amazon Advertising (SP)` | seller,vendor | -> | `Amazon Advertising Ads Recommendations` | seller,vendor | -> | `Amazon Advertising Brand Metrics` | seller,vendor | -> | `Amazon Attribution` | attribution | -> | `Amazon DSP` | dsp | +### Amazon Advertising Profile Brands + +
+ + GET https://service.api.openbridge.io/service/amzadv/brands/{{remoteIdentityId}}?profiles={{profileIds}} + +The Amazon Advertising Profile Brands service endpoint is use to get additional meta data about Amazon Advertising profiles. + +The request endpoint of the AmazonAdvertisingProfile will require the remote identity id, and the profile types you are quering. Depending on the product you are creating a subscription for you will need to request the correct profile types. The profile types parameter is comma separated list of valid types. The table below will show what types for which products. ##### Headers @@ -426,7 +468,7 @@ The request endpoint of the AmazonAdvertisingProfile will require the remote ide ##### Parameters > | name | data type | description | > |-|-|-| -> | profile_types | string | Amazon advertising profile type(s). (see the list above) +> | profiles | string | A csv list of profile IDs valid for the provided remote identity id. ##### Responses @@ -437,28 +479,29 @@ The request endpoint of the AmazonAdvertisingProfile will require the remote ide ##### Example cURL -This example is for an Amazon Selling Partner Sales & Traffic product. +This example is for retrieving Amazon Advertising Profile Brands. > ```curl -> curl -H "Content-Type: application/json" -X GET https://service.api.openbridge.io/service/amzadv/profiles-only/{{remoteIdentityId}}?profile_types={{profileTypes}} +> curl -H "Content-Type: application/json" -X GET https://service.api.openbridge.io/service/amzadv/brands/{{remoteIdentityId}}?profiles={{profileIds}} > ``` -
- -### Amazon Advertising Profile Brands - - - - - - - - - - - +###### Example Response +> ```json +> { +> data: { +> id: number +> type: 'AmazonAdvertisingProfileBrand', +> attributes: { +> brand_entity_id: string; +> brand_registry_name: string, +> profile_id: string, +> } +> } +> } +> ``` +
### History Transaction Creation From 02a57ef91bd6f4553a6a7d6185af9e9f4713a42d Mon Sep 17 00:00:00 2001 From: James Andrews Date: Wed, 25 Oct 2023 21:43:50 +0900 Subject: [PATCH 3/3] updated change log --- CHANGELOG.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 01c2a99..e0cca95 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,14 @@ All notable changes to this project will be documented in this file. +## [0.0.3] - 2023-10-11 + +### Added +- API endpoints for Amazon Advertising Profile lists and Amazon Advertising Profile Brand list + +### Fixed +- Fixed typos and html formatting bugs. + ## [0.0.2] - 2023-10-11 ### Added