To facilitate a smooth transition to Ads Manager V2 (AMv2), AMv2 data will be integrated into our existing public RESTful APIs. This integration allows a smooth transition from Ads Manager V1 (AMv1) to AMv2, ensuring that our users can access the latest features without disruption.
AMv2 data is automatically available alongside AMv1 data in the following API endpoints:
GET /api/v1.0/creatives/{creativeId}/insightsGET /api/v1.0/accounts/{accountId}/insightsGET /api/v1.0/campaigns/{campaignId}/insightsGET /api/v1.0/campaigns/{campaignId}GET /api/v1.0/accounts/{accountId}/campaignsGET /api/v1.0/creatives/{creativeId}GET /api/v1.0/campaigns/{campaignId}/creatives
To maintain compatibility with existing workflows, it's important to understand how AMv2 objects map to the current API format. Below is a table that outlines these mappings:
| AMv2 Object | AMv1 API mapping |
|---|---|
| Campaign | Not directly mapped |
| Ad Group | Mapped to AMv1 Campaigns. |
| Ad | Mapped to AMv1 Creatives. |
AMv2 campaign data is not directly accessible through AMv1 APIs. To obtain reporting data for AMv2 campaigns, it is necessary to aggregate the information using the campaignId provided in the amV2 objects within the relevant AMv1 API endpoints.
To help you easily identify AMv2 data:
- All AMv2 objects within the endpoints will include a nested object named
amV2. This object's presence indicates that the data is from Ads Manager V2. - The
amV2object of AMv1 data will be alwaysnull, allowing users to differentiate between data from AMv1 and AMv2 seamlessly. - The structure and location of the
amV2object may vary depending on the endpoint. To understand exactly where to find theamV2object for each specific endpoint, please refer to the detailed API documentation.
Requests are limited per API key. Making too many requests in a short time will result in a HTTP 429 error. The response body is as follows:
{"code":429,"message":"429 TOO_MANY_REQUESTS"}In this case, please wait a short time and retry the request again.
Added rate limiting.
New properties were added to the amV2 field for Insights API endpoints:
- addToCart, addToCartCpa, addToCartCvr
- purchase, purchaseCpa, purchaseCvr
- subscribe, subscribeCpa, subscribeCvr
- completeRegistration, completeRegistrationCpa, completeRegistrationCvr
- viewContent, viewContentCpa, viewContentCvr
- initiateCheckout, initiateCheckoutCpa, initiateCheckoutCvr
- submitForm, submitFormCpa, submitFormCvr
- contact, contactCpa, contactCvr
- signUp, signUpCpa, signUpCvr
- addPaymentInfo, addPaymentInfoCpa, addPaymentInfoCvr
- addToWishList, addToWishListCpa, addToWishListCvr
- visitCart, visitCartCpa, visitCartCvr
- customizeProduct, customizeProductCpa, customizeProductCvr
- search, searchCpa, searchCvr
- booking, bookingCpa, bookingCvr
- download, downloadCpa, downloadCvr
- startTrial, startTrialCpa, startTrialCvr
- share, shareCpa, shareCvr
- login, loginCpa, loginCvr
- donate, donateCpa, donateCvr
- findLocation, findLocationCpa, findLocationCvr
- timeSpent, timeSpentCpa, timeSpentCvr Fields were added on 2024-08-20:
- install, installCpa, installCvr Fields wer added on 2024-10-30:
- d1Retention, d1RetentionCpa, d1RetentionCvr
https://smartnews-ads.zendesk.com/hc/ja/requests/new?ticket_form_id=1900000456167