Enums and Descriptions

Enum Definitions and JSON Representation

This document provides a comprehensive explanation of the enums used in the AdCreative API. These enums are essential for understanding the JSON requests and responses, enabling developers to use the correct values.

---

1. RenderKind

The RenderKind enum specifies the dimensions of the output renders. Each value corresponds to a specific size or group of sizes.

Definition

{
    "Unset": 0,
    "Post": 1,
    "Story": 2,
    "Landscape": 4,
    "Vertical": 8,
    "PinSize": 16,
    "Social": 31,
    "MediumBanner": 32,
    "LeaderBoard": 64,
    "WideSkyScraper": 128,
    "HalfPage": 256,
    "LargeLeaderboard": 512,
    "FullHD": 1024,
    "Portrait": 2048,
    "Widescreen": 4096,
    "VideoPortrait": 8192,
    "VideoLandscape": 16384,
    "Display": 992,
    "All": 1023
}

Description

Value	Description	Dimensions
Unset	No rendering type set.	N/A
Post	Square post size.	1080x1080 px
Story	Vertical story size.	1080x1920 px
Landscape	Landscape size for banners.	1200x628 px
Vertical	Vertical size for portrait ads.	1080x1350 px
PinSize	Pinterest-specific size.	1000x1500 px
Social	Combination of all social sizes.	Multiple sizes
MediumBanner	Medium rectangle banner.	300x250 px
LeaderBoard	Large horizontal banner.	728x90 px
WideSkyScraper	Tall vertical banner.	160x600 px
HalfPage	Large vertical half-page banner.	300x600 px
LargeLeaderboard	Large leaderboard banner.	970x90 px
FullHD	Full HD resolution.	1920x1080 px
Portrait	Portrait resolution.	768x1024 px
Widescreen	Widescreen resolution.	1024x768 px
VideoPortrait	Portrait-oriented video resolution.	768x1280 px
VideoLandscape	Landscape-oriented video resolution.	1280x768 px
Display	Combination of display ad sizes.	Multiple sizes
All	All possible sizes.	Multiple sizes

---

2. RenderType

The RenderType enum specifies the type of output render.

Definition

{
    "Unset": 0,
    "Html": 1,
    "Svg": 2,
    "AiProduct": 4,
    "AiImageUpscaling": 8,
    "AiProductCreative": 16,
    "AiImageGeneration": 32,
    "AiSampledImageGeneration": 64,
    "AiFaceEnhancing": 128,
    "AiInPainting": 1024,
    "AiOutPainting": 127,
    "AiDressing": 256,
    "AiDetailEnhancing": 512,
    "TemplateBased": 19,
    "AiGenerationBased": 100,
    "All": 127
}

Description

Value	Description
Unset	No render type set.
Html	HTML-based render (deprecated).
Svg	SVG format render.
AiProduct	AI-generated product images.
AiImageUpscaling	AI-based image upscaling.
AiProductCreative	AI-generated product creatives.
AiImageGeneration	AI-based image generation.
AiSampledImageGeneration	AI image generation using a sample.
AiFaceEnhancing	AI-based facial detail enhancement.
AiInPainting	AI-based in-painting for image restoration.
AiOutPainting	AI-based out-painting for extending images.
AiDressing	AI dressing of models.
AiDetailEnhancing	AI-based detail enhancement.
TemplateBased	Template-based rendering types.
AiGenerationBased	AI generation-related rendering types.
All	All rendering types.

---

3. RenderState

The RenderState enum describes the state of a rendering process.

Definition

{
    "NotStarted": 0,
    "Started": 1,
    "Scheduled": 2,
    "Cancelled": 3,
    "Failed": 4,
    "Succeeded": 5,
    "Default": 0
}

Description

Value	Description
NotStarted	The render process has not started.
Started	The render process has started.
Scheduled	The render process is scheduled.
Cancelled	The render process was cancelled.
Failed	The render process failed.
Succeeded	The render process succeeded.
Default	The default state (equivalent to NotStarted).

---

4. NotificationChannel

The NotificationChannel enum specifies the channel for notifications.

Definition

{
    "WebHook": 0,
    "SignalR": 1,
    "RabbitMQ": 2
}

Description

Value	Description
WebHook	Notifications are sent via WebHook.
SignalR	Notifications are sent via SignalR.
RabbitMQ	Notifications are sent via RabbitMQ.

---

5. ImageStyle

