Module: FacebookAds

Extended by:
FacebookAds, Shortcuts
Included in:
FacebookAds
Defined in:
lib/facebook_ads/edge.rb,
lib/facebook_ads.rb,
lib/facebook_ads/config.rb,
lib/facebook_ads/errors.rb,
lib/facebook_ads/fields.rb,
lib/facebook_ads/session.rb,
lib/facebook_ads/version.rb,
lib/facebook_ads/ad_object.rb,
lib/facebook_ads/param_set.rb,
lib/facebook_ads/api_request.rb,
lib/facebook_ads/field_types.rb,
lib/facebook_ads/utils/utils.rb,
lib/facebook_ads/api_response.rb,
lib/facebook_ads/ad_objects/ad.rb,
lib/facebook_ads/ad_objects/lead.rb,
lib/facebook_ads/ad_objects/user.rb,
lib/facebook_ads/batch_api/batch.rb,
lib/facebook_ads/videos/video_io.rb,
lib/facebook_ads/ad_objects/event.rb,
lib/facebook_ads/ad_objects/hotel.rb,
lib/facebook_ads/field_types/base.rb,
lib/facebook_ads/field_types/enum.rb,
lib/facebook_ads/field_types/list.rb,
lib/facebook_ads/ad_objects/ad_set.rb,
lib/facebook_ads/ad_objects/domain.rb,
lib/facebook_ads/helpers/shortcuts.rb,
lib/facebook_ads/ad_objects/id_name.rb,
lib/facebook_ads/field_types/double.rb,
lib/facebook_ads/field_types/object.rb,
lib/facebook_ads/ad_objects/ad_image.rb,
lib/facebook_ads/ad_objects/ad_label.rb,
lib/facebook_ads/ad_objects/ad_study.rb,
lib/facebook_ads/ad_objects/ad_video.rb,
lib/facebook_ads/ad_objects/business.rb,
lib/facebook_ads/ad_objects/campaign.rb,
lib/facebook_ads/ad_objects/day_part.rb,
lib/facebook_ads/field_types/boolean.rb,
lib/facebook_ads/field_types/integer.rb,
lib/facebook_ads/ad_objects/ads_pixel.rb,
lib/facebook_ads/ad_objects/app_links.rb,
lib/facebook_ads/ad_objects/rate_card.rb,
lib/facebook_ads/ad_objects/targeting.rb,
lib/facebook_ads/field_types/datetime.rb,
lib/facebook_ads/helpers/edge_helpers.rb,
lib/facebook_ads/helpers/node_helpers.rb,
lib/facebook_ads/videos/video_request.rb,
lib/facebook_ads/ad_objects/ad_account.rb,
lib/facebook_ads/ad_objects/ad_preview.rb,
lib/facebook_ads/ad_objects/hotel_room.rb,
lib/facebook_ads/batch_api/batch_proxy.rb,
lib/facebook_ads/field_types/ad_object.rb,
lib/facebook_ads/ad_objects/ad_activity.rb,
lib/facebook_ads/ad_objects/ad_creative.rb,
lib/facebook_ads/ad_objects/product_set.rb,
lib/facebook_ads/ad_objects/transaction.rb,
lib/facebook_ads/ad_objects/ads_insights.rb,
lib/facebook_ads/ad_objects/ios_app_link.rb,
lib/facebook_ads/ad_objects/leadgen_form.rb,
lib/facebook_ads/ad_objects/product_feed.rb,
lib/facebook_ads/ad_objects/product_item.rb,
lib/facebook_ads/ad_objects/web_app_link.rb,
lib/facebook_ads/field_types/string_type.rb,
lib/facebook_ads/field_types/upload_file.rb,
lib/facebook_ads/ad_objects/ad_report_run.rb,
lib/facebook_ads/ad_objects/ad_study_cell.rb,
lib/facebook_ads/ad_objects/offsite_pixel.rb,
lib/facebook_ads/ad_objects/product_group.rb,
lib/facebook_ads/ad_objects/delivery_check.rb,
lib/facebook_ads/ad_objects/lookalike_spec.rb,
lib/facebook_ads/ad_objects/minimum_budget.rb,
lib/facebook_ads/ad_objects/reach_estimate.rb,
lib/facebook_ads/ad_objects/ad_account_roas.rb,
lib/facebook_ads/ad_objects/ad_account_user.rb,
lib/facebook_ads/ad_objects/ads_image_crops.rb,
lib/facebook_ads/ad_objects/ads_pixel_stats.rb,
lib/facebook_ads/ad_objects/custom_audience.rb,
lib/facebook_ads/ad_objects/product_catalog.rb,
lib/facebook_ads/ad_objects/product_variant.rb,
lib/facebook_ads/ad_objects/video_thumbnail.rb,
lib/facebook_ads/ad_objects/ad_async_request.rb,
lib/facebook_ads/ad_objects/ad_keyword_stats.rb,
lib/facebook_ads/ad_objects/ads_action_stats.rb,
lib/facebook_ads/ad_objects/ads_data_partner.rb,
lib/facebook_ads/ad_objects/android_app_link.rb,
lib/facebook_ads/ad_objects/partner_category.rb,
lib/facebook_ads/ad_objects/rev_share_policy.rb,
lib/facebook_ads/ad_objects/windows_app_link.rb,
lib/facebook_ads/ad_objects/ad_place_page_set.rb,
lib/facebook_ads/ad_objects/ad_recommendation.rb,
lib/facebook_ads/ad_objects/custom_conversion.rb,
lib/facebook_ads/ad_objects/delivery_estimate.rb,
lib/facebook_ads/ad_objects/lead_gen_question.rb,
lib/facebook_ads/ad_objects/roas_cohorts_data.rb,
lib/facebook_ads/ad_objects/ad_promoted_object.rb,
lib/facebook_ads/ad_objects/ad_study_objective.rb,
lib/facebook_ads/ad_objects/event_source_group.rb,
lib/facebook_ads/ad_objects/flexible_targeting.rb,
lib/facebook_ads/ad_objects/lead_gen_qualifier.rb,
lib/facebook_ads/ad_objects/product_feed_upload.rb,
lib/facebook_ads/ad_objects/ad_async_request_set.rb,
lib/facebook_ads/ad_objects/custom_audiences_tos.rb,
lib/facebook_ads/ad_objects/reach_frequency_spec.rb,
lib/facebook_ads/ad_objects/ad_creative_link_data.rb,
lib/facebook_ads/ad_objects/ad_creative_text_data.rb,
lib/facebook_ads/ad_objects/business_page_request.rb,
lib/facebook_ads/ad_objects/external_event_source.rb,
lib/facebook_ads/ad_objects/product_feed_schedule.rb,
lib/facebook_ads/ad_objects/ad_creative_offer_data.rb,
lib/facebook_ads/ad_objects/ad_creative_photo_data.rb,
lib/facebook_ads/ad_objects/ad_creative_place_data.rb,
lib/facebook_ads/ad_objects/ad_creative_video_data.rb,
lib/facebook_ads/ad_objects/ad_recommendation_data.rb,
lib/facebook_ads/ad_objects/ads_pixel_stats_result.rb,
lib/facebook_ads/ad_objects/custom_audience_status.rb,
lib/facebook_ads/ad_objects/funding_source_details.rb,
lib/facebook_ads/ad_objects/profile_picture_source.rb,
lib/facebook_ads/ad_objects/targeting_dynamic_rule.rb,
lib/facebook_ads/ad_objects/targeting_geo_location.rb,
lib/facebook_ads/ad_objects/windows_phone_app_link.rb,
lib/facebook_ads/ad_objects/adgroup_relevance_score.rb,
lib/facebook_ads/ad_objects/adgroup_review_feedback.rb,
lib/facebook_ads/ad_objects/conversion_action_query.rb,
lib/facebook_ads/ad_objects/custom_audience_session.rb,
lib/facebook_ads/ad_objects/targeting_sentence_line.rb,
lib/facebook_ads/ad_objects/lead_gen_question_option.rb,
lib/facebook_ads/ad_objects/outcome_prediction_point.rb,
lib/facebook_ads/ad_objects/user_lead_gen_field_data.rb,
lib/facebook_ads/ad_objects/agency_client_declaration.rb,
lib/facebook_ads/ad_objects/delivery_check_extra_info.rb,
lib/facebook_ads/ad_objects/product_feed_upload_error.rb,
lib/facebook_ads/ad_objects/broad_targeting_categories.rb,
lib/facebook_ads/ad_objects/custom_audience_ad_account.rb,
lib/facebook_ads/ad_objects/custom_audience_permission.rb,
lib/facebook_ads/ad_objects/reach_frequency_prediction.rb,
lib/facebook_ads/ad_objects/targeting_geo_location_zip.rb,
lib/facebook_ads/ad_objects/business_ad_account_request.rb,
lib/facebook_ads/ad_objects/custom_audience_data_source.rb,
lib/facebook_ads/ad_objects/targeting_geo_location_city.rb,
lib/facebook_ads/ad_objects/transaction_currency_amount.rb,
lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb,
lib/facebook_ads/ad_objects/targeting_geo_location_place.rb,
lib/facebook_ads/ad_objects/ad_creative_object_story_spec.rb,
lib/facebook_ads/ad_objects/custom_audience_prefill_state.rb,
lib/facebook_ads/ad_objects/funding_source_details_coupon.rb,
lib/facebook_ads/ad_objects/targeting_geo_location_market.rb,
lib/facebook_ads/ad_objects/targeting_geo_location_region.rb,
lib/facebook_ads/ad_objects/custom_conversion_stats_result.rb,
lib/facebook_ads/ad_objects/product_catalog_image_settings.rb,
lib/facebook_ads/ad_objects/product_item_commerce_insights.rb,
lib/facebook_ads/ad_objects/helpers/custom_audience_helpers.rb,
lib/facebook_ads/ad_objects/targeting_product_audience_spec.rb,
lib/facebook_ads/ad_objects/product_feed_upload_error_sample.rb,
lib/facebook_ads/ad_objects/product_catalog_hotel_rooms_batch.rb,
lib/facebook_ads/ad_objects/user_lead_gen_disclaimer_response.rb,
lib/facebook_ads/ad_objects/legacy_business_ad_account_request.rb,
lib/facebook_ads/ad_objects/ad_creative_link_data_app_link_spec.rb,
lib/facebook_ads/ad_objects/targeting_product_audience_sub_spec.rb,
lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb,
lib/facebook_ads/ad_objects/roas_cohorts_per_cohort_interval_unit.rb,
lib/facebook_ads/ad_objects/ad_creative_link_data_child_attachment.rb,
lib/facebook_ads/ad_objects/targeting_geo_location_custom_location.rb,
lib/facebook_ads/ad_objects/product_catalog_pricing_variables_batch.rb,
lib/facebook_ads/ad_objects/ad_async_request_set_notification_result.rb,
lib/facebook_ads/ad_objects/product_catalog_image_settings_operation.rb,
lib/facebook_ads/ad_objects/targeting_geo_location_electoral_district.rb,
lib/facebook_ads/ad_objects/targeting_geo_location_political_district.rb,
lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action_value.rb,
lib/facebook_ads/ad_objects/adgroup_placement_specific_review_feedback.rb

