ppc 0.3.0 → 1.0.1

data/lib/ppc/api/sogou/group.rb

@@ -1,116 +0,0 @@
-# -*- coding:utf-8  -*-
-module PPC
-  module API
-    class Sogou
-      class Group< Sogou
-        Service = 'CpcGrp'
-
-        @map =[
-                        [:plan_id, :cpcPlanId],
-                        [:id, :cpcGrpId],
-                        [:name, :cpcGrpName],
-                        [:price, :maxPrice],
-                        [:negative, :negativeWords],
-                        [:exact_negative, :exactNegativeWords],
-                        [:pause, :pause],
-                        [:status, :status],
-                        [:opt, :opt]
-                      ]
-
-        def self.ids(auth, debug = false )
-          """
-          @return : Array of cpcPlanGrpIdTypes
-          """
-          response = request( auth, Service , "getAllCpcGrpId" )
-          #此处返回值与key与开发文档不同
-          process( response, 'cpcPlanGrpIds', debug ){ |x| make_planGroupIds( x ) }
-        end
-
-        def self.get( auth, ids, debug = false )
-          ids = [ ids ] unless ids.is_a? Array
-          body = { cpcGrpIds: ids }
-          response = request(auth, Service, "getCpcGrpByCpcGrpId",body )
-          process( response, 'cpcGrpTypes', debug ){ |x| reverse_type(x) }
-        end
-
-        def self.add( auth, groups, debug = false )
-          """
-          @ input : one or list of AdgroupType
-          @ output : list of AdgroupType
-          """
-          cpcGrpTypes = make_type( groups )
-
-          body = {cpcGrpTypes:  cpcGrpTypes }
-          
-          response = request( auth, Service, "addCpcGrp", body  )
-          process( response, 'cpcGrpTypes', debug ){ |x| reverse_type(x) }
-        end
-
-        def self.update( auth, groups, debug = false )
-          """
-          @ input : one or list of AdgroupType
-          @ output : list of AdgroupType
-          """
-          cpcGrpTypes = make_type( groups )
-          body = {cpcGrpTypes: cpcGrpTypes}
-          
-          response = request( auth, Service, "updateCpcGrp",body )
-          process( response, 'cpcGrpTypes', debug ){ |x| reverse_type(x) }
-        end
-
-        def self.delete( auth, ids, debug = false )
-          """
-          delete group body has no message
-          """
-          ids = [ ids ] unless ids.is_a? Array
-          body = { cpcGrpIds: ids }
-          response = request( auth, Service,"deleteCpcGrp", body )
-          process( response, 'nil', debug ){ |x|  x  }
-        end
-
-        def self.search_by_plan_id( auth, ids, debug = false )
-          ids = [ ids ] unless ids.is_a? Array
-          body = { cpcPlanIds: ids }
-          response = request( auth, Service ,"getCpcGrpByCpcPlanId",  body )
-          # 此处key与开发文档不同
-          process( response, 'cpcPlanGrps', debug ){ |x| make_planGroups( x ) }
-        end
-
-        def self.search_id_by_plan_id( auth, ids, debug = false )
-          ids = [ ids ] unless ids.is_a? Array
-          body = { cpcPlanIds: ids }
-          response = request( auth, Service ,"getCpcGrpIdByCpcPlanId",  body )
-          process( response, 'cpcPlanGrpIds', debug ){ |x| make_planGroupIds( x ) }
-        end
-
-        private
-        def self.make_planGroupIds( cpcPlanGrpIdTypes )
-          cpcPlanGrpIdTypes = [cpcPlanGrpIdTypes] unless cpcPlanGrpIdTypes.is_a? Array
-          planGroupIds = []
-          cpcPlanGrpIdTypes.each do |cpcPlanGrpIdType|
-            planGroupId = { }
-            planGroupId[:plan_id] = cpcPlanGrpIdType[:cpc_plan_id]
-            planGroupId[:group_ids] = cpcPlanGrpIdType[:cpc_grp_ids]
-            planGroupIds << planGroupId
-          end
-          return planGroupIds
-        end
-
-        private
-        def self.make_planGroups( cpcPlanGrpTypes )
-          # 多加一行change成array
-          cpcPlanGrpTypes = [cpcPlanGrpTypes] unless cpcPlanGrpTypes.is_a? Array
-          planGroups = []
-          cpcPlanGrpTypes.each do |cpcPlanGrpType|
-            planGroup = {}
-            planGroup[:plan_id] = cpcPlanGrpType[:cpc_plan_id]
-            planGroup[:groups] = reverse_type( cpcPlanGrpType[:cpc_grp_types] )
-            planGroups << planGroup
-          end
-          return planGroups
-        end
-
-      end # class group
-    end # class baidu
-  end # API
-end # module