The ImageStyle enum specifies various styles for generating stock images. Each value represents a unique style, providing users with diverse options for image creation. Below is the detailed documentation for each enum value, including its purpose and description.

---

Definition

{
    "Unset": 0,
    "CustomWithText": 1,
    "CustomWithImage": 2,
    "Photorealistic": 3,
    "StudioShot": 4,
    "ThreeDRender": 5,
    "HighlyDetailed": 6,
    "Fantasy": 7,
    "Cinematic": 8,
    "Cyberpunk": 9,
    "DigitalPainting": 10,
    "IsometricArt": 11,
    "Surrealism": 12
}

---

Enum Values

Name	Value	Description
Unset	0	The image style is unset. This is the default value.
CustomWithText	1	Custom image style with added text elements.
CustomWithImage	2	The style is derived from a custom image provided by the user.
Photorealistic	3	Stock images with lifelike precision and detail.
StudioShot	4	Clean, focused images with soft, professional lighting.
ThreeDRender	5	3D-rendered images with realistic depth and polished textures.
HighlyDetailed	6	Highly detailed images with intricate textures and sharp definition.
Fantasy	7	Mystical and enchanting visuals with a touch of magic.
Cinematic	8	Dramatic lighting and intense shadows for a filmic look.
Cyberpunk	9	Futuristic style with neon highlights and high-tech aesthetics.
DigitalPainting	10	Artistically crafted visuals with bold colors and soft strokes.
IsometricArt	11	Precise, structured visuals with a three-dimensional perspective.
Surrealism	12	Dreamlike scenes with abstract, otherworldly elements.

---

Usage Examples

Example 1: Setting Image Style

var imageStyle = ImageStyle.Photorealistic;
Console.WriteLine($"Selected image style: {imageStyle}");

Example 2: Conditional Logic with Image Styles

switch (imageStyle)
{
    case ImageStyle.Cyberpunk:
        Console.WriteLine("Creating a futuristic cyberpunk-themed image...");
        break;
    case ImageStyle.Fantasy:
        Console.WriteLine("Generating a magical fantasy-themed image...");
        break;
    default:
        Console.WriteLine("Using default image style.");
        break;
}

---

Additional Notes

• The Unset value serves as a placeholder and should be avoided in production scenarios.

• CustomWithText and CustomWithImage allow user-provided inputs to influence the image style.

• Styles like Photorealistic and StudioShot are ideal for realistic and professional visuals, while Fantasy and Cyberpunk cater to creative and futuristic designs.

6. AdTextType

The AdTextType enum specifies various ad text styles and methodologies used for generating high-conversion ad copy. Each value corresponds to a specific ad text framework or principle, providing detailed examples and explanations.

Definition

{
    "Unknown": 0,
    "SharpTechnique": 1,
    "GateFramework": 2,
    "LiftMethod": 3,
    "PasFormula": 4,
    "BabFormula": 5,
    "FabFormula": 6,
    "AidaModel": 7,
    "FourCSPrinciple": 8,
    "FourUSPrinciple": 9,
    "SlapMethod": 10,
    "QuestMethod": 11,
    "AccaModel": 12,
    "KissPrinciple": 13,
    "MetaPackage": 14,
    "GooglePackage": 15,
    "OAthFormula": 16,
    "PPPPFormula": 17,
    "PaisFormula": 18,
    "AppFormula": 19,
    "SuccessMethod": 20,
    "Headline": 21,
    "ShortHeadline": 22,
    "LongHeadline": 23,
    "GoogleResponsiveSearchAds": 24,
    "GoogleResponsiveDisplayAds": 25,
    "LinkedInSingleImageVideoAds": 26,
    "LinkedInTextAds": 27,
    "BingSearchAds": 28,
    "BingDisplayAds": 29,
    "PowerPack": 30,
    "Description": 31,
    "AiRenderProductVideoFromImageChat": 32,
    "AiProductImageAndVideoRecommendationChat": 33,
    "AiProductVideoPromptRecommendationsChat": 34,
    "AiProductVideoPromptOptimizerChat": 35,
    "ProductPhotoShootImageDescription": 36,
    "ProductPhotoShootRecommendationForVideo": 37,
    "ProductPhotoShootOptimizerForVideo": 38,
    "BuyerPersona": 39
}

---

AdTextType Enum Description Table

