zernio-sdk 0.0.528 → 0.0.530
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 +20 -9
- data/docs/AdsApi.md +301 -11
- data/docs/CreateAdInsightsReportRequest.md +8 -0
- data/docs/CreateCallAdRequest.md +80 -0
- data/docs/CreateMessagingAdRequest.md +78 -0
- data/docs/CreateStandaloneAdRequest.md +2 -0
- data/docs/CreateStandaloneAdRequestCarouselCardsInner.md +26 -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/GetAdPreviews200Response.md +20 -0
- data/lib/zernio-sdk/api/ads_api.rb +295 -13
- data/lib/zernio-sdk/models/create_ad_insights_report_request.rb +43 -1
- 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 +41 -1
- data/lib/zernio-sdk/models/create_standalone_ad_request_carousel_cards_inner.rb +243 -0
- 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_previews200_response.rb +158 -0
- data/lib/zernio-sdk/version.rb +1 -1
- data/lib/zernio-sdk.rb +15 -8
- data/openapi.yaml +516 -320
- data/spec/api/ads_api_spec.rb +56 -3
- data/spec/models/create_ad_insights_report_request_spec.rb +24 -0
- 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_carousel_cards_inner_spec.rb +60 -0
- data/spec/models/create_standalone_ad_request_spec.rb +6 -0
- 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_previews200_response_spec.rb +42 -0
- metadata +61 -33
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
# Zernio::CreateMessagingAdRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **account_id** | **String** | Facebook or Instagram SocialAccount ID. | |
|
|
8
|
+
| **ad_account_id** | **String** | Meta ad account ID, e.g. `act_123456789`. | |
|
|
9
|
+
| **name** | **String** | Ad display name. Used to derive campaign / ad set names. On the multi-creative shape, each ad's Meta name gets a \" #N\" suffix (1-indexed) so Ads Manager shows them as a numbered batch. | |
|
|
10
|
+
| **headline** | **String** | Single-creative shape only. Mutually exclusive with `creatives[]`. | [optional] |
|
|
11
|
+
| **body** | **String** | Primary text shown above the image / video. Single-creative shape only. Mutually exclusive with `creatives[]`. | [optional] |
|
|
12
|
+
| **image_url** | **String** | Image asset for single-creative shape. Mutually exclusive with `video` and with `creatives[]`. Required on the single-creative shape if `video` is not supplied. | [optional] |
|
|
13
|
+
| **video** | [**CtwaAdRequestBodyVideo**](CtwaAdRequestBodyVideo.md) | | [optional] |
|
|
14
|
+
| **creatives** | [**Array<CtwaAdRequestBodyCreativesInner>**](CtwaAdRequestBodyCreativesInner.md) | Multi-creative shape: N CTWA ads under one campaign + one ad set, sharing budget and targeting. Mutually exclusive with the top-level single-creative fields (`headline` / `body` / `imageUrl` / `video`). Each entry must supply its own headline, body, and exactly one of `imageUrl` / `video`. | [optional] |
|
|
15
|
+
| **budget_amount** | **Float** | Budget amount in the ad account's currency major units (e.g. dollars for USD, not cents). Must be > 0. | |
|
|
16
|
+
| **budget_type** | **String** | | |
|
|
17
|
+
| **currency** | **String** | ISO 4217 currency code matching the ad account's currency (e.g. `USD`). Optional; Meta infers from the ad account when omitted. | [optional] |
|
|
18
|
+
| **end_date** | **Time** | ISO 8601 datetime. Required when `budgetType` is `lifetime`. | [optional] |
|
|
19
|
+
| **countries** | **Array<String>** | ISO 3166-1 alpha-2 country codes. Defaults to `[\"US\"]` only when no other geo (`cities`, `regions`, `zips`, `metros`, `customLocations`) is supplied. | [optional] |
|
|
20
|
+
| **cities** | [**Array<CtwaAdRequestBodyCitiesInner>**](CtwaAdRequestBodyCitiesInner.md) | City-level geo targeting for local CTWA campaigns. Each entry maps to Meta's TargetingGeoLocationCity. `key` is Meta's city ID. `radius` and `distance_unit` are coupled: set both or neither. Meta enforces a minimum city radius (~17 km / 10 mi); smaller values resolve to a 0-size audience and the ad fails at launch. For a tighter catchment use customLocations (lat/lng). | [optional] |
|
|
21
|
+
| **regions** | [**Array<CtwaAdRequestBodyRegionsInner>**](CtwaAdRequestBodyRegionsInner.md) | Region / state-level geo targeting. `key` is Meta's region ID (lookupable via GET /v1/ads/targeting/search?type=region). | [optional] |
|
|
22
|
+
| **zips** | [**Array<CtwaAdRequestBodyZipsInner>**](CtwaAdRequestBodyZipsInner.md) | ZIP / postal-code geo targeting. `key` is the platform's postal id resolved via /v1/ads/targeting/search. | [optional] |
|
|
23
|
+
| **metros** | [**Array<CtwaAdRequestBodyZipsInner>**](CtwaAdRequestBodyZipsInner.md) | DMA / metro-area geo targeting. `key` is Meta's metro id (e.g. `DMA:807`). | [optional] |
|
|
24
|
+
| **custom_locations** | [**Array<CreateStandaloneAdRequestCustomLocationsInner>**](CreateStandaloneAdRequestCustomLocationsInner.md) | Point-radius geo (Meta `geo_locations.custom_locations`). Use for targeting a radius around a specific lat/long when no Meta city/region key fits. `distanceUnit` is required. | [optional] |
|
|
25
|
+
| **age_min** | **Integer** | | [optional] |
|
|
26
|
+
| **age_max** | **Integer** | | [optional] |
|
|
27
|
+
| **interests** | [**Array<CreateStandaloneAdRequestBehaviorsInner>**](CreateStandaloneAdRequestBehaviorsInner.md) | | [optional] |
|
|
28
|
+
| **audience_id** | **String** | Custom audience ID to target. | [optional] |
|
|
29
|
+
| **placements** | [**CtwaAdRequestBodyPlacements**](CtwaAdRequestBodyPlacements.md) | | [optional] |
|
|
30
|
+
| **advantage_audience** | **Integer** | Meta's Advantage+ audience expansion. `0` (default) keeps targeting strict; `1` lets Meta expand beyond the supplied targeting when its delivery system finds better matches. Always sent on CREATE (Meta requires it). | [optional] |
|
|
31
|
+
| **objective** | **String** | Defaults to `OUTCOME_ENGAGEMENT`. `OUTCOME_SALES` and `OUTCOME_LEADS` require additional account configuration (Dataset linked to the WABA for sales) and may be rejected by Meta if missing. | [optional] |
|
|
32
|
+
| **bid_strategy** | **String** | Meta bid strategy applied to the shared ad set. Defaults to `LOWEST_COST_WITHOUT_CAP` (auto-bid) when omitted. `LOWEST_COST_WITH_BID_CAP` and `COST_CAP` require `bidAmount`. `LOWEST_COST_WITH_MIN_ROAS` requires `roasAverageFloor`. CTWA's `optimization_goal` is fixed to `CONVERSATIONS`, but the bid strategy is independent. | [optional] |
|
|
33
|
+
| **bid_amount** | **Float** | Whole currency units (e.g. `5` = $5.00 on a USD account). Required when `bidStrategy` is `LOWEST_COST_WITH_BID_CAP` or `COST_CAP`; rejected otherwise. | [optional] |
|
|
34
|
+
| **roas_average_floor** | **Float** | Decimal ROAS multiplier (e.g. `2.0` = 2.0× ROAS floor). Required when `bidStrategy` is `LOWEST_COST_WITH_MIN_ROAS`; rejected otherwise. Meta enforces its own upper bound server-side. | [optional] |
|
|
35
|
+
| **dsa_beneficiary** | **String** | Legal entity that benefits from the ad. Required when targeting EU users (EU DSA, Article 26). Optional if the ad account has a default beneficiary: set it once via `PATCH /v1/ads/accounts` or in Meta Ads Manager, and Meta fills it in whenever the field is omitted. | [optional] |
|
|
36
|
+
| **dsa_payor** | **String** | Legal entity that pays for the ad. Can differ from `dsaBeneficiary` (for example, an agency paying for a client's ads). Same rules as `dsaBeneficiary`: required for EU targeting unless the ad account has a default payor. | [optional] |
|
|
37
|
+
| **destination** | **String** | Where the conversation opens when the ad is tapped. | |
|
|
38
|
+
|
|
39
|
+
## Example
|
|
40
|
+
|
|
41
|
+
```ruby
|
|
42
|
+
require 'zernio-sdk'
|
|
43
|
+
|
|
44
|
+
instance = Zernio::CreateMessagingAdRequest.new(
|
|
45
|
+
account_id: null,
|
|
46
|
+
ad_account_id: null,
|
|
47
|
+
name: null,
|
|
48
|
+
headline: null,
|
|
49
|
+
body: null,
|
|
50
|
+
image_url: null,
|
|
51
|
+
video: null,
|
|
52
|
+
creatives: null,
|
|
53
|
+
budget_amount: null,
|
|
54
|
+
budget_type: null,
|
|
55
|
+
currency: null,
|
|
56
|
+
end_date: null,
|
|
57
|
+
countries: null,
|
|
58
|
+
cities: null,
|
|
59
|
+
regions: null,
|
|
60
|
+
zips: null,
|
|
61
|
+
metros: null,
|
|
62
|
+
custom_locations: null,
|
|
63
|
+
age_min: null,
|
|
64
|
+
age_max: null,
|
|
65
|
+
interests: null,
|
|
66
|
+
audience_id: null,
|
|
67
|
+
placements: null,
|
|
68
|
+
advantage_audience: null,
|
|
69
|
+
objective: null,
|
|
70
|
+
bid_strategy: null,
|
|
71
|
+
bid_amount: null,
|
|
72
|
+
roas_average_floor: null,
|
|
73
|
+
dsa_beneficiary: null,
|
|
74
|
+
dsa_payor: null,
|
|
75
|
+
destination: null
|
|
76
|
+
)
|
|
77
|
+
```
|
|
78
|
+
|
|
@@ -57,6 +57,7 @@
|
|
|
57
57
|
| **start_date** | **Time** | Meta only. Ad-set start time (ISO 8601, e.g. \"2026-06-10T09:00:00Z\"), mapped to the ad set's `start_time`. When omitted the ad starts delivering immediately. For lifetime budgets Meta also requires `endDate`. (Same `schedule.startDate` semantics already available on `POST /v1/ads/boost`.) | [optional] |
|
|
58
58
|
| **instagram_account_id** | **String** | Meta only. Override the Instagram account the ad is delivered as — pass an Instagram Business Account ID (e.g. 17841...), mapped to the creative's `instagram_user_id`. When omitted we auto-resolve the IG account linked to the connected Facebook Page (the existing default). Useful when a Page has more than one eligible IG account. | [optional] |
|
|
59
59
|
| **dynamic_creative** | [**CreateStandaloneAdRequestDynamicCreative**](CreateStandaloneAdRequestDynamicCreative.md) | | [optional] |
|
|
60
|
+
| **carousel_cards** | [**Array<CreateStandaloneAdRequestCarouselCardsInner>**](CreateStandaloneAdRequestCarouselCardsInner.md) | Meta only. Hand-built carousel: 2-10 authored cards in DETERMINISTIC order, mapped to the creative's `link_data.child_attachments`. Unlike `dynamicCreative`, you control the card order and per-card copy/link. Requires top-level `body`, `linkUrl` and `callToAction`. Mutually exclusive with `imageUrl`/`video`, `creatives[]`, `dynamicCreative`, `placementAssets`, `existingCreativeId`, `adSetId`, `leadGenFormId` and goal `catalog_sales`. | [optional] |
|
|
60
61
|
| **placement_assets** | [**CreateStandaloneAdRequestPlacementAssets**](CreateStandaloneAdRequestPlacementAssets.md) | | [optional] |
|
|
61
62
|
| **audience_id** | **String** | Custom audience ID for targeting | [optional] |
|
|
62
63
|
| **campaign_type** | **String** | Google only | [optional][default to 'display'] |
|
|
@@ -135,6 +136,7 @@ instance = Zernio::CreateStandaloneAdRequest.new(
|
|
|
135
136
|
start_date: null,
|
|
136
137
|
instagram_account_id: null,
|
|
137
138
|
dynamic_creative: null,
|
|
139
|
+
carousel_cards: null,
|
|
138
140
|
placement_assets: null,
|
|
139
141
|
audience_id: null,
|
|
140
142
|
campaign_type: null,
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Zernio::CreateStandaloneAdRequestCarouselCardsInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **image_url** | **String** | Card image; uploaded to the ad account and referenced by hash. | |
|
|
8
|
+
| **link_url** | **String** | Card destination URL. Defaults to the top-level linkUrl. | [optional] |
|
|
9
|
+
| **headline** | **String** | Card headline, shown below the card image. | [optional] |
|
|
10
|
+
| **description** | **String** | Card description, shown under the headline. | [optional] |
|
|
11
|
+
| **call_to_action** | **String** | Card CTA override. Defaults to the top-level callToAction; same enum. | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'zernio-sdk'
|
|
17
|
+
|
|
18
|
+
instance = Zernio::CreateStandaloneAdRequestCarouselCardsInner.new(
|
|
19
|
+
image_url: null,
|
|
20
|
+
link_url: null,
|
|
21
|
+
headline: null,
|
|
22
|
+
description: null,
|
|
23
|
+
call_to_action: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Zernio::
|
|
1
|
+
# Zernio::CtwaAdRequestBody
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -10,25 +10,25 @@
|
|
|
10
10
|
| **headline** | **String** | Single-creative shape only. Mutually exclusive with `creatives[]`. | [optional] |
|
|
11
11
|
| **body** | **String** | Primary text shown above the image / video. Single-creative shape only. Mutually exclusive with `creatives[]`. | [optional] |
|
|
12
12
|
| **image_url** | **String** | Image asset for single-creative shape. Mutually exclusive with `video` and with `creatives[]`. Required on the single-creative shape if `video` is not supplied. | [optional] |
|
|
13
|
-
| **video** | [**
|
|
14
|
-
| **creatives** | [**Array<
|
|
13
|
+
| **video** | [**CtwaAdRequestBodyVideo**](CtwaAdRequestBodyVideo.md) | | [optional] |
|
|
14
|
+
| **creatives** | [**Array<CtwaAdRequestBodyCreativesInner>**](CtwaAdRequestBodyCreativesInner.md) | Multi-creative shape: N CTWA ads under one campaign + one ad set, sharing budget and targeting. Mutually exclusive with the top-level single-creative fields (`headline` / `body` / `imageUrl` / `video`). Each entry must supply its own headline, body, and exactly one of `imageUrl` / `video`. | [optional] |
|
|
15
15
|
| **budget_amount** | **Float** | Budget amount in the ad account's currency major units (e.g. dollars for USD, not cents). Must be > 0. | |
|
|
16
16
|
| **budget_type** | **String** | | |
|
|
17
17
|
| **currency** | **String** | ISO 4217 currency code matching the ad account's currency (e.g. `USD`). Optional; Meta infers from the ad account when omitted. | [optional] |
|
|
18
18
|
| **end_date** | **Time** | ISO 8601 datetime. Required when `budgetType` is `lifetime`. | [optional] |
|
|
19
19
|
| **countries** | **Array<String>** | ISO 3166-1 alpha-2 country codes. Defaults to `[\"US\"]` only when no other geo (`cities`, `regions`, `zips`, `metros`, `customLocations`) is supplied. | [optional] |
|
|
20
|
-
| **cities** | [**Array<
|
|
21
|
-
| **regions** | [**Array<
|
|
22
|
-
| **zips** | [**Array<
|
|
23
|
-
| **metros** | [**Array<
|
|
20
|
+
| **cities** | [**Array<CtwaAdRequestBodyCitiesInner>**](CtwaAdRequestBodyCitiesInner.md) | City-level geo targeting for local CTWA campaigns. Each entry maps to Meta's TargetingGeoLocationCity. `key` is Meta's city ID. `radius` and `distance_unit` are coupled: set both or neither. Meta enforces a minimum city radius (~17 km / 10 mi); smaller values resolve to a 0-size audience and the ad fails at launch. For a tighter catchment use customLocations (lat/lng). | [optional] |
|
|
21
|
+
| **regions** | [**Array<CtwaAdRequestBodyRegionsInner>**](CtwaAdRequestBodyRegionsInner.md) | Region / state-level geo targeting. `key` is Meta's region ID (lookupable via GET /v1/ads/targeting/search?type=region). | [optional] |
|
|
22
|
+
| **zips** | [**Array<CtwaAdRequestBodyZipsInner>**](CtwaAdRequestBodyZipsInner.md) | ZIP / postal-code geo targeting. `key` is the platform's postal id resolved via /v1/ads/targeting/search. | [optional] |
|
|
23
|
+
| **metros** | [**Array<CtwaAdRequestBodyZipsInner>**](CtwaAdRequestBodyZipsInner.md) | DMA / metro-area geo targeting. `key` is Meta's metro id (e.g. `DMA:807`). | [optional] |
|
|
24
24
|
| **custom_locations** | [**Array<CreateStandaloneAdRequestCustomLocationsInner>**](CreateStandaloneAdRequestCustomLocationsInner.md) | Point-radius geo (Meta `geo_locations.custom_locations`). Use for targeting a radius around a specific lat/long when no Meta city/region key fits. `distanceUnit` is required. | [optional] |
|
|
25
25
|
| **age_min** | **Integer** | | [optional] |
|
|
26
26
|
| **age_max** | **Integer** | | [optional] |
|
|
27
27
|
| **interests** | [**Array<CreateStandaloneAdRequestBehaviorsInner>**](CreateStandaloneAdRequestBehaviorsInner.md) | | [optional] |
|
|
28
28
|
| **audience_id** | **String** | Custom audience ID to target. | [optional] |
|
|
29
|
-
| **placements** | [**
|
|
29
|
+
| **placements** | [**CtwaAdRequestBodyPlacements**](CtwaAdRequestBodyPlacements.md) | | [optional] |
|
|
30
30
|
| **advantage_audience** | **Integer** | Meta's Advantage+ audience expansion. `0` (default) keeps targeting strict; `1` lets Meta expand beyond the supplied targeting when its delivery system finds better matches. Always sent on CREATE (Meta requires it). | [optional] |
|
|
31
|
-
| **objective** | **String** | Defaults to `OUTCOME_ENGAGEMENT`
|
|
31
|
+
| **objective** | **String** | Defaults to `OUTCOME_ENGAGEMENT`. `OUTCOME_SALES` and `OUTCOME_LEADS` require additional account configuration (Dataset linked to the WABA for sales) and may be rejected by Meta if missing. | [optional] |
|
|
32
32
|
| **bid_strategy** | **String** | Meta bid strategy applied to the shared ad set. Defaults to `LOWEST_COST_WITHOUT_CAP` (auto-bid) when omitted. `LOWEST_COST_WITH_BID_CAP` and `COST_CAP` require `bidAmount`. `LOWEST_COST_WITH_MIN_ROAS` requires `roasAverageFloor`. CTWA's `optimization_goal` is fixed to `CONVERSATIONS`, but the bid strategy is independent. | [optional] |
|
|
33
33
|
| **bid_amount** | **Float** | Whole currency units (e.g. `5` = $5.00 on a USD account). Required when `bidStrategy` is `LOWEST_COST_WITH_BID_CAP` or `COST_CAP`; rejected otherwise. | [optional] |
|
|
34
34
|
| **roas_average_floor** | **Float** | Decimal ROAS multiplier (e.g. `2.0` = 2.0× ROAS floor). Required when `bidStrategy` is `LOWEST_COST_WITH_MIN_ROAS`; rejected otherwise. Meta enforces its own upper bound server-side. | [optional] |
|
|
@@ -40,7 +40,7 @@
|
|
|
40
40
|
```ruby
|
|
41
41
|
require 'zernio-sdk'
|
|
42
42
|
|
|
43
|
-
instance = Zernio::
|
|
43
|
+
instance = Zernio::CtwaAdRequestBody.new(
|
|
44
44
|
account_id: null,
|
|
45
45
|
ad_account_id: null,
|
|
46
46
|
name: null,
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Zernio::
|
|
1
|
+
# Zernio::CtwaAdRequestBodyCitiesInner
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
```ruby
|
|
14
14
|
require 'zernio-sdk'
|
|
15
15
|
|
|
16
|
-
instance = Zernio::
|
|
16
|
+
instance = Zernio::CtwaAdRequestBodyCitiesInner.new(
|
|
17
17
|
key: null,
|
|
18
18
|
radius: null,
|
|
19
19
|
distance_unit: null
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Zernio::
|
|
1
|
+
# Zernio::CtwaAdRequestBodyCreativesInner
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -7,14 +7,14 @@
|
|
|
7
7
|
| **headline** | **String** | | |
|
|
8
8
|
| **body** | **String** | Primary text shown above the image / video. | |
|
|
9
9
|
| **image_url** | **String** | Image asset. Mutually exclusive with this entry's `video`. Required if `video` is not supplied. | [optional] |
|
|
10
|
-
| **video** | [**
|
|
10
|
+
| **video** | [**CtwaAdRequestBodyCreativesInnerVideo**](CtwaAdRequestBodyCreativesInnerVideo.md) | | [optional] |
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
14
14
|
```ruby
|
|
15
15
|
require 'zernio-sdk'
|
|
16
16
|
|
|
17
|
-
instance = Zernio::
|
|
17
|
+
instance = Zernio::CtwaAdRequestBodyCreativesInner.new(
|
|
18
18
|
headline: null,
|
|
19
19
|
body: null,
|
|
20
20
|
image_url: null,
|
data/docs/{CreateCtwaAdRequestCreativesInnerVideo.md → CtwaAdRequestBodyCreativesInnerVideo.md}
RENAMED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Zernio::
|
|
1
|
+
# Zernio::CtwaAdRequestBodyCreativesInnerVideo
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
```ruby
|
|
13
13
|
require 'zernio-sdk'
|
|
14
14
|
|
|
15
|
-
instance = Zernio::
|
|
15
|
+
instance = Zernio::CtwaAdRequestBodyCreativesInnerVideo.new(
|
|
16
16
|
url: null,
|
|
17
17
|
thumbnail_url: null
|
|
18
18
|
)
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Zernio::
|
|
1
|
+
# Zernio::CtwaAdRequestBodyPlacements
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
```ruby
|
|
19
19
|
require 'zernio-sdk'
|
|
20
20
|
|
|
21
|
-
instance = Zernio::
|
|
21
|
+
instance = Zernio::CtwaAdRequestBodyPlacements.new(
|
|
22
22
|
publisher_platforms: null,
|
|
23
23
|
facebook_positions: null,
|
|
24
24
|
instagram_positions: null,
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Zernio::
|
|
1
|
+
# Zernio::CtwaAdRequestBodyRegionsInner
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
```ruby
|
|
12
12
|
require 'zernio-sdk'
|
|
13
13
|
|
|
14
|
-
instance = Zernio::
|
|
14
|
+
instance = Zernio::CtwaAdRequestBodyRegionsInner.new(
|
|
15
15
|
key: null
|
|
16
16
|
)
|
|
17
17
|
```
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Zernio::
|
|
1
|
+
# Zernio::CtwaAdRequestBodyVideo
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
```ruby
|
|
13
13
|
require 'zernio-sdk'
|
|
14
14
|
|
|
15
|
-
instance = Zernio::
|
|
15
|
+
instance = Zernio::CtwaAdRequestBodyVideo.new(
|
|
16
16
|
url: null,
|
|
17
17
|
thumbnail_url: null
|
|
18
18
|
)
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Zernio::
|
|
1
|
+
# Zernio::CtwaAdRequestBodyZipsInner
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
```ruby
|
|
13
13
|
require 'zernio-sdk'
|
|
14
14
|
|
|
15
|
-
instance = Zernio::
|
|
15
|
+
instance = Zernio::CtwaAdRequestBodyZipsInner.new(
|
|
16
16
|
key: null,
|
|
17
17
|
name: null
|
|
18
18
|
)
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zernio::GenerateAdPreviews200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **previews** | [**Array<GenerateAdPreviews200ResponsePreviewsInner>**](GenerateAdPreviews200ResponsePreviewsInner.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zernio-sdk'
|
|
13
|
+
|
|
14
|
+
instance = Zernio::GenerateAdPreviews200Response.new(
|
|
15
|
+
previews: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::GenerateAdPreviews200ResponsePreviewsInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **format** | **String** | | [optional] |
|
|
8
|
+
| **html** | **String** | Meta's <iframe> snippet; null when Meta returned no preview for the format. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::GenerateAdPreviews200ResponsePreviewsInner.new(
|
|
16
|
+
format: null,
|
|
17
|
+
html: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Zernio::GenerateAdPreviewsRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **account_id** | **String** | Zernio SocialAccount id used to resolve the Meta token. | |
|
|
8
|
+
| **ad_account_id** | **String** | Meta ad account id (act_<n>). | |
|
|
9
|
+
| **formats** | **Array<String>** | Meta ad_format values, one preview per format. Defaults to [DESKTOP_FEED_STANDARD]. | [optional] |
|
|
10
|
+
| **existing_creative_id** | **String** | Preview an existing ad-account creative by id. Mutually exclusive with creativeSpec. | [optional] |
|
|
11
|
+
| **creative_spec** | **Hash<String, Object>** | Raw Meta creative spec forwarded verbatim to /generatepreviews. Mutually exclusive with existingCreativeId. | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'zernio-sdk'
|
|
17
|
+
|
|
18
|
+
instance = Zernio::GenerateAdPreviewsRequest.new(
|
|
19
|
+
account_id: null,
|
|
20
|
+
ad_account_id: null,
|
|
21
|
+
formats: null,
|
|
22
|
+
existing_creative_id: null,
|
|
23
|
+
creative_spec: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::GetAdPreviews200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **ad_id** | **String** | | [optional] |
|
|
8
|
+
| **previews** | [**Array<GenerateAdPreviews200ResponsePreviewsInner>**](GenerateAdPreviews200ResponsePreviewsInner.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::GetAdPreviews200Response.new(
|
|
16
|
+
ad_id: null,
|
|
17
|
+
previews: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|