zernio-sdk 0.0.530 → 0.0.532
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +22 -0
- data/docs/AdCampaignsApi.md +76 -0
- data/docs/AdsApi.md +593 -0
- data/docs/CreateRfPrediction201Response.md +22 -0
- data/docs/CreateRfPredictionRequest.md +34 -0
- data/docs/CreateStandaloneAdRequest.md +4 -0
- data/docs/GetAdAccountFinance200Response.md +28 -0
- data/docs/GetAdAccountFinance200ResponseFundingSource.md +20 -0
- data/docs/GetAdSetDetails200Response.md +18 -0
- data/docs/GetAdsActivityLog200Response.md +22 -0
- data/docs/ListAdStudies200Response.md +22 -0
- data/docs/ReserveRfPrediction201Response.md +20 -0
- data/docs/ReserveRfPredictionRequest.md +20 -0
- data/docs/RfPrediction.md +42 -0
- data/docs/UploadAdImage201Response.md +20 -0
- data/docs/UploadAdImage201ResponseImage.md +20 -0
- data/docs/UploadAdImageRequest.md +24 -0
- data/lib/zernio-sdk/api/ad_campaigns_api.rb +73 -0
- data/lib/zernio-sdk/api/ads_api.rb +615 -0
- data/lib/zernio-sdk/models/create_rf_prediction201_response.rb +165 -0
- data/lib/zernio-sdk/models/create_rf_prediction_request.rb +323 -0
- data/lib/zernio-sdk/models/create_standalone_ad_request.rb +35 -3
- data/lib/zernio-sdk/models/create_standalone_ad_request_creatives_inner.rb +2 -2
- data/lib/zernio-sdk/models/get_ad_account_finance200_response.rb +197 -0
- data/lib/zernio-sdk/models/get_ad_account_finance200_response_funding_source.rb +158 -0
- data/lib/zernio-sdk/models/get_ad_set_details200_response.rb +148 -0
- data/lib/zernio-sdk/models/get_ads_activity_log200_response.rb +167 -0
- data/lib/zernio-sdk/models/list_ad_studies200_response.rb +167 -0
- data/lib/zernio-sdk/models/reserve_rf_prediction201_response.rb +156 -0
- data/lib/zernio-sdk/models/reserve_rf_prediction_request.rb +190 -0
- data/lib/zernio-sdk/models/rf_prediction.rb +273 -0
- data/lib/zernio-sdk/models/send_conversions_request_consent.rb +1 -1
- data/lib/zernio-sdk/models/upload_ad_image201_response.rb +156 -0
- data/lib/zernio-sdk/models/upload_ad_image201_response_image.rb +158 -0
- data/lib/zernio-sdk/models/upload_ad_image_request.rb +229 -0
- data/lib/zernio-sdk/version.rb +1 -1
- data/lib/zernio-sdk.rb +13 -0
- data/openapi.yaml +345 -7
- data/spec/api/ad_campaigns_api_spec.rb +14 -0
- data/spec/api/ads_api_spec.rb +111 -0
- data/spec/models/boost_post_request_spec.rb +1 -1
- data/spec/models/create_rf_prediction201_response_spec.rb +48 -0
- data/spec/models/create_rf_prediction_request_spec.rb +84 -0
- data/spec/models/create_standalone_ad_request_creatives_inner_spec.rb +1 -1
- data/spec/models/create_standalone_ad_request_dynamic_creative_spec.rb +1 -1
- data/spec/models/create_standalone_ad_request_spec.rb +18 -2
- data/spec/models/get_ad_account_finance200_response_funding_source_spec.rb +42 -0
- data/spec/models/get_ad_account_finance200_response_spec.rb +66 -0
- data/spec/models/get_ad_set_details200_response_spec.rb +36 -0
- data/spec/models/get_ads_activity_log200_response_spec.rb +48 -0
- data/spec/models/list_ad_studies200_response_spec.rb +48 -0
- data/spec/models/reserve_rf_prediction201_response_spec.rb +42 -0
- data/spec/models/reserve_rf_prediction_request_spec.rb +42 -0
- data/spec/models/rf_prediction_spec.rb +108 -0
- data/spec/models/upload_ad_image201_response_image_spec.rb +42 -0
- data/spec/models/upload_ad_image201_response_spec.rb +42 -0
- data/spec/models/upload_ad_image_request_spec.rb +54 -0
- metadata +54 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f5c7aae8aa0d4f6849a28e26a4d71c5074264026717d7b7a666e9e636170781e
|
|
4
|
+
data.tar.gz: 053dd32b6648528c8e4b2cb94c628288dd06335acce9f4fe08e57586ccb143fc
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 70e1a5658a768a16184940231db1e86b53c137367242e296332283d73566a018c71ecd34d36b02c0efdebb3416a72cc792a438bd2a6b3506347dfaacc7c6423a
|
|
7
|
+
data.tar.gz: dc2c702ccf60d3420b39d02ede8806e452de4e9330071598190e67a663b6053fdd83c9bd4d88b584ee8dea45dab97b9a92ae9ff2d56813c0742ec0542f2f8571
|
data/README.md
CHANGED
|
@@ -99,6 +99,7 @@ Class | Method | HTTP request | Description
|
|
|
99
99
|
*Zernio::AdCampaignsApi* | [**bulk_update_ad_campaign_status**](docs/AdCampaignsApi.md#bulk_update_ad_campaign_status) | **POST** /v1/ads/campaigns/bulk-status | Pause or resume many campaigns
|
|
100
100
|
*Zernio::AdCampaignsApi* | [**delete_ad_campaign**](docs/AdCampaignsApi.md#delete_ad_campaign) | **DELETE** /v1/ads/campaigns/{campaignId} | Delete a campaign
|
|
101
101
|
*Zernio::AdCampaignsApi* | [**duplicate_ad_campaign**](docs/AdCampaignsApi.md#duplicate_ad_campaign) | **POST** /v1/ads/campaigns/{campaignId}/duplicate | Duplicate a campaign
|
|
102
|
+
*Zernio::AdCampaignsApi* | [**get_ad_set_details**](docs/AdCampaignsApi.md#get_ad_set_details) | **GET** /v1/ads/ad-sets/{adSetId} | Live ad-set details incl. learning phase (Meta)
|
|
102
103
|
*Zernio::AdCampaignsApi* | [**get_ad_tree**](docs/AdCampaignsApi.md#get_ad_tree) | **GET** /v1/ads/tree | Get campaign tree
|
|
103
104
|
*Zernio::AdCampaignsApi* | [**get_ads_timeline**](docs/AdCampaignsApi.md#get_ads_timeline) | **GET** /v1/ads/timeline | Get daily account metrics
|
|
104
105
|
*Zernio::AdCampaignsApi* | [**list_ad_campaigns**](docs/AdCampaignsApi.md#list_ad_campaigns) | **GET** /v1/ads/campaigns | List campaigns
|
|
@@ -110,12 +111,14 @@ Class | Method | HTTP request | Description
|
|
|
110
111
|
*Zernio::AdsApi* | [**adjust_conversions**](docs/AdsApi.md#adjust_conversions) | **POST** /v1/ads/conversions/adjustments | Adjust uploaded conversions
|
|
111
112
|
*Zernio::AdsApi* | [**archive_lead_form**](docs/AdsApi.md#archive_lead_form) | **DELETE** /v1/ads/lead-forms/{formId} | Archive a lead form
|
|
112
113
|
*Zernio::AdsApi* | [**boost_post**](docs/AdsApi.md#boost_post) | **POST** /v1/ads/boost | Boost post as ad
|
|
114
|
+
*Zernio::AdsApi* | [**cancel_rf_reservation**](docs/AdsApi.md#cancel_rf_reservation) | **DELETE** /v1/ads/rf-predictions/{predictionId} | Cancel a Reach & Frequency reservation (Meta)
|
|
113
115
|
*Zernio::AdsApi* | [**create_ad_insights_report**](docs/AdsApi.md#create_ad_insights_report) | **POST** /v1/ads/insights/reports | Submit an async insights report run (Meta)
|
|
114
116
|
*Zernio::AdsApi* | [**create_call_ad**](docs/AdsApi.md#create_call_ad) | **POST** /v1/ads/call | Create Click-to-Call ad
|
|
115
117
|
*Zernio::AdsApi* | [**create_conversion_destination**](docs/AdsApi.md#create_conversion_destination) | **POST** /v1/accounts/{accountId}/conversion-destinations | Create a conversion destination
|
|
116
118
|
*Zernio::AdsApi* | [**create_ctwa_ad**](docs/AdsApi.md#create_ctwa_ad) | **POST** /v1/ads/ctwa | Create Click-to-WhatsApp ad (deprecated)
|
|
117
119
|
*Zernio::AdsApi* | [**create_lead_form**](docs/AdsApi.md#create_lead_form) | **POST** /v1/ads/lead-forms | Create a lead form
|
|
118
120
|
*Zernio::AdsApi* | [**create_messaging_ad**](docs/AdsApi.md#create_messaging_ad) | **POST** /v1/ads/messaging | Create click-to-message ad (WhatsApp / Messenger / Instagram Direct)
|
|
121
|
+
*Zernio::AdsApi* | [**create_rf_prediction**](docs/AdsApi.md#create_rf_prediction) | **POST** /v1/ads/rf-predictions | Create a Reach & Frequency prediction (Meta)
|
|
119
122
|
*Zernio::AdsApi* | [**create_standalone_ad**](docs/AdsApi.md#create_standalone_ad) | **POST** /v1/ads/create | Create standalone ad
|
|
120
123
|
*Zernio::AdsApi* | [**create_test_lead**](docs/AdsApi.md#create_test_lead) | **POST** /v1/ads/lead-forms/{formId}/test-leads | Create a test lead
|
|
121
124
|
*Zernio::AdsApi* | [**delete_ad**](docs/AdsApi.md#delete_ad) | **DELETE** /v1/ads/{adId} | Cancel an ad
|
|
@@ -123,11 +126,13 @@ Class | Method | HTTP request | Description
|
|
|
123
126
|
*Zernio::AdsApi* | [**estimate_ad_reach**](docs/AdsApi.md#estimate_ad_reach) | **POST** /v1/ads/targeting/reach-estimate | Estimate audience reach
|
|
124
127
|
*Zernio::AdsApi* | [**generate_ad_previews**](docs/AdsApi.md#generate_ad_previews) | **POST** /v1/ads/preview | Render pre-create ad previews (Meta)
|
|
125
128
|
*Zernio::AdsApi* | [**get_ad**](docs/AdsApi.md#get_ad) | **GET** /v1/ads/{adId} | Get ad details
|
|
129
|
+
*Zernio::AdsApi* | [**get_ad_account_finance**](docs/AdsApi.md#get_ad_account_finance) | **GET** /v1/ads/accounts/finance | Ad account finances (Meta)
|
|
126
130
|
*Zernio::AdsApi* | [**get_ad_analytics**](docs/AdsApi.md#get_ad_analytics) | **GET** /v1/ads/{adId}/analytics | Get ad analytics
|
|
127
131
|
*Zernio::AdsApi* | [**get_ad_comments**](docs/AdsApi.md#get_ad_comments) | **GET** /v1/ads/{adId}/comments | List comments on an ad
|
|
128
132
|
*Zernio::AdsApi* | [**get_ad_insights_report**](docs/AdsApi.md#get_ad_insights_report) | **GET** /v1/ads/insights/reports/{reportRunId} | Poll an async insights report run (Meta)
|
|
129
133
|
*Zernio::AdsApi* | [**get_ad_previews**](docs/AdsApi.md#get_ad_previews) | **GET** /v1/ads/{adId}/preview | Render previews of an existing ad (Meta)
|
|
130
134
|
*Zernio::AdsApi* | [**get_ad_tracking_tags**](docs/AdsApi.md#get_ad_tracking_tags) | **GET** /v1/ads/{adId}/tracking-tags | Get ad tracking tags
|
|
135
|
+
*Zernio::AdsApi* | [**get_ads_activity_log**](docs/AdsApi.md#get_ads_activity_log) | **GET** /v1/ads/activity | Ad account change / audit log (Meta)
|
|
131
136
|
*Zernio::AdsApi* | [**get_campaign_analytics**](docs/AdsApi.md#get_campaign_analytics) | **GET** /v1/ads/campaigns/{campaignId}/analytics | Get campaign analytics
|
|
132
137
|
*Zernio::AdsApi* | [**get_conversion_destination**](docs/AdsApi.md#get_conversion_destination) | **GET** /v1/accounts/{accountId}/conversion-destinations/{destinationId} | Get a conversion destination
|
|
133
138
|
*Zernio::AdsApi* | [**get_conversion_metrics**](docs/AdsApi.md#get_conversion_metrics) | **GET** /v1/accounts/{accountId}/conversion-destinations/{destinationId}/metrics | Get attribution metrics
|
|
@@ -137,9 +142,11 @@ Class | Method | HTTP request | Description
|
|
|
137
142
|
*Zernio::AdsApi* | [**get_lead_form**](docs/AdsApi.md#get_lead_form) | **GET** /v1/ads/lead-forms/{formId} | Get a lead form
|
|
138
143
|
*Zernio::AdsApi* | [**get_linked_in_bid_pricing**](docs/AdsApi.md#get_linked_in_bid_pricing) | **POST** /v1/ads/targeting/bid-pricing | Suggested bid and budget bounds (LinkedIn)
|
|
139
144
|
*Zernio::AdsApi* | [**get_linked_in_supply_forecast**](docs/AdsApi.md#get_linked_in_supply_forecast) | **POST** /v1/ads/targeting/supply-forecast | Impressions, clicks and spend forecast (LinkedIn)
|
|
145
|
+
*Zernio::AdsApi* | [**get_rf_prediction**](docs/AdsApi.md#get_rf_prediction) | **GET** /v1/ads/rf-predictions/{predictionId} | Read a Reach & Frequency prediction (Meta)
|
|
140
146
|
*Zernio::AdsApi* | [**list_ad_accounts**](docs/AdsApi.md#list_ad_accounts) | **GET** /v1/ads/accounts | List ad accounts
|
|
141
147
|
*Zernio::AdsApi* | [**list_ad_catalog_product_sets**](docs/AdsApi.md#list_ad_catalog_product_sets) | **GET** /v1/ads/catalogs/{catalogId}/product-sets | List a catalog's product sets
|
|
142
148
|
*Zernio::AdsApi* | [**list_ad_catalogs**](docs/AdsApi.md#list_ad_catalogs) | **GET** /v1/ads/catalogs | List Meta product catalogs
|
|
149
|
+
*Zernio::AdsApi* | [**list_ad_studies**](docs/AdsApi.md#list_ad_studies) | **GET** /v1/ads/studies | A/B tests and lift studies (Meta)
|
|
143
150
|
*Zernio::AdsApi* | [**list_ads**](docs/AdsApi.md#list_ads) | **GET** /v1/ads | List ads
|
|
144
151
|
*Zernio::AdsApi* | [**list_ads_business_centers**](docs/AdsApi.md#list_ads_business_centers) | **GET** /v1/ads/business-centers | List TikTok Business Centers
|
|
145
152
|
*Zernio::AdsApi* | [**list_conversion_associations**](docs/AdsApi.md#list_conversion_associations) | **GET** /v1/accounts/{accountId}/conversion-destinations/{destinationId}/associations | List associated campaigns
|
|
@@ -150,6 +157,7 @@ Class | Method | HTTP request | Description
|
|
|
150
157
|
*Zernio::AdsApi* | [**list_whats_app_conversions**](docs/AdsApi.md#list_whats_app_conversions) | **GET** /v1/whatsapp/conversions | List conversion events
|
|
151
158
|
*Zernio::AdsApi* | [**query_ad_insights**](docs/AdsApi.md#query_ad_insights) | **GET** /v1/ads/insights | Flexible live insights query (Meta)
|
|
152
159
|
*Zernio::AdsApi* | [**remove_conversion_associations**](docs/AdsApi.md#remove_conversion_associations) | **DELETE** /v1/accounts/{accountId}/conversion-destinations/{destinationId}/associations | Remove associated campaigns
|
|
160
|
+
*Zernio::AdsApi* | [**reserve_rf_prediction**](docs/AdsApi.md#reserve_rf_prediction) | **POST** /v1/ads/rf-predictions/{predictionId}/reserve | Reserve a Reach & Frequency prediction (Meta)
|
|
153
161
|
*Zernio::AdsApi* | [**search_ad_interests**](docs/AdsApi.md#search_ad_interests) | **GET** /v1/ads/interests | Search targeting interests
|
|
154
162
|
*Zernio::AdsApi* | [**search_ad_targeting**](docs/AdsApi.md#search_ad_targeting) | **GET** /v1/ads/targeting/search | Search targeting options
|
|
155
163
|
*Zernio::AdsApi* | [**send_conversions**](docs/AdsApi.md#send_conversions) | **POST** /v1/ads/conversions | Send conversion events
|
|
@@ -159,6 +167,7 @@ Class | Method | HTTP request | Description
|
|
|
159
167
|
*Zernio::AdsApi* | [**update_ad_status**](docs/AdsApi.md#update_ad_status) | **PUT** /v1/ads/{adId}/status | Pause or resume a single ad
|
|
160
168
|
*Zernio::AdsApi* | [**update_ad_tracking_tags**](docs/AdsApi.md#update_ad_tracking_tags) | **PATCH** /v1/ads/{adId}/tracking-tags | Set ad tracking tags
|
|
161
169
|
*Zernio::AdsApi* | [**update_conversion_destination**](docs/AdsApi.md#update_conversion_destination) | **PATCH** /v1/accounts/{accountId}/conversion-destinations/{destinationId} | Update a conversion destination
|
|
170
|
+
*Zernio::AdsApi* | [**upload_ad_image**](docs/AdsApi.md#upload_ad_image) | **POST** /v1/ads/images | Upload an ad image from base64 (Meta)
|
|
162
171
|
*Zernio::AnalyticsApi* | [**get_analytics**](docs/AnalyticsApi.md#get_analytics) | **GET** /v1/analytics | Get post analytics
|
|
163
172
|
*Zernio::AnalyticsApi* | [**get_best_time_to_post**](docs/AnalyticsApi.md#get_best_time_to_post) | **GET** /v1/analytics/best-time | Get best times to post
|
|
164
173
|
*Zernio::AnalyticsApi* | [**get_content_decay**](docs/AnalyticsApi.md#get_content_decay) | **GET** /v1/analytics/content-decay | Get content performance decay
|
|
@@ -765,6 +774,8 @@ Class | Method | HTTP request | Description
|
|
|
765
774
|
- [Zernio::CreateProfileRequest](docs/CreateProfileRequest.md)
|
|
766
775
|
- [Zernio::CreateQueueSlot201Response](docs/CreateQueueSlot201Response.md)
|
|
767
776
|
- [Zernio::CreateQueueSlotRequest](docs/CreateQueueSlotRequest.md)
|
|
777
|
+
- [Zernio::CreateRfPrediction201Response](docs/CreateRfPrediction201Response.md)
|
|
778
|
+
- [Zernio::CreateRfPredictionRequest](docs/CreateRfPredictionRequest.md)
|
|
768
779
|
- [Zernio::CreateSequence200Response](docs/CreateSequence200Response.md)
|
|
769
780
|
- [Zernio::CreateSequence200ResponseSequence](docs/CreateSequence200ResponseSequence.md)
|
|
770
781
|
- [Zernio::CreateSequenceRequest](docs/CreateSequenceRequest.md)
|
|
@@ -927,6 +938,8 @@ Class | Method | HTTP request | Description
|
|
|
927
938
|
- [Zernio::GetAccountHealth200ResponsePermissionsPostingInner](docs/GetAccountHealth200ResponsePermissionsPostingInner.md)
|
|
928
939
|
- [Zernio::GetAccountHealth200ResponseTokenStatus](docs/GetAccountHealth200ResponseTokenStatus.md)
|
|
929
940
|
- [Zernio::GetAd200Response](docs/GetAd200Response.md)
|
|
941
|
+
- [Zernio::GetAdAccountFinance200Response](docs/GetAdAccountFinance200Response.md)
|
|
942
|
+
- [Zernio::GetAdAccountFinance200ResponseFundingSource](docs/GetAdAccountFinance200ResponseFundingSource.md)
|
|
930
943
|
- [Zernio::GetAdAnalytics200Response](docs/GetAdAnalytics200Response.md)
|
|
931
944
|
- [Zernio::GetAdAnalytics200ResponseAd](docs/GetAdAnalytics200ResponseAd.md)
|
|
932
945
|
- [Zernio::GetAdAudience200Response](docs/GetAdAudience200Response.md)
|
|
@@ -936,8 +949,10 @@ Class | Method | HTTP request | Description
|
|
|
936
949
|
- [Zernio::GetAdInsightsReport200Response](docs/GetAdInsightsReport200Response.md)
|
|
937
950
|
- [Zernio::GetAdInsightsReport200ResponsePaging](docs/GetAdInsightsReport200ResponsePaging.md)
|
|
938
951
|
- [Zernio::GetAdPreviews200Response](docs/GetAdPreviews200Response.md)
|
|
952
|
+
- [Zernio::GetAdSetDetails200Response](docs/GetAdSetDetails200Response.md)
|
|
939
953
|
- [Zernio::GetAdTrackingTags200Response](docs/GetAdTrackingTags200Response.md)
|
|
940
954
|
- [Zernio::GetAdTree200Response](docs/GetAdTree200Response.md)
|
|
955
|
+
- [Zernio::GetAdsActivityLog200Response](docs/GetAdsActivityLog200Response.md)
|
|
941
956
|
- [Zernio::GetAdsTimeline200Response](docs/GetAdsTimeline200Response.md)
|
|
942
957
|
- [Zernio::GetAdsTimeline200ResponseRowsInner](docs/GetAdsTimeline200ResponseRowsInner.md)
|
|
943
958
|
- [Zernio::GetAllAccountsHealth200Response](docs/GetAllAccountsHealth200Response.md)
|
|
@@ -1290,6 +1305,7 @@ Class | Method | HTTP request | Description
|
|
|
1290
1305
|
- [Zernio::ListAdCatalogProductSets200ResponseProductSetsInner](docs/ListAdCatalogProductSets200ResponseProductSetsInner.md)
|
|
1291
1306
|
- [Zernio::ListAdCatalogs200Response](docs/ListAdCatalogs200Response.md)
|
|
1292
1307
|
- [Zernio::ListAdCatalogs200ResponseCatalogsInner](docs/ListAdCatalogs200ResponseCatalogsInner.md)
|
|
1308
|
+
- [Zernio::ListAdStudies200Response](docs/ListAdStudies200Response.md)
|
|
1293
1309
|
- [Zernio::ListAds200Response](docs/ListAds200Response.md)
|
|
1294
1310
|
- [Zernio::ListAdsBusinessCenters200Response](docs/ListAdsBusinessCenters200Response.md)
|
|
1295
1311
|
- [Zernio::ListApiKeys200Response](docs/ListApiKeys200Response.md)
|
|
@@ -1511,6 +1527,8 @@ Class | Method | HTTP request | Description
|
|
|
1511
1527
|
- [Zernio::ReplyToMention200Response](docs/ReplyToMention200Response.md)
|
|
1512
1528
|
- [Zernio::ReplyToMentionRequest](docs/ReplyToMentionRequest.md)
|
|
1513
1529
|
- [Zernio::ResendSmsRegistrationOtp200Response](docs/ResendSmsRegistrationOtp200Response.md)
|
|
1530
|
+
- [Zernio::ReserveRfPrediction201Response](docs/ReserveRfPrediction201Response.md)
|
|
1531
|
+
- [Zernio::ReserveRfPredictionRequest](docs/ReserveRfPredictionRequest.md)
|
|
1514
1532
|
- [Zernio::RestoreWorkflowVersion200Response](docs/RestoreWorkflowVersion200Response.md)
|
|
1515
1533
|
- [Zernio::RestoreWorkflowVersion200ResponseWorkflow](docs/RestoreWorkflowVersion200ResponseWorkflow.md)
|
|
1516
1534
|
- [Zernio::RetweetPost200Response](docs/RetweetPost200Response.md)
|
|
@@ -1522,6 +1540,7 @@ Class | Method | HTTP request | Description
|
|
|
1522
1540
|
- [Zernio::ReviewWebhookReview](docs/ReviewWebhookReview.md)
|
|
1523
1541
|
- [Zernio::ReviewWebhookReviewReply](docs/ReviewWebhookReviewReply.md)
|
|
1524
1542
|
- [Zernio::ReviewWebhookReviewReviewer](docs/ReviewWebhookReviewReviewer.md)
|
|
1543
|
+
- [Zernio::RfPrediction](docs/RfPrediction.md)
|
|
1525
1544
|
- [Zernio::SavedTargetingAudience](docs/SavedTargetingAudience.md)
|
|
1526
1545
|
- [Zernio::ScheduleBroadcast200Response](docs/ScheduleBroadcast200Response.md)
|
|
1527
1546
|
- [Zernio::ScheduleBroadcast200ResponseBroadcast](docs/ScheduleBroadcast200ResponseBroadcast.md)
|
|
@@ -1818,6 +1837,9 @@ Class | Method | HTTP request | Description
|
|
|
1818
1837
|
- [Zernio::UpdateWorkflowRequest](docs/UpdateWorkflowRequest.md)
|
|
1819
1838
|
- [Zernio::UpdateYoutubeDefaultPlaylist200Response](docs/UpdateYoutubeDefaultPlaylist200Response.md)
|
|
1820
1839
|
- [Zernio::UpdateYoutubeDefaultPlaylistRequest](docs/UpdateYoutubeDefaultPlaylistRequest.md)
|
|
1840
|
+
- [Zernio::UploadAdImage201Response](docs/UploadAdImage201Response.md)
|
|
1841
|
+
- [Zernio::UploadAdImage201ResponseImage](docs/UploadAdImage201ResponseImage.md)
|
|
1842
|
+
- [Zernio::UploadAdImageRequest](docs/UploadAdImageRequest.md)
|
|
1821
1843
|
- [Zernio::UploadMediaDirect200Response](docs/UploadMediaDirect200Response.md)
|
|
1822
1844
|
- [Zernio::UploadPhoneNumberKycDocument200Response](docs/UploadPhoneNumberKycDocument200Response.md)
|
|
1823
1845
|
- [Zernio::UploadPhoneNumberPortInDocument200Response](docs/UploadPhoneNumberPortInDocument200Response.md)
|
data/docs/AdCampaignsApi.md
CHANGED
|
@@ -7,6 +7,7 @@ All URIs are relative to *https://zernio.com/api*
|
|
|
7
7
|
| [**bulk_update_ad_campaign_status**](AdCampaignsApi.md#bulk_update_ad_campaign_status) | **POST** /v1/ads/campaigns/bulk-status | Pause or resume many campaigns |
|
|
8
8
|
| [**delete_ad_campaign**](AdCampaignsApi.md#delete_ad_campaign) | **DELETE** /v1/ads/campaigns/{campaignId} | Delete a campaign |
|
|
9
9
|
| [**duplicate_ad_campaign**](AdCampaignsApi.md#duplicate_ad_campaign) | **POST** /v1/ads/campaigns/{campaignId}/duplicate | Duplicate a campaign |
|
|
10
|
+
| [**get_ad_set_details**](AdCampaignsApi.md#get_ad_set_details) | **GET** /v1/ads/ad-sets/{adSetId} | Live ad-set details incl. learning phase (Meta) |
|
|
10
11
|
| [**get_ad_tree**](AdCampaignsApi.md#get_ad_tree) | **GET** /v1/ads/tree | Get campaign tree |
|
|
11
12
|
| [**get_ads_timeline**](AdCampaignsApi.md#get_ads_timeline) | **GET** /v1/ads/timeline | Get daily account metrics |
|
|
12
13
|
| [**list_ad_campaigns**](AdCampaignsApi.md#list_ad_campaigns) | **GET** /v1/ads/campaigns | List campaigns |
|
|
@@ -227,6 +228,81 @@ end
|
|
|
227
228
|
- **Accept**: application/json
|
|
228
229
|
|
|
229
230
|
|
|
231
|
+
## get_ad_set_details
|
|
232
|
+
|
|
233
|
+
> <GetAdSetDetails200Response> get_ad_set_details(ad_set_id, account_id, opts)
|
|
234
|
+
|
|
235
|
+
Live ad-set details incl. learning phase (Meta)
|
|
236
|
+
|
|
237
|
+
Reads the ad set live from Meta, returned verbatim. The default projection includes `learning_stage_info` (learning-phase status: LEARNING / SUCCESS / FAIL / WAIVING — Meta omits its `status` key on paused ad sets), delivery settings, budgets, schedule and targeting. `fields` is a raw-passthrough override; unknown fields return Meta's 400 verbatim. Meta only.
|
|
238
|
+
|
|
239
|
+
### Examples
|
|
240
|
+
|
|
241
|
+
```ruby
|
|
242
|
+
require 'time'
|
|
243
|
+
require 'zernio-sdk'
|
|
244
|
+
# setup authorization
|
|
245
|
+
Zernio.configure do |config|
|
|
246
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
247
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
248
|
+
end
|
|
249
|
+
|
|
250
|
+
api_instance = Zernio::AdCampaignsApi.new
|
|
251
|
+
ad_set_id = 'ad_set_id_example' # String | Meta ad set id (platformAdSetId).
|
|
252
|
+
account_id = 'account_id_example' # String | Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
|
|
253
|
+
opts = {
|
|
254
|
+
fields: 'fields_example' # String | Comma-separated Graph field override (supports nested {} projections).
|
|
255
|
+
}
|
|
256
|
+
|
|
257
|
+
begin
|
|
258
|
+
# Live ad-set details incl. learning phase (Meta)
|
|
259
|
+
result = api_instance.get_ad_set_details(ad_set_id, account_id, opts)
|
|
260
|
+
p result
|
|
261
|
+
rescue Zernio::ApiError => e
|
|
262
|
+
puts "Error when calling AdCampaignsApi->get_ad_set_details: #{e}"
|
|
263
|
+
end
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
#### Using the get_ad_set_details_with_http_info variant
|
|
267
|
+
|
|
268
|
+
This returns an Array which contains the response data, status code and headers.
|
|
269
|
+
|
|
270
|
+
> <Array(<GetAdSetDetails200Response>, Integer, Hash)> get_ad_set_details_with_http_info(ad_set_id, account_id, opts)
|
|
271
|
+
|
|
272
|
+
```ruby
|
|
273
|
+
begin
|
|
274
|
+
# Live ad-set details incl. learning phase (Meta)
|
|
275
|
+
data, status_code, headers = api_instance.get_ad_set_details_with_http_info(ad_set_id, account_id, opts)
|
|
276
|
+
p status_code # => 2xx
|
|
277
|
+
p headers # => { ... }
|
|
278
|
+
p data # => <GetAdSetDetails200Response>
|
|
279
|
+
rescue Zernio::ApiError => e
|
|
280
|
+
puts "Error when calling AdCampaignsApi->get_ad_set_details_with_http_info: #{e}"
|
|
281
|
+
end
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
### Parameters
|
|
285
|
+
|
|
286
|
+
| Name | Type | Description | Notes |
|
|
287
|
+
| ---- | ---- | ----------- | ----- |
|
|
288
|
+
| **ad_set_id** | **String** | Meta ad set id (platformAdSetId). | |
|
|
289
|
+
| **account_id** | **String** | Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token. | |
|
|
290
|
+
| **fields** | **String** | Comma-separated Graph field override (supports nested {} projections). | [optional] |
|
|
291
|
+
|
|
292
|
+
### Return type
|
|
293
|
+
|
|
294
|
+
[**GetAdSetDetails200Response**](GetAdSetDetails200Response.md)
|
|
295
|
+
|
|
296
|
+
### Authorization
|
|
297
|
+
|
|
298
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
299
|
+
|
|
300
|
+
### HTTP request headers
|
|
301
|
+
|
|
302
|
+
- **Content-Type**: Not defined
|
|
303
|
+
- **Accept**: application/json
|
|
304
|
+
|
|
305
|
+
|
|
230
306
|
## get_ad_tree
|
|
231
307
|
|
|
232
308
|
> <GetAdTree200Response> get_ad_tree(opts)
|