data/lib/ppc/api/sogou/keyword.rb

@@ -1,182 +0,0 @@
-# -*- coding:utf-8 -*-
-module PPC
-  module API
-    class Sogou
-      class Keyword< Sogou
-        Service = 'Cpc'
-
-        Match_type  = { 'exact' => 0, 'wide' => 1,0 => 'exact', 1 => 'wide' } 
-                
-        @map  = [
-                            [:id,:cpcId],
-                            [:group_id,:cpcGrpId],
-                            [:keyword,:cpc],
-                            [:price,:price],
-                            [:pc_destination,:visitUrl],
-                            [:mobile_destination,:mobileVisitUrl],
-                            [:match_type,:matchType],
-                            [:pause,:pause],
-                            [:status,:status],
-                            [:quality,:cpcQuality]
-                        ]
-        @quality_map = [
-                                      [:id,:cpcId],
-                                      [:quality,:cpcQuality]
-                                    ]
-
-        @status_map = [
-                                    [:id,:cpcId],
-                                    [:status,:status]
-                                  ]
-
-        # 后面改成info方法
-        def self.get( auth, ids, debug = false )
-          '''
-          getCpcByCpcId
-          '''
-          ids = [ ids ] unless ids.is_a? Array
-          body = { cpcIds: ids}
-          response = request( auth, Service, 'getCpcByCpcId', body )
-          process(response, 'cpcTypes', debug){|x| reverse_type( x ) }
-        end
-
-        def self.add( auth, keywords, debug = false )
-          '''
-          '''
-          cpcTypes = make_type( keywords ) 
-          body = { cpcTypes: cpcTypes }
-          response = request( auth, Service, "addCpc", body )
-          process(response, 'cpcTypes', debug){|x| reverse_type(x)  }
-        end
-
-        def self.update( auth, keywords, debug = false  )
-          '''
-          '''
-          cpcTypes = make_type( keywords ) 
-          body = { cpcTypes: cpcTypes }
-          response = request( auth, Service, "updateCpc", body )
-          process(response, 'cpcTypes', debug){|x| reverse_type(x)  }
-        end
-
-        def self.delete( auth, ids, debug = false )
-          """
-          """
-          ids = [ ids ] unless ids.is_a? Array
-          body = { cpcIds: ids}
-          response = request( auth, Service, 'deleteCpc', body )
-          process(response, 'nil', debug){|x| x }
-        end
-
-        def self.search_by_group_id( auth, group_ids, debug = false  )
-          """
-          getKeywordByGroupIds
-          @input: list of group id
-          @output:  list of groupKeyword
-          """
-          group_ids = [ group_ids ] unless group_ids.is_a? Array
-          body = { cpcGrpIds: group_ids }
-          response = request( auth, Service, "getCpcByCpcGrpId", body )
-          process(response, 'cpcGrpCpcs', debug){|x| make_groupKeywords( x ) }
-        end
-
-        def self.search_id_by_group_id( auth, group_ids, debug = false  )
-          group_ids = [ group_ids ] unless group_ids.is_a? Array
-          body = { cpcGrpIds: group_ids }
-          response = request( auth, Service, "getCpcIdByCpcGrpId", body )
-          process(response, 'cpcGrpCpcIds', debug){|x| make_groupKeywordIds( x ) }
-        end
-
-        # sogou的keyword服务不提供质量度
-        def self.status( auth, ids, debug = false )
-          '''
-          Return [ { id: id, status: status} ... ]
-          '''
-          ids = [ ids ] unless ids.is_a? Array
-          body = { cpcIds: ids}
-          response = request( auth, Service, 'getCpcByCpcId', body )
-          
-          process(response, 'cpcTypes', debug){  |x|  reverse_type(x, @status_map) }
-        end
-
-        def self.quality( auth ,ids, debug = false )
-          '''
-          Return [ { id: id, quality: quality} ... ]
-          '''
-          ids = [ ids ] unless ids.is_a? Array
-          body = { cpcIds: ids}
-          response = request( auth, Service, 'getCpcByCpcId', { cpcIds: ids} )
-          process(response, 'cpcTypes', debug){  |x| reverse_type(x, @quality_map) }
-        end
-
-        private
-        def self.make_groupKeywordIds( cpcGrpCpcIdTypes )
-          cpcGrpCpcIdTypes = [cpcGrpCpcIdTypes] unless cpcGrpCpcIdTypes.is_a? Array
-          group_keyword_ids = []
-          cpcGrpCpcIdTypes.each do |cpcGrpCpcIdType|
-            group_keyword_id = { }
-            group_keyword_id[:group_id] = cpcGrpCpcIdType[:cpc_grp_id]
-            group_keyword_id[:keyword_ids] = cpcGrpCpcIdType[:cpc_ids]
-            group_keyword_ids << group_keyword_id
-          end
-          return group_keyword_ids
-        end
-
-        private
-        def self.make_groupKeywords( cpcGrpCpcTypes )
-          cpcGrpCpcTypes = [cpcGrpCpcTypes] unless cpcGrpCpcTypes.is_a? Array 
-          group_keywords = []
-          cpcGrpCpcTypes.each do |cpcGrpCpcType|
-            group_keyword = {}
-            group_keyword[:group_id] = cpcGrpCpcType[:cpc_grp_id]
-            group_keyword[:keywords] = reverse_type( cpcGrpCpcType[:cpc_types] )
-            group_keywords << group_keyword
-          end
-          return group_keywords
-        end
-
-        # Override
-       def self.make_type( params, map = @map)
-          params = [ params ] unless params.is_a? Array
-          types = []
-          params.each do |param|
-            type = {}
-              map.each do |key|
-                # 增加对matchtype的自动转换
-                if key[0] == :match_type
-                   value = param[ key[0] ]
-                  type[ key[1] ] = Match_type[ value ] if value                 
-                else
-                  value = param[ key[0] ]
-                  type[ key[1] ] = value if value != nil
-                end
-              end
-            types << type
-          end
-          return types
-        end
-
-        # Overwrite
-        def self.reverse_type( types, map = @map )
-          types = [ types ] unless types.is_a? Array
-          params = []
-          types.each do |type|
-            param = {}
-             # 增加对matchtype的自动转换
-              map.each do |key|
-                if key[0] == :match_type
-                   value = type[ key[1].to_s.snake_case.to_sym]
-                  param[ key[0] ] = Match_type[ value ] if value                 
-                else
-                  value = type[ key[1].to_s.snake_case.to_sym ]
-                  param[ key[0] ] = value if value != nil
-                end
-              end # map.each
-            params << param
-          end # types.each
-          return params
-        end
-
-      end # keyword
-    end # Baidu
-  end # API
-end # PPC

