Class: PPC::API::Sm::Keyword

Inherits:
PPC::API::Sm show all
Defined in:
lib/ppc/api/sm/keyword.rb

Constant Summary collapse

Service = 
'keyword'
Match_type = 
{ 'exact' => 0, 'phrase' => 1, 'wide' => 2, 0 => 'exact', 1 => 'phrase' , 2 => 'wide'  }

Class Method Summary collapse

Methods inherited from PPC::API::Sm

process, request_uri

Methods included from PPC::API

#debug_off, #debug_on, #is_no_quota, #make_type, #process, #request, #request_http_body, #request_http_header, #request_uri, #reverse_type

Class Method Details

.add(auth, keywords) ⇒ Object 



28
29
30
31
32
33
 
# File 'lib/ppc/api/sm/keyword.rb', line 28

def self.add(auth, keywords)
  keyword_types = make_type(keywords) 
  body = {keywordTypes: keyword_types}
  response = request(auth, Service, "addKeyword", body)
  return process(response, 'keywordTypes'){|x| reverse_type(x)}
end

.delete(auth, ids) ⇒ Object 



42
43
44
45
46
47
 
# File 'lib/ppc/api/sm/keyword.rb', line 42

def self.delete(auth, ids)
  ids = [ids] unless ids.is_a? Array
  body = {keywordIds: ids}
  response = request(auth, Service, 'deleteKeyword', body, 'delete')
  return process(response, 'result'){|x| x }
end

.get(auth, ids) ⇒ Object 



21
22
23
24
25
26
 
# File 'lib/ppc/api/sm/keyword.rb', line 21

def self.get(auth, ids)
  ids = [ids] unless ids.is_a? Array
  body = {keywordIds: ids}
  response = request(auth, Service, 'getKeywordByKeywordId', body)
  return process(response, 'keywordTypes'){|x| reverse_type(x)}
end

.search_by_group_id(auth, group_ids) ⇒ Object 



49
50
51
52
53
54
 
# File 'lib/ppc/api/sm/keyword.rb', line 49

def self.search_by_group_id(auth, group_ids)
  group_ids = [group_ids] unless group_ids.is_a? Array
  body = {adgroupIds: group_ids}
  response = request(auth, Service, "getKeywordByAdgroupId", body)
  return process(response, 'groupKeywords'){|x| make_groupKeywords(x)}
end

.search_id_by_group_id(auth, group_ids) ⇒ Object 



56
57
58
59
60
61
 
# File 'lib/ppc/api/sm/keyword.rb', line 56

def self.search_id_by_group_id(auth, group_ids)
  group_ids = [group_ids] unless group_ids.is_a? Array
  body = {adgroupIds: group_ids}
  response = request(auth, Service, "getKeywordIdByAdgroupId", body)
  return process(response, 'groupKeywordIds'){|x| make_groupKeywordIds(x)}
end

.update(auth, keywords) ⇒ Object 



35
36
37
38
39
40
 
# File 'lib/ppc/api/sm/keyword.rb', line 35

def self.update(auth, keywords)
  keyword_types = make_type(keywords) 
  body = {keywordTypes: keyword_types}
  response = request(auth, Service, "updateKeyword", body)
  return process(response, 'keywordTypes'){|x| reverse_type(x)}
end