GithubHelp home page GithubHelp logo

boudra / zuck Goto Github PK

View Code? Open in Web Editor NEW
14.0 4.0 4.0 12 KB

Facebook Graph API wrapper for Elixir

License: MIT License

Elixir 100.00%
facebook-api facebook-graph-api elixir facebook-ads facebook

zuck's Introduction

Zuck

Installation

The package can be installed by adding zuck to your list of dependencies in mix.exs:

def deps do
  [{:zuck, git: "https://github.com/boudra/zuck.git"}}]
end

Configuration

config :zuck, 
  app_id: "",
  app_secret: "",
  log: true,
  debug: true,
  version: "v2.9",
  endpoint: "https://graph.facebook.com/",
  http: [] # these will be passed to hackney

Roadmap

  • Batch requests
  • Real time updates
  • Facebook messenger

Usage

Basic example

{:ok, user} = Zuck.get("/me", %{
  access_token: "TOKEN",
  fields: "name,email"
})

Pagination trough streams

You can use the stream helpers to handle multipage data, very useful when getting ad insights or large lists of data, the stream will handle the cursor and make the necesary requests for you:

Zuck.get_stream("/act_ACCOUNT_ID/insights", %{
  access_token: "TOKEN",
  level: "ad",
  date_preset: "yesterday",
  fields: "ad_name"
})
|> Enum.map(fn ad -> ad.ad_name end)

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/zuck.

zuck's People

Contributors

boudra avatar darrhiggs avatar gravityblast avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.