zernio-sdk 0.0.529 → 0.0.531
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 +32 -9
- data/docs/AdCampaignsApi.md +76 -0
- data/docs/AdsApi.md +599 -11
- data/docs/CreateCallAdRequest.md +80 -0
- data/docs/CreateMessagingAdRequest.md +78 -0
- data/docs/{CreateCtwaAdRequest.md → CtwaAdRequestBody.md} +10 -10
- data/docs/{CreateCtwaAdRequestCitiesInner.md → CtwaAdRequestBodyCitiesInner.md} +2 -2
- data/docs/{CreateCtwaAdRequestCreativesInner.md → CtwaAdRequestBodyCreativesInner.md} +3 -3
- data/docs/{CreateCtwaAdRequestCreativesInnerVideo.md → CtwaAdRequestBodyCreativesInnerVideo.md} +2 -2
- data/docs/{CreateCtwaAdRequestPlacements.md → CtwaAdRequestBodyPlacements.md} +2 -2
- data/docs/{CreateCtwaAdRequestRegionsInner.md → CtwaAdRequestBodyRegionsInner.md} +2 -2
- data/docs/{CreateCtwaAdRequestVideo.md → CtwaAdRequestBodyVideo.md} +2 -2
- data/docs/{CreateCtwaAdRequestZipsInner.md → CtwaAdRequestBodyZipsInner.md} +2 -2
- data/docs/GenerateAdPreviews200Response.md +18 -0
- data/docs/GenerateAdPreviews200ResponsePreviewsInner.md +20 -0
- data/docs/GenerateAdPreviewsRequest.md +26 -0
- data/docs/GetAdAccountFinance200Response.md +28 -0
- data/docs/GetAdAccountFinance200ResponseFundingSource.md +20 -0
- data/docs/GetAdPreviews200Response.md +20 -0
- data/docs/GetAdSetDetails200Response.md +18 -0
- data/docs/GetAdsActivityLog200Response.md +22 -0
- data/docs/ListAdStudies200Response.md +22 -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 +604 -13
- data/lib/zernio-sdk/models/create_call_ad_request.rb +869 -0
- data/lib/zernio-sdk/models/create_messaging_ad_request.rb +844 -0
- data/lib/zernio-sdk/models/create_standalone_ad_request.rb +2 -2
- data/lib/zernio-sdk/models/create_standalone_ad_request_creatives_inner.rb +2 -2
- data/lib/zernio-sdk/models/{create_ctwa_ad_request.rb → ctwa_ad_request_body.rb} +12 -12
- data/lib/zernio-sdk/models/{create_ctwa_ad_request_cities_inner.rb → ctwa_ad_request_body_cities_inner.rb} +3 -3
- data/lib/zernio-sdk/models/{create_ctwa_ad_request_creatives_inner.rb → ctwa_ad_request_body_creatives_inner.rb} +4 -4
- data/lib/zernio-sdk/models/{create_ctwa_ad_request_creatives_inner_video.rb → ctwa_ad_request_body_creatives_inner_video.rb} +3 -3
- data/lib/zernio-sdk/models/{create_ctwa_ad_request_placements.rb → ctwa_ad_request_body_placements.rb} +3 -3
- data/lib/zernio-sdk/models/{create_ctwa_ad_request_regions_inner.rb → ctwa_ad_request_body_regions_inner.rb} +3 -3
- data/lib/zernio-sdk/models/{create_ctwa_ad_request_video.rb → ctwa_ad_request_body_video.rb} +3 -3
- data/lib/zernio-sdk/models/{create_ctwa_ad_request_zips_inner.rb → ctwa_ad_request_body_zips_inner.rb} +3 -3
- data/lib/zernio-sdk/models/generate_ad_previews200_response.rb +149 -0
- data/lib/zernio-sdk/models/generate_ad_previews200_response_previews_inner.rb +158 -0
- data/lib/zernio-sdk/models/generate_ad_previews_request.rb +254 -0
- 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_previews200_response.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/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 +22 -8
- data/openapi.yaml +679 -327
- data/spec/api/ad_campaigns_api_spec.rb +14 -0
- data/spec/api/ads_api_spec.rb +111 -3
- data/spec/models/boost_post_request_spec.rb +1 -1
- data/spec/models/create_call_ad_request_spec.rb +238 -0
- data/spec/models/create_messaging_ad_request_spec.rb +236 -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 +2 -2
- data/spec/models/{create_ctwa_ad_request_cities_inner_spec.rb → ctwa_ad_request_body_cities_inner_spec.rb} +6 -6
- data/spec/models/{create_ctwa_ad_request_creatives_inner_spec.rb → ctwa_ad_request_body_creatives_inner_spec.rb} +6 -6
- data/spec/models/{create_ctwa_ad_request_creatives_inner_video_spec.rb → ctwa_ad_request_body_creatives_inner_video_spec.rb} +6 -6
- data/spec/models/{create_ctwa_ad_request_placements_spec.rb → ctwa_ad_request_body_placements_spec.rb} +6 -6
- data/spec/models/{create_ctwa_ad_request_regions_inner_spec.rb → ctwa_ad_request_body_regions_inner_spec.rb} +6 -6
- data/spec/models/{create_ctwa_ad_request_spec.rb → ctwa_ad_request_body_spec.rb} +6 -6
- data/spec/models/{create_ctwa_ad_request_video_spec.rb → ctwa_ad_request_body_video_spec.rb} +6 -6
- data/spec/models/{create_ctwa_ad_request_zips_inner_spec.rb → ctwa_ad_request_body_zips_inner_spec.rb} +6 -6
- data/spec/models/generate_ad_previews200_response_previews_inner_spec.rb +42 -0
- data/spec/models/generate_ad_previews200_response_spec.rb +36 -0
- data/spec/models/generate_ad_previews_request_spec.rb +60 -0
- 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_previews200_response_spec.rb +42 -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/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 +90 -34
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: eaa5f26849657a92627dca36e035af7aebc2f4a966c08b7d997ba4708c20ee89
|
|
4
|
+
data.tar.gz: d363d35b4b938148821659d8d51ea2860e0eae73f71c1acc078a7101c915305b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: becc912c9e3733c3d2b0db5f32416a246da50d584735c75ee4f18465e59fc46932c6140474cea5a8fe9b00927110bd94d988a211c5c9696775481038ba07a01c
|
|
7
|
+
data.tar.gz: 294b76a7f76b4f716efb3b8e3c095166a39a9b4a0a7b59c3e0b67d9fff4c89ff1f71d7258765fbb4f398f9c0287fcc33d6fe4dd9e56789fb82e4fc9aa45f597c
|
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
|
|
@@ -111,19 +112,25 @@ Class | Method | HTTP request | Description
|
|
|
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
|
|
113
114
|
*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)
|
|
115
|
+
*Zernio::AdsApi* | [**create_call_ad**](docs/AdsApi.md#create_call_ad) | **POST** /v1/ads/call | Create Click-to-Call ad
|
|
114
116
|
*Zernio::AdsApi* | [**create_conversion_destination**](docs/AdsApi.md#create_conversion_destination) | **POST** /v1/accounts/{accountId}/conversion-destinations | Create a conversion destination
|
|
115
|
-
*Zernio::AdsApi* | [**create_ctwa_ad**](docs/AdsApi.md#create_ctwa_ad) | **POST** /v1/ads/ctwa | Create Click-to-WhatsApp ad
|
|
117
|
+
*Zernio::AdsApi* | [**create_ctwa_ad**](docs/AdsApi.md#create_ctwa_ad) | **POST** /v1/ads/ctwa | Create Click-to-WhatsApp ad (deprecated)
|
|
116
118
|
*Zernio::AdsApi* | [**create_lead_form**](docs/AdsApi.md#create_lead_form) | **POST** /v1/ads/lead-forms | Create a lead form
|
|
119
|
+
*Zernio::AdsApi* | [**create_messaging_ad**](docs/AdsApi.md#create_messaging_ad) | **POST** /v1/ads/messaging | Create click-to-message ad (WhatsApp / Messenger / Instagram Direct)
|
|
117
120
|
*Zernio::AdsApi* | [**create_standalone_ad**](docs/AdsApi.md#create_standalone_ad) | **POST** /v1/ads/create | Create standalone ad
|
|
118
121
|
*Zernio::AdsApi* | [**create_test_lead**](docs/AdsApi.md#create_test_lead) | **POST** /v1/ads/lead-forms/{formId}/test-leads | Create a test lead
|
|
119
122
|
*Zernio::AdsApi* | [**delete_ad**](docs/AdsApi.md#delete_ad) | **DELETE** /v1/ads/{adId} | Cancel an ad
|
|
120
123
|
*Zernio::AdsApi* | [**delete_conversion_destination**](docs/AdsApi.md#delete_conversion_destination) | **DELETE** /v1/accounts/{accountId}/conversion-destinations/{destinationId} | Delete a conversion destination
|
|
121
124
|
*Zernio::AdsApi* | [**estimate_ad_reach**](docs/AdsApi.md#estimate_ad_reach) | **POST** /v1/ads/targeting/reach-estimate | Estimate audience reach
|
|
125
|
+
*Zernio::AdsApi* | [**generate_ad_previews**](docs/AdsApi.md#generate_ad_previews) | **POST** /v1/ads/preview | Render pre-create ad previews (Meta)
|
|
122
126
|
*Zernio::AdsApi* | [**get_ad**](docs/AdsApi.md#get_ad) | **GET** /v1/ads/{adId} | Get ad details
|
|
127
|
+
*Zernio::AdsApi* | [**get_ad_account_finance**](docs/AdsApi.md#get_ad_account_finance) | **GET** /v1/ads/accounts/finance | Ad account finances (Meta)
|
|
123
128
|
*Zernio::AdsApi* | [**get_ad_analytics**](docs/AdsApi.md#get_ad_analytics) | **GET** /v1/ads/{adId}/analytics | Get ad analytics
|
|
124
129
|
*Zernio::AdsApi* | [**get_ad_comments**](docs/AdsApi.md#get_ad_comments) | **GET** /v1/ads/{adId}/comments | List comments on an ad
|
|
125
130
|
*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)
|
|
131
|
+
*Zernio::AdsApi* | [**get_ad_previews**](docs/AdsApi.md#get_ad_previews) | **GET** /v1/ads/{adId}/preview | Render previews of an existing ad (Meta)
|
|
126
132
|
*Zernio::AdsApi* | [**get_ad_tracking_tags**](docs/AdsApi.md#get_ad_tracking_tags) | **GET** /v1/ads/{adId}/tracking-tags | Get ad tracking tags
|
|
133
|
+
*Zernio::AdsApi* | [**get_ads_activity_log**](docs/AdsApi.md#get_ads_activity_log) | **GET** /v1/ads/activity | Ad account change / audit log (Meta)
|
|
127
134
|
*Zernio::AdsApi* | [**get_campaign_analytics**](docs/AdsApi.md#get_campaign_analytics) | **GET** /v1/ads/campaigns/{campaignId}/analytics | Get campaign analytics
|
|
128
135
|
*Zernio::AdsApi* | [**get_conversion_destination**](docs/AdsApi.md#get_conversion_destination) | **GET** /v1/accounts/{accountId}/conversion-destinations/{destinationId} | Get a conversion destination
|
|
129
136
|
*Zernio::AdsApi* | [**get_conversion_metrics**](docs/AdsApi.md#get_conversion_metrics) | **GET** /v1/accounts/{accountId}/conversion-destinations/{destinationId}/metrics | Get attribution metrics
|
|
@@ -136,6 +143,7 @@ Class | Method | HTTP request | Description
|
|
|
136
143
|
*Zernio::AdsApi* | [**list_ad_accounts**](docs/AdsApi.md#list_ad_accounts) | **GET** /v1/ads/accounts | List ad accounts
|
|
137
144
|
*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
|
|
138
145
|
*Zernio::AdsApi* | [**list_ad_catalogs**](docs/AdsApi.md#list_ad_catalogs) | **GET** /v1/ads/catalogs | List Meta product catalogs
|
|
146
|
+
*Zernio::AdsApi* | [**list_ad_studies**](docs/AdsApi.md#list_ad_studies) | **GET** /v1/ads/studies | A/B tests and lift studies (Meta)
|
|
139
147
|
*Zernio::AdsApi* | [**list_ads**](docs/AdsApi.md#list_ads) | **GET** /v1/ads | List ads
|
|
140
148
|
*Zernio::AdsApi* | [**list_ads_business_centers**](docs/AdsApi.md#list_ads_business_centers) | **GET** /v1/ads/business-centers | List TikTok Business Centers
|
|
141
149
|
*Zernio::AdsApi* | [**list_conversion_associations**](docs/AdsApi.md#list_conversion_associations) | **GET** /v1/accounts/{accountId}/conversion-destinations/{destinationId}/associations | List associated campaigns
|
|
@@ -155,6 +163,7 @@ Class | Method | HTTP request | Description
|
|
|
155
163
|
*Zernio::AdsApi* | [**update_ad_status**](docs/AdsApi.md#update_ad_status) | **PUT** /v1/ads/{adId}/status | Pause or resume a single ad
|
|
156
164
|
*Zernio::AdsApi* | [**update_ad_tracking_tags**](docs/AdsApi.md#update_ad_tracking_tags) | **PATCH** /v1/ads/{adId}/tracking-tags | Set ad tracking tags
|
|
157
165
|
*Zernio::AdsApi* | [**update_conversion_destination**](docs/AdsApi.md#update_conversion_destination) | **PATCH** /v1/accounts/{accountId}/conversion-destinations/{destinationId} | Update a conversion destination
|
|
166
|
+
*Zernio::AdsApi* | [**upload_ad_image**](docs/AdsApi.md#upload_ad_image) | **POST** /v1/ads/images | Upload an ad image from base64 (Meta)
|
|
158
167
|
*Zernio::AnalyticsApi* | [**get_analytics**](docs/AnalyticsApi.md#get_analytics) | **GET** /v1/analytics | Get post analytics
|
|
159
168
|
*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
|
|
160
169
|
*Zernio::AnalyticsApi* | [**get_content_decay**](docs/AnalyticsApi.md#get_content_decay) | **GET** /v1/analytics/content-decay | Get content performance decay
|
|
@@ -698,6 +707,7 @@ Class | Method | HTTP request | Description
|
|
|
698
707
|
- [Zernio::CreateBroadcastRequestSegmentFilters](docs/CreateBroadcastRequestSegmentFilters.md)
|
|
699
708
|
- [Zernio::CreateBroadcastRequestTemplate](docs/CreateBroadcastRequestTemplate.md)
|
|
700
709
|
- [Zernio::CreateBroadcastRequestTemplateVariableMappingValue](docs/CreateBroadcastRequestTemplateVariableMappingValue.md)
|
|
710
|
+
- [Zernio::CreateCallAdRequest](docs/CreateCallAdRequest.md)
|
|
701
711
|
- [Zernio::CreateCommentAutomation200Response](docs/CreateCommentAutomation200Response.md)
|
|
702
712
|
- [Zernio::CreateCommentAutomation200ResponseAutomation](docs/CreateCommentAutomation200ResponseAutomation.md)
|
|
703
713
|
- [Zernio::CreateCommentAutomation200ResponseAutomationStats](docs/CreateCommentAutomation200ResponseAutomationStats.md)
|
|
@@ -710,14 +720,6 @@ Class | Method | HTTP request | Description
|
|
|
710
720
|
- [Zernio::CreateConversionDestinationRequest](docs/CreateConversionDestinationRequest.md)
|
|
711
721
|
- [Zernio::CreateConversionDestinationRequestValue](docs/CreateConversionDestinationRequestValue.md)
|
|
712
722
|
- [Zernio::CreateCtwaAd201Response](docs/CreateCtwaAd201Response.md)
|
|
713
|
-
- [Zernio::CreateCtwaAdRequest](docs/CreateCtwaAdRequest.md)
|
|
714
|
-
- [Zernio::CreateCtwaAdRequestCitiesInner](docs/CreateCtwaAdRequestCitiesInner.md)
|
|
715
|
-
- [Zernio::CreateCtwaAdRequestCreativesInner](docs/CreateCtwaAdRequestCreativesInner.md)
|
|
716
|
-
- [Zernio::CreateCtwaAdRequestCreativesInnerVideo](docs/CreateCtwaAdRequestCreativesInnerVideo.md)
|
|
717
|
-
- [Zernio::CreateCtwaAdRequestPlacements](docs/CreateCtwaAdRequestPlacements.md)
|
|
718
|
-
- [Zernio::CreateCtwaAdRequestRegionsInner](docs/CreateCtwaAdRequestRegionsInner.md)
|
|
719
|
-
- [Zernio::CreateCtwaAdRequestVideo](docs/CreateCtwaAdRequestVideo.md)
|
|
720
|
-
- [Zernio::CreateCtwaAdRequestZipsInner](docs/CreateCtwaAdRequestZipsInner.md)
|
|
721
723
|
- [Zernio::CreateCustomField200Response](docs/CreateCustomField200Response.md)
|
|
722
724
|
- [Zernio::CreateCustomFieldRequest](docs/CreateCustomFieldRequest.md)
|
|
723
725
|
- [Zernio::CreateDiscordGuildRole201Response](docs/CreateDiscordGuildRole201Response.md)
|
|
@@ -747,6 +749,7 @@ Class | Method | HTTP request | Description
|
|
|
747
749
|
- [Zernio::CreateLeadFormRequest](docs/CreateLeadFormRequest.md)
|
|
748
750
|
- [Zernio::CreateLeadFormRequestQuestionsInner](docs/CreateLeadFormRequestQuestionsInner.md)
|
|
749
751
|
- [Zernio::CreateLeadFormRequestQuestionsInnerOptionsInner](docs/CreateLeadFormRequestQuestionsInnerOptionsInner.md)
|
|
752
|
+
- [Zernio::CreateMessagingAdRequest](docs/CreateMessagingAdRequest.md)
|
|
750
753
|
- [Zernio::CreatePhoneNumberKycLink200Response](docs/CreatePhoneNumberKycLink200Response.md)
|
|
751
754
|
- [Zernio::CreatePhoneNumberKycLinkRequest](docs/CreatePhoneNumberKycLinkRequest.md)
|
|
752
755
|
- [Zernio::CreatePhoneNumberKycLinkRequestBranding](docs/CreatePhoneNumberKycLinkRequestBranding.md)
|
|
@@ -824,6 +827,14 @@ Class | Method | HTTP request | Description
|
|
|
824
827
|
- [Zernio::CreateWorkflow200ResponseWorkflow](docs/CreateWorkflow200ResponseWorkflow.md)
|
|
825
828
|
- [Zernio::CreateWorkflowRequest](docs/CreateWorkflowRequest.md)
|
|
826
829
|
- [Zernio::CrosspostDiscordMessage200Response](docs/CrosspostDiscordMessage200Response.md)
|
|
830
|
+
- [Zernio::CtwaAdRequestBody](docs/CtwaAdRequestBody.md)
|
|
831
|
+
- [Zernio::CtwaAdRequestBodyCitiesInner](docs/CtwaAdRequestBodyCitiesInner.md)
|
|
832
|
+
- [Zernio::CtwaAdRequestBodyCreativesInner](docs/CtwaAdRequestBodyCreativesInner.md)
|
|
833
|
+
- [Zernio::CtwaAdRequestBodyCreativesInnerVideo](docs/CtwaAdRequestBodyCreativesInnerVideo.md)
|
|
834
|
+
- [Zernio::CtwaAdRequestBodyPlacements](docs/CtwaAdRequestBodyPlacements.md)
|
|
835
|
+
- [Zernio::CtwaAdRequestBodyRegionsInner](docs/CtwaAdRequestBodyRegionsInner.md)
|
|
836
|
+
- [Zernio::CtwaAdRequestBodyVideo](docs/CtwaAdRequestBodyVideo.md)
|
|
837
|
+
- [Zernio::CtwaAdRequestBodyZipsInner](docs/CtwaAdRequestBodyZipsInner.md)
|
|
827
838
|
- [Zernio::CtwaMultiResponse](docs/CtwaMultiResponse.md)
|
|
828
839
|
- [Zernio::CtwaSingleResponse](docs/CtwaSingleResponse.md)
|
|
829
840
|
- [Zernio::DeactivateSmsRegistration200Response](docs/DeactivateSmsRegistration200Response.md)
|
|
@@ -912,12 +923,17 @@ Class | Method | HTTP request | Description
|
|
|
912
923
|
- [Zernio::GbpSpecialHourPeriod](docs/GbpSpecialHourPeriod.md)
|
|
913
924
|
- [Zernio::GbpSpecialHourPeriodStartDate](docs/GbpSpecialHourPeriodStartDate.md)
|
|
914
925
|
- [Zernio::GbpUpdateFreeFormServiceItemLabel](docs/GbpUpdateFreeFormServiceItemLabel.md)
|
|
926
|
+
- [Zernio::GenerateAdPreviews200Response](docs/GenerateAdPreviews200Response.md)
|
|
927
|
+
- [Zernio::GenerateAdPreviews200ResponsePreviewsInner](docs/GenerateAdPreviews200ResponsePreviewsInner.md)
|
|
928
|
+
- [Zernio::GenerateAdPreviewsRequest](docs/GenerateAdPreviewsRequest.md)
|
|
915
929
|
- [Zernio::GeoRestriction](docs/GeoRestriction.md)
|
|
916
930
|
- [Zernio::GetAccountHealth200Response](docs/GetAccountHealth200Response.md)
|
|
917
931
|
- [Zernio::GetAccountHealth200ResponsePermissions](docs/GetAccountHealth200ResponsePermissions.md)
|
|
918
932
|
- [Zernio::GetAccountHealth200ResponsePermissionsPostingInner](docs/GetAccountHealth200ResponsePermissionsPostingInner.md)
|
|
919
933
|
- [Zernio::GetAccountHealth200ResponseTokenStatus](docs/GetAccountHealth200ResponseTokenStatus.md)
|
|
920
934
|
- [Zernio::GetAd200Response](docs/GetAd200Response.md)
|
|
935
|
+
- [Zernio::GetAdAccountFinance200Response](docs/GetAdAccountFinance200Response.md)
|
|
936
|
+
- [Zernio::GetAdAccountFinance200ResponseFundingSource](docs/GetAdAccountFinance200ResponseFundingSource.md)
|
|
921
937
|
- [Zernio::GetAdAnalytics200Response](docs/GetAdAnalytics200Response.md)
|
|
922
938
|
- [Zernio::GetAdAnalytics200ResponseAd](docs/GetAdAnalytics200ResponseAd.md)
|
|
923
939
|
- [Zernio::GetAdAudience200Response](docs/GetAdAudience200Response.md)
|
|
@@ -926,8 +942,11 @@ Class | Method | HTTP request | Description
|
|
|
926
942
|
- [Zernio::GetAdComments200ResponsePagination](docs/GetAdComments200ResponsePagination.md)
|
|
927
943
|
- [Zernio::GetAdInsightsReport200Response](docs/GetAdInsightsReport200Response.md)
|
|
928
944
|
- [Zernio::GetAdInsightsReport200ResponsePaging](docs/GetAdInsightsReport200ResponsePaging.md)
|
|
945
|
+
- [Zernio::GetAdPreviews200Response](docs/GetAdPreviews200Response.md)
|
|
946
|
+
- [Zernio::GetAdSetDetails200Response](docs/GetAdSetDetails200Response.md)
|
|
929
947
|
- [Zernio::GetAdTrackingTags200Response](docs/GetAdTrackingTags200Response.md)
|
|
930
948
|
- [Zernio::GetAdTree200Response](docs/GetAdTree200Response.md)
|
|
949
|
+
- [Zernio::GetAdsActivityLog200Response](docs/GetAdsActivityLog200Response.md)
|
|
931
950
|
- [Zernio::GetAdsTimeline200Response](docs/GetAdsTimeline200Response.md)
|
|
932
951
|
- [Zernio::GetAdsTimeline200ResponseRowsInner](docs/GetAdsTimeline200ResponseRowsInner.md)
|
|
933
952
|
- [Zernio::GetAllAccountsHealth200Response](docs/GetAllAccountsHealth200Response.md)
|
|
@@ -1280,6 +1299,7 @@ Class | Method | HTTP request | Description
|
|
|
1280
1299
|
- [Zernio::ListAdCatalogProductSets200ResponseProductSetsInner](docs/ListAdCatalogProductSets200ResponseProductSetsInner.md)
|
|
1281
1300
|
- [Zernio::ListAdCatalogs200Response](docs/ListAdCatalogs200Response.md)
|
|
1282
1301
|
- [Zernio::ListAdCatalogs200ResponseCatalogsInner](docs/ListAdCatalogs200ResponseCatalogsInner.md)
|
|
1302
|
+
- [Zernio::ListAdStudies200Response](docs/ListAdStudies200Response.md)
|
|
1283
1303
|
- [Zernio::ListAds200Response](docs/ListAds200Response.md)
|
|
1284
1304
|
- [Zernio::ListAdsBusinessCenters200Response](docs/ListAdsBusinessCenters200Response.md)
|
|
1285
1305
|
- [Zernio::ListApiKeys200Response](docs/ListApiKeys200Response.md)
|
|
@@ -1808,6 +1828,9 @@ Class | Method | HTTP request | Description
|
|
|
1808
1828
|
- [Zernio::UpdateWorkflowRequest](docs/UpdateWorkflowRequest.md)
|
|
1809
1829
|
- [Zernio::UpdateYoutubeDefaultPlaylist200Response](docs/UpdateYoutubeDefaultPlaylist200Response.md)
|
|
1810
1830
|
- [Zernio::UpdateYoutubeDefaultPlaylistRequest](docs/UpdateYoutubeDefaultPlaylistRequest.md)
|
|
1831
|
+
- [Zernio::UploadAdImage201Response](docs/UploadAdImage201Response.md)
|
|
1832
|
+
- [Zernio::UploadAdImage201ResponseImage](docs/UploadAdImage201ResponseImage.md)
|
|
1833
|
+
- [Zernio::UploadAdImageRequest](docs/UploadAdImageRequest.md)
|
|
1811
1834
|
- [Zernio::UploadMediaDirect200Response](docs/UploadMediaDirect200Response.md)
|
|
1812
1835
|
- [Zernio::UploadPhoneNumberKycDocument200Response](docs/UploadPhoneNumberKycDocument200Response.md)
|
|
1813
1836
|
- [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)
|