Package com.google.openrtb

Interface OpenRtb.NativeResponseOrBuilder

    • Method Detail

      • hasVer

        boolean hasVer()
         Version of the Native Markup version in use.
 RECOMMENDED by the OpenRTB Native specification.
        optional string ver = 1;
        Returns:
        Whether the ver field is set.

      • getVer

        String getVer()
         Version of the Native Markup version in use.
 RECOMMENDED by the OpenRTB Native specification.
        optional string ver = 1;
        Returns:
        The ver.

      • getVerBytes

        com.google.protobuf.ByteString getVerBytes()
         Version of the Native Markup version in use.
 RECOMMENDED by the OpenRTB Native specification.
        optional string ver = 1;
        Returns:
        The bytes for ver.

      • getAssetsList

        List<OpenRtb.NativeResponse.Asset> getAssetsList()
         List of native ad's assets.
 RECOMMENDED in 1.0, 1.1, or in 1.2 as a fallback if assetsurl is provided.
 REQUIRED in 1.2, if not assetsurl is provided.
        repeated .com.google.openrtb.NativeResponse.Asset assets = 2;

      • getAssets

        OpenRtb.NativeResponse.Asset getAssets​(int index)
         List of native ad's assets.
 RECOMMENDED in 1.0, 1.1, or in 1.2 as a fallback if assetsurl is provided.
 REQUIRED in 1.2, if not assetsurl is provided.
        repeated .com.google.openrtb.NativeResponse.Asset assets = 2;

      • getAssetsCount

        int getAssetsCount()
         List of native ad's assets.
 RECOMMENDED in 1.0, 1.1, or in 1.2 as a fallback if assetsurl is provided.
 REQUIRED in 1.2, if not assetsurl is provided.
        repeated .com.google.openrtb.NativeResponse.Asset assets = 2;

      • getAssetsOrBuilderList

        List<? extends OpenRtb.NativeResponse.AssetOrBuilder> getAssetsOrBuilderList()
         List of native ad's assets.
 RECOMMENDED in 1.0, 1.1, or in 1.2 as a fallback if assetsurl is provided.
 REQUIRED in 1.2, if not assetsurl is provided.
        repeated .com.google.openrtb.NativeResponse.Asset assets = 2;

      • getAssetsOrBuilder

        OpenRtb.NativeResponse.AssetOrBuilder getAssetsOrBuilder​(int index)
         List of native ad's assets.
 RECOMMENDED in 1.0, 1.1, or in 1.2 as a fallback if assetsurl is provided.
 REQUIRED in 1.2, if not assetsurl is provided.
        repeated .com.google.openrtb.NativeResponse.Asset assets = 2;

      • hasAssetsurl

        boolean hasAssetsurl()
         URL of alternate source for the assets object. The expected response is a
 JSON object mirroring the asset object in the bid response, subject to
 certain requirements as specified in the individual objects.
 Where present, overrides the assets object in the response.
        optional string assetsurl = 6;
        Returns:
        Whether the assetsurl field is set.

      • getAssetsurl

        String getAssetsurl()
         URL of alternate source for the assets object. The expected response is a
 JSON object mirroring the asset object in the bid response, subject to
 certain requirements as specified in the individual objects.
 Where present, overrides the assets object in the response.
        optional string assetsurl = 6;
        Returns:
        The assetsurl.

      • getAssetsurlBytes

        com.google.protobuf.ByteString getAssetsurlBytes()
         URL of alternate source for the assets object. The expected response is a
 JSON object mirroring the asset object in the bid response, subject to
 certain requirements as specified in the individual objects.
 Where present, overrides the assets object in the response.
        optional string assetsurl = 6;
        Returns:
        The bytes for assetsurl.

      • hasDcourl

        boolean hasDcourl()
         URL where a dynamic creative specification may be found for populating this
 ad, per the Dynamic Content Ads Specification.
 Note this is a beta option as the interpretation of the Dynamic Content Ads
 Specification and how to assign those elementes into a native ad is outside
 the scope of this spec and must be agreed offline between parties or as may
 be specified in a future revision of the Dynamic Content Ads spec.
 Where present, overrides the assets object in the response.
        optional string dcourl = 7;
        Returns:
        Whether the dcourl field is set.

      • getDcourl

        String getDcourl()
         URL where a dynamic creative specification may be found for populating this
 ad, per the Dynamic Content Ads Specification.
 Note this is a beta option as the interpretation of the Dynamic Content Ads
 Specification and how to assign those elementes into a native ad is outside
 the scope of this spec and must be agreed offline between parties or as may
 be specified in a future revision of the Dynamic Content Ads spec.
 Where present, overrides the assets object in the response.
        optional string dcourl = 7;
        Returns:
        The dcourl.

      • getDcourlBytes

        com.google.protobuf.ByteString getDcourlBytes()
         URL where a dynamic creative specification may be found for populating this
 ad, per the Dynamic Content Ads Specification.
 Note this is a beta option as the interpretation of the Dynamic Content Ads
 Specification and how to assign those elementes into a native ad is outside
 the scope of this spec and must be agreed offline between parties or as may
 be specified in a future revision of the Dynamic Content Ads spec.
 Where present, overrides the assets object in the response.
        optional string dcourl = 7;
        Returns:
        The bytes for dcourl.

      • hasLink

        boolean hasLink()
         Destination Link. This is default link object for the ad.
 Individual assets can also have a link object which applies if the asset is
 activated (clicked). If the asset doesn't have a link object, the parent
 link object applies.
 See ResponseLink definition.
 REQUIRED by the OpenRTB Native specification.
        required .com.google.openrtb.NativeResponse.Link link = 3;
        Returns:
        Whether the link field is set.

      • getLink

        OpenRtb.NativeResponse.Link getLink()
         Destination Link. This is default link object for the ad.
 Individual assets can also have a link object which applies if the asset is
 activated (clicked). If the asset doesn't have a link object, the parent
 link object applies.
 See ResponseLink definition.
 REQUIRED by the OpenRTB Native specification.
        required .com.google.openrtb.NativeResponse.Link link = 3;
        Returns:
        The link.

      • getLinkOrBuilder

        OpenRtb.NativeResponse.LinkOrBuilder getLinkOrBuilder()
         Destination Link. This is default link object for the ad.
 Individual assets can also have a link object which applies if the asset is
 activated (clicked). If the asset doesn't have a link object, the parent
 link object applies.
 See ResponseLink definition.
 REQUIRED by the OpenRTB Native specification.
        required .com.google.openrtb.NativeResponse.Link link = 3;

      • getImptrackersList

        @Deprecated
