カスタムのネイティブ広告フォーマット

カスタム ネイティブ広告フォーマット

アド マネージャーでは、システム定義のネイティブ広告フォーマットに加え、アセットのカスタムリストを定義することで、独自のネイティブ広告フォーマットも作成できます。こうしたフォーマットはカスタム ネイティブ広告フォーマットと呼ばれ、予約済みの広告と一緒に使用できます。このフォーマットでは、任意の構造化データをアプリに渡すことが可能です。こうした広告は、NativeCustomFormatAd オブジェクトで表されます。

カスタム ネイティブ広告フォーマットを読み込む

このガイドでは、カスタム ネイティブ広告フォーマットの読み込みと表示方法について説明します。

AdLoader の作成

ネイティブ広告と同様に、カスタム ネイティブ広告フォーマットは AdLoader クラスを使って読み込みます。

Java

AdLoader adLoader = new AdLoader.Builder(context, "/21775744923/example/native")
    .forCustomFormatAd("10063170",
      new NativeCustomFormatAd.OnCustomFormatAdLoadedListener() {
          @Override
          public void onCustomFormatAdLoaded(NativeCustomFormatAd ad) {
              // Show the custom format and record an impression.
          }
      },
      new NativeCustomFormatAd.OnCustomClickListener() {
          @Override
          public void onCustomClick(NativeCustomFormatAd ad, String s) {
              // Handle the click action
          }
      })
    .withAdListener( ... )
    .withNativeAdOptions( ... )
    .build();

Kotlin

val adLoader = AdLoader.Builder(this, "/21775744923/example/native")
        .forCustomFormatAd("10063170",
            { ad ->
                // Show the custom format and record an impression.
            },
            { ad, s ->
            // Handle the click action
            })
        .withAdListener( ... )
        .withNativeAdOptions( ... )
        .build()

forCustomFormatAd メソッドで AdLoader を設定してカスタム ネイティブ広告フォーマットをリクエストします。このメソッドには、次の 3 つのパラメータが渡されます。

  • AdLoader でリクエストすべきカスタム ネイティブ広告フォーマットの ID。各カスタム ネイティブ広告フォーマットには ID が関連付けられています。このパラメータは、アプリが AdLoader にリクエストさせるフォーマットを指定する役割を持ちます。
  • 広告が正常に読み込まれたときに呼び出す OnCustomFormatAdLoadedListener。
  • 広告がタップまたはクリックされたときに呼び出す OnCustomClickListener（省略可）。リスナーの詳細については、以下の「クリックとインプレッションの処理」のセクションをご覧ください。

1 つの広告ユニットで複数のクリエイティブ フォーマットを配信するよう設定できるため、固有のフォーマット ID を使って forCustomFormatAd を複数回呼び出して、複数のカスタム ネイティブ広告フォーマットに対応できる AdLoader を作成することもできます。

カスタム ネイティブ広告フォーマット ID

カスタム ネイティブ広告フォーマットを識別するために使用されるフォーマット ID は、アド マネージャー管理画面の [配信] プルダウンの [ネイティブ] で確認できます。

各カスタム ネイティブ広告フォーマットの ID は、それぞれの名前の横に表示されます。名前をクリックすると詳細画面が開き、フォーマットのフィールドに関する情報が表示されます。

ここでは、個々のフィールドを追加、編集、削除できます。各アセットの名前をメモします。名前は、カスタムのネイティブ広告フォーマットを表示する際、各アセットのデータを取得するために使用されます。

カスタム ネイティブ広告フォーマットを表示する

カスタムのネイティブ広告フォーマットは、広告を構成するアセットの独自のリストをパブリッシャー様が定義できるという点で、システム定義のネイティブ広告フォーマットと異なります。そのため、カスタムのネイティブ広告フォーマットを表示するプロセスは、システム定義のフォーマットの場合と次の点で異なります。

  1. NativeCustomFormatAd クラスは、お客様がアド マネージャーで定義したカスタム ネイティブ広告フォーマットを処理するもので、アセットを取得するために名前付きの「ゲッター」ではなく、代わりに、フィールドの名前を引数として使用する getText や getImage などのメソッドが用意されています。
  2. NativeAdView で使用する NativeCustomFormatAd のような専用の広告ビュークラスはありません。ユーザー エクスペリエンスに適したレイアウトを自由に使用できます。
  3. 専用の ViewGroup クラスがないため、広告のアセット表示に使うビューを登録する必要はありません。そのため、広告表示のコードは数行減りますが、後でクリックを処理する際に追加作業が必要になります。