Value	Description
Unknown	Unknown text type.
SharpTechnique	SHARP Technique: Short Headlines for Ads. Examples: Improve your child’s grades with Learning Room! Get ahead of the competition with Learning Room! Give your child the tools they need to succeed with Learning Room! Help your child reach their full potential with Learning Room!
GateFramework	GATE Framework: General Ad Texts. Examples: Are you ready for a whiter, healthier smile in as little as 9 minutes per day? Our Snow Teeth Whitening Kit helps brighten teeth, remove coffee and wine stains, and doesn’t cause pain. With more than 600,000 customers who are extremely satisfied with the results, we’re sure you’ll love our at home teeth whitening kit too. Buy your kit today for immediate results!
LiftMethod	LIFT Method: Listicle Style Ad Texts. Examples: At-Home Teeth Whitening Made Easy Ad: We turn yellow and stained teeth into pearly whites in just 9-minutes a day. 😁 The World’s #1 Teeth Whitening System ⭐️ Loved by 600,000+ Happy Customers ✅ Featured in GQ, Elle, Vogue & Forbes Get your Snow Teeth Whitening Kit today, receive 50% discount!
PasFormula	PAS Formula: Pain-Agitate-Solution Style Ad Texts. Pain: While you should get your teeth professionally cleaned twice a year, it’s not exactly realistic when you’re busy with work and personal commitments. Agitate: Our whitening kit removes 99% of stains within 14 days — without the pain. Solution: Whiten your teeth in minutes per day with our DIY teeth whitener solution designed for sensitive teeth and gums.
BabFormula	BAB Formula: Before-After-Bridge Style Ad Texts. Examples: Before: Writing blog posts and landing pages for your clients can be a tedious task. After: ContentBot, an AI-powered copywriting assistant makes it easy. Bridge: Automate your marketing efforts and save time!
FabFormula	FAB Formula: Feature-Advantage-Benefit Style Ad Texts. Features: Specially designed for making froth milk and delicious coffee. Advantages: Simple one-touch operation. Benefits: Enjoy delicious coffee with family and friends.
AidaModel	AIDA Model: Attention, Interest, Desire, Action. Examples: Attention: Get a Dazzling Smile in Just 7 Days! Interest: Tired of hiding your yellow teeth? Desire: Advanced whitening technology removes stains. Action: Order now for a confident smile!
FourCSPrinciple	4C’s Principle: Clear, Concise, Compelling, Credible. Examples: Clear: Whiten your teeth up to 8 shades in just 7 days. Concise: Try our enamel-safe tooth whitening gel. Compelling: Join thousands of radiant smiles! Credible: Trusted by leading dentists.
FourUSPrinciple	4U’s Principle: Urgent, Unique, Ultra-specific, Useful. Examples: Urgent: Limited-time offer: Save 25%! Unique: Exclusive, patented whitening formula. Ultra-specific: Dentist-approved, results in just 7 days. Useful: Enjoy a whiter smile without hassle.
SlapMethod	SLAP Method: Stop, Look, Act, Purchase. Examples: Stop: New Breakthrough: Dazzling Smiles in 7 Days! Look: Discover SmileBright, the revolutionary tooth whitening solution. Act: Ready to embrace a brilliant smile? Order now! Purchase: Buy one, get one 50% off!
QuestMethod	QUEST Method: Qualify, Understand, Educate, Stimulate, Transition. Examples: Qualify: Looking for a fast way to brighten your smile? Understand: Self-conscious about yellow teeth? Educate: SmileBright delivers visible results in just 7 days. Stimulate: Imagine the confidence of a radiant smile. Transition: Order SmileBright today!
AccaModel	ACCA Model: Awareness, Comprehension, Conviction, Action. Examples: Awareness: Introducing SmileBright. Comprehension: Dentist-approved formula removes stains. Conviction: Trusted by thousands for brilliant smiles. Action: Order SmileBright now!
KissPrinciple	KISS Principle: Keep It Simple and Straightforward. Examples: Simple: Whiten your teeth quickly. Straightforward: Removes stubborn stains in 7 days. Call to Action: Order SmileBright today!
MetaPackage	Meta Package: Dynamic Creative Ads. Examples: Meta Dynamic Creative Ads require 5 Primary Texts and 5 Headlines. Generates multiple sets using proven copywriting frameworks.
GooglePackage	Google Package: Performance Max Ads. Examples: Requires 5 Headlines, 5 Long Headlines, and 5 Descriptions. Generated with high-conversion-rate methodologies.
OAthFormula	OATH Formula: Old-Annoyed-Thorough-Hesitant Style Ad Texts. Examples: Self-conscious about stained teeth? Frustrated that brushing doesn’t work? Our revolutionary whitening product ensures visibly whiter teeth in just 2 weeks!
PPPPFormula	PPPP Formula: Picture-Promise-Prove-Push Style Ad Texts. Examples: Picture yourself with a radiant smile. Promise: Remove years of stains. Prove: Testimonials and before-and-after photos. Push: Start smiling with confidence!
PaisFormula	PAIS Formula: Problem-Agitate-Invalidate-Solve Style Ad Texts. Examples: Problem: Struggling with teeth stains? Agitate: Lack of potency in over-the-counter solutions. Invalidate: Whitening toothpaste isn’t enough. Solve: Our product guarantees results in just 2 weeks.
AppFormula	APP Formula: Agree-Promise-Preview Style Ad Texts. Examples: Agree: A bright smile boosts confidence. Promise: Removes deep-set stains. Preview: Efficient and easy-to-use whitening solution.
SuccessMethod	SUCCESs Method: Simple-Unexpected-Concrete-Credible-Emotional-Story Style Ad Texts. Examples: Simple: Whiten your teeth easily. Unexpected: Immediate visible effects. Credible: Trusted by dentists. Emotional: Joy of transformation. Story: A brighter smile starts here.
Headline	Headline text type.
ShortHeadline	Short Headline text type.
LongHeadline	Long Headline text type.
GoogleResponsive SearchAds	Google Package: Responsive Search Ads. Examples: 15 Headlines (30 characters) and 4 Descriptions (90 characters) required. High conversion rates achieved through tested methodologies.
GoogleResponsive DisplayAds	Google Package: Responsive Display Ads. Examples: 5 Headlines (30 characters), 1 Long Headline (90 characters), and 5 Descriptions (90 characters). Consistently high conversion rates.
LinkedInSingle ImageVideoAds	LinkedIn Package: Single Image/Video Ads. Examples: Requires 1 headline (up to 100 characters) and 1 description (up to 600 characters). More than 10 texts generated.
LinkedInTextAds	LinkedIn Package: Text Ads. Examples: Requires 1 headline (up to 25 characters) and 1 description (up to 75 characters). Generates over 10 options.
BingSearchAds	Bing Ads Package: Search Ads. Examples: 15 Headlines (30 characters) and 4 Descriptions (90 characters) required. Optimized for high conversion rates.
BingDisplayAds	Bing Ads Package: Audience Display Ads. Examples: Requires 15 Short Headlines, 5 Long Headlines, and 5 Ad Texts.
PowerPack	Power Pack: All-in-one Ad Text Package. Examples: Generates over 20 conversion-focused ad texts using all powerful copywriting techniques at AdCreative.ai.
Description	Description text type.
AiRenderProduct VideoFromImageChat	AI Render Product Video From Image Chat text type.
AiProductImageAndVideo RecommendationChat	AI Product Image And Video Recommendation Chat text type.
AiProductVideoPrompt RecommendationsChat	AI Product Video Prompt Recommendations Chat text type.
AiProductVideoPrompt OptimizerChat	AI Product Video Prompt Optimizer Chat text type.
ProductPhotoShootImage Description	Product Photo Shoot Image Description text type.
ProductPhotoShoot RecommendationForVideo	Product Photo Shoot Recommendation For Video text type.
ProductPhotoShoot OptimizerForVideo	Product Photo Shoot Optimizer For Video text type.
BuyerPersona	Buyer Persona text type.