List<String> getImptrackersList()
        Deprecated.
        com.google.openrtb.NativeResponse.imptrackers is deprecated. See openrtb.proto;l=1689
         DEPRECATED in OpenRTB Native 1.2+. Prefer object <code>EventTracker</code>.
 Array of impression tracking URLs, expected to return a 1x1 image or
 204 response - typically only passed when using 3rd party trackers.
        repeated string imptrackers = 4 [deprecated = true];
        Returns:
        A list containing the imptrackers.

      • getImptrackersCount

        @Deprecated
int getImptrackersCount()
        Deprecated.
        com.google.openrtb.NativeResponse.imptrackers is deprecated. See openrtb.proto;l=1689
         DEPRECATED in OpenRTB Native 1.2+. Prefer object <code>EventTracker</code>.
 Array of impression tracking URLs, expected to return a 1x1 image or
 204 response - typically only passed when using 3rd party trackers.
        repeated string imptrackers = 4 [deprecated = true];
        Returns:
        The count of imptrackers.

      • getImptrackers

        @Deprecated
String getImptrackers​(int index)
        Deprecated.
        com.google.openrtb.NativeResponse.imptrackers is deprecated. See openrtb.proto;l=1689
         DEPRECATED in OpenRTB Native 1.2+. Prefer object <code>EventTracker</code>.
 Array of impression tracking URLs, expected to return a 1x1 image or
 204 response - typically only passed when using 3rd party trackers.
        repeated string imptrackers = 4 [deprecated = true];
        Parameters:
        index - The index of the element to return.
        Returns:
        The imptrackers at the given index.

      • getImptrackersBytes

        @Deprecated
