Audience Manager API の概要

 

開始する前に:

AAM API の操作を開始する前に、いくつかの作業を行う必要があります。以下が必要です:

  • API アクセスを許可する必要があります。
  • カスタマー ID(クライアント ID とも呼ばれます)。
  • API シークレット。
  • API リクエストを容易にするためのソフトウェア(Postman と呼ばれるスタンドアローンの Google Chrome アプリケーションをお勧めしますが、CuRL を使用することもできます)。

この情報を入手するには、コンサルタントまたは AAM のカスタマーケアチームに相談してください。

この情報を取得したら、ベース 64 エンコーディングを使用してクライアント ID および API の暗号をエンコードする必要があります。エンコードされたストリングは次の形式である必要があります:

clientid:secret

 

base64encode.com などのサイトを使用して、エンコードを行うことができます。

結果のエンコーディングは次のようになります:bXljbGllbnRpZDpteWFwaXNlY3JldA==

 

ドキュメントの概要:

以下のリンクをクリックして、ドキュメントのそのセクションにジャンプします

 

クライアントの設定(メール集配人)

アクセストークンを要求してください

さらなる例

 

クライアントの設定:

前述のように、HTTP クライアントを選択する際には複数の異なるオプションがあります。このドキュメントでは、Postman と呼ばれる従来の Chrome アプリケーションに焦点を当てています。

Postman は、ここから入手できます:http://www.getpostman.com/

 

Postman は、HTTP リクエストを整理または操作するための本当に優れた機能を多数備えています。アプリケーションは 2 つのメインセクションに分割されます。左側には検索フィールドがあり、リクエスト履歴を見たり、コレクションにリクエストを格納したりする機能もあります。アプリケーションの残りの部分は、リクエストのコンパイルと送信に専念しています。

 

Postman でのリクエストの作成は、かなりの単純なプロセスです。一般的な HTTP 要求の場合は、実行するリクエストのタイプ、ターゲットとする URL、および必要なパラメーターを知っておく必要があります。各リクエストは異なるので、必要な情報があることを確認するために、API ドキュメントを参照することをお勧めします。

 

注意:API に対して要求を行うには、最初にアクセストークンを要求する必要があります。詳しくはアクセストークンを要求を参照してください。

 

必要なリクエストの種類がわかったら、ドロップダウンから選択してリクエストの種類を指定することから始めます。

次に、URL フィールドに API URL を入力します。これは、「https://api.demdex.com/v1/traits/」のような形式にする必要があります。

最後に、要求パラメーターを定義します。これは、「Headers」タブまたは「Body」タブのいずれかに、さまざまな値を入力して行われます。

 

ヘッダーは送信される要求に応じてわずかに変更されますが、通常は次の 3 つの項目が含まれます:

 

  • 承認 | アプリケーション/json
  • 権限付与 | ベアラー <access token>
  • コンテンツ - タイプ | アプリケーション/json

本文もまた、送信される要求のタイプと、ターゲットとする URL(またはエンドポイント)の両方に応じて変更されます。一般的に、値は、様々なデータペアを含む JSON 形式ブロックで提供されます。

他のリクエストでは、値は代わりにパラメーターで提供されます。

 

リクエストに対してすべての設定が完了したら、右上の「送信」ボタンをクリックするか、またはディスクボタンをクリックしてコレクションに保存します。

 

アクセストークンの要求:

最初の API 呼び出しでは、アクセストークンを要求する必要があります。これを行うには、「https://api.demdex.com/oauth/token」に投稿のリクエストを送信します。  投稿の一環として、複数のヘッダーやその他のパラメーターを定義する必要があります。

 

URL: https://api.demdex.com/oauth/token

 

ヘッダー:

承認:アプリケーション/json
認可:基本 <base 64 encoded token>

 

フォームの種類:x-www-form-urlencoded

 

リクエストボディ(個別キー:値のペア):

grant_ type:パスワード
ユーザー名:<AAM Customer Username>
パスワード:<AAM Customer Password>

 

Curl の例:

curl -X POST -H "Accept: application/json"
-H "Authorization: Basic " -H
"Cache-Control: no-cache" -H "Content-Type:
application/x-www-form-urlencoded" -d
'grant_type=password&username=&password=' https://api.demdex.com/oauth/token

 

さらなる例:

ここでは、API の使用を開始するのに役立ついくつかの追加の例を示します。

 

特性の作成:

HTTP リクエストタイプ:投稿

URL:https://api.demdex.com/v1/traits/

ヘッダー:

  • 承認:アプリケーション/json
  • 権限付与:ベアラー <access token>
  • コンテンツタイプ:アプリケーション/json

リクエスト本文:

新しい
特性を作り出すには、特性の構造とタイプの両方、および特性が従うルールを定義する必要があります。  必須の値には、特性タイプ、特性名、特性記述、特性ルール、データソース ID、親フォルダー ID などがあります。詳細については、https://marketing.adobe.com/resources/help/en_US/aam/?f=c_methods を参照してください。

{
	"traitType": "RULE_BASED_TRAIT",
	"name": "Blog Post",
	"description": "Tracks when a blog post has been created within the Demo app",
	"comments": "",
	"integrationCode": "post-1",
	"traitRule": "blogPostID==\"1\"",
	"dataSourceId": 14266,
	"folderId": 81659
}

 

すべてのルールベースの特性を要求します:

HTTP リクエストタイプ:Get

URL:https://api.demdex.com/v1/traits/?restrictType=RULE_BASED_TRAIT

ヘッダー:

  • 承認:アプリケーション/json
  • 権限付与:ベアラー <access token>
  • コンテンツタイプ:アプリケーション/json

リクエスト本文:該当なし

 

API ドキュメント

API でできることの詳細については、ドキュメントページを参照してください。

本作品は Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License によってライセンス許可を受けています。  Twitter™ および Facebook の投稿には、Creative Commons の規約内容は適用されません。

法律上の注意   |   プライバシーポリシー