zernio-sdk 0.0.540 → 0.0.542
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 +4 -42
- data/docs/AdAudiencesApi.md +5 -5
- data/docs/AdCampaignsApi.md +0 -142
- data/docs/AdsApi.md +18 -700
- data/docs/InboxApi.md +79 -0
- data/docs/InboxWebhookMessageAttachmentsInner.md +1 -1
- data/docs/SMSApi.md +1 -276
- data/docs/SendSmsRequest.md +1 -1
- data/docs/WebhookPayloadMessageMessage.md +1 -1
- data/docs/WebhookPayloadMessageMessageAttachmentsInner.md +22 -0
- data/docs/WebhookPayloadMessageSentMessage.md +1 -1
- data/docs/WebhookPayloadMessageSentMessageAttachmentsInner.md +22 -0
- data/lib/zernio-sdk/api/ad_audiences_api.rb +4 -4
- data/lib/zernio-sdk/api/ad_campaigns_api.rb +0 -142
- data/lib/zernio-sdk/api/ads_api.rb +39 -739
- data/lib/zernio-sdk/api/inbox_api.rb +92 -0
- data/lib/zernio-sdk/api/sms_api.rb +2 -256
- data/lib/zernio-sdk/models/inbox_webhook_message_attachments_inner.rb +1 -1
- data/lib/zernio-sdk/models/send_sms_request.rb +1 -1
- data/lib/zernio-sdk/models/webhook_payload_message_message.rb +1 -1
- data/lib/zernio-sdk/models/{create_sms_sender_id_request.rb → webhook_payload_message_message_attachments_inner.rb} +52 -33
- data/lib/zernio-sdk/models/webhook_payload_message_sent_message.rb +1 -1
- data/lib/zernio-sdk/models/{update_ad_creative_request.rb → webhook_payload_message_sent_message_attachments_inner.rb} +46 -44
- data/lib/zernio-sdk/version.rb +1 -1
- data/lib/zernio-sdk.rb +3 -26
- data/openapi.yaml +87 -624
- data/spec/api/ad_audiences_api_spec.rb +2 -2
- data/spec/api/ad_campaigns_api_spec.rb +0 -25
- data/spec/api/ads_api_spec.rb +0 -128
- data/spec/api/inbox_api_spec.rb +48 -0
- data/spec/api/sms_api_spec.rb +1 -47
- data/spec/models/{list_ad_images200_response_spec.rb → webhook_payload_message_message_attachments_inner_spec.rb} +9 -9
- data/spec/models/{list_ad_creatives200_response_spec.rb → webhook_payload_message_sent_message_attachments_inner_spec.rb} +9 -9
- metadata +13 -105
- data/docs/CreateAdCampaign201Response.md +0 -24
- data/docs/CreateAdCampaignRequest.md +0 -32
- data/docs/CreateAdCreative201Response.md +0 -20
- data/docs/CreateAdCreativeRequest.md +0 -38
- data/docs/CreateAdCreativeRequestCarouselCardsInner.md +0 -26
- data/docs/CreateSmsSenderId200Response.md +0 -22
- data/docs/CreateSmsSenderIdRequest.md +0 -18
- data/docs/DeleteAdCreative200Response.md +0 -20
- data/docs/DeleteSmsSenderId200Response.md +0 -18
- data/docs/DuplicateAd200Response.md +0 -22
- data/docs/DuplicateAdRequest.md +0 -28
- data/docs/DuplicateAdSet200Response.md +0 -22
- data/docs/DuplicateAdSetRequest.md +0 -36
- data/docs/GetAdCreative200Response.md +0 -18
- data/docs/ListAdCreatives200Response.md +0 -22
- data/docs/ListAdImages200Response.md +0 -22
- data/docs/ListAdLabels200Response.md +0 -22
- data/docs/ListHighDemandPeriods200Response.md +0 -22
- data/docs/ListSmsSenderIds200Response.md +0 -20
- data/docs/ListSmsSenderIds200ResponseBudget.md +0 -24
- data/docs/ListSmsSenderIds200ResponseBudgetPendingRequest.md +0 -22
- data/docs/ListSmsSenderIds200ResponseSenderIdsInner.md +0 -24
- data/docs/RequestSmsSenderIdLimitIncrease200Response.md +0 -20
- data/docs/RequestSmsSenderIdLimitIncreaseRequest.md +0 -20
- data/docs/UpdateAdCreative200Response.md +0 -22
- data/docs/UpdateAdCreativeRequest.md +0 -20
- data/lib/zernio-sdk/models/create_ad_campaign201_response.rb +0 -210
- data/lib/zernio-sdk/models/create_ad_campaign_request.rb +0 -343
- data/lib/zernio-sdk/models/create_ad_creative201_response.rb +0 -157
- data/lib/zernio-sdk/models/create_ad_creative_request.rb +0 -390
- data/lib/zernio-sdk/models/create_ad_creative_request_carousel_cards_inner.rb +0 -255
- data/lib/zernio-sdk/models/create_sms_sender_id200_response.rb +0 -166
- data/lib/zernio-sdk/models/delete_ad_creative200_response.rb +0 -156
- data/lib/zernio-sdk/models/delete_sms_sender_id200_response.rb +0 -147
- data/lib/zernio-sdk/models/duplicate_ad200_response.rb +0 -200
- data/lib/zernio-sdk/models/duplicate_ad_request.rb +0 -243
- data/lib/zernio-sdk/models/duplicate_ad_set200_response.rb +0 -201
- data/lib/zernio-sdk/models/duplicate_ad_set_request.rb +0 -302
- data/lib/zernio-sdk/models/get_ad_creative200_response.rb +0 -148
- data/lib/zernio-sdk/models/list_ad_creatives200_response.rb +0 -167
- data/lib/zernio-sdk/models/list_ad_images200_response.rb +0 -167
- data/lib/zernio-sdk/models/list_ad_labels200_response.rb +0 -167
- data/lib/zernio-sdk/models/list_high_demand_periods200_response.rb +0 -168
- data/lib/zernio-sdk/models/list_sms_sender_ids200_response.rb +0 -158
- data/lib/zernio-sdk/models/list_sms_sender_ids200_response_budget.rb +0 -178
- data/lib/zernio-sdk/models/list_sms_sender_ids200_response_budget_pending_request.rb +0 -167
- data/lib/zernio-sdk/models/list_sms_sender_ids200_response_sender_ids_inner.rb +0 -175
- data/lib/zernio-sdk/models/request_sms_sender_id_limit_increase200_response.rb +0 -156
- data/lib/zernio-sdk/models/request_sms_sender_id_limit_increase_request.rb +0 -210
- data/lib/zernio-sdk/models/update_ad_creative200_response.rb +0 -165
- data/spec/models/create_ad_campaign201_response_spec.rb +0 -58
- data/spec/models/create_ad_campaign_request_spec.rb +0 -94
- data/spec/models/create_ad_creative201_response_spec.rb +0 -42
- data/spec/models/create_ad_creative_request_carousel_cards_inner_spec.rb +0 -60
- data/spec/models/create_ad_creative_request_spec.rb +0 -96
- data/spec/models/create_sms_sender_id200_response_spec.rb +0 -48
- data/spec/models/create_sms_sender_id_request_spec.rb +0 -36
- data/spec/models/delete_ad_creative200_response_spec.rb +0 -42
- data/spec/models/delete_sms_sender_id200_response_spec.rb +0 -36
- data/spec/models/duplicate_ad200_response_spec.rb +0 -52
- data/spec/models/duplicate_ad_request_spec.rb +0 -74
- data/spec/models/duplicate_ad_set200_response_spec.rb +0 -52
- data/spec/models/duplicate_ad_set_request_spec.rb +0 -102
- data/spec/models/get_ad_creative200_response_spec.rb +0 -36
- data/spec/models/list_ad_labels200_response_spec.rb +0 -48
- data/spec/models/list_high_demand_periods200_response_spec.rb +0 -48
- data/spec/models/list_sms_sender_ids200_response_budget_pending_request_spec.rb +0 -48
- data/spec/models/list_sms_sender_ids200_response_budget_spec.rb +0 -54
- data/spec/models/list_sms_sender_ids200_response_sender_ids_inner_spec.rb +0 -54
- data/spec/models/list_sms_sender_ids200_response_spec.rb +0 -42
- data/spec/models/request_sms_sender_id_limit_increase200_response_spec.rb +0 -42
- data/spec/models/request_sms_sender_id_limit_increase_request_spec.rb +0 -42
- data/spec/models/update_ad_creative200_response_spec.rb +0 -48
- data/spec/models/update_ad_creative_request_spec.rb +0 -42
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 47986c4f30471814d73640bf453ec32a6ef449ff7c27ec3ef83665323f3c9b69
|
|
4
|
+
data.tar.gz: abeea3280688c501b4df3113f11a4ebc1fb5ee8f9ce5552178bcd5ae20887402
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 5c25cdcf4197c51400857a3cc30661ba158ea4a172605ac12038072169178ce139499cb637e4858ad71e352acfcd02f77f58de581523c1130b28f9a7f930b0a6
|
|
7
|
+
data.tar.gz: dc7187ce2ecdc4e82fba620f3b8dd51cc698264d0f074891c459f6e887afb0c5c507b45e3a1af80b5379ddb8e1a64c8f974ceee69a4637be7cb1237e2232821a
|
data/README.md
CHANGED
|
@@ -95,12 +95,10 @@ Class | Method | HTTP request | Description
|
|
|
95
95
|
*Zernio::AdAudiencesApi* | [**delete_ad_audience**](docs/AdAudiencesApi.md#delete_ad_audience) | **DELETE** /v1/ads/audiences/{audienceId} | Delete custom audience
|
|
96
96
|
*Zernio::AdAudiencesApi* | [**get_ad_audience**](docs/AdAudiencesApi.md#get_ad_audience) | **GET** /v1/ads/audiences/{audienceId} | Get audience details
|
|
97
97
|
*Zernio::AdAudiencesApi* | [**list_ad_audiences**](docs/AdAudiencesApi.md#list_ad_audiences) | **GET** /v1/ads/audiences | List custom audiences
|
|
98
|
-
*Zernio::AdAudiencesApi* | [**update_ad_audience**](docs/AdAudiencesApi.md#update_ad_audience) | **PUT** /v1/ads/audiences/{audienceId} | Update
|
|
98
|
+
*Zernio::AdAudiencesApi* | [**update_ad_audience**](docs/AdAudiencesApi.md#update_ad_audience) | **PUT** /v1/ads/audiences/{audienceId} | Update saved targeting audience
|
|
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
|
-
*Zernio::AdCampaignsApi* | [**create_ad_campaign**](docs/AdCampaignsApi.md#create_ad_campaign) | **POST** /v1/ads/campaigns | Create a standalone campaign (Meta)
|
|
101
100
|
*Zernio::AdCampaignsApi* | [**delete_ad_campaign**](docs/AdCampaignsApi.md#delete_ad_campaign) | **DELETE** /v1/ads/campaigns/{campaignId} | Delete a campaign
|
|
102
101
|
*Zernio::AdCampaignsApi* | [**duplicate_ad_campaign**](docs/AdCampaignsApi.md#duplicate_ad_campaign) | **POST** /v1/ads/campaigns/{campaignId}/duplicate | Duplicate a campaign
|
|
103
|
-
*Zernio::AdCampaignsApi* | [**duplicate_ad_set**](docs/AdCampaignsApi.md#duplicate_ad_set) | **POST** /v1/ads/ad-sets/{adSetId}/duplicate | Duplicate an ad set (Meta)
|
|
104
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)
|
|
105
103
|
*Zernio::AdCampaignsApi* | [**get_ad_tree**](docs/AdCampaignsApi.md#get_ad_tree) | **GET** /v1/ads/tree | Get campaign tree
|
|
106
104
|
*Zernio::AdCampaignsApi* | [**get_ads_timeline**](docs/AdCampaignsApi.md#get_ads_timeline) | **GET** /v1/ads/timeline | Get daily account metrics
|
|
@@ -114,7 +112,6 @@ Class | Method | HTTP request | Description
|
|
|
114
112
|
*Zernio::AdsApi* | [**archive_lead_form**](docs/AdsApi.md#archive_lead_form) | **DELETE** /v1/ads/lead-forms/{formId} | Archive a lead form
|
|
115
113
|
*Zernio::AdsApi* | [**boost_post**](docs/AdsApi.md#boost_post) | **POST** /v1/ads/boost | Boost post as ad
|
|
116
114
|
*Zernio::AdsApi* | [**cancel_rf_reservation**](docs/AdsApi.md#cancel_rf_reservation) | **DELETE** /v1/ads/rf-predictions/{predictionId} | Cancel a Reach & Frequency reservation (Meta)
|
|
117
|
-
*Zernio::AdsApi* | [**create_ad_creative**](docs/AdsApi.md#create_ad_creative) | **POST** /v1/ads/creatives | Create a standalone creative (Meta)
|
|
118
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)
|
|
119
116
|
*Zernio::AdsApi* | [**create_call_ad**](docs/AdsApi.md#create_call_ad) | **POST** /v1/ads/call | Create Click-to-Call ad
|
|
120
117
|
*Zernio::AdsApi* | [**create_conversion_destination**](docs/AdsApi.md#create_conversion_destination) | **POST** /v1/accounts/{accountId}/conversion-destinations | Create a conversion destination
|
|
@@ -125,16 +122,13 @@ Class | Method | HTTP request | Description
|
|
|
125
122
|
*Zernio::AdsApi* | [**create_standalone_ad**](docs/AdsApi.md#create_standalone_ad) | **POST** /v1/ads/create | Create standalone ad
|
|
126
123
|
*Zernio::AdsApi* | [**create_test_lead**](docs/AdsApi.md#create_test_lead) | **POST** /v1/ads/lead-forms/{formId}/test-leads | Create a test lead
|
|
127
124
|
*Zernio::AdsApi* | [**delete_ad**](docs/AdsApi.md#delete_ad) | **DELETE** /v1/ads/{adId} | Cancel an ad
|
|
128
|
-
*Zernio::AdsApi* | [**delete_ad_creative**](docs/AdsApi.md#delete_ad_creative) | **DELETE** /v1/ads/creatives/{creativeId} | Delete a creative (Meta)
|
|
129
125
|
*Zernio::AdsApi* | [**delete_conversion_destination**](docs/AdsApi.md#delete_conversion_destination) | **DELETE** /v1/accounts/{accountId}/conversion-destinations/{destinationId} | Delete a conversion destination
|
|
130
|
-
*Zernio::AdsApi* | [**duplicate_ad**](docs/AdsApi.md#duplicate_ad) | **POST** /v1/ads/{adId}/duplicate | Duplicate an ad (Meta)
|
|
131
126
|
*Zernio::AdsApi* | [**estimate_ad_reach**](docs/AdsApi.md#estimate_ad_reach) | **POST** /v1/ads/targeting/reach-estimate | Estimate audience reach
|
|
132
127
|
*Zernio::AdsApi* | [**generate_ad_previews**](docs/AdsApi.md#generate_ad_previews) | **POST** /v1/ads/preview | Render pre-create ad previews (Meta)
|
|
133
128
|
*Zernio::AdsApi* | [**get_ad**](docs/AdsApi.md#get_ad) | **GET** /v1/ads/{adId} | Get ad details
|
|
134
129
|
*Zernio::AdsApi* | [**get_ad_account_finance**](docs/AdsApi.md#get_ad_account_finance) | **GET** /v1/ads/accounts/finance | Ad account finances (Meta)
|
|
135
130
|
*Zernio::AdsApi* | [**get_ad_analytics**](docs/AdsApi.md#get_ad_analytics) | **GET** /v1/ads/{adId}/analytics | Get ad analytics
|
|
136
131
|
*Zernio::AdsApi* | [**get_ad_comments**](docs/AdsApi.md#get_ad_comments) | **GET** /v1/ads/{adId}/comments | List comments on an ad
|
|
137
|
-
*Zernio::AdsApi* | [**get_ad_creative**](docs/AdsApi.md#get_ad_creative) | **GET** /v1/ads/creatives/{creativeId} | Creative details (Meta)
|
|
138
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)
|
|
139
133
|
*Zernio::AdsApi* | [**get_ad_previews**](docs/AdsApi.md#get_ad_previews) | **GET** /v1/ads/{adId}/preview | Render previews of an existing ad (Meta)
|
|
140
134
|
*Zernio::AdsApi* | [**get_ad_tracking_tags**](docs/AdsApi.md#get_ad_tracking_tags) | **GET** /v1/ads/{adId}/tracking-tags | Get ad tracking tags
|
|
@@ -152,16 +146,12 @@ Class | Method | HTTP request | Description
|
|
|
152
146
|
*Zernio::AdsApi* | [**list_ad_accounts**](docs/AdsApi.md#list_ad_accounts) | **GET** /v1/ads/accounts | List ad accounts
|
|
153
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
|
|
154
148
|
*Zernio::AdsApi* | [**list_ad_catalogs**](docs/AdsApi.md#list_ad_catalogs) | **GET** /v1/ads/catalogs | List Meta product catalogs
|
|
155
|
-
*Zernio::AdsApi* | [**list_ad_creatives**](docs/AdsApi.md#list_ad_creatives) | **GET** /v1/ads/creatives | Creative library (Meta)
|
|
156
|
-
*Zernio::AdsApi* | [**list_ad_images**](docs/AdsApi.md#list_ad_images) | **GET** /v1/ads/images | Ad image library (Meta)
|
|
157
|
-
*Zernio::AdsApi* | [**list_ad_labels**](docs/AdsApi.md#list_ad_labels) | **GET** /v1/ads/labels | Ad labels (Meta)
|
|
158
149
|
*Zernio::AdsApi* | [**list_ad_studies**](docs/AdsApi.md#list_ad_studies) | **GET** /v1/ads/studies | A/B tests and lift studies (Meta)
|
|
159
150
|
*Zernio::AdsApi* | [**list_ads**](docs/AdsApi.md#list_ads) | **GET** /v1/ads | List ads
|
|
160
151
|
*Zernio::AdsApi* | [**list_ads_business_centers**](docs/AdsApi.md#list_ads_business_centers) | **GET** /v1/ads/business-centers | List TikTok Business Centers
|
|
161
152
|
*Zernio::AdsApi* | [**list_conversion_associations**](docs/AdsApi.md#list_conversion_associations) | **GET** /v1/accounts/{accountId}/conversion-destinations/{destinationId}/associations | List associated campaigns
|
|
162
153
|
*Zernio::AdsApi* | [**list_conversion_destinations**](docs/AdsApi.md#list_conversion_destinations) | **GET** /v1/accounts/{accountId}/conversion-destinations | List conversion destinations
|
|
163
154
|
*Zernio::AdsApi* | [**list_form_leads**](docs/AdsApi.md#list_form_leads) | **GET** /v1/ads/lead-forms/{formId}/leads | List leads for a single form
|
|
164
|
-
*Zernio::AdsApi* | [**list_high_demand_periods**](docs/AdsApi.md#list_high_demand_periods) | **GET** /v1/ads/high-demand-periods | High demand periods / budget schedules (Meta)
|
|
165
155
|
*Zernio::AdsApi* | [**list_lead_forms**](docs/AdsApi.md#list_lead_forms) | **GET** /v1/ads/lead-forms | List lead forms
|
|
166
156
|
*Zernio::AdsApi* | [**list_leads**](docs/AdsApi.md#list_leads) | **GET** /v1/ads/leads | List submitted leads
|
|
167
157
|
*Zernio::AdsApi* | [**list_whats_app_conversions**](docs/AdsApi.md#list_whats_app_conversions) | **GET** /v1/whatsapp/conversions | List conversion events
|
|
@@ -174,7 +164,6 @@ Class | Method | HTTP request | Description
|
|
|
174
164
|
*Zernio::AdsApi* | [**send_whats_app_conversion**](docs/AdsApi.md#send_whats_app_conversion) | **POST** /v1/whatsapp/conversions | Send WhatsApp conversion event
|
|
175
165
|
*Zernio::AdsApi* | [**update_ad**](docs/AdsApi.md#update_ad) | **PUT** /v1/ads/{adId} | Update ad
|
|
176
166
|
*Zernio::AdsApi* | [**update_ad_account**](docs/AdsApi.md#update_ad_account) | **PATCH** /v1/ads/accounts | Update ad account settings
|
|
177
|
-
*Zernio::AdsApi* | [**update_ad_creative**](docs/AdsApi.md#update_ad_creative) | **PUT** /v1/ads/creatives/{creativeId} | Rename a creative (Meta)
|
|
178
167
|
*Zernio::AdsApi* | [**update_ad_status**](docs/AdsApi.md#update_ad_status) | **PUT** /v1/ads/{adId}/status | Pause or resume a single ad
|
|
179
168
|
*Zernio::AdsApi* | [**update_ad_tracking_tags**](docs/AdsApi.md#update_ad_tracking_tags) | **PATCH** /v1/ads/{adId}/tracking-tags | Set ad tracking tags
|
|
180
169
|
*Zernio::AdsApi* | [**update_conversion_destination**](docs/AdsApi.md#update_conversion_destination) | **PATCH** /v1/accounts/{accountId}/conversion-destinations/{destinationId} | Update a conversion destination
|
|
@@ -332,6 +321,7 @@ Class | Method | HTTP request | Description
|
|
|
332
321
|
*Zernio::GMBVerificationsApi* | [**fetch_google_business_verification_options**](docs/GMBVerificationsApi.md#fetch_google_business_verification_options) | **POST** /v1/accounts/{accountId}/gmb-verifications/options | Fetch verification options
|
|
333
322
|
*Zernio::GMBVerificationsApi* | [**get_google_business_verifications**](docs/GMBVerificationsApi.md#get_google_business_verifications) | **GET** /v1/accounts/{accountId}/gmb-verifications | Get verification state
|
|
334
323
|
*Zernio::GMBVerificationsApi* | [**start_google_business_verification**](docs/GMBVerificationsApi.md#start_google_business_verification) | **POST** /v1/accounts/{accountId}/gmb-verifications | Start a verification
|
|
324
|
+
*Zernio::InboxApi* | [**get_whats_app_media**](docs/InboxApi.md#get_whats_app_media) | **GET** /v1/whatsapp/media/{mediaId} | Download WhatsApp media
|
|
335
325
|
*Zernio::InboxAnalyticsApi* | [**get_inbox_conversation_analytics**](docs/InboxAnalyticsApi.md#get_inbox_conversation_analytics) | **GET** /v1/analytics/inbox/conversations/{conversationId} | Get conversation analytics
|
|
336
326
|
*Zernio::InboxAnalyticsApi* | [**get_inbox_heatmap**](docs/InboxAnalyticsApi.md#get_inbox_heatmap) | **GET** /v1/analytics/inbox/heatmap | Get day × hour heatmap
|
|
337
327
|
*Zernio::InboxAnalyticsApi* | [**get_inbox_response_time**](docs/InboxAnalyticsApi.md#get_inbox_response_time) | **GET** /v1/analytics/inbox/response-time | Get inbox response-time stats
|
|
@@ -411,17 +401,13 @@ Class | Method | HTTP request | Description
|
|
|
411
401
|
*Zernio::ReviewsApi* | [**list_inbox_reviews**](docs/ReviewsApi.md#list_inbox_reviews) | **GET** /v1/inbox/reviews | List reviews
|
|
412
402
|
*Zernio::ReviewsApi* | [**reply_to_inbox_review**](docs/ReviewsApi.md#reply_to_inbox_review) | **POST** /v1/inbox/reviews/{reviewId}/reply | Reply to review
|
|
413
403
|
*Zernio::SMSApi* | [**appeal_sms_registration**](docs/SMSApi.md#appeal_sms_registration) | **POST** /v1/sms/registrations/{id}/appeal | Appeal a rejected campaign
|
|
414
|
-
*Zernio::SMSApi* | [**create_sms_sender_id**](docs/SMSApi.md#create_sms_sender_id) | **POST** /v1/sms/sender-ids | Create an alphanumeric sender ID
|
|
415
404
|
*Zernio::SMSApi* | [**deactivate_sms_registration**](docs/SMSApi.md#deactivate_sms_registration) | **DELETE** /v1/sms/registrations/{id} | Deactivate a brand/campaign registration
|
|
416
|
-
*Zernio::SMSApi* | [**delete_sms_sender_id**](docs/SMSApi.md#delete_sms_sender_id) | **DELETE** /v1/sms/sender-ids/{id} | Delete an alphanumeric sender ID
|
|
417
405
|
*Zernio::SMSApi* | [**disable_sms_on_number**](docs/SMSApi.md#disable_sms_on_number) | **DELETE** /v1/phone-numbers/{id}/sms | Disable SMS on a number
|
|
418
406
|
*Zernio::SMSApi* | [**enable_sms_on_number**](docs/SMSApi.md#enable_sms_on_number) | **POST** /v1/phone-numbers/{id}/sms | Enable SMS on a number
|
|
419
407
|
*Zernio::SMSApi* | [**get_sms_registration**](docs/SMSApi.md#get_sms_registration) | **GET** /v1/sms/registrations/{id} | Get a carrier registration
|
|
420
408
|
*Zernio::SMSApi* | [**list_sms_opt_outs**](docs/SMSApi.md#list_sms_opt_outs) | **GET** /v1/sms/opt-outs | List SMS opt-outs
|
|
421
409
|
*Zernio::SMSApi* | [**list_sms_registrations**](docs/SMSApi.md#list_sms_registrations) | **GET** /v1/sms/registrations | List carrier registrations
|
|
422
|
-
*Zernio::SMSApi* | [**list_sms_sender_ids**](docs/SMSApi.md#list_sms_sender_ids) | **GET** /v1/sms/sender-ids | List alphanumeric sender IDs
|
|
423
410
|
*Zernio::SMSApi* | [**lookup_sms_number**](docs/SMSApi.md#lookup_sms_number) | **GET** /v1/sms/lookup | Look up carrier + line type
|
|
424
|
-
*Zernio::SMSApi* | [**request_sms_sender_id_limit_increase**](docs/SMSApi.md#request_sms_sender_id_limit_increase) | **POST** /v1/sms/sender-ids/limit-request | Request a higher sender ID daily limit
|
|
425
411
|
*Zernio::SMSApi* | [**resend_sms_registration_otp**](docs/SMSApi.md#resend_sms_registration_otp) | **POST** /v1/sms/registrations/{id}/resend-otp | Re-send the sole-prop OTP
|
|
426
412
|
*Zernio::SMSApi* | [**reuse_sms_registration_for_number**](docs/SMSApi.md#reuse_sms_registration_for_number) | **POST** /v1/phone-numbers/{id}/sms/reuse-registration | Add number to SMS registration
|
|
427
413
|
*Zernio::SMSApi* | [**send_sms**](docs/SMSApi.md#send_sms) | **POST** /v1/sms/messages | Send an SMS/MMS
|
|
@@ -719,11 +705,6 @@ Class | Method | HTTP request | Description
|
|
|
719
705
|
- [Zernio::CreateAccountGroupRequest](docs/CreateAccountGroupRequest.md)
|
|
720
706
|
- [Zernio::CreateAdAudience201Response](docs/CreateAdAudience201Response.md)
|
|
721
707
|
- [Zernio::CreateAdAudienceRequest](docs/CreateAdAudienceRequest.md)
|
|
722
|
-
- [Zernio::CreateAdCampaign201Response](docs/CreateAdCampaign201Response.md)
|
|
723
|
-
- [Zernio::CreateAdCampaignRequest](docs/CreateAdCampaignRequest.md)
|
|
724
|
-
- [Zernio::CreateAdCreative201Response](docs/CreateAdCreative201Response.md)
|
|
725
|
-
- [Zernio::CreateAdCreativeRequest](docs/CreateAdCreativeRequest.md)
|
|
726
|
-
- [Zernio::CreateAdCreativeRequestCarouselCardsInner](docs/CreateAdCreativeRequestCarouselCardsInner.md)
|
|
727
708
|
- [Zernio::CreateAdInsightsReport202Response](docs/CreateAdInsightsReport202Response.md)
|
|
728
709
|
- [Zernio::CreateAdInsightsReportRequest](docs/CreateAdInsightsReportRequest.md)
|
|
729
710
|
- [Zernio::CreateAdInsightsReportRequestFilteringInner](docs/CreateAdInsightsReportRequestFilteringInner.md)
|
|
@@ -810,8 +791,6 @@ Class | Method | HTTP request | Description
|
|
|
810
791
|
- [Zernio::CreateSequenceRequestStepsInner](docs/CreateSequenceRequestStepsInner.md)
|
|
811
792
|
- [Zernio::CreateSequenceRequestStepsInnerTemplate](docs/CreateSequenceRequestStepsInnerTemplate.md)
|
|
812
793
|
- [Zernio::CreateSequenceRequestStepsInnerTemplateVariableMappingValue](docs/CreateSequenceRequestStepsInnerTemplateVariableMappingValue.md)
|
|
813
|
-
- [Zernio::CreateSmsSenderId200Response](docs/CreateSmsSenderId200Response.md)
|
|
814
|
-
- [Zernio::CreateSmsSenderIdRequest](docs/CreateSmsSenderIdRequest.md)
|
|
815
794
|
- [Zernio::CreateStandaloneAd201Response](docs/CreateStandaloneAd201Response.md)
|
|
816
795
|
- [Zernio::CreateStandaloneAd201ResponseOneOf](docs/CreateStandaloneAd201ResponseOneOf.md)
|
|
817
796
|
- [Zernio::CreateStandaloneAd201ResponseOneOf1](docs/CreateStandaloneAd201ResponseOneOf1.md)
|
|
@@ -878,7 +857,6 @@ Class | Method | HTTP request | Description
|
|
|
878
857
|
- [Zernio::DeleteAccountGroup200Response](docs/DeleteAccountGroup200Response.md)
|
|
879
858
|
- [Zernio::DeleteAdCampaign200Response](docs/DeleteAdCampaign200Response.md)
|
|
880
859
|
- [Zernio::DeleteAdCampaignRequest](docs/DeleteAdCampaignRequest.md)
|
|
881
|
-
- [Zernio::DeleteAdCreative200Response](docs/DeleteAdCreative200Response.md)
|
|
882
860
|
- [Zernio::DeleteDiscordScheduledEvent200Response](docs/DeleteDiscordScheduledEvent200Response.md)
|
|
883
861
|
- [Zernio::DeleteGoogleBusinessMedia200Response](docs/DeleteGoogleBusinessMedia200Response.md)
|
|
884
862
|
- [Zernio::DeleteGoogleBusinessPlaceAction200Response](docs/DeleteGoogleBusinessPlaceAction200Response.md)
|
|
@@ -886,7 +864,6 @@ Class | Method | HTTP request | Description
|
|
|
886
864
|
- [Zernio::DeleteInboxComment200Response](docs/DeleteInboxComment200Response.md)
|
|
887
865
|
- [Zernio::DeleteInboxReviewReply200Response](docs/DeleteInboxReviewReply200Response.md)
|
|
888
866
|
- [Zernio::DeleteInboxReviewReplyRequest](docs/DeleteInboxReviewReplyRequest.md)
|
|
889
|
-
- [Zernio::DeleteSmsSenderId200Response](docs/DeleteSmsSenderId200Response.md)
|
|
890
867
|
- [Zernio::DeleteWhatsappBusinessUsernameRequest](docs/DeleteWhatsappBusinessUsernameRequest.md)
|
|
891
868
|
- [Zernio::DialVoiceWebCall200Response](docs/DialVoiceWebCall200Response.md)
|
|
892
869
|
- [Zernio::DialVoiceWebCallRequest](docs/DialVoiceWebCallRequest.md)
|
|
@@ -906,12 +883,8 @@ Class | Method | HTTP request | Description
|
|
|
906
883
|
- [Zernio::DiscordScheduledEvent](docs/DiscordScheduledEvent.md)
|
|
907
884
|
- [Zernio::DiscordScheduledEventEntityMetadata](docs/DiscordScheduledEventEntityMetadata.md)
|
|
908
885
|
- [Zernio::DmButton](docs/DmButton.md)
|
|
909
|
-
- [Zernio::DuplicateAd200Response](docs/DuplicateAd200Response.md)
|
|
910
886
|
- [Zernio::DuplicateAdCampaign200Response](docs/DuplicateAdCampaign200Response.md)
|
|
911
887
|
- [Zernio::DuplicateAdCampaignRequest](docs/DuplicateAdCampaignRequest.md)
|
|
912
|
-
- [Zernio::DuplicateAdRequest](docs/DuplicateAdRequest.md)
|
|
913
|
-
- [Zernio::DuplicateAdSet200Response](docs/DuplicateAdSet200Response.md)
|
|
914
|
-
- [Zernio::DuplicateAdSetRequest](docs/DuplicateAdSetRequest.md)
|
|
915
888
|
- [Zernio::DuplicateWorkflow201Response](docs/DuplicateWorkflow201Response.md)
|
|
916
889
|
- [Zernio::DuplicateWorkflow201ResponseWorkflow](docs/DuplicateWorkflow201ResponseWorkflow.md)
|
|
917
890
|
- [Zernio::EditDiscordGuildRoleRequest](docs/EditDiscordGuildRoleRequest.md)
|
|
@@ -983,7 +956,6 @@ Class | Method | HTTP request | Description
|
|
|
983
956
|
- [Zernio::GetAdComments200Response](docs/GetAdComments200Response.md)
|
|
984
957
|
- [Zernio::GetAdComments200ResponseMeta](docs/GetAdComments200ResponseMeta.md)
|
|
985
958
|
- [Zernio::GetAdComments200ResponsePagination](docs/GetAdComments200ResponsePagination.md)
|
|
986
|
-
- [Zernio::GetAdCreative200Response](docs/GetAdCreative200Response.md)
|
|
987
959
|
- [Zernio::GetAdInsightsReport200Response](docs/GetAdInsightsReport200Response.md)
|
|
988
960
|
- [Zernio::GetAdInsightsReport200ResponsePaging](docs/GetAdInsightsReport200ResponsePaging.md)
|
|
989
961
|
- [Zernio::GetAdPreviews200Response](docs/GetAdPreviews200Response.md)
|
|
@@ -1347,9 +1319,6 @@ Class | Method | HTTP request | Description
|
|
|
1347
1319
|
- [Zernio::ListAdCatalogProductSets200ResponseProductSetsInner](docs/ListAdCatalogProductSets200ResponseProductSetsInner.md)
|
|
1348
1320
|
- [Zernio::ListAdCatalogs200Response](docs/ListAdCatalogs200Response.md)
|
|
1349
1321
|
- [Zernio::ListAdCatalogs200ResponseCatalogsInner](docs/ListAdCatalogs200ResponseCatalogsInner.md)
|
|
1350
|
-
- [Zernio::ListAdCreatives200Response](docs/ListAdCreatives200Response.md)
|
|
1351
|
-
- [Zernio::ListAdImages200Response](docs/ListAdImages200Response.md)
|
|
1352
|
-
- [Zernio::ListAdLabels200Response](docs/ListAdLabels200Response.md)
|
|
1353
1322
|
- [Zernio::ListAdStudies200Response](docs/ListAdStudies200Response.md)
|
|
1354
1323
|
- [Zernio::ListAds200Response](docs/ListAds200Response.md)
|
|
1355
1324
|
- [Zernio::ListAdsBusinessCenters200Response](docs/ListAdsBusinessCenters200Response.md)
|
|
@@ -1394,7 +1363,6 @@ Class | Method | HTTP request | Description
|
|
|
1394
1363
|
- [Zernio::ListGoogleBusinessMedia200ResponseMediaItemsInnerLocationAssociation](docs/ListGoogleBusinessMedia200ResponseMediaItemsInnerLocationAssociation.md)
|
|
1395
1364
|
- [Zernio::ListGoogleBusinessPlaceActions200Response](docs/ListGoogleBusinessPlaceActions200Response.md)
|
|
1396
1365
|
- [Zernio::ListGoogleBusinessPlaceActions200ResponsePlaceActionLinksInner](docs/ListGoogleBusinessPlaceActions200ResponsePlaceActionLinksInner.md)
|
|
1397
|
-
- [Zernio::ListHighDemandPeriods200Response](docs/ListHighDemandPeriods200Response.md)
|
|
1398
1366
|
- [Zernio::ListInboxComments200Response](docs/ListInboxComments200Response.md)
|
|
1399
1367
|
- [Zernio::ListInboxComments200ResponseDataInner](docs/ListInboxComments200ResponseDataInner.md)
|
|
1400
1368
|
- [Zernio::ListInboxConversationAnalytics200Response](docs/ListInboxConversationAnalytics200Response.md)
|
|
@@ -1447,10 +1415,6 @@ Class | Method | HTTP request | Description
|
|
|
1447
1415
|
- [Zernio::ListSmsRegistrations200Response](docs/ListSmsRegistrations200Response.md)
|
|
1448
1416
|
- [Zernio::ListSmsRegistrations200ResponseRegistrationsInner](docs/ListSmsRegistrations200ResponseRegistrationsInner.md)
|
|
1449
1417
|
- [Zernio::ListSmsRegistrations200ResponseRegistrationsInnerThroughput](docs/ListSmsRegistrations200ResponseRegistrationsInnerThroughput.md)
|
|
1450
|
-
- [Zernio::ListSmsSenderIds200Response](docs/ListSmsSenderIds200Response.md)
|
|
1451
|
-
- [Zernio::ListSmsSenderIds200ResponseBudget](docs/ListSmsSenderIds200ResponseBudget.md)
|
|
1452
|
-
- [Zernio::ListSmsSenderIds200ResponseBudgetPendingRequest](docs/ListSmsSenderIds200ResponseBudgetPendingRequest.md)
|
|
1453
|
-
- [Zernio::ListSmsSenderIds200ResponseSenderIdsInner](docs/ListSmsSenderIds200ResponseSenderIdsInner.md)
|
|
1454
1418
|
- [Zernio::ListSnapchatProfiles200Response](docs/ListSnapchatProfiles200Response.md)
|
|
1455
1419
|
- [Zernio::ListSnapchatProfiles200ResponsePublicProfilesInner](docs/ListSnapchatProfiles200ResponsePublicProfilesInner.md)
|
|
1456
1420
|
- [Zernio::ListTrackingTagSharedAccounts200Response](docs/ListTrackingTagSharedAccounts200Response.md)
|
|
@@ -1580,8 +1544,6 @@ Class | Method | HTTP request | Description
|
|
|
1580
1544
|
- [Zernio::ReplyToInboxReviewRequest](docs/ReplyToInboxReviewRequest.md)
|
|
1581
1545
|
- [Zernio::ReplyToMention200Response](docs/ReplyToMention200Response.md)
|
|
1582
1546
|
- [Zernio::ReplyToMentionRequest](docs/ReplyToMentionRequest.md)
|
|
1583
|
-
- [Zernio::RequestSmsSenderIdLimitIncrease200Response](docs/RequestSmsSenderIdLimitIncrease200Response.md)
|
|
1584
|
-
- [Zernio::RequestSmsSenderIdLimitIncreaseRequest](docs/RequestSmsSenderIdLimitIncreaseRequest.md)
|
|
1585
1547
|
- [Zernio::ResendSmsRegistrationOtp200Response](docs/ResendSmsRegistrationOtp200Response.md)
|
|
1586
1548
|
- [Zernio::ReserveRfPrediction201Response](docs/ReserveRfPrediction201Response.md)
|
|
1587
1549
|
- [Zernio::ReserveRfPredictionRequest](docs/ReserveRfPredictionRequest.md)
|
|
@@ -1788,8 +1750,6 @@ Class | Method | HTTP request | Description
|
|
|
1788
1750
|
- [Zernio::UpdateAdCampaignRequestPlatformSpecificData](docs/UpdateAdCampaignRequestPlatformSpecificData.md)
|
|
1789
1751
|
- [Zernio::UpdateAdCampaignStatus200Response](docs/UpdateAdCampaignStatus200Response.md)
|
|
1790
1752
|
- [Zernio::UpdateAdCampaignStatusRequest](docs/UpdateAdCampaignStatusRequest.md)
|
|
1791
|
-
- [Zernio::UpdateAdCreative200Response](docs/UpdateAdCreative200Response.md)
|
|
1792
|
-
- [Zernio::UpdateAdCreativeRequest](docs/UpdateAdCreativeRequest.md)
|
|
1793
1753
|
- [Zernio::UpdateAdRequest](docs/UpdateAdRequest.md)
|
|
1794
1754
|
- [Zernio::UpdateAdRequestBudget](docs/UpdateAdRequestBudget.md)
|
|
1795
1755
|
- [Zernio::UpdateAdRequestCreative](docs/UpdateAdRequestCreative.md)
|
|
@@ -1998,6 +1958,7 @@ Class | Method | HTTP request | Description
|
|
|
1998
1958
|
- [Zernio::WebhookPayloadMessageDeliveryStatusError](docs/WebhookPayloadMessageDeliveryStatusError.md)
|
|
1999
1959
|
- [Zernio::WebhookPayloadMessageEdited](docs/WebhookPayloadMessageEdited.md)
|
|
2000
1960
|
- [Zernio::WebhookPayloadMessageMessage](docs/WebhookPayloadMessageMessage.md)
|
|
1961
|
+
- [Zernio::WebhookPayloadMessageMessageAttachmentsInner](docs/WebhookPayloadMessageMessageAttachmentsInner.md)
|
|
2001
1962
|
- [Zernio::WebhookPayloadMessageMessageSender](docs/WebhookPayloadMessageMessageSender.md)
|
|
2002
1963
|
- [Zernio::WebhookPayloadMessageMessageSenderInstagramProfile](docs/WebhookPayloadMessageMessageSenderInstagramProfile.md)
|
|
2003
1964
|
- [Zernio::WebhookPayloadMessageMetadata](docs/WebhookPayloadMessageMetadata.md)
|
|
@@ -2009,6 +1970,7 @@ Class | Method | HTTP request | Description
|
|
|
2009
1970
|
- [Zernio::WebhookPayloadMessageMetadataStoryReply](docs/WebhookPayloadMessageMetadataStoryReply.md)
|
|
2010
1971
|
- [Zernio::WebhookPayloadMessageSent](docs/WebhookPayloadMessageSent.md)
|
|
2011
1972
|
- [Zernio::WebhookPayloadMessageSentMessage](docs/WebhookPayloadMessageSentMessage.md)
|
|
1973
|
+
- [Zernio::WebhookPayloadMessageSentMessageAttachmentsInner](docs/WebhookPayloadMessageSentMessageAttachmentsInner.md)
|
|
2012
1974
|
- [Zernio::WebhookPayloadMessageSentMessageSender](docs/WebhookPayloadMessageSentMessageSender.md)
|
|
2013
1975
|
- [Zernio::WebhookPayloadPost](docs/WebhookPayloadPost.md)
|
|
2014
1976
|
- [Zernio::WebhookPayloadPostPlatform](docs/WebhookPayloadPostPlatform.md)
|
data/docs/AdAudiencesApi.md
CHANGED
|
@@ -9,7 +9,7 @@ All URIs are relative to *https://zernio.com/api*
|
|
|
9
9
|
| [**delete_ad_audience**](AdAudiencesApi.md#delete_ad_audience) | **DELETE** /v1/ads/audiences/{audienceId} | Delete custom audience |
|
|
10
10
|
| [**get_ad_audience**](AdAudiencesApi.md#get_ad_audience) | **GET** /v1/ads/audiences/{audienceId} | Get audience details |
|
|
11
11
|
| [**list_ad_audiences**](AdAudiencesApi.md#list_ad_audiences) | **GET** /v1/ads/audiences | List custom audiences |
|
|
12
|
-
| [**update_ad_audience**](AdAudiencesApi.md#update_ad_audience) | **PUT** /v1/ads/audiences/{audienceId} | Update
|
|
12
|
+
| [**update_ad_audience**](AdAudiencesApi.md#update_ad_audience) | **PUT** /v1/ads/audiences/{audienceId} | Update saved targeting audience |
|
|
13
13
|
|
|
14
14
|
|
|
15
15
|
## add_users_to_ad_audience
|
|
@@ -371,9 +371,9 @@ end
|
|
|
371
371
|
|
|
372
372
|
> <CreateAdAudience201Response> update_ad_audience(audience_id, update_ad_audience_request)
|
|
373
373
|
|
|
374
|
-
Update
|
|
374
|
+
Update saved targeting audience
|
|
375
375
|
|
|
376
|
-
Update
|
|
376
|
+
Update a `saved_targeting` audience's name, description, or spec. Only `saved_targeting` audiences are updatable (they exist only on Zernio); uploaded/derived audiences return 422, delete and recreate those instead. `spec` replaces the stored spec wholesale (no merge). Ads already created from this audience are unaffected, they snapshot the targeting at creation.
|
|
377
377
|
|
|
378
378
|
### Examples
|
|
379
379
|
|
|
@@ -391,7 +391,7 @@ audience_id = 'audience_id_example' # String |
|
|
|
391
391
|
update_ad_audience_request = Zernio::UpdateAdAudienceRequest.new # UpdateAdAudienceRequest |
|
|
392
392
|
|
|
393
393
|
begin
|
|
394
|
-
# Update
|
|
394
|
+
# Update saved targeting audience
|
|
395
395
|
result = api_instance.update_ad_audience(audience_id, update_ad_audience_request)
|
|
396
396
|
p result
|
|
397
397
|
rescue Zernio::ApiError => e
|
|
@@ -407,7 +407,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
407
407
|
|
|
408
408
|
```ruby
|
|
409
409
|
begin
|
|
410
|
-
# Update
|
|
410
|
+
# Update saved targeting audience
|
|
411
411
|
data, status_code, headers = api_instance.update_ad_audience_with_http_info(audience_id, update_ad_audience_request)
|
|
412
412
|
p status_code # => 2xx
|
|
413
413
|
p headers # => { ... }
|
data/docs/AdCampaignsApi.md
CHANGED
|
@@ -5,10 +5,8 @@ All URIs are relative to *https://zernio.com/api*
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
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
|
-
| [**create_ad_campaign**](AdCampaignsApi.md#create_ad_campaign) | **POST** /v1/ads/campaigns | Create a standalone campaign (Meta) |
|
|
9
8
|
| [**delete_ad_campaign**](AdCampaignsApi.md#delete_ad_campaign) | **DELETE** /v1/ads/campaigns/{campaignId} | Delete a campaign |
|
|
10
9
|
| [**duplicate_ad_campaign**](AdCampaignsApi.md#duplicate_ad_campaign) | **POST** /v1/ads/campaigns/{campaignId}/duplicate | Duplicate a campaign |
|
|
11
|
-
| [**duplicate_ad_set**](AdCampaignsApi.md#duplicate_ad_set) | **POST** /v1/ads/ad-sets/{adSetId}/duplicate | Duplicate an ad set (Meta) |
|
|
12
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) |
|
|
13
11
|
| [**get_ad_tree**](AdCampaignsApi.md#get_ad_tree) | **GET** /v1/ads/tree | Get campaign tree |
|
|
14
12
|
| [**get_ads_timeline**](AdCampaignsApi.md#get_ads_timeline) | **GET** /v1/ads/timeline | Get daily account metrics |
|
|
@@ -88,75 +86,6 @@ end
|
|
|
88
86
|
- **Accept**: application/json
|
|
89
87
|
|
|
90
88
|
|
|
91
|
-
## create_ad_campaign
|
|
92
|
-
|
|
93
|
-
> <CreateAdCampaign201Response> create_ad_campaign(create_ad_campaign_request)
|
|
94
|
-
|
|
95
|
-
Create a standalone campaign (Meta)
|
|
96
|
-
|
|
97
|
-
Creates a campaign WITHOUT its first ad set / ad (the ODAX shell only). Ad sets join it later via `existingCampaignId` on the create endpoints. A budget here is campaign-level (CBO) by definition; omit it for ABO (each ad set carries its own budget). Created `PAUSED` unless `status: ACTIVE`. The campaign materializes in `/v1/ads/tree` via the next sync discovery pass. Meta only.
|
|
98
|
-
|
|
99
|
-
### Examples
|
|
100
|
-
|
|
101
|
-
```ruby
|
|
102
|
-
require 'time'
|
|
103
|
-
require 'zernio-sdk'
|
|
104
|
-
# setup authorization
|
|
105
|
-
Zernio.configure do |config|
|
|
106
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
107
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
108
|
-
end
|
|
109
|
-
|
|
110
|
-
api_instance = Zernio::AdCampaignsApi.new
|
|
111
|
-
create_ad_campaign_request = Zernio::CreateAdCampaignRequest.new({account_id: 'account_id_example', ad_account_id: 'ad_account_id_example', name: 'name_example', goal: 'engagement'}) # CreateAdCampaignRequest |
|
|
112
|
-
|
|
113
|
-
begin
|
|
114
|
-
# Create a standalone campaign (Meta)
|
|
115
|
-
result = api_instance.create_ad_campaign(create_ad_campaign_request)
|
|
116
|
-
p result
|
|
117
|
-
rescue Zernio::ApiError => e
|
|
118
|
-
puts "Error when calling AdCampaignsApi->create_ad_campaign: #{e}"
|
|
119
|
-
end
|
|
120
|
-
```
|
|
121
|
-
|
|
122
|
-
#### Using the create_ad_campaign_with_http_info variant
|
|
123
|
-
|
|
124
|
-
This returns an Array which contains the response data, status code and headers.
|
|
125
|
-
|
|
126
|
-
> <Array(<CreateAdCampaign201Response>, Integer, Hash)> create_ad_campaign_with_http_info(create_ad_campaign_request)
|
|
127
|
-
|
|
128
|
-
```ruby
|
|
129
|
-
begin
|
|
130
|
-
# Create a standalone campaign (Meta)
|
|
131
|
-
data, status_code, headers = api_instance.create_ad_campaign_with_http_info(create_ad_campaign_request)
|
|
132
|
-
p status_code # => 2xx
|
|
133
|
-
p headers # => { ... }
|
|
134
|
-
p data # => <CreateAdCampaign201Response>
|
|
135
|
-
rescue Zernio::ApiError => e
|
|
136
|
-
puts "Error when calling AdCampaignsApi->create_ad_campaign_with_http_info: #{e}"
|
|
137
|
-
end
|
|
138
|
-
```
|
|
139
|
-
|
|
140
|
-
### Parameters
|
|
141
|
-
|
|
142
|
-
| Name | Type | Description | Notes |
|
|
143
|
-
| ---- | ---- | ----------- | ----- |
|
|
144
|
-
| **create_ad_campaign_request** | [**CreateAdCampaignRequest**](CreateAdCampaignRequest.md) | | |
|
|
145
|
-
|
|
146
|
-
### Return type
|
|
147
|
-
|
|
148
|
-
[**CreateAdCampaign201Response**](CreateAdCampaign201Response.md)
|
|
149
|
-
|
|
150
|
-
### Authorization
|
|
151
|
-
|
|
152
|
-
[bearerAuth](../README.md#bearerAuth)
|
|
153
|
-
|
|
154
|
-
### HTTP request headers
|
|
155
|
-
|
|
156
|
-
- **Content-Type**: application/json
|
|
157
|
-
- **Accept**: application/json
|
|
158
|
-
|
|
159
|
-
|
|
160
89
|
## delete_ad_campaign
|
|
161
90
|
|
|
162
91
|
> <DeleteAdCampaign200Response> delete_ad_campaign(campaign_id, delete_ad_campaign_request)
|
|
@@ -299,77 +228,6 @@ end
|
|
|
299
228
|
- **Accept**: application/json
|
|
300
229
|
|
|
301
230
|
|
|
302
|
-
## duplicate_ad_set
|
|
303
|
-
|
|
304
|
-
> <DuplicateAdSet200Response> duplicate_ad_set(ad_set_id, duplicate_ad_set_request)
|
|
305
|
-
|
|
306
|
-
Duplicate an ad set (Meta)
|
|
307
|
-
|
|
308
|
-
Duplicates an ad set, including its ads and creatives by default (`deepCopy: true`), via Meta's native `POST /{adset-id}/copies`. The copy is created paused so callers can review before launching. `campaignId` retargets the copy into another campaign; omitted = the source's own campaign. The new hierarchy materializes asynchronously — sync discovery is triggered automatically (`syncAfter: false` to skip). Meta only.
|
|
309
|
-
|
|
310
|
-
### Examples
|
|
311
|
-
|
|
312
|
-
```ruby
|
|
313
|
-
require 'time'
|
|
314
|
-
require 'zernio-sdk'
|
|
315
|
-
# setup authorization
|
|
316
|
-
Zernio.configure do |config|
|
|
317
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
318
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
319
|
-
end
|
|
320
|
-
|
|
321
|
-
api_instance = Zernio::AdCampaignsApi.new
|
|
322
|
-
ad_set_id = 'ad_set_id_example' # String | Source platform ad set ID
|
|
323
|
-
duplicate_ad_set_request = Zernio::DuplicateAdSetRequest.new({platform: 'facebook'}) # DuplicateAdSetRequest |
|
|
324
|
-
|
|
325
|
-
begin
|
|
326
|
-
# Duplicate an ad set (Meta)
|
|
327
|
-
result = api_instance.duplicate_ad_set(ad_set_id, duplicate_ad_set_request)
|
|
328
|
-
p result
|
|
329
|
-
rescue Zernio::ApiError => e
|
|
330
|
-
puts "Error when calling AdCampaignsApi->duplicate_ad_set: #{e}"
|
|
331
|
-
end
|
|
332
|
-
```
|
|
333
|
-
|
|
334
|
-
#### Using the duplicate_ad_set_with_http_info variant
|
|
335
|
-
|
|
336
|
-
This returns an Array which contains the response data, status code and headers.
|
|
337
|
-
|
|
338
|
-
> <Array(<DuplicateAdSet200Response>, Integer, Hash)> duplicate_ad_set_with_http_info(ad_set_id, duplicate_ad_set_request)
|
|
339
|
-
|
|
340
|
-
```ruby
|
|
341
|
-
begin
|
|
342
|
-
# Duplicate an ad set (Meta)
|
|
343
|
-
data, status_code, headers = api_instance.duplicate_ad_set_with_http_info(ad_set_id, duplicate_ad_set_request)
|
|
344
|
-
p status_code # => 2xx
|
|
345
|
-
p headers # => { ... }
|
|
346
|
-
p data # => <DuplicateAdSet200Response>
|
|
347
|
-
rescue Zernio::ApiError => e
|
|
348
|
-
puts "Error when calling AdCampaignsApi->duplicate_ad_set_with_http_info: #{e}"
|
|
349
|
-
end
|
|
350
|
-
```
|
|
351
|
-
|
|
352
|
-
### Parameters
|
|
353
|
-
|
|
354
|
-
| Name | Type | Description | Notes |
|
|
355
|
-
| ---- | ---- | ----------- | ----- |
|
|
356
|
-
| **ad_set_id** | **String** | Source platform ad set ID | |
|
|
357
|
-
| **duplicate_ad_set_request** | [**DuplicateAdSetRequest**](DuplicateAdSetRequest.md) | | |
|
|
358
|
-
|
|
359
|
-
### Return type
|
|
360
|
-
|
|
361
|
-
[**DuplicateAdSet200Response**](DuplicateAdSet200Response.md)
|
|
362
|
-
|
|
363
|
-
### Authorization
|
|
364
|
-
|
|
365
|
-
[bearerAuth](../README.md#bearerAuth)
|
|
366
|
-
|
|
367
|
-
### HTTP request headers
|
|
368
|
-
|
|
369
|
-
- **Content-Type**: application/json
|
|
370
|
-
- **Accept**: application/json
|
|
371
|
-
|
|
372
|
-
|
|
373
231
|
## get_ad_set_details
|
|
374
232
|
|
|
375
233
|
> <GetAdSetDetails200Response> get_ad_set_details(ad_set_id, account_id, opts)
|