---

6. AdTextTones

AdTextTones Enum - JSON Format and Usage Guide

The AdTextTones enum represents the tone of the generated text output in the API. Each tone is provided as a descriptive string value to ensure clarity and ease of use. Below is the JSON representation of the enum, followed by an explanation for implementing it in your API requests.

---

JSON Representation

{
  "AdTextTones": [
    "Professional",
    "Informal",
    "Friendly",
    "Enthusiastic",
    "Humorous",
    "Inspirational",
    "Persuasive",
    "Luxurious",
    "Conversational",
    "Educational",
    "Emotional",
    "Authoritative",
    "Nostalgic",
    "Romantic",
    "Playful",
    "Sarcastic",
    "Urgent",
    "Empathetic",
    "Uplifting",
    "Minimalist"
  ]
}

---

Explanation

• Purpose: The AdTextTones enum defines the tone of the text content generated by the API. Developers can choose the desired tone by passing its string value (e.g., "Friendly", "Professional") in the relevant API request.

• Data Type: The tone values are provided as strings to ensure compatibility and readability in API integrations.

• Example Use Case: When creating a text generation request, the tone can be specified in the payload to align the generated content with the desired communication style.

---

Example Request Payload

Below is an example of how to include a tone selection in your API request:

{
  "projectName": "Marketing Campaign 2025",
  "contentType": "Ad Copy",
  "tone": "Inspirational",
  "keywords": ["innovative", "sustainable", "future-focused"],
  "targetAudience": "Tech Enthusiasts"
}

