기기

Capgo은 기기별 업데이터 메타데이터를 보고합니다. 이 API을 사용하여 메타데이터를 가져오거나 기기별 private 채널 override를 설정하고 제거합니다.

데이터 보존

기기 데이터는 90일 기기 활동의 마지막부터. 기기는 업데이터를 설치할 필요가 없습니다: 업데이터 및 통계 확인은 메타데이터를 갱신할 수 있습니다.

기기 메타데이터

각 레코드에는 기기 ID, 플랫폼, 업데이터 및 OS 버전, 네이티브 빌드, 설치된 번들, 프로덕션 및 에뮬레이터 상태, 커스텀 ID 및 채널 override가 포함될 수 있습니다.

사용 가능한 경우 country_code code은 기기에서 Cloudflare-처리된 요청에서 받은 최신 유효한 두 개의 문자 ISO 3166-1 국가 코드입니다. GPS 또는 앱에서 제공하는 위치 값이 아닙니다. 사용할 수 없을 때는 단일 기기 조회를 사용하세요. null When unavailable; use a single-device lookup when you need this field.

__CAPGO_KEEP_0__

__CAPGO_KEEP_2__

https://api.capgo.app/device/

__CAPGO_KEEP_4__ __CAPGO_KEEP_5__ __CAPGO_KEEP_6__ __CAPGO_KEEP_7__ __CAPGO_KEEP_8__

__CAPGO_KEEP_9__

interface DeviceChannelOverride {
  app_id: string; // reverse-domain app ID, for example com.example.app
  device_id: string;
  channel: string; // existing non-public channel name
}

__CAPGO_KEEP_12__

curl -X POST \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "com.example.app",
    "device_id": "device_456",
    "channel": "beta"
  }' \
  https://api.capgo.app/device/

공개 채널은 장치 오버라이드로 사용할 수 없습니다.

성공 응답

{
  "status": "ok"
}

GET

https://api.capgo.app/device/

장치 메타데이터를 가져옵니다. 결과는 커서 페이지네이션을 사용할 때 생략됩니다. device_id.

쿼리 매개변수

• app_id: 필요 한 역 도메인 앱 ID, 예를 들어 com.example.app.
• device_id: __CAPGO_KEEP_0__ ID. __CAPGO_KEEP_0__ 있을 때, 응답은 단일 기기 rather than 페이징 목록입니다.
• customIdMode: __CAPGO_KEEP_0__ boolean. __CAPGO_KEEP_1__을 설정하여 __CAPGO_KEEP_2__이 비어 있지 않은 기기만 반환합니다. true : __CAPGO_KEEP_0__ 이전 목록 응답에서 __CAPGO_KEEP_3__입니다. custom_id.
• cursor: __CAPGO_KEEP_0__ 페이지당 기기 수입니다.
• limit예제 요청

제목: 예제 요청

# Get the first page
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/device/?app_id=com.example.app"

# Get one device, including its request-derived country when available
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/device/?app_id=com.example.app&device_id=device_456"

# Get only devices with a custom ID
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/device/?app_id=com.example.app&customIdMode=true"

# Get the next page
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/device/?app_id=com.example.app&cursor=2024-01-01T00:00:00Z%7Cdevice_456"

제목: 응답 유형

interface DeviceListResponse {
  data: Device[];
  nextCursor?: string;
  hasMore: boolean;
}

interface Device {
  updated_at: string;
  device_id: string;
  custom_id: string;
  version?: number;
  version_name: string | null;
  channel?: string;
  app_id: string;
  platform: "ios" | "android" | "electron";
  plugin_version: string;
  os_version: string;
  version_build: string;
  is_prod: boolean;
  is_emulator: boolean;
  key_id: string | null;
  install_source: string | null;
  country_code: string | null;
}

country_code Capgo에 저장된 유효한 Cloudflare-유도된 국가 code가 있는 경우, Capgo는 기기별로 조회됩니다. 유효한 국가가 없는 요청은 마지막 유효한 값을 지우지 않으며, 목록 응답은 null 이 필드에 대한 설명입니다.

예시 응답 (목록)

{
  "data": [
    {
      "device_id": "device_456",
      "custom_id": "test-device-1",
      "version": 1,
      "version_name": "1.0.0",
      "app_id": "com.example.app",
      "platform": "ios",
      "plugin_version": "5.0.0",
      "os_version": "17.0",
      "version_build": "1",
      "is_prod": true,
      "is_emulator": false,
      "key_id": null,
      "install_source": null,
      "country_code": null,
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "2024-01-01T00:00:00Z|device_456",
  "hasMore": true
}

예시 응답 (단일 기기)

{
  "device_id": "device_456",
  "custom_id": "test-device-1",
  "version": 1,
  "version_name": "1.0.0",
  "app_id": "com.example.app",
  "platform": "ios",
  "plugin_version": "5.0.0",
  "os_version": "17.0",
  "version_build": "1",
  "is_prod": true,
  "is_emulator": false,
  "key_id": "MIIB",
  "install_source": null,
  "country_code": "FR",
  "updated_at": "2024-01-01T00:00:00Z",
  "channel": "beta"
}

DELETE

https://api.capgo.app/device/

기기의 채널 오버라이드를 삭제합니다. 기기는 다시 정상 채널 선택을 사용하게 되며, 이 엔드포인트는 메타데이터 기록을 삭제하지 않습니다.

요청 본문 또는 쿼리 매개변수

interface DeviceOverrideRemoval {
  app_id: string;
  device_id: string;
}

예제 요청

curl -X DELETE \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "com.example.app",
    "device_id": "device_456"
  }' \
  https://api.capgo.app/device/

성공 응답

{
  "status": "ok"
}

오류

오류는 HTTP 오류 상태와 JSON 본문과 error 및 field. 일반 오류 코드는 다음과 같습니다. message when

• invalid_app_id 이름이 역 도메인 식별자가 아닌 경우. app_id 알 수 없는 장치 검색을 위해.
• device_not_found 요청된 채널이 존재하지 않을 때.
• channel_not_found 공개 채널로 장치 override 시도할 때.
• public_channel_override 직접 번들 override 시도; 채널을 사용하세요.
• invalid_version_id 또는
• cannot_access_app __CAPGO_KEEP_0__ 키가 필요한 권한이 없을 때. cannot_access_channel when the API key lacks the required permission.

제목이 '일반적인 사용 사례'인 섹션

1. __CAPGO_KEEP_0__을 개인 베타 채널로 이동하세요.

   {
     "app_id": "com.example.app",
     "device_id": "device_456",
     "channel": "beta"
   }

2. __CAPGO_KEEP_0__을 일반 채널 선택으로 초기화하세요.

   __CAPGO_KEEP_2__와 __CAPGO_KEEP_3__ ID를 사용하여 엔드포인트를 사용하세요. DELETE __CAPGO_KEEP_0__에서 계속하세요.

__CAPGO_KEEP_0__에서 계속하세요.

__CAPGO_KEEP_5__에서 채널 구현 세부 사항을 확인하세요. __CAPGO_KEEP_4__을 사용하여 채널 라우팅과 스테이지드 롤아웃을 계획하세요. __CAPGO_KEEP_5__ __CAPGO_KEEP_6__ __CAPGO_KEEP_4__과 __CAPGO_KEEP_5__을 연결하세요. 채널 채널 구현 세부 정보에 대해 채널 채널 구현 세부 정보에 대해 베타 테스트 솔루션 베타 테스트 솔루션의 제품 워크플로에 대해 버전 대상 솔루션 버전 대상 솔루션의 제품 워크플로에 대해