איסוף נתונים מותאמים אישית באמצעות המדיניות DataCapture

הדף הזה רלוונטי ל-Apigee ול-Apigee Hybrid.

לעיון במסמכי התיעוד של Apigee Edge

בנוסף לנתוני ה-API הרגילים שנאספים על ידי Apigee, אפשר גם לאסוף נתונים מותאמים אישית באמצעות מדיניות DataCapture. יש שני שלבים עיקריים שצריך לבצע, כפי שמתואר בקטעים הבאים:

1. יוצרים משאב REST של כלי לאיסוף נתונים.
2. מציינים את הנתונים שרוצים לאסוף באמצעות רכיב <Collect> של מדיניות DataCapture.

הערה:אם יש לכם ארגון Apigee עם חיוב לפי שימוש, אתם צריכים להפעיל את התוסף Apigee API Analytics כדי להשתמש במדיניות הזו. מידע נוסף זמין במאמר בנושא ניהול התוסף Apigee API Analytics.

אם אתם לא בטוחים אם אתם משתמשים בארגון Apigee עם מינוי או עם תשלום לפי שימוש, פנו לאדמין של ארגון Apigee שלכם.

יצירת משאב REST של כלי לאיסוף נתונים

כדי להשתמש במדיניות DataCapture, צריך קודם ליצור משאב REST מסוג Data Collector. כדי לעשות את זה, שולחים בקשת API כמו הבקשה הבאה:

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -X POST -H "content-type:application/json" \
  -d '
{
  "name": "dc_my_custom_data",
  "description": "Collects data for analysis.",
  "type": "STRING",
}' \
  "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/datacollectors"

כך נוצר משאב בשם dc_my_custom_data, שאפשר להשתמש בו עם המדיניות DataCapture.

הערות:

• השם של משאב 'איסוף נתונים' חייב להתחיל בקידומת dc_.
• אם משתמשים בכלי לאיסוף נתונים בכמה כללי מדיניות, הנתונים שנאספים יוחלפו על ידי כללי המדיניות האחרונים שמופעלים.

אזהרה: אל תיצרו שני מאגרי נתונים ששמותיהם שונים רק בשימוש באותיות רישיות, כמו dc_my_data ו-dc_My_Data, כי אז ייצוא הנתונים יגרום לשגיאה 'שמות עמודות כפולים'.

ציון הנתונים לאיסוף

אפשר לציין את הנתונים לאיסוף באמצעות הרכיב <Collect> במדיניות DataCapture. יש כמה דרכים לעשות את זה, כמו שמוסבר בקטע דוגמאות בדף העזר בנושא DataCapture. אחת הדרכים היא לציין משתנה של זרימת נתונים, שמאחסן נתונים שמועברים בבקשות ובתגובות של API. לדוגמה, אפשר לאסוף נתונים שהלקוחות מזינים בטופס בדף אינטרנט באמצעות משתנה ה-flow ‏message.formparam.param_name.values, כאשר param_name הוא שם של פרמטר בטופס. נניח שלטופס יש פרמטר בשם payment_amount. המשתנה המתאים בתהליך העבודה יהיה message.formparam.payment_amount.values.

הקוד הבא מציין את המשתנה הזה באמצעות המאפיין ref של הרכיב <Collect>.

<DataCapture name="capturepayment">
    <Capture>
        <DataCollector>dc_my_custom_data</DataCollector>
        <Collect ref="message.form_param.payment_amount.values" >
    </Capture>
</DataCapture>

בהגדרה הזו, הנתונים שמוזנים בשדה payment_amount בטופס ייאספו על ידי DataCapture וייאוחסנו במשתנה בשם dc_my_custom_data.

יצירת דוח בהתאמה אישית מנתונים שנאספו באמצעות DataCapture

אחרי שמגדירים את איסוף הנתונים באמצעות מדיניות DataCapture, אפשר להשתמש בנתונים כדי ליצור דוח בהתאמה אישית לפי ההליך שמתואר במאמר הוספת דוח בהתאמה אישית. כדי לעשות זאת, כשבוחרים מדד לדוח, כמו שמוצג בשלב 4 של התהליך, בוחרים את המשתנה ששמו זהה למשאב Data Collector REST שיצרתם עבור DataCapture – לדוגמה, dc_my_custom_data.

אפשר גם להשתמש באותו משתנה כמאפיין בדוח בהתאמה אישית. מאחר שמאפיינים מקבצים נתונים לפי ערכי המשתנה, בדרך כלל עדיף שהמשתנה יהיה מחרוזת שמקבלת רק מספר מוגבל של ערכים.