lib/facebook_ads/ad_objects/ad_creative.rb

# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
#
# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
# copy, modify, and distribute this software in source code or binary form for use
# in connection with the web services and APIs provided by Facebook.
#
# As with any software that integrates with the Facebook platform, your use of
# this software is subject to the Facebook Platform Policy
# [http://developers.facebook.com/policy/]. This copyright notice shall be
# included in all copies or substantial portions of the software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

# FB:AUTOGEN

module FacebookAds
  # This class is auto-generated.

  # For any issues or feature requests related to this class, please let us know
  # on github and we'll fix in our codegen framework. We'll not be able to accept
  # pull request for this class.

  class AdCreative < AdObject
    CALL_TO_ACTION_TYPE = [
      "ADD_TO_CART",
      "APPLY_NOW",
      "BOOK_TRAVEL",
      "BUY",
      "BUY_NOW",
      "BUY_TICKETS",
      "CALL",
      "CALL_ME",
      "CALL_NOW",
      "CONTACT",
      "CONTACT_US",
      "DONATE",
      "DONATE_NOW",
      "DOWNLOAD",
      "EVENT_RSVP",
      "FIND_A_GROUP",
      "FIND_YOUR_GROUPS",
      "FOLLOW_NEWS_STORYLINE",
      "FOLLOW_PAGE",
      "FOLLOW_USER",
      "GET_DIRECTIONS",
      "GET_OFFER",
      "GET_OFFER_VIEW",
      "GET_QUOTE",
      "GET_SHOWTIMES",
      "INSTALL_APP",
      "INSTALL_MOBILE_APP",
      "LEARN_MORE",
      "LIKE_PAGE",
      "LISTEN_MUSIC",
      "LISTEN_NOW",
      "MESSAGE_PAGE",
      "MOBILE_DOWNLOAD",
      "MOMENTS",
      "NO_BUTTON",
      "OPEN_LINK",
      "ORDER_NOW",
      "PAY_TO_ACCESS",
      "PLAY_GAME",
      "PLAY_GAME_ON_FACEBOOK",
      "PURCHASE_GIFT_CARDS",
      "RECORD_NOW",
      "REFER_FRIENDS",
      "REQUEST_TIME",
      "SAY_THANKS",
      "SEE_MORE",
      "SELL_NOW",
      "SEND_A_GIFT",
      "SEND_GIFT_MONEY",
      "SHARE",
      "SHOP_NOW",
      "SIGN_UP",
      "SOTTO_SUBSCRIBE",
      "START_ORDER",
      "SUBSCRIBE",
      "SWIPE_UP_PRODUCT",
      "SWIPE_UP_SHOP",
      "UPDATE_APP",
      "USE_APP",
      "USE_MOBILE_APP",
      "VIDEO_ANNOTATION",
      "VIDEO_CALL",
      "VISIT_PAGES_FEED",
      "WATCH_MORE",
      "WATCH_VIDEO",
      "WHATSAPP_MESSAGE",
      "WOODHENGE_SUPPORT",
    ]

    OBJECT_TYPE = [
      "APPLICATION",
      "DOMAIN",
      "EVENT",
      "INVALID",
      "OFFER",
      "PAGE",
      "PHOTO",
      "POST_DELETED",
      "PRIVACY_CHECK_FAIL",
      "SHARE",
      "STATUS",
      "STORE_ITEM",
      "VIDEO",
    ]

    STATUS = [
      "ACTIVE",
      "DELETED",
      "IN_PROCESS",
      "WITH_ISSUES",
    ]

    APPLINK_TREATMENT = [
      "automatic",
      "deeplink_with_appstore_fallback",
      "deeplink_with_web_fallback",
      "web_only",
    ]

    AUTHORIZATION_CATEGORY = [
      "NONE",
      "POLITICAL",
    ]

    CATEGORIZATION_CRITERIA = [
      "brand",
      "category",
      "product_type",
    ]

    CATEGORY_MEDIA_SOURCE = [
      "CATEGORY",
      "MIXED",
      "PRODUCTS_COLLAGE",
      "PRODUCTS_SLIDESHOW",
    ]

    DYNAMIC_AD_VOICE = [
      "DYNAMIC",
      "STORY_OWNER",
    ]

    INSTANT_CHECKOUT_SETTING = [
      "off",
      "on",
    ]

    OPERATOR = [
      "ALL",
      "ANY",
    ]


    field :account_id, 'string'
    field :actor_id, 'string'
    field :adlabels, { list: 'AdLabel' }
    field :applink_treatment, 'string'
    field :asset_feed_spec, 'AdAssetFeedSpec'
    field :authorization_category, 'string'
    field :auto_update, 'bool'
    field :body, 'string'
    field :branded_content_sponsor_page_id, 'string'
    field :bundle_folder_id, 'string'
    field :call_to_action_type, { enum: -> { CALL_TO_ACTION_TYPE }}
    field :categorization_criteria, 'string'
    field :category_media_source, 'string'
    field :collaborative_ads_lsb_image_bank_id, 'string'
    field :destination_set_id, 'string'
    field :dynamic_ad_voice, 'string'
    field :effective_authorization_category, 'string'
    field :effective_instagram_media_id, 'string'
    field :effective_instagram_story_id, 'string'
    field :effective_object_story_id, 'string'
    field :enable_direct_install, 'bool'
    field :enable_launch_instant_app, 'bool'
    field :id, 'string'
    field :image_crops, 'AdsImageCrops'
    field :image_hash, 'string'
    field :image_url, 'string'
    field :instagram_actor_id, 'string'
    field :instagram_permalink_url, 'string'
    field :instagram_story_id, 'string'
    field :instagram_user_id, 'string'
    field :interactive_components_spec, 'AdCreativeInteractiveComponentsSpec'
    field :link_deep_link_url, 'string'
    field :link_destination_display_url, 'string'
    field :link_og_id, 'string'
    field :link_url, 'string'
    field :messenger_sponsored_message, 'string'
    field :name, 'string'
    field :object_id, 'string'
    field :object_store_url, 'string'
    field :object_story_id, 'string'
    field :object_story_spec, 'AdCreativeObjectStorySpec'
    field :object_type, { enum: -> { OBJECT_TYPE }}
    field :object_url, 'string'
    field :omnichannel_link_spec, 'AdCreativeOmnichannelLinkSpec'
    field :place_page_set_id, 'string'
    field :platform_customizations, 'AdCreativePlatformCustomization'
    field :playable_asset_id, 'string'
    field :portrait_customizations, 'AdCreativePortraitCustomizations'
    field :product_set_id, 'string'
    field :recommender_settings, 'AdCreativeRecommenderSettings'
    field :source_instagram_media_id, 'string'
    field :status, { enum: -> { STATUS }}
    field :template_url, 'string'
    field :template_url_spec, 'AdCreativeTemplateUrlSpec'
    field :thumbnail_id, 'string'
    field :thumbnail_url, 'string'
    field :title, 'string'
    field :url_tags, 'string'
    field :use_page_actor_override, 'bool'
    field :video_id, 'string'
    field :call_to_action, 'object'
    field :image_file, 'string'
    field :instant_checkout_setting, { enum: -> { INSTANT_CHECKOUT_SETTING }}
    field :is_dco_internal, 'bool'

    has_edge :adlabels do |edge|
      edge.post 'AdCreative' do |api|
        api.has_param :adlabels, { list: 'object' }
      end
    end

    has_edge :creative_insights do |edge|
      edge.get 'AdCreativeInsights'
    end

    has_edge :previews do |edge|
      edge.get 'AdPreview' do |api|
        api.has_param :ad_format, { enum: -> { AdPreview::AD_FORMAT }}
        api.has_param :dynamic_asset_label, 'string'
        api.has_param :dynamic_creative_spec, 'object'
        api.has_param :dynamic_customization, 'object'
        api.has_param :end_date, 'datetime'
        api.has_param :height, 'int'
        api.has_param :locale, 'string'
        api.has_param :place_page_id, 'int'
        api.has_param :post, 'object'
        api.has_param :product_item_ids, { list: 'string' }
        api.has_param :render_type, { enum: -> { AdPreview::RENDER_TYPE }}
        api.has_param :start_date, 'datetime'
        api.has_param :width, 'int'
      end
    end

  end
end