Skip to content

UpdateAdSetRequest.md

Latest commit

 

History

History
36 lines (30 loc) · 3.11 KB

UpdateAdSetRequest.md

File metadata and controls

36 lines (30 loc) · 3.11 KB
Raw

Zernio::UpdateAdSetRequest

Properties

Name Type Description Notes
platform String
budget UpdateAdSetRequestBudget [optional]
status String Writes the ad set's own on/off switch (Meta: `configured_status`) on Meta and LinkedIn, whatever delivery status its ads report. Omit if not toggling delivery state. [optional]
name String Rename the ad set (Meta only; other platforms return 501). At least one of budget/status/bidStrategy/name is required. [optional]
bid_strategy BidStrategy Ad-set-level bid strategy. Overrides the campaign-level default. Supported on Meta (facebook, instagram), TikTok, and OpenAI. On TikTok the Meta-style enum is mapped to bid_type / bid_price / deep_bid_type automatically. On OpenAI, LOWEST_COST_WITH_BID_CAP and COST_CAP both map to the ad group's `bidding_config.max_bid_micros` (one knob covers both); LOWEST_COST_WITH_MIN_ROAS is rejected with 422 (OpenAI has no ROAS-based bidding). Other platforms (linkedin, pinterest, google, twitter) return 501 Not Implemented when bidStrategy is set. [optional]
bid_amount Float Bid cap in WHOLE currency units (USD: 5 = $5.00; JPY: 100 = ¥100). Required when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. Internally converted to Meta's smallest-denomination integer, or (on OpenAI) to micros (× 1,000,000). Meta only: may be sent alone, WITHOUT bidStrategy, to update the cap amount on an ad set whose parent campaign is COST_CAP or LOWEST_COST_WITH_BID_CAP (the strategy is inherited from the campaign and is left untouched). [optional]
roas_average_floor Float Minimum ROAS as a decimal multiplier (2.0 = 2.0x). Required when bidStrategy is LOWEST_COST_WITH_MIN_ROAS. Sent to Meta as `bid_constraints.roas_average_floor` × 10000. Not supported on OpenAI (422). [optional]
value_rule_set_id String Meta only (other platforms return 501). Value rule set to attach to this ad set, from `/v1/ads/value-rule-sets`. Sending a different id replaces the current association. To DETACH, send `valueRulesApplied: false` and omit this field. [optional]
value_rules_applied Boolean Meta only (other platforms return 501). `false` DETACHES the ad set's value rule set and must be sent WITHOUT `valueRuleSetId`; the combination returns 400. `true` is optional when attaching, since attachment is driven by `valueRuleSetId`, and requires it to be present. [optional]
platform_specific_data UpdateAdSetRequestPlatformSpecificData [optional]

Example

require 'zernio-sdk'

instance = Zernio::UpdateAdSetRequest.new(
  platform: null,
  budget: null,
  status: null,
  name: null,
  bid_strategy: null,
  bid_amount: null,
  roas_average_floor: null,
  value_rule_set_id: null,
  value_rules_applied: null,
  platform_specific_data: null
)