diff --git a/src/docs/asciidoc/check-is-possible-admob.adoc b/src/docs/asciidoc/check-is-possible-admob.adoc new file mode 100644 index 00000000..9d508af8 --- /dev/null +++ b/src/docs/asciidoc/check-is-possible-admob.adoc @@ -0,0 +1,52 @@ +:reproducible: +== 상점에서 보상형 광고 가능한지 여부 (명세) + +=== 요청 + +[http,json] +---- +GET /api/v1/admob/{tag} HTTP/1.1 +Authorization: Bearer your-access-token +Content-Type: application/json +---- + +=== 요청 파라미터 + +---- +tag -> shop +---- +* 보상형 광고 다른곳에서 사용할 수도 있으므로 tag로 어떤 곳에서 사용하고 있는곳인지 tag로 명시 +* 현재는 상점 -> shop에서만 보상형 광고 진행 + +=== 응답 + +[http,json] +---- +HTTP/1.1 200 OK +Vary: Origin +Vary: Access-Control-Request-Method +Vary: Access-Control-Request-Headers +Content-Type: application/json +{ + "status" : 200, + "message" : "광고 보고 포인트 얻기 가능 여부 조회에 성공했습니다.", + "data": { + "createdAt": "2024-01-01 12:00:00", + "isPossible" : true, + } +} +---- + + +=== NOTE + +- Header에 무작위한 UUID4 값을 넣어주세요 +* 예시) IdempotencyKey: 0397b5f3-ecdc-47d6-b5d7-2b1afcf00e87 +- 주의사항 +* 같은 멱등성키를 2번 요청하면, 400번 에러. +- ADMOB +* ADMOB 서버에 SSV(ServerSideVerification) Options의 customData에 입력한 것과 동일한 멱등성 키를 넘겨주세요. + +=== CHANGELOG + +- 2024.02.16 명세서 작성 \ No newline at end of file diff --git a/src/docs/asciidoc/index.adoc b/src/docs/asciidoc/index.adoc index eb3d84b5..20168055 100644 --- a/src/docs/asciidoc/index.adoc +++ b/src/docs/asciidoc/index.adoc @@ -116,4 +116,6 @@ * 🆕 link:reward-event.html[이벤트 보상, 2024-02-07] -* 🆕 link:reward-admob.html[광고보고 보상 얻기, 2024-02-11] \ No newline at end of file +* 🆕 link:reward-admob.html[광고보고 보상 얻기, 2024-02-11] + +* 🆕 link:check-is-possible-admob.adoc[광고보고 보상 얻기 가능 여부 조회, 2024-02-16 (명세)] \ No newline at end of file diff --git a/src/main/resources/static/docs/check-is-possible-admob.html b/src/main/resources/static/docs/check-is-possible-admob.html new file mode 100644 index 00000000..dd8b368b --- /dev/null +++ b/src/main/resources/static/docs/check-is-possible-admob.html @@ -0,0 +1,550 @@ + + + + + + + +상점에서 보상형 광고 가능한지 여부 (명세) + + + + + +
+
+

상점에서 보상형 광고 가능한지 여부 (명세)

+
+
+

요청

+
+
+
GET /api/v1/admob/{tag} HTTP/1.1
+Authorization: Bearer your-access-token
+Content-Type: application/json
+
+
+
+
+

요청 파라미터

+
+
+
tag -> shop
+
+
+
+
    +
  • +

    보상형 광고 다른곳에서 사용할 수도 있으므로 tag로 어떤 곳에서 사용하고 있는곳인지 tag로 명시

    +
  • +
  • +

    현재는 상점 → shop에서만 보상형 광고 진행

    +
  • +
+
+
+
+

응답

+
+
+
HTTP/1.1 200 OK
+Vary: Origin
+Vary: Access-Control-Request-Method
+Vary: Access-Control-Request-Headers
+Content-Type: application/json
+{
+  "status" : 200,
+  "message" : "광고 보고 포인트 얻기 가능 여부 조회에 성공했습니다.",
+  "data": {
+    "createdAt": "2024-01-01 12:00:00",
+    "isPossible" : true,
+  }
+}
+
+
+
+
+

NOTE

+
+
    +
  • +

    Header에 무작위한 UUID4 값을 넣어주세요

    +
    +
      +
    • +

      예시) IdempotencyKey: 0397b5f3-ecdc-47d6-b5d7-2b1afcf00e87

      +
    • +
    +
    +
  • +
  • +

    주의사항

    +
    +
      +
    • +

      같은 멱등성키를 2번 요청하면, 400번 에러.

      +
    • +
    +
    +
  • +
  • +

    ADMOB

    +
    +
      +
    • +

      ADMOB 서버에 SSV(ServerSideVerification) Options의 customData에 입력한 것과 동일한 멱등성 키를 넘겨주세요.

      +
    • +
    +
    +
  • +
+
+
+
+

CHANGELOG

+
+
    +
  • +

    2024.02.16 명세서 작성

    +
  • +
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/find-event.html b/src/main/resources/static/docs/find-event.html index 0e5d5edc..292228db 100644 --- a/src/main/resources/static/docs/find-event.html +++ b/src/main/resources/static/docs/find-event.html @@ -499,7 +499,7 @@

응답

} ] } }, { - "tag" : "ADMOB", + "tag" : "ADMOB_POINT", "startDate" : "2024-01-01T00:00:00+09:00", "endDate" : "2024-12-31T00:00:00+09:00", "title" : "ADMOB 광고입니다.", @@ -568,7 +568,7 @@

응답

} ] } }, { - "tag" : "ADMOB", + "tag" : "ADMOB_POINT", "startDate" : "2024-01-01T00:00:00+09:00", "endDate" : "2024-12-31T00:00:00+09:00", "title" : "ADMOB 광고입니다.", @@ -616,7 +616,7 @@

응답

} ], "eventReward" : null }, { - "tag" : "ADMOB", + "tag" : "ADMOB_POINT", "startDate" : "2024-01-01T00:00:00+09:00", "endDate" : "2024-12-31T00:00:00+09:00", "title" : "ADMOB 광고입니다.",