VAMPRequest

Objective-C

@interface VAMPRequest : NSObject <NSCopying>

Swift

class VAMPRequest : NSObject, NSCopying

VAMPRequest

  • ロードリクエストのタイムアウト値を秒数で設定します。

    最小30秒、最大120秒。デフォルトは60秒。

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval requestTimeout;

    Swift

    var requestTimeout: TimeInterval { get set }

  • Deprecated

    VAMPVideoConfiguration

    動画に関する設定をします。

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) VAMPVideoConfiguration *videoConfiguration;

    Swift

    @NSCopying var videoConfiguration: VAMPVideoConfiguration? { get set }

  • App Content URL

    設定は -setContentURL:error: で行います。 前後の空白・改行を除去（trim）した値を保持します。

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *contentURL;

    Swift

    var contentURL: String? { get }

  • デフォルトのVAMPRequestオブジェクトを取得します。

    Declaration

    Objective-C

    + (nonnull instancetype)request;

  • App Content URL を設定します。

    アプリの主要コンテンツに一致するウェブサイトの URL を設定すると、 コンテンツターゲティング用の atp パラメータとして広告リクエストに付与されます。

    URL の長さが上限（512 UTF-16 code unit。前後の空白・改行を除去した後の長さで判定）を 超える場合は NO を返して error に詳細を渡します。このとき contentURL は 未設定（nil）になります（設定済みの値があった場合も、古い URL でターゲティング しないように解除されます）。 このエラーは設定時にのみ返るもので、広告のロードは中断しません （上限超過時は atp を送らずにリクエストを継続します）。

    contentURL プロパティには前後の空白・改行を除去（trim）した値が保持されます。 trim 後に空文字列となる場合は未設定（nil）として扱います。

    成否は戻り値（NO）で判定してください。Cocoa のエラー規約に従い、成功時には error 引数へ書き込みを行わないため、error 変数の内容だけで成否を判定しないでください。

    Declaration

    Objective-C

    - (BOOL)setContentURL:(nullable NSString *)contentURL
                error:(NSError *_Nullable *_Nullable)error;

    Swift

    func setContentURL(_ contentURL: String?) throws

    Parameters

    contentURL

    App Content URL（nil を渡すと設定を解除します）
    error

    上限超過時にエラー詳細が渡されます（成功時は書き込まれません）

    Return Value

    設定に成功した場合は YES、上限超過で設定されなかった場合は NO