리포트 API 베스트 프랙티스

API 엔드포인트

https://api.tapjoy.com/graphql

API와의 통신

POST /graphqlHost: api.tapjoy.comAuthorization: Bearer <OAuth Token>{  "query": "query { user { firstName } }"}

curl -H "Authorization: Bearer <OAuth Token>" -X POST -d "\\{  \"query\": \"query { user { firstName } }\"\}\" https://api.tapjoy.com/graphql

Ruby
require 'json'require 'net/https'access_token = "<OAuth Token>"query = <<~ENDquery {  user {    firstName  }}ENDjson = JSON.dump({query: query})http = Net::HTTP.new('api.tapjoy.com', 443)http.use_ssl = truerequest = Net::HTTP::Post.new('/graphql')request['Authorization'] = "Bearer #{access_token}"request.body = jsonresponse = http.request(request)result = JSON.parse(response.body)data = result['data']errors = result['errors']

오류 처리

• 서버/네트워크 오류
• 인증/권한 부여 오류
• 쿼리 구문 오류
• 데이터 유효성 검사 오류

query {  user {    firstName    lastName  }}

서버 및 네트워크 오류

인증 및 권한 부여 오류

• OAuth 토큰이 만료됨
• OAuth 토큰이 유효하지 않음
• 기본 인증 시스템에 문제가 발생하고 있음

{  "errors": [    {      "message": "Authentication could not be verified. Please try again later.",      "code": 403    }  ]}

• message

  - 사람이 이해할 수 있는 오류에 대한 설명

• code

  - HTTP 상태 코드에 대응하는 GraphQL 상태 코드

쿼리 구문 오류

{  "errors": [    {      "message": "Field 'user' doesn't exist on type 'Query'",      "locations": [        {          "line": 2,          "column": 3        }      ],      "fields": [        "query",        "user"      ]    }  ]}

• message

  - 사람이 이해할 수 있는 오류에 대한 설명

• locations

  - 구문 오류의 위치

• fields

  - 구문 오류에 영향을 받는 필드

데이터 유효성 검사 오류

mutation {  updateAdSet(input: {    id: "00000000-0000-0000-0000-000000000000",    bidding: {amount: 10000}  }) {    adSet {      id    }  }}

{  "data": {    "updateAdSet": null  },  "errors": [    {      "message": "Amount is below the minimum (20000 micros)",      "locations": [        {          "line": 2,          "column": 3        }      ],      "path": [        "updateAdSet",        "input",        "bidding",        "amount"      ],      "code": 422    }  ]}

• message

  - 사람이 이해할 수 있는 오류에 대한 설명

• locations

  - 유효성 검사 오류의 위치

• path

  - 잘못된 것으로 판단된 필드에 대한 완전한 참조

• code

  - HTTP 상태 코드에 대응하는 GraphQL 상태 코드

제한

데이터 보관

페이지 매김

• first

  또는

  last

  인수 제공
• 단일 페이지에 100개 노드를 초과하지 않음

{  advertiser {    adSets(first: 50) {      edges {        node {          id          name          ads(first: 50) {            edges {              node {                id                name              }            }          }        }      }    }  }}

after

before

{  advertiser {    adSets(first: 50, after: "Mg==") {      edges {        node {          id          name        }      }      pageInfo {        endCursor        hasNextPage      }    }  }}

호출 복잡도

{  advertiser {    adSets(first: 50) {     # <= 50 calls      edges {        node {          id          name          ads(first: 50) {  # <= 50 calls            edges {              node {                id                name              }            }          }        }      }    }  }}

50      = 50 ad sets+50 x 50 = 2500 ads        = 2550 calls

인사이트 복잡도

{  advertiser {    # 50 calls    adSets(first: 50) {      edges {        node {          id          name          # 7 calls          insights(timeRange: {from: "2024-03-01T00:00:00Z", until: "2024-03-08T00:00:00Z"}) {            timestamps            reports {              country              impressions              conversions              spend            }          }        }      }    }  }}

50      = 50 ad sets+50 x 7  = 350 insights        = 400 calls