Créer un adaptateur de signaux sécurisés

Important :Les signaux sécurisés sont en version bêta. Ce document est destiné à certains partenaires uniquement. Ne distribuez pas ce document sans l'autorisation de Google.

Les signaux sécurisés sont des données encodées qu'un appareil client collecte et partage avec certains enchérisseurs. Cette page vous explique comment collecter et envoyer des signaux sécurisés Google Ad Manager à l'aide du SDK IMA (Interactive Media Ads).

Avant de commencer

Avant de continuer, assurez-vous de disposer du SDK IMA pour iOS 3.18.5 ou version ultérieure.

Créer l'interface de l'adaptateur de signal sécurisé

Pour collecter et fournir des signaux sécurisés, créez des classes qui implémentent l'interface :

Objective-C

• MySecureSignalsAdapter.h :

#import <Foundation/Foundation.h>
#import <GoogleInteractiveMediaAds/GoogleInteractiveMediaAds.h>
/** An example implementation of Secure Signals adapter. */
@interface MySecureSignalsAdapter : NSObject <IMASecureSignalsAdapter>
@end

• MySecureSignalsAdapter.m:

@implementation MySecureSignalsAdapter

  /**
* Default constructor with no arguments for IMA SDK to instantiate this class.
*/
- (instancetype)init {
  self = [super init];

  return self;
}
@end

Swift

import Foundation
import GoogleInteractiveMediaAds

/** An example implementation of Secure Signals adapter. */
@objc(MySecureSignalsAdapter)
public class MySecureSignalsAdapter: IMASecureSignalsAdapter {
  /**
  * Default constructor with no arguments for IMA SDK to instantiate this class.
  */
  override init() {
    super.init()
  }
}

Initialiser l'adaptateur

Le SDK IMA initialise chaque adaptateur une seule fois en appelant la méthode d'initialisation de l'adaptateur. Implémentez cette méthode pour commencer les dépendances de chiffrement, configurer des caches ou précalculer les signaux qui restent les mêmes dans tous les appels de collecte de signaux.

L'exemple suivant initialise l'adaptateur :

Objective-C

...
@interface MySecureSignalsAdapter
@property(nonatomic) NSError *initError;
@end
...
/**
* Initialize your SDK and any dependencies.
* IMA SDK calls this function exactly once before signal collection.
*/
- (instancetype)init {
  self = [super init];
  @try {
    // Initialize your SDK and any dependencies.
    ...
  }
  @catch(NSException *exception) {
    // Build NSError to be passed by Signal Collector.
    _initError = ...;
  }
  return self;
}
...

Swift

...
@objc(MySecureSignalsAdapter)
public class MySecureSignalsAdapter: IMASecureSignalsAdapter {
...
  private var initError

  override init() {
    super.init()

    do {
      // Initialize your SDK and any dependencies.
      ...
    } catch {
      // Build NSError to be passed by Signal Collector.
      self.initError = ...;
    }
  }
}

Collecte des signaux

Avant le lancement d'une demande d'annonce, le SDK IMA appelle une méthode de collecte des signaux de manière asynchrone. Ces méthodes de collecte de signaux contiennent une fonction de rappel pour transmettre les signaux chiffrés ou signaler une erreur.

Remarque :Vous devez collecter les signaux dans un délai de 500 millisecondes, le chiffrement et de transmettre le signal chiffré à la fonction de rappel. Au bout de 500 millisecondes, le SDK IMA supprime toute collecte de signaux.

Les exemples suivants collectent les signaux sécurisés via la fonction de rappel :

Objective-C

...
/**
* Invokes your SDK to collect, encrypt and pass the signal collection results to IMA SDK.
* IMA SDK calls this function before each ad request.
*
* @param completion A callback function to pass signal collection results to IMA SDK.
*/
- (void)collectSignalsWithCompletion:(IMASignalCompletionHandler)completion {
  // Output any initialization errors
  if (self.initError) {
    completion(nil, self.initError);
    return;
  }
  @try {
    // Collect and encrypt the signals.
    NSString *signals = ...
    // Pass the encrypted signals to IMA SDK.
    completion(signals, nil);
  }
  @catch(NSException *exception) {
    NSError *collectSignalError = ...;
    // Pass signal collection failures to IMA SDK.
    completion(nil, collectSignalError);
  }
}
...

Swift

...
  /**
  * Invokes your SDK to collect, encrypt and pass the signal collection results to IMA SDK.
  * IMA SDK calls this function before each ad request.
  *
  * @param completion A callback function to pass signal collection results to IMA SDK.
  */
  public func collectSignals(completion: @escaping IMASignalCompletionHandler) {
    if (self.initError) {
      completion(nil, self.initError)
      return
    }

    do {
      // Collect and encrypt the signals.
      var signals = ...
      // Pass the encrypted signals to IMA SDK.
      completion(signals, nil)
    } catch {
      NSError collectSignalError = ...
      // Pass signal collection failures to IMA SDK.
      completion(nil, collectSignalError)
    }
  }
