Package com.vk.api.sdk.queries.ads

Class AdsGetTargetingStatsQuery

    • Constructor Detail

      • AdsGetTargetingStatsQuery

        public AdsGetTargetingStatsQuery​(VkApiClient client,
                                 UserActor actor,
                                 int accountId,
                                 java.lang.String linkUrl)
        Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
        Parameters:
        client - VK API client
        actor - actor with access token
        accountId - value of "account id" parameter.
        linkUrl - value of "link url" parameter.

    • Method Detail

      • accountId

        protected AdsGetTargetingStatsQuery accountId​(int value)
        Advertising account ID.
        Parameters:
        value - value of "account id" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • clientId

        public AdsGetTargetingStatsQuery clientId​(java.lang.Integer value)
        Set client id
        Parameters:
        value - value of "client id" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • criteria

        public AdsGetTargetingStatsQuery criteria​(java.lang.String value)
        Serialized JSON object that describes targeting parameters. Description of 'criteria' object see below.
        Parameters:
        value - value of "criteria" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • adId

        public AdsGetTargetingStatsQuery adId​(java.lang.Integer value)
        ID of an ad which targeting parameters shall be analyzed.
        Parameters:
        value - value of "ad id" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • adFormat

        public AdsGetTargetingStatsQuery adFormat​(GetTargetingStatsAdFormat value)
        Ad format. Possible values: *'1' — image and text,, *'2' — big image,, *'3' — exclusive format,, *'4' — community, square image,, *'7' — special app format,, *'8' — special community format,, *'9' — post in community,, *'10' — app board.
        Parameters:
        value - value of "ad format" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • adPlatform

        public AdsGetTargetingStatsQuery adPlatform​(java.lang.String value)
        Platforms to use for ad showing. Possible values: (for 'ad_format' = '1'), *'0' — VK and partner sites,, *'1' — VK only. (for 'ad_format' = '9'), *'all' — all platforms,, *'desktop' — desktop version,, *'mobile' — mobile version and apps.
        Parameters:
        value - value of "ad platform" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • adPlatformNoWall

        public AdsGetTargetingStatsQuery adPlatformNoWall​(java.lang.String value)
        Set ad platform no wall
        Parameters:
        value - value of "ad platform no wall" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • adPlatformNoAdNetwork

        public AdsGetTargetingStatsQuery adPlatformNoAdNetwork​(java.lang.String value)
        Set ad platform no ad network
        Parameters:
        value - value of "ad platform no ad network" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • publisherPlatforms

        public AdsGetTargetingStatsQuery publisherPlatforms​(java.lang.String value)
        Set publisher platforms
        Parameters:
        value - value of "publisher platforms" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • linkUrl

        protected AdsGetTargetingStatsQuery linkUrl​(java.lang.String value)
        URL for the advertised object.
        Parameters:
        value - value of "link url" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • linkDomain

        public AdsGetTargetingStatsQuery linkDomain​(java.lang.String value)
        Domain of the advertised object.
        Parameters:
        value - value of "link domain" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • needPrecise

        public AdsGetTargetingStatsQuery needPrecise​(java.lang.Boolean value)
        Additionally return recommended cpc and cpm to reach 5,10..95 percents of audience.
        Parameters:
        value - value of "need precise" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • impressionsLimitPeriod

        public AdsGetTargetingStatsQuery impressionsLimitPeriod​(java.lang.Integer value)
        Impressions limit period in seconds, must be a multiple of 86400(day)
        Parameters:
        value - value of "impressions limit period" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.