शुरू करें

ज़रूरी शर्तें

  • Xcode 13 या इसके बाद का वर्शन

इस गाइड में, PAL SDK को चालू करने का तरीका बताया गया है, ताकि आपको नॉनस मिल सके और वीडियो चलाने से जुड़े इवेंट को मॉनिटर किया जा सके. पूरी गाइड को समझने के लिए, PAL tvOS का सैंपल ऐप्लिकेशन डाउनलोड करें.

अपने प्रोजेक्ट में PAL SDK जोड़ना

Swift Package Manager का इस्तेमाल करके PAL SDK इंस्टॉल करना

प्रोग्रामैटिक ऐक्सेस लाइब्रेरी एसडीके टूल, Swift Package Manager के साथ काम करता है. इसके लिए, एसडीके टूल का 2.5.3 या उसके बाद का वर्शन होना ज़रूरी है. Swift पैकेज इंपोर्ट करने के लिए, यहां दिया गया तरीका अपनाएं.

  1. Xcode में, IMA SDK Swift Package इंस्टॉल करें. इसके लिए, File > Add Packages... पर जाएं.

  2. दिखने वाले प्रॉम्प्ट में, IMA SDK Swift Package GitHub रिपॉज़िटरी खोजें:

    https://github.com/googleads/swift-package-manager-google-programmatic-access-library-tvos

  3. PAL SDK Swift पैकेज का वह वर्शन चुनें जिसका आपको इस्तेमाल करना है. हमारा सुझाव है कि नए प्रोजेक्ट के लिए, अगले मुख्य वर्शन तक का इस्तेमाल करें.

इसके बाद, Xcode आपके पैकेज की डिपेंडेंसी से जुड़ी समस्या को हल कर देगा और उन्हें बैकग्राउंड में डाउनलोड करेगा. पैकेज डिपेंडेंसी जोड़ने के बारे में ज़्यादा जानने के लिए, Apple का लेख पढ़ें.

PAL SDK को मैन्युअल तरीके से डाउनलोड और इंस्टॉल करना

अगर आपको Swift Package Manager का इस्तेमाल नहीं करना है, तो PAL SDK डाउनलोड करें और उसे अपने प्रोजेक्ट में मैन्युअल तरीके से जोड़ें.

  1. tvOS के लिए PAL SDK डाउनलोड और एक्सट्रैक्ट करें
  2. अपने प्रोजेक्ट में फ़्रेमवर्क को शामिल करने के लिए, Apple Developer Guide में दिए गए निर्देशों का पालन करें.

नॉनस जनरेट करना

"नॉन्स", एन्क्रिप्ट (सुरक्षित) की गई एक स्ट्रिंग होती है. इसे PAL, PALNonceLoader का इस्तेमाल करके जनरेट करता है. PAL SDK को हर नए स्ट्रीम अनुरोध के साथ, नया जनरेट किया गया नॉनस भेजना होता है. हालांकि, एक ही स्ट्रीम में कई विज्ञापन अनुरोधों के लिए, नॉनस का फिर से इस्तेमाल किया जा सकता है.

नीचे दिए गए सभी कोड स्निपेट, PAL tvOS के सैंपल ऐप्लिकेशन में ViewController.m में किए गए बदलाव हैं.

नॉनस का अनुरोध करने के लिए, PAL लाइब्रेरी इंपोर्ट करें:

@import ProgrammaticAccessLibrary;

इसके बाद, PALNonceLoader का एक इंस्टेंस बनाएं और दो डेलिगेट तरीकों के लिए स्टब जोड़ें:

@interface ViewController () <PALNonceLoaderDelegate>
// The nonce loader to use for nonce requests.
@property(nonatomic) PALNonceLoader *nonceLoader;
// The view in which a video would play.
// In this sample, it is mocked for simplification.
@property(nonatomic, weak) IBOutlet UIView *videoView;
@end
...
- (void) viewDidLoad {
  [super viewDidLoad];
  // The default value for 'directedForChildOrUnknownAge' is
  // 'NO'. Update the value after the appropriate consent has been gathered.
  // By default, PAL automatically determines whether to enable limited ads
  // based on the user's TCF (Transparency and Consent Framework) consent data
  // on the device. If you must manually override the default behavior,
  // for example, to meet your app's requirements, use the
  // `PALSettings.forceLimitedAds` property.
  PALSettings *settings = [[PALSettings alloc] init];
  settings.directedForChildOrUnknownAge = NO;

  self.nonceLoader = [[PALNonceLoader alloc] initWithSettings:settings];
  self.nonceLoader.delegate = self;
}

#pragma mark - PALNonceLoaderDelegate methods

- (void)nonceLoader:(PALNonceLoader *)nonceLoader
            withRequest:(PALNonceRequest *)request
    didLoadNonceManager:(PALNonceManager *)nonceManager {
}

- (void)nonceLoader:(PALNonceLoader *)nonceLoader
         withRequest:(PALNonceRequest *)request
    didFailWithError:(NSError *)error {
}

इसके बाद, नॉन्स का अनुरोध करें, उसकी प्रॉपर्टी भरें, और उसका इस्तेमाल नॉन्स मैनेजर को शुरू करने के लिए करें:

@interface ViewController () <PALNonceLoaderDelegate>
// The nonce loader to use for nonce requests.
@property(nonatomic) PALNonceLoader *nonceLoader;
// The nonce manager result from the last successful nonce request.
@property(nonatomic) PALNonceManager *nonceManager;
// The view in which a video would play. In this sample, it is mocked for
// simplification.
@property(nonatomic, weak) IBOutlet UIView *videoView;
@end

...

- (void)viewDidLoad {
  ...
  self.nonceLoader.delegate = self;
  [self requestNonceManager];
}

...

#pragma mark - UI Callback methods

/**
 * Requests a new nonce manager with a request containing arbitrary test values
 * like a (sane) user might supply. Displays the nonce or error on success. This
 * should be called once per stream.
 *
 * The PALNonceRequest parameters set here are example parameters.
 * You should set your parameters based on your own app characteristics.
 */
- (void)requestNonceManager {
  PALNonceRequest *request = [[PALNonceRequest alloc] init];
  request.continuousPlayback = PALFlagOff;
  request.descriptionURL = [NSURL URLWithString:@"https://example.com/desc?key=val"];
  request.iconsSupported = YES;
  request.playerType = @"AwesomePlayer";
  request.playerVersion = @"4.2.1";
  request.PPID = @"123987456";
  request.sessionID = @"Sample SID";
  // Sample API framework integers. See reference docs for more details.
  request.supportedAPIFrameworks = [NSMutableSet setWithArray:@[ @2, @7, @9 ]];
  request.videoPlayerHeight = 480;
  request.videoPlayerWidth = 640;
  request.willAdAutoPlay = PALFlagOn;
  request.willAdPlayMuted = PALFlagOff;

  if (self.nonceManager) {
    // Detach the old nonce manager's gesture recognizer before destroying it.
    [self.videoView removeGestureRecognizer:self.nonceManager.gestureRecognizer];
    self.nonceManager = nil;
  }
  [self.nonceLoader loadNonceManagerWithRequest:request];
}

आखिर में, जनरेट किए गए नॉनस को लॉग करने के लिए, नॉनस लोडर डेलिगेट भरें:

#pragma mark - PALNonceLoaderDelegate methods

- (void)nonceLoader:(PALNonceLoader *)nonceLoader
            withRequest:(PALNonceRequest *)request
    didLoadNonceManager:(PALNonceManager *)nonceManager {
  NSLog(@"Programmatic access nonce: %@", nonceManager.nonce);
  // Capture the created nonce manager and attach its gesture recognizer to the video view.
  self.nonceManager = nonceManager;
  [self.videoView addGestureRecognizer:self.nonceManager.gestureRecognizer];
}

