ppc 1.3.0 → 1.3.2

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

@@ -0,0 +1,42 @@
+module PPC
+  module API
+    class Sogou
+      class Account < Sogou
+        Service = 'Account'
+
+        @map = [
+                [:id,:accountid],            
+                [:balance,:balance],         
+                [:cost,:totalCost],               
+                [:payment,:totalPay],                          
+                [:budget_type,:type],                   
+                [:budget,:budget],                              
+                [:region,:regions],                    
+                [:exclude_ip,:excludeIps],                        
+                [:open_domains,:domains],                  
+                [:offline_time,:budgetOfflineTime],         
+                [:opt,:opt]                                  
+              ]
+
+        def self.info(auth)
+          response = request(auth,Service,'getAccountInfo'  )
+          process( response, 'accountInfoType' ){ |x|reverse_type(x)[0] }
+        end
+
+        def self.update(auth, param = {})
+          """
+          update account info
+          @ params : account_info_type
+          @return : account info_type
+          """
+          # for account service, there is not bulk operation
+          infoType = make_type( param )[0]
+          body = { accountInfoType: infoType }
+          response = request(auth,Service,'updateAccountInfo', body)
+          process( response, 'accountInfoType' ){ |x|reverse_type(x)[0] }
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# -*- coding:utf-8 -*-
+module PPC
+  module API
+    class Sogou
+      class Bulk < Sogou
+        Service = 'AccountDownload'
+
+        def self.get_all_object( auth, ids )
+          #文档上面写的输入类型是String？
+          body = nil
+          body = { 'cpcPlanIds' => ids } if ids
+          response = request( auth, Service, 'getAccountFile', body )
+          process( response, 'accountFileId' ){ |x| x }
+        end
+
+        def self.get_file_state( auth, id )
+          body = { 'accountFileId' => id }
+          response = request( auth, Service, 'getAccountFileStatus' , body )
+          process( response, 'isGenerated' ){ |x| x }
+        end
+
+        def self.get_file_path(auth, id)
+          body = {'accountFileId' => id}
+          response = request(auth, Service, 'getAccountFilePath', body)
+          process(response, 'accountFilePath'){|x| x}
+        end
+
+        def self.download( auth, ids = nil)
+          result = get_all_object(auth, ids)
+          field_id = result[:result]
+          loop do 
+            status = get_file_state(auth, field_id)
+            return get_file_path(auth, field_id) if status[:result] == '1'
+            sleep 15
+          end
+        end
+
+        def self.get_cpc_rank(auth, device)
+          body = {'deviceType' => device}
+          response = request(auth, 'CpcRank', 'getCpcRankId', body)
+          process(response, 'rankId'){|x| x}
+        end
+
+        def self.get_cpc_rank_status(auth, rank_id)
+          body = {'rankId' => rank_id}
+          response = request(auth, 'CpcRank', 'getCpcRankStatus', body)
+          process(response, 'isGenerated' ){|x| x }
+        end
+
+        def self.get_cpc_rank_path(auth, rank_id)
+          body = {'rankId' => rank_id}
+          response = request(auth, 'CpcRank', 'getCpcRankPath', body)
+          process(response, 'rankPath'){|x| x}
+        end
+
+        def self.download_cpc_rank(auth, device = 0)
+          result = get_cpc_rank(auth, device)
+          rank_id = result[:result]
+          loop do 
+            status = get_cpc_rank_status(auth, rank_id)
+            return get_cpc_rank_path(auth, rank_id) if status[:result] == '1'
+            sleep 15
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,117 @@
+# -*- coding:utf-8 -*-
+module PPC
+  module API
+    class Sogou
+      class Creative< Sogou
+        Service = 'CpcIdea'
+
+        @map =[
+          [:id,:cpcIdeaId],
+          [:group_id,:cpcGrpId],
+          [:title,:title],
+          [:description1,:description1],
+          [:description2,:description2],
+          [:pc_destination,:visitUrl],
+          [:pc_display,:showUrl],
+          [:moile_destination,:mobileVisitUrl],
+          [:mobile_display,:mobileShowUrl],
+          [:pause,:pause],
+          [:status,:status] 
+        ]
+
+        @status_map = [
+          [:id,:cpcIdeaId],
+          [:status,:status]
+        ]
+
+
+        def self.add( auth, creatives )
+          body = { cpcIdeaTypes: make_type( creatives ) }
+          response = request( auth, Service, 'addCpcIdea', body )
+          process( response, 'cpcIdeaTypes' ){ |x| reverse_type(x) }
+        end
+
+        def self.get( auth, ids,  getTemp = 0 )
+          '''
+          \'getCreativeByCreativeId\'
+          @ input : creative ids
+          @ output: creative informations
+          '''
+          ids = [ ids ] unless ids.is_a? Array
+          body = { cpcIdeaIds: ids, getTemp: getTemp }
+          response = request( auth, Service, 'getCpcIdeaByCpcIdeaId', body )
+          process( response, 'cpcIdeaTypes' ){ |x| reverse_type(x) }
+        end
+
+        def self.update( auth, creatives )
+          '''
+          根据实际使用情况，更新的时候creative title为必填选
+          '''
+          body = { cpcIdeaTypes: make_type( creatives ) }
+          response = request( auth, Service, 'updateCpcIdea', body )
+          process( response, 'cpcIdeaTypes' ){ |x| reverse_type(x) }
+        end
+
+        def self.delete( auth, ids )
+          ids = [ ids ] unless ids.is_a? Array
+          body = { cpcIdeaIds: ids }
+          response = request( auth, Service, 'deleteCpcIdea', body )
+          process( response, '' ){ |x| x }
+        end
+
+        def self.status( auth, ids, getTemp = 0 )
+          ids = [ ids ] unless ids.is_a? Array
+          body = { cpcIdeaIds: ids, getTemp: getTemp }
+          response = request( auth, Service, 'getCpcIdeaByCpcIdeaId', body )
+          process( response, 'cpcIdeaTypes' ){ |x| reverse_type(x, @status_map) }
+        end
+
+        def self.search_id_by_group_id( auth, ids,  getTemp = 0 )
+          '''
+          \'getCreativeIdByAdgroupId\'
+          @ input: group ids
+          @ output:  groupCreativeIds
+          '''
+          ids = [ ids ] unless ids.is_a? Array
+          body = { cpcGrpIds: ids, getTemp: getTemp }
+          response = request( auth, Service, 'getCpcIdeaIdByCpcGrpId', body )
+          process( response, 'cpcGrpIdeaIds' ){ |x| make_groupCreativeIds( x ) }
+        end
+
+        def self.search_by_group_id( auth, ids,  getTemp = 0 )
+          ids = [ ids ] unless ids.is_a? Array
+          body = { cpcGrpIds: ids, getTemp: getTemp }
+          response = request( auth, Service, 'getCpcIdeaByCpcGrpId', body )
+          process( response, 'cpcGrpIdeas' ){ |x| make_groupCreatives( x ) }
+        end
+
+        private
+        def self.make_groupCreativeIds( cpcGrpIdeaIdTypes )
+          cpcGrpIdeaIdTypes = [cpcGrpIdeaIdTypes] unless cpcGrpIdeaIdTypes.is_a? Array
+          group_creative_ids = []
+          cpcGrpIdeaIdTypes.each do |cpcGrpIdeaIdType|
+            group_creative_id = { }
+            group_creative_id[:group_id] = cpcGrpIdeaIdType[:cpc_grp_id]
+            group_creative_id[:creative_ids] = cpcGrpIdeaIdType[:cpc_idea_ids]
+            group_creative_ids << group_creative_id
+          end
+          return group_creative_ids
+        end
+
+        private
+        def self.make_groupCreatives( cpcGrpIdeaTypes )
+          cpcGrpIdeaTypes = [cpcGrpIdeaTypes] unless cpcGrpIdeaTypes.is_a? Array
+          group_creatives = []
+          cpcGrpIdeaTypes.each do |cpcGrpIdeaType|
+            group_creative = {}
+            group_creative[:group_id] = cpcGrpIdeaType[:cpc_grp_id]
+            group_creative[:creatives] = reverse_type( cpcGrpIdeaType[:cpc_idea_types] )
+            group_creatives << group_creative
+          end
+          return group_creatives
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,123 @@
+# -*- 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 )
+          """
+          @return : Array of cpcPlanGrpIdTypes
+          """
+          response = request( auth, Service , "getAllCpcGrpId" )
+          #此处返回值与key与开发文档不同
+          process( response, 'cpcPlanGrpIds' ){ |x| make_planGroupIds( x ) }
+        end
+
+        def self.get( auth, ids )
+          ids = [ ids ] unless ids.is_a? Array
+          body = { cpcGrpIds: ids }
+          response = request(auth, Service, "getCpcGrpByCpcGrpId",body )
+          process( response, 'cpcGrpTypes' ){ |x| reverse_type(x) }
+        end
+
+        def self.add( auth, groups )
+          """
+          @ 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' ){ |x| reverse_type(x) }
+        end
+
+        def self.update( auth, groups )
+          """
+          @ 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' ){ |x| reverse_type(x) }
+        end
+
+        def self.delete( auth, ids )
+          """
+          delete group body has no message
+          """
+          ids = [ ids ] unless ids.is_a? Array
+          body = { cpcGrpIds: ids }
+          response = request( auth, Service,"deleteCpcGrp", body )
+          process( response, '' ){ |x|  x  }
+        end
+
+        def self.search_by_plan_id( auth, ids )
+          ids = [ ids ] unless ids.is_a? Array
+          body = { cpcPlanIds: ids }
+          response = request( auth, Service ,"getCpcGrpByCpcPlanId",  body )
+          # 此处key与开发文档不同
+          process( response, 'cpcPlanGrps' ){ |x| make_planGroups( x ) }
+        end
+
+        def self.search_id_by_plan_id( auth, ids )
+          ids = [ ids ] unless ids.is_a? Array
+          body = { cpcPlanIds: ids }
+          response = request( auth, Service ,"getCpcGrpIdByCpcPlanId",  body )
+          process( response, 'cpcPlanGrpIds' ){ |x| make_planGroupIds( x ) }
+        end
+
+        private
+        def self.make_planGroupIds( cpcPlanGrpIdTypes )
+          """
+          Transfer Sogou API to PPC API
+          Item: cpc_plan_group_ids
+          """
+          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 )
+          """
+          Transfer Sogou API to PPC API
+          """
+          # 多加一行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

