README

为Laravel 5.*提供的一个简单房屋广告/交叉推广API。这个包是由Sweaty Chair Studio的房屋广告解决方案开发而来，为玩家提供插页式房屋广告图片。这包括获取当前房屋广告的API以及一个（即将推出）简单的网页控制台来创建和编辑房屋广告。此包旨在成为一个即插即用解决方案，以便在您的应用中提供自己的房屋广告，跨推广其他应用，或者简单地显示正在进行的活动。

所有当前房屋广告都会反馈给客户端，客户端可以选择显示一个，或者逐个显示它们。这取决于您想要的方式以及您如何设置客户端。在我们的案例中，我们希望每次客户端应用启动时只显示一个房屋广告，如果有多个要显示，则显示优先级最高的一个。点击过的房屋广告（成功重定向）将不再显示。所有这些都可以在数据库中设置，因此您可以根据客户端使用。

您可以用它来显示静态图像或视频，以插页式或在应用内UI框中显示，这完全取决于您在客户端中的设置，但这超出了本包的范围，但API设置应该涵盖了客户端的大多数情况。

网页控制台在待办事项列表中。同时，您需要手动将房屋广告添加到数据库中。

详细步骤请参考这里。

目录

• 安装
• 配置
• 使用
  • 房屋广告表
  • API URL
  • Unity客户端存储库
• 待办事项
• 许可证

安装

通过Composer安装此包

$ composer require furic/house-ads

如果您正在使用Laravel 5.5或更高版本，则安装已完成。否则，请按照以下步骤操作。

打开config/app.php并按照以下步骤操作

找到providers数组并添加我们的服务提供者。

'providers' => [
    // ...
    Furic\HouseAds\HouseAdsServiceProvider::class
],

配置

要创建数据库中的兑换码表，请运行

$ php artisan migrate

使用

房屋广告表

| Name            | Type      | Not Null |
|-----------------|-----------|----------|
| id              | integer   |     ✓    |
| game_id         | integer   |     ✓    |
| media_portrait  | varchar   |          |
| media_landscape | varchar   |          |
| open_url        | tinyint   |     ✓    |
| url_ios         | varchar   |          |
| url_android     | varchar   |          |
| repeat_count    | tinyint   |     ✓    |
| priority        | tinyint   |     ✓    |
| start_at        | date      |     ✓    |
| end_at          | date      |     ✓    |
| confirmed_count | mediumint |     ✓    |
| cancelled_count | mediumint |     ✓    |
| created_at      | datetime  |          |
| updated_at      | datetime  |          |

• 游戏ID：此房屋广告重定向到的游戏/应用。这用于客户端应用以区分并不显示其自己的房屋广告。
• 肖像媒体：肖像图像/视频文件名。媒体应该已上传并存储在<服务器根目录>/media文件夹中。您还可以使用视频并在客户端应用中实现播放功能。
• 景观媒体：景观图片/视频的文件名。
• 打开URL：是否应打开房屋广告的URL，否则客户端只需显示图片/视频。这主要用于显示事件媒体。
• iOS URL：在iOS设备上打开的URL。
• Android URL：在Android设备上打开的URL。
• 重复计数：等待多少次应用启动后再次显示此广告，仅适用于插页式弹出广告。
• 优先级：在单个应用启动中显示最高优先级的广告。
• 开始时间：此房屋广告开始日期，用于安排未来的房屋广告。
• 结束时间：此房屋广告结束日期，用于在给定时间段内结束促销。
• 显示计数：显示计数，仅用于分析。
• 确认计数：确认计数（成功重定向），仅用于分析。
• 取消计数：取消计数（失败重定向），仅用于分析。

API URL

GET <服务器URL>/api/house-ads 返回包含所有有效房屋广告的JSON数组。

GET <服务器URL>/api/house-ads/{id} 返回包含给定ID的房屋广告的JSON数据，仅用于调试目的。

PUT <服务器URL>/api/house-ads/{id} 更新房屋广告的显示、点击或取消计数。

API文档可以在此处找到。

Unity客户端存储库

您可以直接将此存储库导入Unity，使用此包与Laravel服务器进行通信：<待添加>

待办事项

• 创建Web控制台以添加/编辑房屋广告和上传媒体。
• 为Web控制台添加管理员登录。
• 添加测试和工厂。

许可证

laravel-house-ads遵循MIT许可证。