com.google.protobuf.ByteString getImptrackersBytes​(int index)
        Deprecated.
        com.google.openrtb.NativeResponse.imptrackers is deprecated. See openrtb.proto;l=1689
         DEPRECATED in OpenRTB Native 1.2+. Prefer object <code>EventTracker</code>.
 Array of impression tracking URLs, expected to return a 1x1 image or
 204 response - typically only passed when using 3rd party trackers.
        repeated string imptrackers = 4 [deprecated = true];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the imptrackers at the given index.

      • hasJstracker

        @Deprecated
boolean hasJstracker()
        Deprecated.
        com.google.openrtb.NativeResponse.jstracker is deprecated. See openrtb.proto;l=1694
         DEPRECATED in OpenRTB Native 1.2+. Prefer object <code>EventTracker</code>.
 Optional javascript impression tracker. Contains <script> tags to be
 executed at impression time where it can be supported.
        optional string jstracker = 5 [deprecated = true];
        Returns:
        Whether the jstracker field is set.

      • getJstracker

        @Deprecated
String getJstracker()
        Deprecated.
        com.google.openrtb.NativeResponse.jstracker is deprecated. See openrtb.proto;l=1694
         DEPRECATED in OpenRTB Native 1.2+. Prefer object <code>EventTracker</code>.
 Optional javascript impression tracker. Contains <script> tags to be
 executed at impression time where it can be supported.
        optional string jstracker = 5 [deprecated = true];
        Returns:
        The jstracker.

      • getJstrackerBytes

        @Deprecated
com.google.protobuf.ByteString getJstrackerBytes()
        Deprecated.
        com.google.openrtb.NativeResponse.jstracker is deprecated. See openrtb.proto;l=1694
         DEPRECATED in OpenRTB Native 1.2+. Prefer object <code>EventTracker</code>.
 Optional javascript impression tracker. Contains <script> tags to be
 executed at impression time where it can be supported.
        optional string jstracker = 5 [deprecated = true];
        Returns:
        The bytes for jstracker.

      • getEventtrackersList

        List<OpenRtb.NativeResponse.EventTracker> getEventtrackersList()
         Array of response event trackers to run with the ad, in response to the
 declared supported methods in the NativeRequest. Replaces imptrackers and
 jstrackers.
        repeated .com.google.openrtb.NativeResponse.EventTracker eventtrackers = 8;

      • getEventtrackers

        OpenRtb.NativeResponse.EventTracker getEventtrackers​(int index)
         Array of response event trackers to run with the ad, in response to the
 declared supported methods in the NativeRequest. Replaces imptrackers and
 jstrackers.
        repeated .com.google.openrtb.NativeResponse.EventTracker eventtrackers = 8;

      • getEventtrackersCount

        int getEventtrackersCount()
         Array of response event trackers to run with the ad, in response to the
 declared supported methods in the NativeRequest. Replaces imptrackers and
 jstrackers.
        repeated .com.google.openrtb.NativeResponse.EventTracker eventtrackers = 8;

      • getEventtrackersOrBuilderList

        List<? extends OpenRtb.NativeResponse.EventTrackerOrBuilder> getEventtrackersOrBuilderList()
         Array of response event trackers to run with the ad, in response to the
 declared supported methods in the NativeRequest. Replaces imptrackers and
 jstrackers.
        repeated .com.google.openrtb.NativeResponse.EventTracker eventtrackers = 8;

      • getEventtrackersOrBuilder

        OpenRtb.NativeResponse.EventTrackerOrBuilder getEventtrackersOrBuilder​(int index)
         Array of response event trackers to run with the ad, in response to the
 declared supported methods in the NativeRequest. Replaces imptrackers and
 jstrackers.
        repeated .com.google.openrtb.NativeResponse.EventTracker eventtrackers = 8;

      • hasPrivacy

        boolean hasPrivacy()
         If support was indicated in the request, URL of a page informing the user
 about the buyer's targeting activity.
        optional string privacy = 9;
        Returns:
        Whether the privacy field is set.

      • getPrivacy

        String getPrivacy()
         If support was indicated in the request, URL of a page informing the user
 about the buyer's targeting activity.
        optional string privacy = 9;
        Returns:
        The privacy.

      • getPrivacyBytes

        com.google.protobuf.ByteString getPrivacyBytes()
         If support was indicated in the request, URL of a page informing the user
 about the buyer's targeting activity.
        optional string privacy = 9;
        Returns:
        The bytes for privacy.