Package com.google.openrtb

Interface OpenRtb.BidRequest.SiteOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getCat​(int index)
      Array of IAB content categories of the site.
      com.google.protobuf.ByteString getCatBytes​(int index)
      Array of IAB content categories of the site.
      int getCatCount()
      Array of IAB content categories of the site.
      List<String> getCatList()
      Array of IAB content categories of the site.
      OpenRtb.BidRequest.Content getContent()
      Details about the Content (Section 3.2.9) within the site.
      OpenRtb.BidRequest.ContentOrBuilder getContentOrBuilder()
      Details about the Content (Section 3.2.9) within the site.
      String getDomain()
      Domain of the site, used for advertiser side blocking.
      com.google.protobuf.ByteString getDomainBytes()
      Domain of the site, used for advertiser side blocking.
      String getId()
      Site ID on the exchange.
      com.google.protobuf.ByteString getIdBytes()
      Site ID on the exchange.
      String getKeywords()
      Comma separated list of keywords about this site.
      com.google.protobuf.ByteString getKeywordsBytes()
      Comma separated list of keywords about this site.
      boolean getMobile()
      Indicates if the site has been programmed to optimize layout when viewed on mobile devices.
      String getName()
      Site name (may be masked at publisher's request).
      com.google.protobuf.ByteString getNameBytes()
      Site name (may be masked at publisher's request).
      String getPage()
      URL of the page where the impression will be shown.
      com.google.protobuf.ByteString getPageBytes()
      URL of the page where the impression will be shown.
      String getPagecat​(int index)
      Array of IAB content categories that describe the current page or view of the site.
      com.google.protobuf.ByteString getPagecatBytes​(int index)
      Array of IAB content categories that describe the current page or view of the site.
      int getPagecatCount()
      Array of IAB content categories that describe the current page or view of the site.
      List<String> getPagecatList()
      Array of IAB content categories that describe the current page or view of the site.
      boolean getPrivacypolicy()
      Indicates if the site has a privacy policy.
      OpenRtb.BidRequest.Publisher getPublisher()
      Details about the Publisher (Section 3.2.8) of the site.
      OpenRtb.BidRequest.PublisherOrBuilder getPublisherOrBuilder()
      Details about the Publisher (Section 3.2.8) of the site.
      String getRef()
      Referrer URL that caused navigation to the current page.
      com.google.protobuf.ByteString getRefBytes()
      Referrer URL that caused navigation to the current page.
      String getSearch()
      Search string that caused navigation to the current page.
      com.google.protobuf.ByteString getSearchBytes()
      Search string that caused navigation to the current page.
      String getSectioncat​(int index)
      Array of IAB content categories that describe the current section of the site.
      com.google.protobuf.ByteString getSectioncatBytes​(int index)
      Array of IAB content categories that describe the current section of the site.
      int getSectioncatCount()
      Array of IAB content categories that describe the current section of the site.
      List<String> getSectioncatList()
      Array of IAB content categories that describe the current section of the site.
      boolean hasContent()
      Details about the Content (Section 3.2.9) within the site.
      boolean hasDomain()
      Domain of the site, used for advertiser side blocking.
      boolean hasId()
      Site ID on the exchange.
      boolean hasKeywords()
      Comma separated list of keywords about this site.
      boolean hasMobile()
      Indicates if the site has been programmed to optimize layout when viewed on mobile devices.
      boolean hasName()
      Site name (may be masked at publisher's request).
      boolean hasPage()
      URL of the page where the impression will be shown.
      boolean hasPrivacypolicy()
      Indicates if the site has a privacy policy.
      boolean hasPublisher()
      Details about the Publisher (Section 3.2.8) of the site.
      boolean hasRef()
      Referrer URL that caused navigation to the current page.
      boolean hasSearch()
      Search string that caused navigation to the current page.

      • Methods inherited from interface com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder

        getDefaultInstanceForType, getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, hasExtension, hasExtension, hasExtension

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasId

        boolean hasId()
         Site ID on the exchange.
 RECOMMENDED by the OpenRTB specification.
        optional string id = 1;
        Returns:
        Whether the id field is set.

      • getId

        String getId()
         Site ID on the exchange.
 RECOMMENDED by the OpenRTB specification.
        optional string id = 1;
        Returns:
        The id.

      • getIdBytes

        com.google.protobuf.ByteString getIdBytes()
         Site ID on the exchange.
 RECOMMENDED by the OpenRTB specification.
        optional string id = 1;
        Returns:
        The bytes for id.

      • hasName

        boolean hasName()
         Site name (may be masked at publisher's request).
        optional string name = 2;
        Returns:
        Whether the name field is set.

      • getName

        String getName()
         Site name (may be masked at publisher's request).
        optional string name = 2;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Site name (may be masked at publisher's request).
        optional string name = 2;
        Returns:
        The bytes for name.

      • hasDomain

        boolean hasDomain()
         Domain of the site, used for advertiser side blocking.
 For example, "foo.com".
        optional string domain = 3;
        Returns:
        Whether the domain field is set.

      • getDomain

        String getDomain()
         Domain of the site, used for advertiser side blocking.
 For example, "foo.com".
        optional string domain = 3;
        Returns:
        The domain.

      • getDomainBytes

        com.google.protobuf.ByteString getDomainBytes()
         Domain of the site, used for advertiser side blocking.
 For example, "foo.com".
        optional string domain = 3;
        Returns:
        The bytes for domain.

      • getCatList

        List<String> getCatList()
         Array of IAB content categories of the site.
 See enum ContentCategory.
        repeated string cat = 4;
        Returns:
        A list containing the cat.

      • getCatCount

        int getCatCount()
         Array of IAB content categories of the site.
 See enum ContentCategory.
        repeated string cat = 4;
        Returns:
        The count of cat.

      • getCat

        String getCat​(int index)
         Array of IAB content categories of the site.
 See enum ContentCategory.
        repeated string cat = 4;
        Parameters:
        index - The index of the element to return.
        Returns:
        The cat at the given index.

      • getCatBytes

        com.google.protobuf.ByteString getCatBytes​(int index)
         Array of IAB content categories of the site.
 See enum ContentCategory.
        repeated string cat = 4;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the cat at the given index.

      • getSectioncatList

        List<String> getSectioncatList()
         Array of IAB content categories that describe the current section
 of the site.
 See enum ContentCategory.
        repeated string sectioncat = 5;
        Returns:
        A list containing the sectioncat.

      • getSectioncatCount

        int getSectioncatCount()
         Array of IAB content categories that describe the current section
 of the site.
 See enum ContentCategory.
        repeated string sectioncat = 5;
        Returns:
        The count of sectioncat.

      • getSectioncat

        String getSectioncat​(int index)
         Array of IAB content categories that describe the current section
 of the site.
 See enum ContentCategory.
        repeated string sectioncat = 5;
        Parameters:
        index - The index of the element to return.
        Returns:
        The sectioncat at the given index.

      • getSectioncatBytes

        com.google.protobuf.ByteString getSectioncatBytes​(int index)
         Array of IAB content categories that describe the current section
 of the site.
 See enum ContentCategory.
        repeated string sectioncat = 5;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the sectioncat at the given index.

      • getPagecatList

        List<String> getPagecatList()
         Array of IAB content categories that describe the current page or view
 of the site.
 See enum ContentCategory.
        repeated string pagecat = 6;
        Returns:
        A list containing the pagecat.

      • getPagecatCount

        int getPagecatCount()
         Array of IAB content categories that describe the current page or view
 of the site.
 See enum ContentCategory.
        repeated string pagecat = 6;
        Returns:
        The count of pagecat.

      • getPagecat

        String getPagecat​(int index)
         Array of IAB content categories that describe the current page or view
 of the site.
 See enum ContentCategory.
        repeated string pagecat = 6;
        Parameters:
        index - The index of the element to return.
        Returns:
        The pagecat at the given index.

      • getPagecatBytes

        com.google.protobuf.ByteString getPagecatBytes​(int index)
         Array of IAB content categories that describe the current page or view
 of the site.
 See enum ContentCategory.
        repeated string pagecat = 6;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the pagecat at the given index.

      • hasPage

        boolean hasPage()
         URL of the page where the impression will be shown.
        optional string page = 7;
        Returns:
        Whether the page field is set.

      • getPage

        String getPage()
         URL of the page where the impression will be shown.
        optional string page = 7;
        Returns:
        The page.

      • getPageBytes

        com.google.protobuf.ByteString getPageBytes()
         URL of the page where the impression will be shown.
        optional string page = 7;
        Returns:
        The bytes for page.

      • hasPrivacypolicy

        boolean hasPrivacypolicy()
         Indicates if the site has a privacy policy.
        optional bool privacypolicy = 8;
        Returns:
        Whether the privacypolicy field is set.

      • getPrivacypolicy

        boolean getPrivacypolicy()
         Indicates if the site has a privacy policy.
        optional bool privacypolicy = 8;
        Returns:
        The privacypolicy.

      • hasRef

        boolean hasRef()
         Referrer URL that caused navigation to the current page.
        optional string ref = 9;
        Returns:
        Whether the ref field is set.

      • getRef

        String getRef()
         Referrer URL that caused navigation to the current page.
        optional string ref = 9;
        Returns:
        The ref.

      • getRefBytes

        com.google.protobuf.ByteString getRefBytes()
         Referrer URL that caused navigation to the current page.
        optional string ref = 9;
        Returns:
        The bytes for ref.

      • hasSearch

        boolean hasSearch()
         Search string that caused navigation to the current page.
        optional string search = 10;
        Returns:
        Whether the search field is set.

      • getSearch

        String getSearch()
         Search string that caused navigation to the current page.
        optional string search = 10;
        Returns:
        The search.

      • getSearchBytes

        com.google.protobuf.ByteString getSearchBytes()
         Search string that caused navigation to the current page.
        optional string search = 10;
        Returns:
        The bytes for search.

      • hasPublisher

        boolean hasPublisher()
         Details about the Publisher (Section 3.2.8) of the site.
        optional .com.google.openrtb.BidRequest.Publisher publisher = 11;
        Returns:
        Whether the publisher field is set.

      • getPublisher

        OpenRtb.BidRequest.Publisher getPublisher()
         Details about the Publisher (Section 3.2.8) of the site.
        optional .com.google.openrtb.BidRequest.Publisher publisher = 11;
        Returns:
        The publisher.

      • getPublisherOrBuilder

        OpenRtb.BidRequest.PublisherOrBuilder getPublisherOrBuilder()
         Details about the Publisher (Section 3.2.8) of the site.
        optional .com.google.openrtb.BidRequest.Publisher publisher = 11;

      • hasContent

        boolean hasContent()
         Details about the Content (Section 3.2.9) within the site.
        optional .com.google.openrtb.BidRequest.Content content = 12;
        Returns:
        Whether the content field is set.

      • getContent

        OpenRtb.BidRequest.Content getContent()
         Details about the Content (Section 3.2.9) within the site.
        optional .com.google.openrtb.BidRequest.Content content = 12;
        Returns:
        The content.

      • getContentOrBuilder

        OpenRtb.BidRequest.ContentOrBuilder getContentOrBuilder()
         Details about the Content (Section 3.2.9) within the site.
        optional .com.google.openrtb.BidRequest.Content content = 12;

      • hasKeywords

        boolean hasKeywords()
         Comma separated list of keywords about this site.
 Note: OpenRTB 2.2 allowed an array-of-strings as alternate implementation
 but this was fixed in 2.3+ where it's definitely a single string with CSV
 content again. Compatibility with some OpenRTB 2.2 exchanges that adopted
 the alternate representation may require custom handling of the JSON.
        optional string keywords = 13;
        Returns:
        Whether the keywords field is set.

      • getKeywords

        String getKeywords()
         Comma separated list of keywords about this site.
 Note: OpenRTB 2.2 allowed an array-of-strings as alternate implementation
 but this was fixed in 2.3+ where it's definitely a single string with CSV
 content again. Compatibility with some OpenRTB 2.2 exchanges that adopted
 the alternate representation may require custom handling of the JSON.
        optional string keywords = 13;
        Returns:
        The keywords.

      • getKeywordsBytes

        com.google.protobuf.ByteString getKeywordsBytes()
         Comma separated list of keywords about this site.
 Note: OpenRTB 2.2 allowed an array-of-strings as alternate implementation
 but this was fixed in 2.3+ where it's definitely a single string with CSV
 content again. Compatibility with some OpenRTB 2.2 exchanges that adopted
 the alternate representation may require custom handling of the JSON.
        optional string keywords = 13;
        Returns:
        The bytes for keywords.

      • hasMobile

        boolean hasMobile()
         Indicates if the site has been programmed to optimize layout
 when viewed on mobile devices.
        optional bool mobile = 15;
        Returns:
        Whether the mobile field is set.

      • getMobile

        boolean getMobile()
         Indicates if the site has been programmed to optimize layout
 when viewed on mobile devices.
        optional bool mobile = 15;
        Returns:
        The mobile.