NativeCustomFormatAd を表示する関数の例を次に示します。

Java

public void displayCustomFormatAd (ViewGroup parent,
                                     NativeCustomFormatAd customFormatAd) {
    // Inflate a layout and add it to the parent ViewGroup.
    LayoutInflater inflater = (LayoutInflater) parent.getContext()
            .getSystemService(Context.LAYOUT_INFLATER_SERVICE);
    View adView = inflater.inflate(R.layout.custom_format_ad, parent);

    // Locate the TextView that will hold the value for "Headline" and
    // set its text.
    TextView myHeadlineView = (TextView) adView.findViewById(R.id.headline);
    myHeadlineView.setText(customFormatAd.getText("Headline"));

    // Locate the ImageView that will hold the value for "MainImage" and
    // set its drawable.
    Button myMainImageView = (ImageView) adView.findViewById(R.id.main_image);
    myMainImageView.setImageDrawable(
            customFormatAd.getImage("MainImage").getDrawable());

    ...
    // Continue locating views and displaying assets until finished.
    ...
}

Kotlin

public fun displayCustomFormatAd (parent: ViewGroup,
                                customFormatAd: NativeCustomFormatAd) {
    val adView = layoutInflater
            .inflate(R.layout.ad_simple_custom_format, null)

    val myHeadlineView = adView.findViewById<TextView>(R.id.headline)
    myHeadlineView.setText(customFormatAd.getText("Headline"));

    // Locate the ImageView that will hold the value for "MainImage" and
    // set its drawable.
    val myMainImageView = adView.findViewById(R.id.main_image);
    myMainImageView.setImageDrawable(
            customFormatAd.getImage("MainImage").drawable);

    ...
    // Continue locating views and displaying assets until finished.
    ...
}

AdChoices アイコンをレンダリングする

デジタル サービス法（DSA）への準拠の一環として、欧州経済領域（EEA）で配信される純広告には、AdChoices アイコンと Google の [この広告について] ページへのリンクが必要です。カスタムのネイティブ広告を実装する場合は、AdChoices アイコンを表示する必要があります。メインの広告アセットを表示する際は、表示の手順に沿って、AdChoices アイコンのクリック リスナーを設定することをおすすめします。

次の例では、AdChoices ロゴを保持する <ImageView /> 要素をビュー階層で定義していることを前提としています。

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android">
    <ImageView
        android:id="@+id/adChoices"
        android:layout_width="15dp"
        android:layout_height="15dp"
        android:adjustViewBounds="true"
        android:contentDescription="AdChoices icon." />
</LinearLayout>

次の例では、AdChoices アイコンをレンダリングし、適切なクリック動作を構成します。

Java

private AdSimpleCustomTemplateBinding customTemplateBinding;

private void populateAdView(final NativeCustomFormatAd nativeCustomFormatAd) {
  // Render the AdChoices icon.
  String adChoicesKey = NativeAdAssetNames.ASSET_ADCHOICES_CONTAINER_VIEW;
  NativeAd.Image adChoicesAsset = nativeCustomFormatAd.getImage(adChoicesKey);
  if (adChoicesAsset == null) {
    customTemplateBinding.adChoices.setVisibility(View.GONE);
  } else {
    customTemplateBinding.adChoices.setVisibility(View.VISIBLE);
    customTemplateBinding.adChoices.setImageDrawable(adChoicesAsset.getDrawable());

    // Enable clicks on AdChoices.
    customTemplateBinding.adChoices.setOnClickListener(
        new View.OnClickListener() {
          @Override
          public void onClick(View v) {
            nativeCustomFormatAd.performClick(adChoicesKey);
          }
        });
  }
  ...
}

Kotlin

private lateinit var customTemplateBinding: AdSimpleCustomTemplateBinding