data/lib/ppc/api/sogou/plan.rb

@@ -1,66 +0,0 @@
-module PPC
-  module API
-    class Sogou
-      class Plan< Sogou
-        Service = 'CpcPlan'
-
-        @map = [
-                          [:id,:cpcPlanId],
-                          [:name,:cpcPlanName],
-                          [:budget,:budget], 
-                          [:region,:regions],
-                          [:ip,:excludeIps] ,
-                          [:negative,:negativeWords],
-                          [:exact_negative,:exactNegativeWords],
-                          [:schedule,:schedule], 
-                          [:budget_offline_time,:budgetOfflineTime],
-                          [:show_prob,:showProb],   
-                          [:join_union ,:joinUnion],
-                          [:device,:device],
-                          [:price_ratio,:mobilePriceRate ], 
-                          [:pause,:pause],
-                          [:status,:status],
-                        ]
-
-        def self.all( auth, debug = false )
-          response = request( auth, Service, 'getAllCpcPlan' )
-          process( response, 'cpcPlanTypes' , debug ){ |x| reverse_type(x) }
-        end
-
-        def self.ids( auth, debug = false )
-          response = request( auth, Service, 'getAllCpcPlanId' )
-          process( response, 'cpcPlanIds' , debug ){ |x| x }
-        end
-
-        def self.get( auth, ids, debug = false )
-          ids = [ ids ] unless ids.is_a? Array
-          body = { cpcPlanIds: ids }
-          response = request( auth, Service, 'getCpcPlanByCpcPlanId', body)
-          process( response, 'cpcPlanTypes' , debug ){ |x| reverse_type(x) }
-        end
-
-        def self.add( auth, plans, debug = false )
-          cpcPlanTypes = make_type( plans )
-          body = { cpcPlanTypes: cpcPlanTypes }
-          response = request( auth, Service, 'addCpcPlan', body)
-          process( response, 'cpcPlanTypes' , debug ){ |x| reverse_type(x) }
-        end
-
-        def self.update(auth,plans, debug = false )
-          cpcPlanTypes = make_type( plans )
-          body = { cpcPlanTypes: cpcPlanTypes }
-          response = request( auth, Service, 'updateCpcPlan', body)
-          process( response, 'cpcPlanTypes' , debug ){ |x| reverse_type(x) }
-        end
-
-        def self.delete(auth, ids, debug = false )
-          ids = [ ids ] unless ids.class == Array
-          body = { cpcPlanIds: ids }
-          response = request( auth, Service, 'deleteCpcPlan', body)
-          process( response, '' , debug ){ |x| x }
-        end
-       
-      end # Service
-    end # baidu
-  end # API
-end # PPC

