PipedriveからAPI経由でデータを取得する

この記事は

• PipedriveというシンプルなSFA/CRMからAPI経由で取引情報を取得した際のメモです

手順

• rubyでアクセスします
• pipedrive-rubyというgemを使います

gemインストール

• 普通に入れます

$ gem install pipedrive-ruby

アクセス

• Pipedriveの画面からAPI用のトークンを取得しておきます
• READMEには記載がないですが、allというメソッドで全件取得ができます

require 'pipedrive-ruby'

token = 'xxxxx'
Pipedrive.authenticate(token)
deals = Pipedrive::Deal.all

p deals

• 取得されるデータは下記のような感じです

#<Pipedrive::Deal
  id=6,
  public_id=473900,
  creator_user_id={
    "id"=>3271440,
    "name"=>"Shota Onishi",
    "email"=>"[e-mail]",
    "has_pic"=>false,
    "pic_hash"=>nil,
    "active_flag"=>true,
    "value"=>3271440
  },
  user_id={
    "id"=>3271440,
    "name"=>"Shota Onishi",
    "email"=>"[e-mail]",
    "has_pic"=>false,
    "pic_hash"=>nil,
    "active_flag"=>true,
    "value"=>3271440
  },
  person_id=nil,
  org_id={
    "name"=>"Locus",
    "people_count"=>0,
    "owner_id"=>3271440,
    "address"=>nil,
    "cc_email"=>"[e-mail]",
    "value"=>6
  },
  stage_id=2,
  title="Locus",
  value=50000000,
  currency="JPY",
  add_time="2017-11-21 04:55:55",
  update_time="2017-11-21 04:55:55",
  stage_change_time=nil,
  active=true,
  deleted=false,
  status="open",
  probability=nil,
  next_activity_date=nil,
  next_activity_time=nil,
  next_activity_id=nil,
  last_activity_id=nil,
  last_activity_date=nil,
  lost_reason=nil,
  visible_to="3",
  close_time=nil,
  pipeline_id=1,
  won_time=nil,
  first_won_time=nil,
  lost_time=nil,
  products_count=0,
  files_count=0,
  notes_count=0,
  followers_count=1,
  email_messages_count=0,
  activities_count=0,
  done_activities_count=0,
  undone_activities_count=0,
  reference_activities_count=0,
  participants_count=0,
  expected_close_date=nil,
  last_incoming_mail_time=nil,
  last_outgoing_mail_time=nil,
  cdca78a0b34a7869c0613f4045415ae9442ead3b=nil,
  df828efb37075639ec488d899cafe47b7bf7dd21=nil,
  stage_order_nr=2,
  person_name=nil,
  org_name="Locus",
  next_activity_subject=nil,
  next_activity_type=nil,
  next_activity_duration=nil,
  next_activity_note=nil,
  formatted_value="￥50,000,000",
  rotten_time=nil,
  weighted_value=50000000,
  formatted_weighted_value="￥50,000,000",
  owner_name="Shota Onishi",
  cc_email="[e-mail]",
  org_hidden=false,
  person_hidden=false>

• cdca78a0b34a7869c0613f4045415ae9442ead3bとかdf828efb37075639ec488d899cafe47b7bf7dd21みたいな謎ハッシュ値の属性がありますが、これはカスタム項目みたいです
• カスタム項目を追加する時に発行されているIDのようなので、人によって異なるっぽいですね