This document provides information required when creating subscriptions for Openbridge products.
These products pull reports from resources attributed to the Amazon Advertising API.
This product requires a call to the service API to get the requisit information for the subscription product meta.
The first call that needs to be made is to the Amazon Advertising profiles endpoint. This endpoint will return a list of Amazon Advertising profiles based on the requested type. This list will provide the profile_id meta data. If you need more information to display you can request the brand information for the profiles by calling the Amazon Advertising Profile Brands endpoint. You can pass up to five profile IDs to retrieve their brand information simultaniously. If you had more than five profiles you would need to iterate through them in groups of five to get them all.
Product Attributes
Key Value Product ID 70 Remote Identity Type ID 14
Required Subscription Product Meta
Data Key Data Format Value Data Value profile_id STRINGAssociated profile ID. remote_identity_id STRINGRemote identity associated with the associated profile.
This product requires a call to the service API to get the requisit information for the subscription product meta.
The first call that needs to be made is to the Amazon Advertising profiles endpoint. This endpoint will return a list of Amazon Advertising profiles based on the requested type. This list will provide the profile_id meta data. If you need more information to display you can request the brand information for the profiles by calling the Amazon Advertising Profile Brands endpoint. You can pass up to five profile IDs to retrieve their brand information simultaniously. If you had more than five profiles you would need to iterate through them in groups of five to get them all.
Product Attributes
Key Value Product ID 75 Remote Identity Type ID 14
Required Subscription Product Meta
Data Key Data Format Value Data Value profile_id STRINGAssociated profile ID. remote_identity_id STRINGRemote identity associated with the associated profile.
This product requires a call to the service API to get the requisit information for the subscription product meta.
The first call that needs to be made is to the Amazon Advertising profiles endpoint. This endpoint will return a list of Amazon Advertising profiles based on the requested type. This list will provide the profile_id meta data. If you need more information to display you can request the brand information for the profiles by calling the Amazon Advertising Profile Brands endpoint. You can pass up to five profile IDs to retrieve their brand information simultaniously. If you had more than five profiles you would need to iterate through them in groups of five to get them all.
Product Attributes
Key Value Product ID 50 Remote Identity Type ID 14
Required Subscription Product Meta
Data Key Data Format Value Data Value profile_id STRINGAssociated profile ID. remote_identity_id STRINGRemote identity associated with the associated profile.
Product Attributes
Key Value Product ID 54 Remote Identity Type ID 14
Required Subscription Product Meta
Data Key Data Format Value Data Value profile_id STRINGAssociated profile ID. This field is an empty string for Amazon managed accounts remote_identity_id STRINGRemote identity associated with the associated profile. account_id STRINGRemote identity associated with the associated profile. managed STRINGtruefor Amazon managed accountsfalsefor non managed accounts .advertiser_ids JSONA stringified array of Attribution advertiser IDs. In case of an Amazon managed accounts it should be an empty array [].
This product does not require any additional calls to the openbridge service API.
Product Attributes
Key Value Product ID 53 Remote Identity Type ID 17
Required Subscription Product Meta
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile.
This product does not require any additional calls to the openbridge service API.
Product Attributes
Key Value Product ID 55 Remote Identity Type ID 17
Required Subscription Product Meta
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile.
This product does not require any additional calls to the openbridge service API.
Product Attributes
Key Value Product ID 56 Remote Identity Type ID 17
Required Subscription Product Meta
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile.
This product does not require any additional calls to the openbridge service API.
Product Attributes
Key Value Product ID 57 Remote Identity Type ID 17
Required Subscription Product Meta
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile.
This product does not require any additional calls to the openbridge service API.
Product Attributes
Key Value Product ID 58 Remote Identity Type ID 17
Required Subscription Product Meta
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile.
This product does not require any additional calls to the openbridge service API.
Product Attributes
Key Value Product ID 60 Remote Identity Type ID 17
Required Subscription Product Meta
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile.
This product does not require any additional calls to the openbridge service API.
Product Attributes
Key Value Product ID 61 Remote Identity Type ID 17
Required Subscription Product Meta
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile.
This product does not require any additional calls to the openbridge service API.
Product Attributes
Key Value Product ID 62 Remote Identity Type ID 17
Required Subscription Product Meta
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile.
This product does not require any additional calls to the openbridge service API.
Product Attributes
Key Value Product ID 64 Remote Identity Type ID 17
Required Subscription Product Meta
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile.
This product does not require any additional calls to the openbridge service API.
Product Attributes
Key Value Product ID 65 Remote Identity Type ID 17
Required Subscription Product Meta
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile.
This product does not require any additional calls to the openbridge service API.
Product Attributes
Key Value Product ID 66 Remote Identity Type ID 18
Required Subscription Product Meta
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile.
This product does not require any additional calls to the openbridge service API.
Product Attributes
Key Value Product ID 67 Remote Identity Type ID 18
Required Subscription Product Meta
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile.
This product does not require any additional calls to the openbridge service API.
Product Attributes
Key Value Product ID 69 Remote Identity Type ID 18
Required Subscription Product Meta
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile.
This product does not require any additional calls to the openbridge service API.
Product Attributes
Key Value Product ID 72 Remote Identity Type ID 18
Required Subscription Product Meta
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile.
Amazon Catalog Keyword Tracker requires no additional API lookups with the Openbridge Service API.
Product Attributes
Key Value Product ID 82 Remote Identity Type ID 17 or 18
Required Subscription Product Meta
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile. keywords STRINGA stringified JSON array of keywords. The limit is 100 keywords to prevent Amazon API rate limiting. Subscriptions with more than 100 may fail to generate reports. subproduct_id STRINGThis product requires a subproduct id which will always be the string keywords.
Amazon Catalog API requires no additional API lookups with the Openbridge Service API. However, it is recommended that when choosing the id_type of ASIN that you use the Openbridge Service API for validating ASIN numbers if you are not 100% sure the ASINs you are providing are correct.
Product Attributes
Key Value Product ID 82 Remote Identity Type ID 17 or 18
Required Subscription Product Meta
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile. ids STRINGA stringified JSON array of ids of the type defined by id_type. The limit should be 100 ids to prevent Amazon API rate limiting. Subscriptions with more than 100 may fail to generate reports.identity_type STRINGsellerorvendordepending if the identity type is a seller or a vendor identity.id_type STRINGThe catalog API can be used to request reports on different types of identifiers. ASIN,EAN,GTIN,ISBN,JAN,MINSAN,SKU, andUPC. Note: thatSKUtypes can not be used withvendortype identities due to permission restrictions.subproduct_id STRINGThis product requires a subproduct id which will always be the string identifiers.
Facebook marketing requires a Facebook Ad account ID that is connected to the authorized identity attached to the subscription. A list of available Facebook Ad account IDs can be requested with the Facebook Ads endpoint on the Openbridge Service API.
Product Attributes
Key Value Product ID 11 Remote Identity Type ID 2
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile. ad_account_id STRINGFacebook marketing account ID.
Facebook marketing requires a Facebook Page account ID that is connected to the authorized identity attached to the subscription. A list of available Facebook Page account IDs can be requested with the Facebook Page Profiles endpoint on the Openbridge Service API. Product Attributes
Key Value Product ID 2 Remote Identity Type ID 2
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile. account_id STRINGFacebook page account ID.
Instagram Insights requires a Instagram account ID that is connected to the authorized identity attached to the subscription. As well as the Facebook page ID that the instagram account is connected too. A list of available Facebook Page account IDs and their attached Instagram Account Ids can be requested with the Facebook Page Profiles endpoint on the Openbridge Service API.
Product Attributes
Key Value Product ID 34 Remote Identity Type ID 2
Required Subscription Product Meta
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile. account_id STRINGInstagram account ID. fb_account_id STRINGFacebook page account ID.
Instagram Stories requires a Instagram account ID that is connected to the authorized identity attached to the subscription. As well as the Facebook page ID that the instagram account is connected too. A list of available Facebook Page account IDs and their attached Instagram Account Ids can be requested with the Facebook Page Profiles endpoint on the Openbridge Service API.
Product Attributes
Key Value Product ID 38 Remote Identity Type ID 2
Required Subscription Product Meta
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile. account_id STRINGInstagram account ID. fb_account_id STRINGFacebook page account ID.
Google Ads requires a manager customer ID and client customer ID associated with the remote identity attached to the subsciption. A list of available manager customer and client customer IDs can be requested from the Openbridge Service API.
Product Attributes
Key Value Product ID 63 Remote Identity Type ID 1
Required Subscription Product Meta
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile. manager_customer_id STRINGThe manager id that manages the client_customer_id. client_customer_id STRINGThe client's customer id where the reports reside.
Google Analytics 360 requires a project ID and dataset ID associated with the remote identity attached to the subsciption. A list of available project and dataset IDs can be requested with the Google Ads endpoint on the Openbridge Service API.
Product Attributes
Key Value Product ID 3 Remote Identity Type ID 1
Required Subscription Product Meta
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile. project_id STRINGProject ID associated with the Google BigQuery associated with the Google Analytics account. dataset_id STRINGDataset ID associated with the Google BigQuery associated with the Google Analytics account.
Google Campaign Manager requires a profile ID and report ID associated with the remote identity attached to the subsciption. A list of available profile can be requested with the Google Campaign Manager Profiles endpoint on the Openbridge Service API and report IDs can be requested with the Google Campaign Manager Profiles endpoint
Product Attributes
Key Value Product ID 4 Remote Identity Type ID 1
Required Subscription Product Meta
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile. dfa_profile_id STRINGCampaign Manager profile ID. dfa_report_id STRINGCampaign report ID.
Google Search Ads 360 requires a profile ID and report ID associated with the remote identity attached to the subsciption. A list of available profile and report IDs can be requested with the Google Search Ads 360 endpoint on the Openbridge Service API.
Product Attributes
Key Value Product ID 7 Remote Identity Type ID 1
Required Subscription Product Meta
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile. agency_id STRINGAgency id associated with the desired reports. advertiser_id STRINGAdvertiser id associated with the desired reports.
Shopify 360 requires the shop creation date associated with the remote identity attached to the subsciption. Shopify info can be requested with the Shopify Info endpoint on the Openbridge Service API.
Product Attributes
Key Value Product ID 44 Remote Identity Type ID 16
Required Subscription Product Meta
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile. shop_created_at STRINGTHe shop creation date in the format of YYYY-mm-dd example 2010-03-01 for March 1st 2010. This information is provided by the shop info endpoint.
Youtube Channel Insights requires a channgel ID associated with the remote identity attached to the subsciption. A list of available channgel ID can be requested from the Openbridge Service API.
Product Attributes
Key Value Product ID 17 Remote Identity Type ID 1
Required Subscription Product Meta
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile. channel_id STRINGYoutube associated channel ID.
Youtube Competitor Channels requires a list of channel ids as a stringified JSON array. The Openbridge service API allows you to get youtube channel IDs based on various Youtube URLs. You can provide a maximum of 7 IDs per subscription.
Product Attributes
Key Value Product ID 18 Remote Identity Type ID 1
Required Subscription Product Meta
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile. channel_ids JSONRemote identity associated with the associated profile.
Youtube Competitor Channels requires a list of channel ids as a stringified JSON array. The Openbridge service API allows you to get youtube channel IDs based on various Youtube URLs. You can provide a maximum of 7 IDs per subscription.
Product Attributes
Key Value Product ID 15 Remote Identity Type ID 1
Required Subscription Product Meta
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile. channel_ids JSONRemote identity associated with the associated profile.
Youtube Video Insights requires a channgel ID associated with the remote identity attached to the subsciption. A list of available channgel ID can be requested from the Openbridge Service API.
Product Attributes
Key Value Product ID 26 Remote Identity Type ID 1
Required Subscription Product Meta
Data Key Data Format Value Data Value remote_identity_id STRINGRemote identity associated with the associated profile. channel_id STRINGYoutube associated channel ID.