- (void)nonceLoader:(PALNonceLoader *)nonceLoader
         withRequest:(PALNonceRequest *)request
    didFailWithError:(NSError *)error {
  NSLog(@"Error generating programmatic access nonce: %@", error);
}

डायरेक्ट VAST कॉल (डीवीसी) करते समय, अपने नॉन्स को givn पैरामीटर की वैल्यू के तौर पर सेट करें. नॉन्स, यूआरएल के लिए सुरक्षित है. आपको इसे यूआरएल के लिए कोड में बदलने की ज़रूरत नहीं है.

आखिर में, आपको एसडीके को कॉन्टेंट चलाने के सेशन की जानकारी और क्लिक भेजने के तरीके जोड़ने होंगे. sendPlaybackStart, sendPlaybackEnd, और sendAdClick तरीकों को लागू करने का यहां दिया गया उदाहरण देखें:

...

// Reports the start of playback for the current content session.
- (void)sendPlaybackStart {
  [self.nonceManager sendPlaybackStart];
}

// Reports the end of playback for the current content session.
- (void)sendPlaybackEnd {
  [self.nonceManager sendPlaybackEnd];
}

// Reports an ad click for the current nonce manager, if not nil.
- (void)sendAdClick {
  [self.nonceManager sendAdClick];
}

आपके इंटिग्रेशन में, sendPlaybackStart को "वीडियो प्लेयर शुरू करें" पर कॉल किया जाना चाहिए, क्योंकि पहली बार वीडियो चलाने पर ऐसा होता है. यह उपयोगकर्ता की ओर से शुरू की गई कार्रवाई (क्लिक-टू-प्ले) या ऐप्लिकेशन की ओर से शुरू की गई कार्रवाई (अपने-आप चलने की सुविधा) के जवाब में होता है. sendPlaybackEnd को तब कॉल किया जाना चाहिए, जब वीडियो चलना बंद हो जाए. साथ ही, sendAdClick को तब कॉल किया जाना चाहिए, जब दर्शक किसी विज्ञापन पर क्लिक करे.

(वैकल्पिक) तीसरे पक्ष के विज्ञापन सर्वर के ज़रिए, Google Ad Manager के सिग्नल भेजना

Ad Manager के लिए, तीसरे पक्ष के विज्ञापन सर्वर के अनुरोध को कॉन्फ़िगर करें. यहां दिया गया तरीका पूरा करने के बाद, नॉन्स पैरामीटर PAL SDK से आपके इंटरमीडियरी सर्वर और फिर Google Ad Manager तक पहुंचता है. इससे Google Ad Manager के ज़रिए बेहतर तरीके से कमाई की जा सकती है.

अपने तीसरे पक्ष के विज्ञापन सर्वर को कॉन्फ़िगर करें, ताकि वह Ad Manager को सर्वर के अनुरोध में नॉनस को शामिल कर सके. यहां तीसरे पक्ष के विज्ञापन सर्वर में कॉन्फ़िगर किए गए विज्ञापन टैग का एक उदाहरण दिया गया है:

https://pubads.serverside.net/gampad/ads?givn=%%custom_key_for_google_nonce%%&...

ज़्यादा जानकारी के लिए, Google Ad Manager के सर्वर-साइड इंटिग्रेशन से जुड़ी गाइड देखें.

Ad Manager, नॉन्स वैल्यू की पहचान करने के लिए givn= को खोजता है. तीसरे पक्ष के विज्ञापन सर्वर को अपने कुछ मैक्रो का इस्तेमाल करना होगा. जैसे, %%custom_key_for_google_nonce%%. साथ ही, इसे पिछले चरण में दिए गए नॉनस क्वेरी पैरामीटर से बदलना होगा. इसे पूरा करने के तरीके के बारे में ज़्यादा जानकारी, तीसरे पक्ष के विज्ञापन सर्वर के दस्तावेज़ में मिलनी चाहिए.