Enterprise APIs

API データのインポートとエクスポートへのアクセス

pyzeにデータをインポートしたりエクスポートしたりするには、いくつかの公開・非公開の方法があります。利用可能なバルクおよびストリーミングデータAPIの全スイートへのフルアクセスについては、アカウントマネージャにお問い合わせください。

ユーザーのプロフィール

User Profiles APIを使用すると、バックエンドやその他の外部システムから取得したユーザーに関するデータを追加することができます。

User ProfilesアップロードAPIエンドポイントとクレデンシャルは、Pyzeアカウントマネージャから取得することができます。このドキュメントでは、https://import.pyze.com/users/profile を例として説明します。

ユーザープロファイルの属性オブジェクトの仕様

この API を使用して、指定されたユーザープロファイル内の Pyze やカスタム属性を作成したり更新したりすることができます。各リクエストには、最大50個のプロファイルフィールドを含めることができます。

フィールド名キー	タイプ	説明	必須
userId	string	Customer id for this user in your database, identifies a user uniquely	Y
Pyze User Profile Fields	Varies	Available fields	N
my_custom_attribute	Varies	Available Types	N

プロファイル属性を削除するには、NULLに設定します。

カスタム属性

プロファイル属性を削除するには、NULLに設定します。

Data Type	Example Values
Boolean	`{ "subscribed": true }`
Strings	`{subscription_type: "Silver" }`
Integer	`{ "score": 30 }`
Dates	`{ "subscription_start": "2017-07-13T17:44:46Z" } Dates must be in ISO 8601 Format`
Arrays	`{ "categories": [ "electronics", "computers" ] }`

呼び出し例

POST https://import.pyze.com/users/profile
Content-Type: application/json
{
  "user_profiles":
      [
      	"customer_id": "user123",
	    "user_alias": {
	        "alias_label": "facebook",
	        "alias_id": "fb123409"
	    },
	    "first_name": "John",
	    "last_name": "Doe",
	    "date_of_first_use": "2016-04-12T17:27:20+00:00",
	    "date_of_birth": "1994-07-06",
	    "gender": "F",
	    "custom-ltv": 35,
	    "custom-purchase": {
	        "inc": 30
	    },
	    "custom-subscription": "premium",
	    "custom-tags": ["whale", "high-spender"]
    ],
    [
	    "pyze_id": "ca1ab028-185d-4833-a3af-5b5d46b62771",
	    "date_of_last_use": "2018-06-20T08:17:00+00:00",
	    "email_id": "jane.doe@gmail.com",
	    "custom-tags": {"remove" :['whale']}
    ]
}

サーバからPyzeにイベントを投稿する

エンタープライズのお客様は、RESTful APIを使用してバックエンドからPyzeにイベントデータを投稿することもできます。

Pyze Enterprise Events APIを使用すると、モバイルアプリやウェブアプリのデータと一緒に、サーバーからイベントを送信することができます。これらのイベントをPyze SDKと同じ速度で、同じレベルの詳細で送信することができます。

Pyze Enterprise Events API は、HTTPS POST イベントを受け付けます。イベントに任意のカスタム属性データをアタッチすることができ、このデータをPyzeシステム全体で属性として使用して、ユーザーをフィルタリングして理解することができます。

エンドポイント

すべての取引のためのURLは次のとおりです： https://import.pyze.com/v1/events

Content-Type HTTPヘッダはapplication/jsonでなければなりません。

データフォーマット

Pyze Enterprise Events APIは、以下のフィールドを持つ標準的なJSONドキュメントを受け入れます。

フィールド名キー	タイプ	説明	必須
type	string	リクエストメッセージの種類、イベント	required
event	string	カスタムイベントの名前	required
userId	strin	ユーザーの一意の識別子	required
eventTime	string	イベントが発生した時のタイムスタンプ。 ISO-8601の日付文字列.	required
context	object		optional
context.userAgent	string	ユーザーデバイスのユーザーエージェント	optional
context.ip	string	ユーザーの現在のIPアドレス	optional
appKey	string	Pyzeアプリのキー	required
messageId	string	各メッセージに固有の識別子	optional
sentAt	string	イベントがPyzeに送信された時のタイムスタンプで、クロックのスキューを修正するのに役立ちます。 ISO-8601 日付文字列	optional
attributes	object	キーと値のペア. イベントに関するその他のプロパティt	optional

レスポンス

Pyze Enterprise Events API は、イベントが適切にフォーマットされ、受け入れられた場合に 202 のレスポンスコードを返します。APIは、JSONオブジェクトの全体的なフォーマットと妥当性、およびリクエストが適切にAuthenticatedされているかどうかのみを検証します。

| 202 | イベントは処理のために受理されました | | 400 | 有効な入力ではありません/“FieldName “が提供されていません| | 401 | 閲覧権限がありません | | 403 | 提供されているアプリへのアクセスが必要です | | 500 | Pyze内部のサーバーエラーです。問題が解決しない場合はPyzeに連絡してください。 t |

例

A Curl 例 :

curl -X POST -H "Content-Type: application/json" -d '{
    "type": "event",
    "event": "test-event",
    "userId": "mohan",
    "eventTime": "2020-06-03T17:03:48-07:00",
    "context": {
      "userAgent": "trial"
    },
    "appKey": "yz1Jn-0pSnekg58etEQO4A"
}' "https://import.pyze.com/v1/events"

最終更新 2021-01-07