data/lib/ppc/api/sogou/report.rb

@@ -1,129 +0,0 @@
-# -*- coding:utf-8 -*-
-module PPC
-  module API
-    class Sogou
-      class Report< Sogou
-        Service = 'Report'
-      
-        # 需要用到的映射集合
-        Type_map = { 'account' => 1, 'plan'=> 2, 'group'=> 3, 
-                      'keyword'=> 5, 'creative'=> 4, 'pair'=> 15, 
-                       'query'=> 3 }
-
-        Range_map = {  'account' => 1, 'plan' => 2, 'group' => 3, 
-                        'creative' => 4, 'keyword' => 5 }
-
-        Device_map = { 'all' => 0, 'pc' => 1, 'mobile' => 2 }
-
-        Unit_map = { 'day' => 1, 'week' => 2, 'month' => 3 }
-
-        def self.get_id( auth, params, debug = false )
-          request = make_reportrequest( params )
-          body =  { reportRequestType: request }
-          response = request( auth, Service, 'getReportId' ,body) 
-          process( response, 'reportId', debug ){ |x| x }
-        end
-
-        def self.get_state( auth, id, debug = false)
-          '''
-          input id should be string
-          '''
-          status = {'-1'=>'Waiting' ,'0'=>'Opearting' ,'1'=>'Finished'}
-          body = { reportId:  id }
-          response = request( auth, Service, 'getReportState' ,body)
-          process( response, 'isGenerated', debug ){ |x| status[x] }
-        end
-
-        def self.get_url( auth, id, debug = false )
-          body = { reportId:  id }
-          response = request( auth, Service, 'getReportPath' ,body)
-          process( response, 'reportFilePath', debug ){ |x| x }       
-        end
-
-        private
-        def self.make_reportrequest( param )
-          '''
-          make RepoerRequestType
-          ======================
-          For more docs please have a look at
-          ::PPC::API::Baidu::Report:make_reportrequest()
-          '''
-          requesttype = {}
-          requesttype[:performanceData]    =     param[:fields] || %w(click)
-          requesttype[:reportType]         =     Type_map[ param[:type] ]        if  param[:type] 
-          requesttype[:statRange]          =     Range_map[ param[:range] ]      if param[:range]
-          requesttype[:unitOfTime]         =     Unit_map[ param[:unit] ]        if param[:unit] 
-          requesttype[:platform]           =     Device_map[ param[:device] ]    if param[:device]
-          requesttype[:idOnly]             =     param[:id_only]                 if param[:id_only]!=nil
-          requesttype[:startDate] = parse_date( param[:startDate] )
-          requesttype[:endDate]   = parse_date( param[:endDate] )
-          return requesttype
-        end
-
-        private 
-        def self.parse_date( date )
-          """
-          Cast string to time:
-          'YYYYMMDD' => Time
-          """
-          if date
-            y = date[0..3]
-            m = date[4..5]
-            d = date[6..7]
-            date = Time.new( y, m, d )
-          else
-            date = (Time.now - 24*3600)
-          end
-          date.utc.iso8601
-        end
-
-        ###########################
-        # intreface for Operation #
-        ###########################
-        def self.download_report( auth, param, debug = false )
-          response = get_id( auth, param )
-          if response[:succ]
-            id = response[:result]
-            p "Got report id:" + id.to_s if debug 
-            loop do
-              sleep 2 
-              break if get_state( auth, id )[:result] == 'Finished'
-              p "Report is not generated, waiting..." if debug 
-            end
-
-            url = get_url( auth, id )[:result]
-            ActiveSupport::Gzip.decompress( open(url).read )
-          else
-            raise response[:failure][:message]
-          end
-        end
-
-        def self.query_report( auth, param = nil, debug = false )
-          param = {} if not param
-          param[:type]   ||= 'query'
-          param[:fields] ||=  %w(click)
-          param[:range]  ||= 'account'
-          param[:unit]   ||= 'day'
-          download_report( auth, param, debug )
-        end
-
-        def self.creative_report( auth, param = nil, debug = false )
-          param = {} if not param
-          param[:type]   ||= 'creative'
-          param[:fields] ||=  %w( cost cpc click impression ctr )
-          param[:range]  ||= 'account'
-          download_report( auth, param, debug )
-        end
-
-        def self.keyword_report( auth, param = nil, debug = false )
-          param = {} if not param
-          param[:type]   ||= 'keyword'
-          param[:fields] ||=  %w( cost cpc click impression ctr )
-          param[:range]  ||= 'account'
-          download_report( auth, param, debug )
-        end
-
-      end # Repost
-    end # Baidu
-  end # API
-end # PPC