private fun populateAdView(nativeCustomFormatAd: NativeCustomFormatAd) {
  // Render the AdChoices icon.
  val adChoicesKey = NativeAdAssetNames.ASSET_ADCHOICES_CONTAINER_VIEW
  val adChoicesAsset = nativeCustomFormatAd.getImage(adChoicesKey)
  if (adChoicesAsset == null) {
    customTemplateBinding.adChoices.visibility = View.GONE
  } else {
    customTemplateBinding.adChoices.setImageDrawable(adChoicesAsset.drawable)
    customTemplateBinding.adChoices.visibility = View.VISIBLE

    // Enable clicks on AdChoices.
    customTemplateBinding.adChoices.setOnClickListener {
      nativeCustomFormatAd.performClick(adChoicesKey)
    }
  }
  ...
}

カスタムのネイティブ広告フォーマットのネイティブ動画

カスタムのフォーマットを作成する際は、そのフォーマットを動画対応にすることもできます。

アプリに実装する際は、NativeCustomFormatAd.getMediaContent() を使ってメディア コンテンツを取得して、次に、setMediaContent() を呼び出して、メディアビューにメディア コンテンツを設定します。広告に動画コンテンツがない場合は、動画なしで広告を表示する代替プランを用意します。

次の例では、広告に動画コンテンツがあるかどうかを確認し、動画がない場合はその表示対象位置に画像を表示しています。

Java

// Called when a custom native ad loads.
@Override
public void onCustomFormatAdLoaded(final NativeCustomFormatAd ad) {

  MediaContent mediaContent = ad.getMediaContent();

  // Assumes you have a FrameLayout in your view hierarchy with the id media_placeholder.
  FrameLayout mediaPlaceholder = (FrameLayout) findViewById(R.id.media_placeholder);

  // Apps can check the MediaContent's hasVideoContent property to determine if the
  // NativeCustomFormatAd has a video asset.
  if (mediaContent != null && mediaContent.hasVideoContent()) {
    MediaView mediaView = new MediaView(mediaPlaceholder.getContext());
    mediaView.setMediaContent(mediaContent);
    mediaPlaceholder.addView(mediaView);

    // Create a new VideoLifecycleCallbacks object and pass it to the VideoController. The
    // VideoController will call methods on this object when events occur in the video
    // lifecycle.
    VideoController vc = mediaContent.getVideoController();
    vc.setVideoLifecycleCallbacks(
        new VideoController.VideoLifecycleCallbacks() {
          @Override
          public void onVideoEnd() {
            // Publishers should allow native ads to complete video playback before
            // refreshing or replacing them with another ad in the same UI location.
            super.onVideoEnd();
          }
        });
  } else {
    ImageView mainImage = new ImageView(this);
    mainImage.setAdjustViewBounds(true);
    mainImage.setImageDrawable(ad.getImage("MainImage").getDrawable());
    mediaPlaceholder.addView(mainImage);
    mainImage.setOnClickListener(
        new View.OnClickListener() {
          @Override
          public void onClick(View view) {
            ad.performClick("MainImage");
          }
        });
  }
}

Kotlin

// Called when a custom native ad loads.
NativeCustomFormatAd.OnCustomFormatAdLoadedListener { ad ->

  val mediaContent = ad.mediaContent

  // Apps can check the MediaContent's hasVideoContent property to determine if the
  // NativeCustomFormatAd has a video asset.
  if (mediaContent != null && mediaContent.hasVideoContent()) {
    val mediaView = MediaView(mediaPlaceholder.getContest())
    mediaView.mediaContent = mediaContent

    val videoController = mediaContent.videoController

    // Create a new VideoLifecycleCallbacks object and pass it to the VideoController. The
    // VideoController will call methods on this object when events occur in the video
    // lifecycle.
    if (videoController != null) {
      videoController.videoLifecycleCallbacks =
        object : VideoController.VideoLifecycleCallbacks() {
          override fun onVideoEnd() {
            // Publishers should allow native ads to complete video playback before refreshing
            // or replacing them with another ad in the same UI location.
            super.onVideoEnd()
          }
        }
    }
  } else {
    val mainImage = ImageView(this)
    mainImage.adjustViewBounds = true
    mainImage.setImageDrawable(ad.getImage("MainImage")?.drawable)

    mainImage.setOnClickListener { ad.performClick("MainImage") }
    customTemplateBinding.simplecustomMediaPlaceholder.addView(mainImage)
  }
}

