{"id":26328690,"url":"https://github.com/forward3d/naver-searchad-api","last_synced_at":"2025-10-12T18:44:35.944Z","repository":{"id":52417981,"uuid":"96762385","full_name":"forward3d/naver-searchad-api","owner":"forward3d","description":"Naver searchad API ruby client gem","archived":false,"fork":false,"pushed_at":"2023-01-13T10:08:27.000Z","size":197,"stargazers_count":1,"open_issues_count":5,"forks_count":1,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-10-07T23:59:12.518Z","etag":null,"topics":["naver","naver-searchad","naver-searchad-api","ppc"],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/forward3d.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-07-10T09:55:50.000Z","updated_at":"2022-11-28T13:05:52.000Z","dependencies_parsed_at":"2023-02-09T15:16:03.398Z","dependency_job_id":null,"html_url":"https://github.com/forward3d/naver-searchad-api","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/forward3d/naver-searchad-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/forward3d%2Fnaver-searchad-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/forward3d%2Fnaver-searchad-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/forward3d%2Fnaver-searchad-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/forward3d%2Fnaver-searchad-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/forward3d","download_url":"https://codeload.github.com/forward3d/naver-searchad-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/forward3d%2Fnaver-searchad-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279001778,"owners_count":26083173,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["naver","naver-searchad","naver-searchad-api","ppc"],"created_at":"2025-03-15T21:18:18.264Z","updated_at":"2025-10-12T18:44:35.911Z","avatar_url":"https://github.com/forward3d.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Naver Searchad API\n\nA Client GEM for [Naver Searchad API](http://naver.github.io/searchad-apidoc/#/guides)\n\n## Alpha\n\nThis library is in Alpha. We will make an effort to support the library, but we reserve the right to make incompatible\nchanges when necessary.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'naver-searchad-api'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install naver-searchad-api\n\n## Compatibility\n\nnaver-searchad-api supports the following Ruby implementations:\n\n* MRI 2.0\n* MRI 2.1\n* MRI 2.2\n* MRI 2.3\n\n## Usage\n\n### Basic usage\n\nTo use an API, instantiate the service. For example to use the Campaign API:\n\n```ruby\nrequire 'naver/searchad/api/campaign/service'\nrequire 'naver/searchad/api/auth'\n\nCampaign = Naver::Searchad::Api::Campaign # Alias the module\ncampaign = Campaign::Service.new\ncampaign.authorization = Naver::Searchad::Api::Auth.get_application_default # See Below Authorization\n\n# Read all campaigns (with camelCase response)\ncampaign.list_campaigns(options: { decode_snake_case: false }) do |res, err|\n  puts res\nend\n\n# Read campaigns by ids\ncampaign.list_campaigns_by_ids(['campaign_id_1', 'campaign_id_2']) do |res, err|\n  puts res\nend\n\n# Create a campaign\ncampaign = { ..... }\ncampaign.create_campaign(campaign) do |res, err|\n  puts res\nend\n\n# Delete\ncampaign_id = ... # A campaign id to delete\ncampaign.delete_campaign(campaign_id)\n```\n\n### Naming conventions vs JSON representation\n\nObject properties in the ruby client use the standard ruby convention for naming -- snake_case. This differs from the underlying JSON representation which typically uses camelCase for properties.\n\n\n### Callbacks\n\nA block can be specified when making calls. If present, the block will be called with the result or error, rather than\nreturning the result from the call or raising the error. Example:\n\n```ruby\n# Read a campaign\ncampaign.get_campaign('campaign_id_1') do |res, err|\n  if err\n    # Handle error\n  else\n    # Handle response\n  end\nend\n```\n\n## Authorization\n\n[Naver Searchad API authorization](http://naver.github.io/searchad-apidoc/#/samples) is used to authorize applications.\n\n### Authorization using environment variables\n\nThe [Naver Searchad API Auth](https://github.com/forward3d/naver-searchad-api/blob/master/lib/naver/searchad/api/auth.rb) also supports authorization via\nenvironment variables if you do not want to check in developer credentials\nor private keys. Simply set the following variables for your application:\n\n```sh\nNAVER_API_KEY=\"YOUR NAVER DEVELOPER API KEY\"\nNAVER_API_SECRET=\"YOUR NAVER DEVELOPER API SECRET\"\nNAVER_API_CLIENT_ID=\"YOUR NAVER DEVELOPER CLIENT ID\"\n```\n\n## Logging\n\nThe client includes a `Logger` instance that can be used to capture debugging information.\n\nTo set the logging level for the client:\n\n```ruby\nNaver::Searchad::Api.logger.level = Logger::DEBUG\n```\n\nWhen running in a Rails environment, the client will default to using `::Rails.logger`. If you\nprefer to use a separate logger instance for API calls, this can be changed via one of two ways.\n\nThe first is to provide a new logger instance:\n\n```ruby\nNaver::Searchad::Api.logger = Logger.new(STDERR)\n```\n\n## License\n\nThis library is licensed under Apache 2.0. Full license text is available in [LICENSE](LICENSE).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/forward3d/naver-searchad-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.\n\nWe encourage contributors to follow [Bozhidar's ruby style guide](https://github.com/bbatsov/ruby-style-guide) in this project.\n\nPull requests (with tests) are appreciated. Please help with:\n\n* Reporting bugs\n* Suggesting features\n* Writing or improving documentation\n* Fixing typos\n* Cleaning whitespace\n* Refactoring code\n* Adding tests\n\nIf you report a bug and don't include a fix, please include a failing test.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fforward3d%2Fnaver-searchad-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fforward3d%2Fnaver-searchad-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fforward3d%2Fnaver-searchad-api/lists"}