広告主セグメントAPIガイド

本ドキュメントでは、ユーザー再契約キャンペーン時、リターゲティング向けとしてネガティブ ターゲティングを目的とするInMobiのセグメントAPIエンドポイントの使用法について説明します。

注意:本ドキュメントは、InMobiにセグメント データを直接提供する広告主を対象にしています。

セグメント エンドポイント

これは、アプリ内のアクティビティに基づいて、ユーザーを様々なセグメントに区分したい広告主に役立ちます。例えば、30日間以上アプリを開いていないユーザーは休止ユーザー、また購入が多いユーザーはハイバリュー ユーザーとしてタグ付けが可能な場合があります。

注意:ユーザーは、2つのセグメントのタグ付けが可能です。

このプロセスには、セグメントの作成、セグメントの削除、セグメントからユーザーの追加と削除の3つの要素があります。

セグメントの作成

このAPIを使用してセグメントを作成します。

送信パラメータ

パラメータ

タイプ

必須?

説明

propertyId

文字列

はい

InMobiで登録されるプロパティID。InMobiのプロパティの登録の詳細については、こちらをクリックします。

segmentName

文字列

はい

セグメント名(独自のプロパティID)、独自の小文字チェックが適用、最大2,000のutf-8文字

送信フォーマット

取得メソッド

URLフォーマット:
http://advertiser.inmobiapis.com/tpce/v1/segment?propertyId=&segmentName=

例:
http://advertiser.inmobiapis.com/tpce/v1/segment?propertyId=12345&segmentName=highpayingusers

JSONレスポンス

成功JSONレスポンス:

{<br />"status":"OK",<br />"message":"success",<br />"code":200,<br />"segmentId":xxxx<br />}

失敗JSONレスポンス:

{<br />"status":"error_status",<br />"message":"error_message",<br />"code":error_code,<br />"segmentId":-1<br />}

注意:SegmentIDは、成功の場合は正の長い値、負の場合は-1

セグメントの削除

このAPIを使用してセグメントを削除します。

送信パラメータ

パラメータ

タイプ

必須?

説明

propertyId

文字列

はい

InMobiで登録されるプロパティID。InMobiのプロパティの登録の詳細については、こちらをクリックします。

segmentId

文字列

はい

セグメントの作成時InMobiによって返されるセグメントID。

送信フォーマット

削除メソッド

URLフォーマット:
http://advertiser.inmobiapis.com/tpce/v1/segment?propertyId=&segmentId=

例:
http://advertiser.inmobiapis.com/tpce/v1/segment?propertyId=12345&segmentId=56789

JSONレスポンス

成功JSONレスポンス:

{<br /> "status":"OK",<br /> "message":"success",<br /> "code":200,<br /> }

失敗JSONレスポンス:

{<br /> "status":"error_status",<br /> "message":"error_message",<br /> "code":error_code,<br /> }

セグメントからユーザーの追加と削除

このAPIを使用して、セグメントからユーザーの追加と削除を行います。

注意:ユーザーをセグメントにタグ付けする前に、インストール エンドポイント上のユーザーのアプリのインストールについてInMobiに通知してください。

送信パラメータ

次のパラメータを送信します。

パラメータ

必須?

説明

propertyId

はい

InMobiで登録されるプロパティID。InMobiのプロパティの登録の詳細については、こちらをクリックします。

segmentIds<br />

はい

ユーザーが存在するセグメントID(セミコロン区切り)のリスト。

u-id-map

はい

デバイスIDセクションでガイドラインに付随するデバイスID。

  • idaは、iOSに必須です。
  • Androidでは、gpIdum5またはo1が必須です。

action

はい

可能な値は、adddeletereplace です。これらは、所定のプロパティおよびセグメントIDのユーザー向けに行われるアクションです。このプロパティを次のように使用します。

  • ユーザーをセグメントにadd
  • ユーザーをセグメントからdelete
  • または、古いユーザーのセグメントを新しいセグメントのリストとreplace

送信フォーマット

任意の時間の単一ユーザー: 取得メソッド

URLフォーマット:
http://advertiser.inmobiapis.com/tpce/v1/usersegment?propertyId=&o1=&um5=&gpId=&ida=&idv=&segmentIds={1;2;3}&action=add

注意:

  • デバイスIDは、クエリー パラメータで別個に送信されます。
  • ダブル クォートは、パラメータでは不要です。
  • セグメントIDを、中括弧内でセミコロンで区切る必要があります。

JSONレスポンス

成功JSONレスポンス:

{<br />"status":"OK",<br />"message":"success",<br />"code":200<br />}

失敗JSONレスポンス:

{<br />"status":”error_status”,<br />"message":"error_message",<br />"code":error_code<br />}
任意の時間の複数ユーザー: マルチパート ファイルのアップロード

ここで広告主は、CSVフォーマットで10 MB以内のバルク セグメント データを送信することができます。ファイルは圧縮する必要があります。

注意:CSVファイルは、以下の定義されたシーケンスで次のヘディングを持つ必要があります。

propertyId, o1, um5, gpId, ida, idv, segmentIds, action

注意:

  • ヘディングがこのシーケンスに従わない場合は、エラーが返されます。
  • ある特定のデバイスIDが利用可能でない場合は、そのコラムに対応する値は空白になります。
  • segmentIdコラムは、セグメントIDのセミコロン区切りのリストからできています。

例:
"12345","40bd001563085fc35165329ea1ff5c5ecbdbbeef","202cb962ac59075b964b07152d234b70",””,"","","{1;2;3}","add"

マルチパート ファイルのアップロードのリクエスト構造については、以下を参照してください。

リクエスト構造

詳細

ポストURL

http://advertiser-content.inmobiapis.com/tpce/v1/upload/usersegment

ヘッダ

  • コンテンツ タイプ:マルチパート/フォーム - データ
  • 許可-エンコード:gzip
  • コンテンツ - 処理:添付; ファイル名="xyzfilename"
  • コンテンツ - 長さ:33
  • コンテンツ - タイプ:text/csv
  • コンテンツ - 転送-エンコード:バイナリ

パート ボディ

添付ファイル ストリーム

JSONレスポンス

{<br />"status":"OK",<br />"message":"success_message xxxxxx ",<br />"code":200,<br />"jobUrl":"job url to check status of file upload"<br />}

注意:JobUrlは、ジョブの成功、失敗、または進行中を示すJSONレスポンスを行います。

デバイスIDガイドライン

iOS

パラメータ名

パラメータ タイプ

説明

ida

文字列

ハッシュなしの広告主IDです。iOS 6以降のみです。詳細な情報については、こちらをクリックしてください。

idv

文字列

ハッシュなしのベンダー用 ID です。iOS 6 以降のみです。詳細な情報については、こちらをクリックしてください。

アンドロイド

パラメータ名

パラメータ タイプ

説明

gpId

文字列

ハッシュなしのGoogle Play広告主ID。詳細に関しては、こちらを参照してください。

o1

文字列

SHA1 / Android_ID

um5

文字列

MD5 / Android_ID