适用于 iOS 的 AFS 移动应用 (AFSMA) 实现

前提条件

本实现指南假定您熟悉以下内容:

概览

本文档简要介绍了在 iOS 移动应用中集成适用于移动应用的 AFS (AFSMA) 广告的过程。AFSMA 广告有时也称为动态高度搜索广告。若要在 iOS 上请求和呈现 AFSMA 广告,您需要实现以下各项:

GADSearchBannerView

  • 该类继承自 iOS UIView 类,并展示 AFSMA 广告。GADSearchBannerView 会使用 GADDynamicHeightSearchRequest 发出请求,并呈现返回的广告。应将 GADSearchBannerView 添加到应用的任何现有视图;通常情况下,它是保存添加 GADSearchBannerView 的视图的父视图控制器。应在 GADSearchBannerView 上设置适当的委托。
  • 必须通过 initWithAdSize:kGADAdSizeFluid 实例化 GADSearchBannerView 才能请求 AFSMA 广告。使用 initWithAdSize:kGADAdSizeBanner 实例化 GADSearchBannerView 会请求旧版 AFSMA 广告。
  • 需要将此对象的 adUnitID 属性设置为您的属性代码。

GADDynamicHeightSearchRequest

  • 此对象可封装广告请求参数。这类似于在 AFS 桌面和移动网站的 JavaScript 广告请求对象(网页选项、单元选项)中设置参数。

(void)adView:(GADBannerView *)bannerView willChangeAdSizeTo:(GADAdSize)size

  • 当广告请求返回时,系统会调用此回调函数。由于返回的广告单元可能包含许多带有不同附加信息的广告,因此在发出广告请求时广告单元的确切尺寸未知。广告返回后,您需要更新横幅广告视图,以适应广告单元的新尺寸。应在此处实现用于在父视图中调整 GADSearchBannerView 大小的代码。

实现示例

以下示例演示了如何使用 GBannerViewController 创建 GADSearchBannerView 作为 UIScrollView 的子视图。为了正确请求 AFSMA 广告,必须使用 initWithAdSize:kGADAdSizeFluid 实例化 GADSearchBannerView 对象。

// GBannerViewController.m implementation

@interface GBannerViewController () <GADAdSizeDelegate,
                                     GADBannerViewDelegate>

@property(nonatomic, strong) GADSearchBannerView *searchBannerView;

@property(nonatomic, strong) UIScrollView *scrollView;

@end

@implementation GBannerViewController

- (void)viewDidLoad {
  [super viewDidLoad];

  // Create the scroll view.
  ....
  ....

  // Create the banner.
  self.searchBannerView = [[GADSearchBannerView alloc] initWithAdSize:kGADAdSizeFluid];

  // Replace with your pub ID (e.g. ms-app-pub-9616389000213823).
  self.searchBannerView.adUnitID = @"ms-app-pub-################";

  // Set the initial location and size of the banner. The initial height
  // is set to 0 since we might not get an ad back.
  self.searchBannerView.frame = CGRectMake(0,
                                           0,
                                           CGRectGetWidth(self.view.bounds),
                                           0);
  self.searchBannerView.autoresizingMask = UIViewAutoresizingFlexibleWidth;

  // Set the delegate properties.
  self.searchBannerView.adSizeDelegate = self;
  self.searchBannerView.delegate = self;

  // Add the new search banner into the parent scrollView.
  [self.scrollView addSubview:self.searchBannerView];
  }

在同一 GBannerViewController 中,创建一个 GADDynamicHeightSearchRequest,用于指定将在 GADSearchView 中呈现的广告的参数。

// Create a search request and load the banner.
GADDynamicHeightSearchRequest *searchRequest = [[GADDynamicHeightSearchRequest alloc] init];

// Ad request options (set using GADDynamicHeightSearchRequest properties).
searchRequest.query = @"flowers";
searchRequest.numberOfAds = 2;

// Replace with the ID of a style from your custom search styles
[searchRequest setAdvancedOptionValue:@"0000000001"
                               forKey:@"styleId"];

可以通过在 GADDynamicHeightSearchRequest 对象上设置其他属性来使用其他自定义选项

如需发出广告请求,请使用 GADSearchBannerView 对象中的 GADDynamicHeightSearchRequest 对象调用 loadRequest

[self.searchBannerView loadRequest:searchRequest];

为了让父视图在广告返回后正确适应 GADSearchBannerView,必须实现以下回调。

// Callback to update the parent view height.
- (void)adView:(GADBannerView *)bannerView willChangeAdSizeTo:(GADAdSize)size {
  // Update the banner view based on the ad size.
  CGRect newFrame = self.searchBannerView.frame;
  newFrame.size.height = size.size.height;
  self.searchBannerView.frame = newFrame;

  // Perform any additional logic needed due to banner view size change.
  ...
}

高级选项

大多数广告请求参数都可以通过 GADDynamicHeightSearchRequest 对象(上述 searchRequest)中的属性来设置。其他参数需要使用键值对和 setAdvancedOptionValue 方法进行设置:

// Advanced customization options (set using key-value pair).

// Set a parameter (parameter_name) and its value (parameter_value).
[searchRequest setAdvancedOptionValue:@"parameter_value"
                               forKey:@"parameter_name"];

// Example: Show visible URL below description (domainLinkAboveDescription: false).
[searchRequest setAdvancedOptionValue:@"false"
                               forKey:@"domainLinkAboveDescription"];

请参阅可用参数的完整列表

调查错误

GADBannerViewDelegate 包含一个回调,可帮助您调查错误:

- (void)adView:(GADBannerView *)bannerView didFailToReceiveAdWithError:(GADRequestError *)error {

  // This callback is triggered when the ad request fails.
  // Add code here to debug the error object to discover causes of failure
  NSLog(@"Ad call failed due to %@", error.userInfo[@"NSUnderlyingError"]);
}

如果广告请求失败,您可以使用此回调来妥善处理错误,并通过错误对象调查错误。