...

Signaler les erreurs

Pour communiquer avec les utilisateurs de votre classe d'adaptateur, signalez toutes les erreurs pendant la collecte des signaux et les transmettre au rappel du collecteur de signaux. Ce processus permet de résoudre les problèmes qui surviennent lors de l'intégration de votre adaptateur aux applications.

Les erreurs susceptibles de s'afficher sont les suivantes:

• Votre SDK ou une dépendance ne sont pas trouvés dans l'application.
• Votre SDK ou une dépendance ne dispose pas de l'autorisation ou du consentement de l'utilisateur requis pour fonctionner.

Spécifier la version de l'adaptateur

Dans votre workflow, veillez à spécifier la version de l'adaptateur. Le SDK IMA inclut la version de votre adaptateur dans chaque demande d'annonce et les transmet avec les signaux sécurisés dans une demande d'enchère.

Dans la requête d'enchère, en fonction de la version de l'adaptateur, vous pouvez identifier les détails de chiffrement, d'encodage et de mise en forme que l'adaptateur utilise pour créer les signaux sécurisés.

L'exemple suivant spécifie la version de l'adaptateur :

Objective-C

...
/**
* Specifies this adapter's version.
*/
static NSInteger const VersionMajor = 1;
static NSInteger const VersionMinor = 0;
static NSInteger const VersionPatch = 1;
...
/**
* @return The version of this adapter.
*         IMA SDK calls this function before each ad request.
*/
+ (IMAVersion *)adapterVersion {
  // The version of the SecureSignals Adapter.
  IMAVersion *adapterVersion = [[IMAVersion alloc] init];
  adapterVersion.majorVersion = VersionMajor;
  adapterVersion.minorVersion = VersionMinor;
  adapterVersion.patchVersion = VersionPatch;
  return adapterVersion;
}
...

Swift

...
  /**
  * Specifies this adapter's version.
  */
  static let VersionMajor = 1;
  static let VersionMinor = 0;
  static let VersionPatch = 1;
...
  /**
  * @return The version of this adapter.
  *         IMA SDK calls this function before each ad request.
  */
  public static func adapterVersion() -> IMAVersion {
    let adapterVersion = IMAVersion()
    adapterVersion.majorVersion = self.VersionMajor
    adapterVersion.minorVersion = self.VersionMinor
    adapterVersion.patchVersion = self.VersionPatch
    return adapterVersion
  }
...

Renvoyer la version du SDK Runtime

Vous pouvez concevoir votre adaptateur pour qu'il fonctionne avec plusieurs versions de votre SDK. Pour que l'adaptateur fonctionne avec plusieurs versions, assurez-vous de renvoyer la version d'exécution du SDK. Dans chaque demande d'annonce, le SDK IMA inclut la version d'exécution avec le paramètre de l'adaptateur.

Les exemples suivants demandent et renvoient la version d'exécution du SDK:

Objective-C

...
/**
* @return The version of your SDK that this adapter is depending on.
*         IMA SDK calls this function before each ad request.
*/
+ (IMAVersion *)adSDKVersion {
  // Request the version from your SDK and convert to an IMAVersion.
  int mySDKVersion[3] = ...

  IMAVersion *adSDKVersion = [[IMAVersion alloc] init];
  adSDKVersion.majorVersion = mySDKVersion[0];
  adSDKVersion.minorVersion = mySDKVersion[1];
  adSDKVersion.patchVersion = mySDKVersion[2];

  return adSDKVersion;
}
...

Swift

...
  /**
  * @return The version of your SDK that this adapter is depending on.
  *         IMA SDK calls this function before each ad request.
  */
public static func adSDKVersion() -> IMAVersion {
    // Request the version from your SDK and convert to an IMAVersion.
    let mySDKVersion = ...

    let adSDKVersion = IMAVersion()
    adSDKVersion.majorVersion = mySDKVersion[0]
    adSDKVersion.minorVersion = mySDKVersion[1]
    adSDKVersion.patchVersion = mySDKVersion[2]
    return adSDKVersion
  }
...

Enregistrer l'adaptateur auprès de Google

Pour que Google autorise l'adaptateur à collecter des signaux, vous devez enregistrer le nom de la classe iOS auprès de Google. Le SDK IMA n'initialise que les adaptateurs que vous enregistrez auprès de Google.

Valider l'adaptateur

Pour valider l'adaptateur, suivez les sections suivantes :

Configurer l'application de test

Avant de valider l'adaptateur, configurez l'application de test. Suivez les procédez comme suit:

1. Ajoutez le SDK IMA à votre fichier de pod :

   source 'https://github.com/CocoaPods/Specs.git'
   platform :ios, '10'
   target "BasicExample" do
     pod 'GoogleAds-IMA-iOS-SDK', '~> 3.17.0'
   end
   

2. Installez le SDK IMA à l'aide de CocoaPods. Pour savoir comment installer le SDK IMA via CocoaPods, Commencer