@@ -0,0 +1,188 @@
+# -*- coding:utf-8 -*-
+"""
+Todo: Implement Activate Method
+"""
+module PPC
+  module API
+    class Sogou
+      class Keyword< Sogou
+        Service = 'Cpc'
+
+        #Match_type  = { 'exact' => 0, 'wide' => 1,0 => 'exact', 1 => 'wide' } 
+        Match_type  = { 'exact' => 0, 'phrase' => 2, 'wide' => 1,'0' => 'exact', '2' => 'phrase', '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 )
+          '''
+          getCpcByCpcId
+          '''
+          ids = [ ids ] unless ids.is_a? Array
+          body = { cpcIds: ids}
+          response = request( auth, Service, 'getCpcByCpcId', body )
+          process(response, 'cpcTypes'){|x| reverse_type( x ) }
+        end
+
+        def self.add( auth, keywords )
+          '''
+          '''
+          cpcTypes = make_type( keywords ) 
+          body = { cpcTypes: cpcTypes }
+          response = request( auth, Service, "addCpc", body )
+          process(response, 'cpcTypes'){|x| reverse_type(x)  }
+        end
+
+        def self.update( auth, keywords )
+          '''
+          '''
+          cpcTypes = make_type( keywords ) 
+          body = { cpcTypes: cpcTypes }
+          response = request( auth, Service, "updateCpc", body )
+          process(response, 'cpcTypes'){|x| reverse_type(x)  }
+        end
+
+        def self.delete( auth, ids )
+          """
+          """
+          ids = [ ids ] unless ids.is_a? Array
+          body = { cpcIds: ids}
+          response = request( auth, Service, 'deleteCpc', body )
+          process(response, ''){|x| x }
+        end
+
+        def self.search_by_group_id( auth, group_ids )
+          """
+          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'){|x| make_groupKeywords( x ) }
+        end
+
+        def self.search_id_by_group_id( auth, group_ids )
+          group_ids = [ group_ids ] unless group_ids.is_a? Array
+          body = { cpcGrpIds: group_ids }
+          response = request( auth, Service, "getCpcIdByCpcGrpId", body )
+          process(response, 'cpcGrpCpcIds'){|x| make_groupKeywordIds( x ) }
+        end
+
+        # sogou的keyword服务不提供质量度和状态，从getInfo方法中查询
+        def self.status( auth, ids )
+          '''
+          Return [ { id: id, status: status} ... ]
+          '''
+          ids = [ ids ] unless ids.is_a? Array
+          body = { cpcIds: ids}
+          response = request( auth, Service, 'getCpcByCpcId', body )
+          process(response, 'cpcTypes'){  |x|  reverse_type(x, @status_map) }
+        end
+
+        def self.quality( auth ,ids )
+          '''
+          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'){  |x| reverse_type(x, @quality_map) }
+        end
+
+        private
+        def self.make_groupKeywordIds( cpcGrpCpcIdTypes )
+          """
+          Transfer Sogou API to PPC API
+          """
+          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