バッチ セグメントの構成サービス

注:

このサービスは現在、一部のクライアントと Microsoft の従業員のみが利用できます。

警告

メンバーのバッチ セグメント構成の num_line または byte 制限を変更する必要がある場合は、ページの情報セクションの指示に従って、EPIC: DMP-376 でチケットを提出してください。 変更を続行するには、Ewa Maciukiewicz から承認を受ける必要があります。

Batch Segment Config Service は、 Batch Segment Service の使用に関連するクライアントごとの設定を追加および修正するために使用される、内部の管理者専用 API です。 クライアントの優先ファイル形式と、その形式に対するエラー チェックの厳密さを構成できます。 使用制限を設定し、クライアントがアクセスできる他のメンバーのセグメント データを定義することもできます。

注:

ファイル形式の詳細については、「 BSS アカウントの初期設定」を参照してください。

他のメンバーのデータへのクライアント アクセス

別のメンバーのデータへのアクセスを希望するクライアントは、 Microsoft 広告カスタマー サポート ポータルを介してサポート リクエストを提出するようにそのメンバーに依頼する必要があります。 たとえば、クライアント A がクライアント B のデータにアクセスしたい場合、クライアント B はクライアント A のアクセスを許可するサポート要求を送信する必要があります。

JSON フィールド

フィールド 種類 説明
created_on string このオブジェクトが作成された時刻。

フィルター条件: はい
並び替え: はい
daily_byte_limit int クライアントがアップロードできる 1 日あたりの最大バイト数。 一般的なガイド: 10G (詳細形式で gzip 圧縮された約 280M ライン)

注: これを上げたいクライアントは、データ制限を適切に使用していること、つまり、完全なデータベースダンプではなく diff ファイルを毎日送信していることを確認する必要があります。 データを賢く使用しないクライアントは、アップロード プロセスをリファクタリングしてデータ送信を最小限に抑える必要があります。

必須:POST
フィルター条件: はい
並び替え: はい
daily_num_lines_limit int クライアントがアップロードできる 1 日あたりの最大行数。

必須:POST
フィルター条件: はい
並び替え: はい
default_domain string ユーザー ID を追加する内部データベース ドメイン。 既定値は 'userdata' に設定されています。 現時点ではほとんどすべてのクライアントが 1 つのドメイン内にあるため、通常は使用されません。

必須:POST
フィルター条件: はい
並び替え: はい
default_expiration int このクライアントがセグメントを期限切れにするまでの時間 (分単位)。 これは、セグメント データ ファイルの有効期限設定によって上書きされます。 値 0 は、セグメントが期限切れにならないことを示します。 -1 は、このユーザーがこのセグメントから削除されることを示します。

注: 何らかの理由で、 POST 要求が有効な入力として 0 を拒否する場合は、0 以外の値で POST してから、値として 0 を使用して同じファイルを再度 PUT すると、動作します。

必須:POST
フィルター条件: はい
並び替え: はい
external_member_uid int "use_external_uids" が trueの場合は、クライアントが使用するユーザー ID を持つメンバー ID を指定します。 値 null は、クライアント独自の member_idを使用することを意味します。 mapUID usersyncing を使用しているメンバーに対してのみ有効です (ヒント: これを使用するクライアントはごくわずかです)。

必須:POST
フィルター条件: はい
並び替え: はい
hourly_byte_limit int クライアントがアップロードできる 1 時間あたりの最大バイト数。

必須:POST
フィルター条件: はい
並び替え: はい
hourly_num_lines_limit int クライアントがアップロードできる 1 時間あたりの最大行数。

必須:POST
フィルター条件: はい
並び替え: はい
id int このオブジェクトの一意の識別子。

フィルター条件: はい
並び替え: はい
last_modified string このオブジェクトが最後に変更された時刻。

フィルター条件: はい
並び替え: はい
max_concurrent_uploads int クライアントが一度に実行できるアップロードの最大数。 一般的なガイド: 1

