Partager via

Service de configuration de segment batch

Remarque

Ce service est actuellement disponible pour un ensemble limité de clients et d’employés Microsoft uniquement.

Avertissement

Si vous avez besoin d’apporter des modifications aux limites ou byte de la num_line configuration du segment de lot d’un membre, veuillez créer un ticket sous EPIC : DMP-376, en suivant les instructions de la section d’informations de la page. Vous devrez recevoir l’approbation d’Ewa Maciukiewicz pour procéder aux modifications.

Le service de configuration de segment Batch est une API interne d’administration uniquement utilisée pour ajouter et modifier des paramètres par client liés à leur utilisation du service de segment batch. Vous pouvez configurer le format de fichier préféré du client, ainsi que la rigueur de notre vérification des erreurs par rapport à ce format. Vous pouvez également définir des limites d’utilisation et définir les données de segment d’autres membres auxquelles le client a accès.

Remarque

Pour plus d’informations sur les spécificités du format de fichier, consultez Configuration initiale du compte BSS.

Accès client aux données d’autres membres

Un client qui souhaite accéder aux données d’un autre membre doit demander à ce membre de déposer une demande de support via notre portail de support client. Par exemple, si le client A souhaite accéder aux données du client B, le client B doit envoyer une demande de support autorisant l’accès du client A.

Champs JSON

Champ Type Description
created_on string Heure à laquelle cet objet a été créé.

Filtrer par : Oui
Trier par : Oui
daily_byte_limit int Nombre maximal d’octets par jour que le client peut charger. Guide général : 10G (environ 280M de lignes avec un format détaillé)

Remarque : Les clients qui souhaitent déclencher cette opération doivent confirmer qu’ils utilisent correctement leurs limites de données, c’est-à-dire qu’ils nous envoient un fichier diff au lieu d’un vidage complet de la base de données chaque jour. Les clients qui n’utilisent pas les données intelligemment doivent refactoriser leur processus de chargement pour réduire l’envoi des données.

Obligatoire sur : POST
Filtrer par : Oui
Trier par : Oui
daily_num_lines_limit int Nombre maximal de lignes par jour que le client peut charger.

Obligatoire sur : POST
Filtrer par : Oui
Trier par : Oui
default_domain string Domaine de base de données interne auquel ajouter l’ID utilisateur. La valeur par défaut est « userdata ». Généralement non utilisé, car presque tous les clients se trouvent dans un domaine pour le moment.

Obligatoire sur : POST
Filtrer par : Oui
Trier par : Oui
default_expiration int Durée, en minutes, après laquelle ce client souhaite que ses segments expirent. Cela est remplacé par tous les paramètres d’expiration dans le fichier de données de segment. Une valeur de 0 indique que le segment ne doit jamais expirer ; -1 indique que cet utilisateur sera supprimé de ce segment.

Remarque : Si, pour une raison quelconque, POST les demandes rejettent 0 comme entrée valide, POST avec une valeur différente de zéro, puis PUT le même fichier à nouveau avec 0 comme valeur et il doit fonctionner.

Obligatoire sur : POST
Filtrer par : Oui
Trier par : Oui
external_member_uid int Si «use_external_uids » est true, indiquez l’ID de membre dont le client utilisera les ID d’utilisateur. Valeur de null signifie que le client utilise son propre member_id. Valide uniquement pour les membres qui utilisent la synchronisation utilisateur mapUID (HINT : Très peu de clients utilisent ce paramètre).

Obligatoire sur : POST
Filtrer par : Oui
Trier par : Oui
hourly_byte_limit int Nombre maximal d’octets par heure que le client peut charger.

Obligatoire sur : POST
Filtrer par : Oui
Trier par : Oui
hourly_num_lines_limit int Nombre maximal de lignes par heure que le client peut charger.

Obligatoire sur : POST
Filtrer par : Oui
Trier par : Oui
id int Identificateur unique de cet objet.

Filtrer par : Oui
Trier par : Oui
last_modified string Heure à laquelle cet objet a été modifié pour la dernière fois.

Filtrer par : Oui
Trier par : Oui
max_concurrent_uploads int Nombre maximal de chargements que le client peut effectuer à la fois. Guide général : 1

Obligatoire sur : POST
Filtrer par : Oui
Trier par : Oui
member_id int ID de membre du client dont vous modifiez la configuration.

Obligatoire le : PUT, POST
Filtrer par : Oui
Trier par : Oui
member_segment_access tableau d’objets ID de membre dont le client a accès aux segments. (Utilisez cette option si vous ajoutez des utilisateurs à des segments pour le compte d’une personne). Pour plus d’informations, consultez la section Tableau d’accès au segment de membre ci-dessous.

Obligatoire sur : POST
Filtrer par : Non
Trier par : Non
num_error_log_lines int Nombre de lignes qui s’affichent dans le journal des erreurs. Guide général : moins de 200

Obligatoire sur : POST
Filtrer par : Oui
Trier par : Oui
num_invalid_before_error int Nombre de lignes non valides à accepter avant de signaler une erreur. Lorsque cette limite est atteinte, le travail est supprimé, mais tout ce qui a été ajouté avant la première erreur s’affiche. Guide général : 50 % du fichier d’un client. En cas de doute, mettez-le très haut.

Obligatoire sur : POST
Filtrer par : Oui
Trier par : Oui
segment_fields tableau Liste de segments corrélés au SEG bloc du format de fichier. Pour plus d’informations, consultez Batch Segment Service.

Obligatoire sur : POST
Filtrer par : Oui
Trier par : Oui
separator_1 string Caractère ou chaîne de caractères utilisé comme séparateur par le service de segments batch.

Obligatoire sur : POST
Filtrer par : Oui
Trier par : Oui
separator_2 string Caractère ou chaîne de caractères utilisé comme séparateur par le service de segments batch.
separator_3 string Caractère ou chaîne de caractères utilisé comme séparateur par le service de segments batch.

Obligatoire sur : POST
Filtrer par : Oui
Trier par : Oui
separator_4 string Caractère ou chaîne de caractères utilisé comme séparateur par le service de segments batch.

Obligatoire sur : POST
Filtrer par : Oui
Trier par : Oui
separator_5 string Caractère ou chaîne de caractères utilisé comme séparateur par le service de segments batch.

Obligatoire sur : POST
Filtrer par : Oui
Trier par : Oui
use_external_uids bool Indique si le client souhaite utiliser des ID d’utilisateur externe pour le mappage d’un nom à un autre. Définissez ce champ sur true afin d’utiliser un external_member_uid.

Obligatoire sur : POST
Filtrer par : Oui
Trier par : Oui
use_specific_geo string NULL Définissez sur par défaut.

Ce champ n’est plus nécessaire pour apporter des améliorations à Batch Segment en 2013. Le système case activée toutes les zones géographiques. Si l’utilisateur se trouve dans plusieurs zones géographiques, il est ajouté aux segments appropriés dans chaque zone géographique dans laquelle il existe.

Obligatoire sur : POST
Filtrer par : Oui
Trier par : Oui

Tableau d’accès aux segments de membre

Champ Type Description
segment_owner_member_id int ID de membre du propriétaire du segment.

Filtrer par : Non
Trier par : Non

Exemples

Voir la configuration d’un membre donné

$ 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