カスタム ネイティブ広告で動画をカスタマイズする方法の詳細については、MediaContent をご覧ください。

実際に動作するネイティブ動画の例については、アド マネージャーのカスタム レンダリング サンプルをダウンロードしてください。

カスタム ネイティブ広告フォーマットのクリックとインプレッション

カスタム ネイティブ広告フォーマットでは、Google Mobile Ads SDK へのクリック イベントの報告とインプレッションの記録をお客様のアプリで行う必要があります。

インプレッションを記録する

カスタム フォーマット広告のインプレッションを記録するには、対応する NativeCustomFormatAd で recordImpression メソッドを呼び出します。

myCustomFormatAd.recordImpression();

アプリで誤って同じ広告に対してこのメソッドを 2 回呼び出すと、1 回のリクエストに対してインプレッションが繰り返し記録されないように SDK で自動的に処理されます。

クリックを報告する

アセットビューでクリックが発生したことを SDK に報告するには、対応する NativeCustomFormatAd で performClick メソッドを呼び出し、クリックされたアセットの名前を渡します。たとえば、「MainImage」というカスタム フォーマットにアセットが存在し、そのアセットに対応する ImageView で発生したクリックをレポートする場合、コードは次のようになります。

myCustomFormatAd.performClick("MainImage");

なお、広告に関連付けられているすべてのビューで、このメソッドを呼び出す必要はありません。「Caption」という別のフィールドは表示されるもののクリックまたはタップされることがない場合は、そのアセットのビューで performClick を呼び出す必要はありません。

カスタム クリック アクションに対応する

カスタム フォーマット広告がクリックされると、SDK は 3 つの応答を次の順序で試行します。

  1. OnCustomClickListener がある場合は、AdLoader から呼び出す。
  2. 広告の各ディープリンクの URL でコンテンツ リゾルバの特定を試み、最初に特定したリゾルバを開始する。
  3. ブラウザを開き、広告の従来のリンク先 URL に移動する。

forCustomFormatAd メソッドは OnCustomClickListener を受け取ります。このメソッドにリスナー オブジェクトを渡すと、SDK は代わりにそのオブジェクトの onCustomClick メソッドを呼び出し、他のアクションは行いません。ただし、リスナーとして null 値を渡すと、SDK は広告に登録されているディープリンクおよびリンク先 URL にフォールバックします。

カスタム クリック リスナーを使うと、クリックへのレスポンスとして最適なアクション（UI の更新、新しいアクティビティの開始、クリックの記録のみ）をアプリで決定できます。発生したクリックの記録のみを行う例を次に示します。

Java

AdLoader adLoader = new AdLoader.Builder(context, "/21775744923/example/native")
    .forCustomFormatAd("10063170",
      new NativeCustomFormatAd.OnCustomFormatAdLoadedListener() {
        // Display the ad.
      },
      new NativeCustomFormatAd.OnCustomClickListener() {
          @Override
          public void onCustomClick(NativeCustomFormatAd ad, String assetName) {
            Log.i("MyApp", "A custom click just happened for " + assetName + "!");
          }
      }).build();

Kotlin

val adLoader = AdLoader.Builder(this, "/21775744923/example/native")
    .forCustomFormatAd("10063170",
        { ad ->
            // Display the ad.
        },
        { ad, assetName ->
                Log.i("MyApp", "A custom click just happened for $assetName!")
    }).build()

最初は、カスタム クリック リスナーがあることに違和感があるかもしれません。クリックの発生をアプリから SDK に伝えたばかりなのに、なぜ SDK からアプリにレポートを返す必要があるのか、疑問に思われるでしょう。

この情報フローはいくつかの理由で有益ですが、最大の理由は、このフローによって SDK がクリックに対するレスポンスを制御し続けられる点です。たとえば、クリエイティブに設定されている第三者のトラッキング URL を自動的に送信したり、コードを追加せずにバックグラウンドで他のタスクを処理したりできます。