必須:POST
フィルター条件: はい
並び替え: はい
member_id int 編集している構成のクライアントのメンバー ID。

必須:PUT、 POST
フィルター条件: はい
並び替え: はい
member_segment_access オブジェクトの配列 クライアントがアクセスできるセグメントを持つメンバー ID。 (これは、ユーザーの代わりにセグメントにユーザーを追加する場合に使用します)。 詳細については、以下の 「メンバー セグメントのアクセス配列 」セクションを参照してください。

必須:POST
フィルター条件: いいえ
並べ替え: いいえ
num_error_log_lines int エラー ログに表示される行数。 一般的なガイド: 200 未満

必須:POST
フィルター条件: はい
並び替え: はい
num_invalid_before_error int エラーを通知する前に受け入れる無効なラインの数。 この制限に達すると、ジョブは強制終了されますが、最初のエラーが発生する前に追加されたすべてのジョブが入力されます。 一般的なガイド: クライアントのファイルの 50%。 疑わしい場合は、これを非常に高く設定します。

必須:POST
フィルター条件: はい
並び替え: はい
segment_fields 配列 ファイル形式の SEG ブロックと関連付けられているセグメントの一覧。 詳細については、「 バッチセグメントサービス」を参照してください。

必須:POST
フィルター条件: はい
並び替え: はい
separator_1 string バッチ セグメント サービスによって区切り記号として使用される文字または文字列。

必須:POST
フィルター条件: はい
並び替え: はい
separator_2 string バッチ セグメント サービスによって区切り記号として使用される文字または文字列。
separator_3 string バッチ セグメント サービスによって区切り記号として使用される文字または文字列。

必須:POST
フィルター条件: はい
並び替え: はい
separator_4 string バッチ セグメント サービスによって区切り記号として使用される文字または文字列。

必須:POST
フィルター条件: はい
並び替え: はい
separator_5 string バッチ セグメント サービスによって区切り記号として使用される文字または文字列。

必須:POST
フィルター条件: はい
並び替え: はい
use_external_uids bool クライアントがある名前から別の名前へのマッピングに外部ユーザー ID を使用するかどうか。 external_member_uidを使用するには、このフィールドを true に設定します。

必須:POST
フィルター条件: はい
並び替え: はい
use_specific_geo string 既定では NULL に設定します。

このフィールドは、2013 年にバッチ セグメントに加えられた改善を行うために不要になりました。 システムがすべての地域をチェックします。 ユーザーが複数の地域にいる場合、存在する各地域の適切なセグメントに追加されます。

必須:POST
フィルター条件: はい
並び替え: はい

メンバー セグメントのアクセス配列

フィールド 種類 説明
segment_owner_member_id int セグメント所有者のメンバー ID。

フィルター条件: いいえ
並べ替え: いいえ

例

特定のメンバーの構成を表示する

$ curl -b cookies "https://api.appnexus.com/batch-segment-config?member_id=1226"
{
  "response": {
    "status": "OK",
    "count": null,
    "start_element": 0,
    "num_elements": 100,
    "batch_segment_upload_config": {
      "member_id": 1226,
      "id": 2,
      "hourly_byte_limit": 3500000000,
      "daily_byte_limit": 3500000000,
      "max_concurrent_uploads": 1,
      "num_error_log_lines": 50,
      "num_invalid_before_error": 1000000000,
      "separator_1": ";",
      "separator_2": ",",
      "separator_3": ":",
      "separator_4": "\t",
      "separator_5": "^",
      "default_domain": "userdata",
      "use_specific_geo": null,
      "segment_fields": "[SEG_ID,EXPIRATION,VALUE]",
      "last_modified": "2012-06-01 15:10:20",
      "created_on": "0000-00-00 00:00:00",
      "default_expiration": 0,
      "use_external_uids": false,
      "external_member_uid": null,
      "member_segment_access": [
        {
          "segment_owner_member_id": 23
        }
      ]
    }
  }
  }
  • Last updated on