• Field Descriptions:

  • projectName: The name of the project for reference.

  • contentType: The type of content you are generating.

  • tone: The selected tone for the text generation, chosen from the AdTextTones enum.

  • keywords: Keywords to focus on in the generated text.

  • targetAudience: The audience the text is aimed at.

---

Notes

• Ensure that the tone field in your API payload contains one of the valid values from the AdTextTones enum.

• If no tone is specified, the API may default to a neutral tone (e.g., "Professional").

This structured approach allows developers to produce content that matches the desired tone and ensures consistent integration with the API.

AdTextTones Enum Description Table

Value	Description
Professional	Uses a formal and polished tone suitable for business or official communications.
Informal	A casual tone that feels relaxed and conversational.
Friendly	A warm and welcoming tone that makes the reader feel comfortable and appreciated.
Enthusiastic	A highly energetic tone that conveys excitement and eagerness.
Humorous	A light-hearted tone that incorporates humor to engage the audience.
Inspirational	A motivating tone that encourages and uplifts the audience.
Persuasive	A compelling tone designed to influence and convince the audience.
Luxurious	A tone that conveys elegance, opulence, and high-quality experiences.
Conversational	A natural and interactive tone that mimics real-life conversations.
Educational	An informative tone that simplifies concepts for learning and understanding.
Emotional	A tone that evokes strong feelings and connects with the reader on a deeper level.
Authoritative	A confident and assertive tone that establishes trust and credibility.
Nostalgic	A tone that evokes memories of the past and creates a sense of longing.
Romantic	A tone filled with affection, passion, and emotional connection.
Playful	A tone that is fun, light, and full of joy, often using creative language.
Sarcastic	A witty and ironic tone used to make a point in a humorous or cutting way.
Urgent	A tone that creates a sense of immediacy and importance, prompting quick action.
Empathetic	A tone that shows understanding and care, connecting with the reader’s emotions.
Uplifting	A positive and encouraging tone designed to boost morale and inspire hope.
Minimalist	A tone that is simple, clear, and concise, focusing only on essential details.

---

7. AdTextEmojiSelection

AdTextEmojiSelection Enum Documentation

Overview

The AdTextEmojiSelection enum is used to define the emoji preference for AI-generated ad texts. This enum is represented by integers when sent as parameters in API requests.

Enum Definition

namespace AdCreative.AdGenius.API.Enums.AdTextGeneration;

/// <summary>
/// The ad text emoji selection for AI.
/// </summary>
public enum AdTextEmojiSelection
{
    /// <summary>
    /// Text with emojis.
    /// </summary>
    WithEmojis,

    /// <summary>
    /// Text without emojis.
    /// </summary>
    WithoutEmojis,

    /// <summary>
    /// Text chosen by AI.
    /// </summary>
    ChosenByAi,
}

JSON Representation

Definition

{
  "AdTextEmojiSelection": [
    "WithEmojis": 0,
    "WithoutEmojis": 1,
    "ChosenByAi": 2,
  ]
}

When using this enum in an API request, it is represented as integers:

{
  "emojiPreference": 0 // Example: With Emojis
}

Enum Values and Descriptions

Value	Name	Description
0	WithEmojis	Text with emojis.
1	WithoutEmojis	Text without emojis.
2	ChosenByAi	Text preference chosen by the AI.

---

Example Usage

C# Example

var selection = AdTextEmojiSelection.ChosenByAi;
Console.WriteLine((int)selection); // Outputs: 2

API Request Example

Using Postman or any HTTP client:

Request Body

{
  "emojiSelection": 1
}

Explanation

• emojiPreference: Specifies whether the generated text should include emojis (0), exclude emojis (1), or let the AI decide (2).

---

Notes

• Ensure the value sent matches the defined range (0, 1, or 2).

• The default behavior should be explicitly defined in your application logic if no value is provided.

This document serves as a reference for all enum definitions, ensuring consistent and correct usage in JSON requests and responses.

---