3. Dans votre projet Xcode, ajoutez votre adaptateur, votre SDK et toutes les dépendances de compilation restantes que vous avez ajoutées.

Vérifier les signaux

Pour vérifier la longueur du signal sécurisé, la valeur chiffrée, la version de votre adaptateur et la version de votre SDK, contactez l'assistance pour partager le journal de trafic capturé.

Consulter les exemples complets

Cette section présente l'exemple final de toutes les étapes et est disponible à titre de référence.

Objective-C

• MySecureSignalsAdapter.h :

#import <Foundation/Foundation.h>
#import <GoogleInteractiveMediaAds/GoogleInteractiveMediaAds.h>

/** An example implementation of Secure Signals adapter. */
@interface MySecureSignalsAdapter : NSObject <IMASecureSignalsAdapter>
@end

• MySecureSignalsAdapter.m:

#import "path/to/MyExampleSecureSignalsAdapter.h"

@interface MySecureSignalsAdapter
@property(nonatomic) NSError *initError;
@end

static NSInteger const VersionMajor = 1;
static NSInteger const VersionMinor = 0;
static NSInteger const VersionPatch = 1;

@implementation MySecureSignalsAdapter
/**
* Initialize your SDK and any dependencies.
* IMA SDK calls this function exactly once before signal collection.
*/
- (instancetype)init {
  self = [super init];
  @try {
    // Initialize your SDK and any dependencies.
    ...
  }
  @catch(NSException *exception) {
    // Build NSError to be passed by Signal Collector.
    _initError = ...;
  }
  return self;
}
/**
* Invokes your SDK to collect, encrypt and pass the signal collection results to IMA SDK.
* IMA SDK calls this function before each ad request.
*
* @param completion A callback function to pass signal collection results to IMA SDK.
*/
- (void)collectSignalsWithCompletion:(IMASignalCompletionHandler)completion {
  if (self.initError) {
    completion(nil, self.initError);
    return;
  }
  @try {
    // Collect and encrypt the signals.
    NSString *signals = ...
    // Pass the encrypted signals to IMA SDK.
    completion(signals, nil);
  }
  @catch(NSException *exception) {
    NSError *collectSignalError = ...;
    // Pass signal collection failures to IMA SDK.
    completion(nil, collectSignalError);
  }
}
/**
* @return The version of this adapter.
*         IMA SDK calls this function before each ad request.
*/
+ (IMAVersion *)adapterVersion {
  // The version of the SecureSignals Adapter.
  IMAVersion *adapterVersion = [[IMAVersion alloc] init];
  adapterVersion.majorVersion = VersionMajor;
  adapterVersion.minorVersion = VersionMinor;
  adapterVersion.patchVersion = VersionPatch;
  return adapterVersion;
}

/**
  * @return The version of your SDK that this adapter depends on.
  *         IMA SDK calls this function before each ad request.
  */
+ (IMAVersion *)adSDKVersion {
  // Request the version from your SDK and convert to an IMAVersion.
  int mySDKVersion[3] = ...

  IMAVersion *adSDKVersion = [[IMAVersion alloc] init];
  adSDKVersion.majorVersion = mySDKVersion[0];
  adSDKVersion.minorVersion = mySDKVersion[1];
  adSDKVersion.patchVersion = mySDKVersion[2];

  return adSDKVersion;
}

@end

Swift

@objc(MySecureSignalsAdapter)
public class MySecureSignalsAdapter: IMASecureSignalsAdapter {
  static let VersionMajor = 1;
  static let VersionMinor = 0;
  static let VersionPatch = 1;

  private var initError

  override init() {
    super.init()

    do {
      // Initialize your SDK and any dependencies.
      ...
    } catch {
      // Build NSError to be passed by Signal Collector.
      self.initError = ...;
    }
  }

  public func collectSignals(completion: @escaping IMASignalCompletionHandler) {
    if (self.initError) {
      completion(nil, self.initError)
      return
    }

    do {
      // Collect and encrypt the signals.
      var signals = ...
      // Pass the encrypted signals to IMA SDK.
      completion(signals, nil)
    } catch {
      NSError collectSignalError = ...
      // Pass signal collection failures to IMA SDK.
      completion(nil, collectSignalError)
    }      
  }

  public static func adapterVersion() -> IMAVersion {
    let adapterVersion = IMAVersion()
    adapterVersion.majorVersion = self.VersionMajor
    adapterVersion.minorVersion = self.VersionMinor
    adapterVersion.patchVersion = self.VersionPatch
    return adapterVersion
  }

  public static func adSDKVersion() -> IMAVersion {
    // Request the version from your SDK and convert to an IMAVersion.
    let mySDKVersion = ...

    let adSDKVersion = IMAVersion()
    adSDKVersion.majorVersion = mySDKVersion[0]
    adSDKVersion.minorVersion = mySDKVersion[1]
    adSDKVersion.patchVersion = mySDKVersion[2]
    return adSDKVersion
  }
}