Overview

FB:AUTOGEN

Defined Under Namespace

Modules: CustomAudienceHelpers, EdgeHasDelete, EdgeHasGet, EdgeHasPost, FieldTypes, Fields, GraphEdges, GraphNodes, HTTPService, NodeHasNoDelete, NodeHasNoGet, NodeHasNoID, NodeHasNoPost, Shortcuts, Utils Classes: APIError, APIRequest, APIResponse, Ad, AdAccount, AdAccountRoas, AdAccountTargetingUnified, AdAccountUser, AdActivity, AdAsyncRequest, AdAsyncRequestSet, AdAsyncRequestSetNotificationResult, AdCreative, AdCreativeLinkData, AdCreativeLinkDataAppLinkSpec, AdCreativeLinkDataCallToAction, AdCreativeLinkDataCallToActionValue, AdCreativeLinkDataChildAttachment, AdCreativeObjectStorySpec, AdCreativeOfferData, AdCreativePhotoData, AdCreativePlaceData, AdCreativeTextData, AdCreativeVideoData, AdImage, AdKeywordStats, AdLabel, AdObject, AdPlacePageSet, AdPreview, AdPromotedObject, AdRecommendation, AdRecommendationData, AdReportRun, AdSet, AdStudy, AdStudyCell, AdStudyObjective, AdVideo, AdgroupPlacementSpecificReviewFeedback, AdgroupRelevanceScore, AdgroupReviewFeedback, AdsActionStats, AdsDataPartner, AdsImageCrops, AdsInsights, AdsPixel, AdsPixelStats, AdsPixelStatsResult, AgencyClientDeclaration, AndroidAppLink, AppLinks, Batch, BatchProxy, BroadTargetingCategories, Business, BusinessAdAccountRequest, BusinessPageRequest, Campaign, ClientError, Config, ConversionActionQuery, CustomAudience, CustomAudienceAdAccount, CustomAudienceDataSource, CustomAudiencePermission, CustomAudiencePrefillState, CustomAudienceSession, CustomAudienceStatus, CustomAudiencesTOS, CustomConversion, CustomConversionStatsResult, DayPart, DeliveryCheck, DeliveryCheckExtraInfo, DeliveryEstimate, Domain, Edge, Error, Event, EventSourceGroup, ExternalEventSource, FlexibleTargeting, FundingSourceDetails, FundingSourceDetailsCoupon, Hotel, HotelRoom, IDName, InvalidParameterError, IosAppLink, Lead, LeadGenQualifier, LeadGenQuestion, LeadGenQuestionOption, LeadgenForm, LegacyBusinessAdAccountRequest, LookalikeSpec, MinimumBudget, OffsitePixel, OutcomePredictionPoint, ParamSet, PartnerCategory, ProductCatalog, ProductCatalogHotelRoomsBatch, ProductCatalogImageSettings, ProductCatalogImageSettingsOperation, ProductCatalogPricingVariablesBatch, ProductFeed, ProductFeedSchedule, ProductFeedUpload, ProductFeedUploadError, ProductFeedUploadErrorSample, ProductGroup, ProductItem, ProductItemCommerceInsights, ProductSet, ProductVariant, ProfilePictureSource, RateCard, ReachEstimate, ReachFrequencyPrediction, ReachFrequencySpec, RevSharePolicy, RoasCohortsData, RoasCohortsPerCohortIntervalUnit, ServerError, Session, Targeting, TargetingDynamicRule, TargetingGeoLocation, TargetingGeoLocationCity, TargetingGeoLocationCustomLocation, TargetingGeoLocationElectoralDistrict, TargetingGeoLocationMarket, TargetingGeoLocationPlace, TargetingGeoLocationPoliticalDistrict, TargetingGeoLocationRegion, TargetingGeoLocationZip, TargetingProductAudienceSpec, TargetingProductAudienceSubSpec, TargetingSentenceLine, Transaction, TransactionCurrencyAmount, User, UserLeadGenDisclaimerResponse, UserLeadGenFieldData, VideoIO, VideoThumbnail, WebAppLink, WindowsAppLink, WindowsPhoneAppLink

Constant Summary collapse

DEFAULT_API_VERSION = 
'v' + API_VERSION
DEFAULT_HOST = 
'graph.facebook.com'
VERSION = 
'0.2.9'
API_VERSION = 
'2.9'

Instance Method Summary collapse

Methods included from Shortcuts

ad_account, business, me

Instance Method Details

#configure {|@config| ... } ⇒ Object Also known as: config

Yields:



36
37
38
39
40
 
# File 'lib/facebook_ads.rb', line 36

def configure
  @config ||= Config.new
  yield @config if block_given?
  @config
end

#with_session(access_token, secret = nil, api_version = DEFAULT_API_VERSION) ⇒ Object 



29
30
31
32
33
34
 
# File 'lib/facebook_ads.rb', line 29

def with_session(access_token, secret = nil, api_version = DEFAULT_API_VERSION)
  original_session = Session.current_session
  Session.current_session = Session.new(access_token, secret, api_version)
  yield
  Session.current_session = original_session
end