ייצוא נתונים מ-Analytics

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X.
מידע

הגדרת הרשאות לסוכני שירות שהוקצו

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

  1. כדי למצוא את השם של סוכן השירות של Google Cloud, מזינים את הפקודה הבאה:
    curl -X GET \
      "https://api.enterprise.apigee.com/v1/organizations/ORG" \
      -u email:password \
      | jq -r '.properties.property[] | select(.name=="serviceAgent.analytics") | .value'

    ORG הוא הארגון שלך. הפעולה הזו מחזירה את השם והערך של סוכן השירות, כפי שמוצג בהמשך:

    "property" : [
      {
       "name" : "serviceAgent.analytics",
       "value" : "service-9q1ibk@gcp-sa-apigee-uap.iam.gserviceaccount.com"
       },
  2. פותחים את מרכז הבקרה של IAM במסוף Google Cloud.
  3. בוחרים את הפרויקט הרלוונטי ב-Google Cloud.
  4. בחלק העליון של החלונית IAM, לוחצים על Add.
  5. בשדה New principals, מזינים את סוכן השירות value שהוחזר בשלב 1. לדוגמה, הערך של value שמוצג בשלב 1 הוא service-9q1ibk@gcp-sa-apigee-uap.iam.gserviceaccount.com.
  6. לוחצים על הלחצן +הוספת תפקיד ומוסיפים את התפקידים הבאים:
    • משתמש ב-BigQuery
    • אדמין של אחסון
  7. לוחצים על שמירה.

נתוני Apigee Analytics

Apigee Analytics אוסף ומנתח מגוון רחב של נתונים שזורמים בממשקי ה-API שלך ומספק כלים להצגה חזותית, כולל מרכזי בקרה אינטראקטיביים, דוחות מותאמים אישית וכלים אחרים שמזהים מגמות בביצועים של שרתי proxy של API. כדי ליהנות מהתוכן העשיר, אתם יכולים לייצא את נתוני הניתוח מ-Apigee Analytics למאגר נתונים משלכם, כמו Google Cloud Storage או Google BigQuery. כך תוכלו להשתמש ביכולות המתקדמות של Google BigQuery ו-TensorFlow כדי לבצע ניתוח נתונים משלכם. אפשר גם לשלב את נתוני הניתוח שיוצאו עם נתונים אחרים, כמו יומני אינטרנט, כדי לקבל תובנות חדשות לגבי המשתמשים, ממשקי ה-API והאפליקציות שלכם.

פורמט הייצוא

לייצא את נתוני הניתוח לאחד מהפורמטים הבאים:

  • ערכים מופרדים בפסיקים (CSV)

    התו המפריד שמוגדר כברירת מחדל הוא תו פסיק (,). תווי המפריד הנתמכים כוללים פסיק (,), קו אנכי (|) וטאב (\t). יש להגדיר את הערך באמצעות המאפיין csvDelimiter, כפי שמתואר בקטע ייצוא הפניה למאפיין בקשה .

  • JSON (מופרד בשורה חדשה)

    מאפשרת להשתמש בתו של השורה החדשה כתו מפריד.

הנתונים המיוצאים כוללים את כל המדדים והמאפיינים המובנים ב-Edge, ואת כל נתוני הניתוח בהתאמה אישית שמוסיפים. תיאור של הנתונים שיוצאו זמין במאמר מדדים, מאפיינים ומסננים ב-Analytics.

אפשר לייצא את נתוני הניתוח למאגרי הנתונים הבאים:

סקירה כללית של תהליך הייצוא

השלבים הבאים מסכמים את התהליך המשמש לייצוא נתוני ניתוח הנתונים:

  1. מגדירים את מאגר הנתונים (Cloud Storage או BigQuery) לייצוא נתונים. עליכם לוודא שמאגר הנתונים הוגדר בצורה נכונה, ושלחשבון השירות המשמש לכתיבת הנתונים למאגר הנתונים יש את ההרשאות המתאימות.

  2. יוצרים מאגר נתונים שמגדיר את המאפיינים של מאגר הנתונים (Cloud Storage או BigQuery) שאליו מייצאים את הנתונים, כולל פרטי הכניסה המשמשים לגישה למאגר הנתונים.

    כשיוצרים מאגר נתונים, צריך להעלות את פרטי הכניסה של מאגר הנתונים ל-Edge Credentials Vault כדי לאחסן אותם באופן מאובטח. המנגנון לייצוא נתונים משתמש בפרטי הכניסה האלה כדי לכתוב נתונים במאגר הנתונים שלכם.

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

  4. אפשר להשתמש ב-API לייצוא נתונים כדי לקבוע מתי הייצוא יסתיים.

  5. בסיום הייצוא, ניתן לגשת לנתונים המיוצאים במאגר הנתונים.

בחלקים הבאים נרחיב על השלבים האלה.

הגדרה של מאגר הנתונים

המנגנון לייצוא נתונים מניתוח הנתונים כותב את הנתונים ב-Cloud Storage או ב-BigQuery. כדי שהכתיבה תתבצע, צריך:

  • יוצרים חשבון שירות ב-Google Cloud Platform.
  • מגדירים את התפקיד של חשבון השירות כדי לקבל גישה ל-Cloud Storage או ל-BigQuery.

יצירת חשבון שירות ל-Cloud Storage או ל-BigQuery

חשבון שירות הוא סוג של חשבון Google ששייך לאפליקציה שלכם במקום למשתמש יחיד. לאחר מכן האפליקציה משתמשת בחשבון השירות כדי לגשת לשירות.

לחשבון שירות יש מפתח לחשבון שירות שמיוצג על ידי מחרוזת JSON. כשיוצרים מאגר נתונים של Edge שמגדיר את החיבור למאגר הנתונים, מעבירים את המפתח הזה. המנגנון לייצוא הנתונים משתמש במפתח כדי לגשת למאגר הנתונים.

חשבון השירות שמשויך למפתח חייב להיות הבעלים של הפרויקט ב-Google Cloud Platform, עם גישת כתיבה לקטגוריה של Google Cloud Storage. במאמר יצירה וניהול של מפתחות של חשבונות שירות במסמכי התיעוד של Google Cloud Platform מוסבר איך ליצור מפתח שירות ולהוריד את המטען הייעודי (payload).

לדוגמה, כשמורידים את המפתח בפעם הראשונה, הוא יפורמט כאובייקט JSON:

{ 
  "type": "service_account", 
  "project_id": "myProject", 
  "private_key_id": "12312312", 
  "private_key": "-----BEGIN PRIVATE KEY-----\n...", 
  "client_email": "client_email@developer.gserviceaccount.com", 
  "client_id": "879876769876", 
  "auth_uri": "https://accounts.google.com/organizations/oauth2/auth", 
  "token_uri": "https://oauth2.googleapis.com/token", 
  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2", 
  "client_x509_cert_url": "https://www.googleapis.com" 
}

הגדרה של Google Cloud Storage

כדי שתוכלו לייצא נתונים אל Google Cloud Storage:

  • יש לוודא שממשקי ה-API של BigQuery ו-Cloud Resource Manager מופעלים בפרויקט שלכם ב-Google Cloud Platform. לקבלת הוראות, אפשר לעיין במאמר הפעלת ממשקי API. ב-Apigee משתמשים ב-BigQuery API כדי להשתמש בתכונות הייצוא של BigQuery בזמן הייצוא ל-Cloud Storage, וב-Cloud Resource Manager API כדי לבדוק את ההרשאה לפני כל ייצוא.
  • מוודאים שחשבון השירות מוקצה לתפקידים הבאים:

    • משתמש משימה ב-BigQuery
    • יוצר אובייקטים של אחסון
    • מנהל אחסון (נדרש רק לצורך בדיקה של מאגר הנתונים, כפי שמתואר במאמר בדיקת הגדרה של מאגר נתונים). אם התפקיד הזה רחב מדי, אפשר להוסיף את ההרשאה storage.buckets.get לתפקיד קיים במקום זאת.)

    לחלופין, אם רוצים לשנות תפקיד קיים או ליצור תפקיד בהתאמה אישית, מוסיפים לתפקיד את ההרשאות הבאות:

הגדרת Google BigQuery

כדי שתוכלו לייצא נתונים אל Google BigQuery:

  • יש לוודא שממשקי ה-API של BigQuery ו-Cloud Resource Manager מופעלים בפרויקט שלכם ב-Google Cloud Platform. לקבלת הוראות, אפשר לעיין במאמר הפעלת ממשקי API. ב-Apigee משתמשים ב-Cloud Resource Manager API כדי לבדוק את ההרשאה לפני כל ייצוא.
  • צריך לוודא ש-BigQuery API מופעל בפרויקט ב-Google Cloud Platform. לקבלת הוראות, אפשר לעיין במאמר הפעלה והשבתה של ממשקי API.
  • מוודאים שחשבון השירות מוקצה לתפקידים הבאים:

    • משתמש משימה ב-BigQuery
    • עורך הנתונים של BigQuery

    כדי לשנות תפקיד קיים או ליצור תפקיד בהתאמה אישית, צריך להוסיף לתפקיד את ההרשאות הבאות:

    • bigquery.datasets.create
    • bigquery.datasets.get
    • bigquery.jobs.create
    • bigquery.tables.create
    • bigquery.tables.get
    • bigquery.tables.updateData

יצירת מאגר נתונים

מאגר הנתונים מגדיר את החיבור למאגר הנתונים שאתם מייצאים (Cloud Storage, BigQuery), כולל פרטי הכניסה שמשמשים לגישה למאגר הנתונים.

מידע על Vault Credentials Vault

Edge משתמש ב-Vault של פרטי הכניסה כדי לאחסן באופן מאובטח את פרטי הכניסה שמשמשים לגישה למאגר הנתונים לייצוא. כדי ששירות יוכל לגשת לפרטי הכניסה ב-Edge Credentials Vault, יש להגדיר צרכן של פרטי כניסה.

כשיוצרים מאגר נתונים באמצעות ממשק המשתמש של Edge, כפי שמתואר בהמשך, Edge יוצר באופן אוטומטי את הצרכן שמשמש לגישה לפרטי הכניסה.

בדיקת הגדרות של מאגר נתונים

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

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

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

כדי להפעיל את תכונת הבדיקה, צריך:

יצירת מאגר נתונים

כדי ליצור מאגר נתונים בממשק המשתמש:

  1. מתחברים לכתובת https://apigee.com/edge כאדמין ארגוני ובוחרים את הארגון.

    הערה: רק מנהלי חשבון ארגוני של Edge יכולים ליצור מאגר נתונים.

  2. בסרגל הניווט הימני, בוחרים באפשרות ניהול > מאגרי נתונים של Analytics. יוצג הדף מאגרי נתונים של Analytics.

  3. לוחצים על הלחצן + Add Datastore (הוספת מאגר נתונים). תתבקשו לבחור את הסוג של מאגר הנתונים:

  4. יש לבחור סוג של יעד ייצוא נתונים:

    • Google Cloud Storage
    • Google BigQuery

    דף ההגדרות האישיות יופיע:

  5. מזינים את השם של מאגר הנתונים.

  6. בוחרים פרטי כניסה שישמשו לגישה למאגר הנתונים. רשימה נפתחת של פרטי כניסה זמינים תופיע.

    פרטי הכניסה הם ספציפיים לסוג של מאגר נתונים. מידע נוסף זמין במאמר יצירת חשבון שירות ל-Cloud Storage או ל-BigQuery.

    • אם כבר העליתם את פרטי הכניסה, בוחרים את פרטי הכניסה מהרשימה הנפתחת. חשוב לבחור את פרטי הכניסה המתאימים לסוג של מאגר הנתונים.

    • אם אתם מוסיפים פרטי כניסה חדשים לאחסון הנתונים, בוחרים באפשרות הוספת חדש. בתיבת הדו-שיח, מזינים:

      1. השם של פרטי הכניסה.
      2. תוכן פרטי הכניסה הוא מפתח חשבון השירות של JSON הספציפי למאגר הנתונים שלכם, כפי שמוגדר ביצירת חשבון שירות ל-Cloud Storage או ל-BigQuery.
      3. בוחרים באפשרות יצירה.
  7. מזינים את המאפיינים הספציפיים לסוג מאגר הנתונים:

    • ב-Google Cloud Storage:
      מאפיין (property) תיאור חובה?
      מזהה הפרויקט מזהה הפרויקט ב-Google Cloud Platform.

      כדי ליצור פרויקט ב-Google Cloud Platform, עיינו במאמר יצירה וניהול של פרויקטים במסמכי התיעוד של Google Cloud Platform.

      כן
      שם הקטגוריה שם הקטגוריה ב-Cloud Storage שאליה רוצים לייצא נתוני ניתוח נתונים. יש לוודא שהקטגוריה קיימת לפני ייצוא הנתונים.

      כדי ליצור קטגוריות של Cloud Storage, קראו את המאמר יצירת קטגוריות אחסון במסמכי התיעוד של Google Cloud Platform.

      כן
      נתיב ספרייה שבה יאוחסנו הנתונים של ניתוח הנתונים בקטגוריה של Cloud Storage. כן
    • ב-BigQuery:
      מאפיין (property) תיאור חובה?
      מזהה הפרויקט מזהה הפרויקט ב-Google Cloud Platform.

      כדי ליצור פרויקט ב-Google Cloud Platform, עיינו במאמר יצירה וניהול של פרויקטים במסמכי התיעוד של Google Cloud Platform.

      כן
      שם מערך הנתונים שם מערך הנתונים ב-BigQuery שאליו רוצים לייצא נתונים של Analytics. צריך לוודא שמערך הנתונים נוצר לפני שמבקשים ייצוא נתונים.

      במאמר יצירה של מערכי נתונים ושימוש בהם במסמכי התיעוד של Google Cloud Platform מוסבר איך ליצור מערך נתונים ב-BigQuery.

      כן
      קידומת טבלה התחילית של שמות הטבלאות שנוצרו עבור נתוני הניתוח במערך הנתונים ב-BigQuery. כן
  8. בוחרים באפשרות בדיקת החיבור כדי לוודא שאפשר להשתמש בפרטי הכניסה כדי לגשת למאגר הנתונים.

    אם הבדיקה הצליחה, שומרים את מאגר הנתונים.

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

  9. אחרי שבדיקת החיבור תסתיים, שומרים את מאגר הנתונים.

שינוי של מאגר נתונים

כדי לשנות מאגר נתונים:

  1. מתחברים לכתובת https://apigee.com/edge כאדמין ארגוני ובוחרים את הארגון.

  2. בסרגל הניווט הימני, בוחרים באפשרות ניהול > מאגרי נתונים של Analytics. יוצג הדף מאגרי נתונים של Analytics.

  3. מעבירים את סמן העכבר מעל העמודה השתנה בדוח כדי לשנות אותה. יופיעו הסמל עריכה ומחיקה.

  4. עורכים או מוחקים את מאגר הנתונים.

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

    אם הבדיקה הצליחה, תוכלו לראות את הנתונים שנדגמו במאגר הנתונים שלכם.

    אם הבדיקה נכשלה, יש לפתור את הבעיות ולנסות שוב.

  6. אחרי שבדיקת החיבור תסתיים, מעדכנים את מאגר הנתונים.

ייצוא של ניתוח הנתונים

כדי לייצא נתונים של ניתוח נתונים, צריך לשלוח בקשת POST ל-API של /analytics/exports. יש להעביר את המידע הבא בגוף הבקשה:

  • השם והתיאור של בקשת הייצוא
  • טווח התאריכים של הנתונים שיוצאו (הערך יכול להתפרס על פני יום אחד בלבד)
  • פורמט של נתונים מיוצאים
  • שם מאגר הנתונים
  • האם המונטיזציה מופעלת בארגון

בהמשך מפורטות דוגמאות לבקשות ייצוא. תיאור מלא של מאפייני גוף הבקשה זמין במאמר ייצוא הפניה למאפיין הבקשה.

התגובה מה-POST צריכה להיות במבנה הבא:

{
    "self": "/organizations/myorg/environments/test/analytics/exports/a7c2f0dd-1b53-4917-9c42-a211b60ce35b",
    "created": "2017-09-28T12:39:35Z",
    "state": "enqueued"
}

חשוב לשים לב שהמאפיין state בתגובה מוגדר כ-enqueued. בקשת ה-POST פועלת באופן אסינכרוני. המשמעות היא שהבדיקה ממשיכה לפעול ברקע גם אחרי שמתקבלת תשובה בתגובה לבקשה. הערכים האפשריים של state כוללים: enqueued, running, completed, failed.

השתמשו בכתובת ה-URL שהוחזרה בנכס self כדי להציג את הסטטוס של הבקשה לייצוא הנתונים, כפי שמתואר בקטע הצגת הסטטוס של בקשת ייצוא לניתוח נתונים. כשהבקשה תושלם, הערך של המאפיין state בתגובה יוגדר ל-completed. לאחר מכן תוכלו לגשת לנתוני הניתוח במאגר הנתונים.

דוגמה 1: ייצוא נתונים ל-Cloud Storage

הבקשה הבאה מייצאת קבוצה מלאה של נתונים גולמיים מ-24 השעות האחרונות מסביבת test בארגון myorg. התוכן מיוצא ל-Cloud Storage בקובץ JSON:

curl -X POST -H "Content-Type:application/json" \
"https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/analytics/exports" \
  -d \
  '{
    "name": "Export raw results to Cloud Storage",
    "description": "Export raw results to Cloud Storage for last 24 hours",
    "dateRange": {
      "start": "2018-06-08", 
      "end": "2018-06-09"
    },
    "outputFormat": "json",
    "datastoreName": "My Cloud Storage data repository"
  }' \
  -u orgAdminEmail:password

השתמשו ב-URI שצוין בנכס self כדי לעקוב אחר סטטוס המשימה כפי שמתואר בקטע הצגת הסטטוס של בקשת ייצוא לניתוח נתונים.

דוגמה 2: ייצוא נתונים ל-BigQuery

הבקשה הבאה מייצאת ל-BigQuery קובץ CSV מופרד בפסיקים:

curl -X POST -H "Content-Type:application/json"  \
  "https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/analytics/exports" \
  -d \
  '{
    "name": "Export query results to BigQuery",
    "description": "One-time export to BigQuery",
    "dateRange": {
      "start": "2018-06-08", 
      "end": "2018-06-09"
    },
    "outputFormat": "csv",
    "csvDelimiter": ",", 
    "datastoreName": "My BigQuery data repository"
  }' \
  -u orgAdminEmail:password

הערה: קובץ ה-CSV המיוצא יוצר טבלת BigQuery עם הקידומת הבאה:

<PREFIX>_<EXPORT_DATE>_api_<UUID>_from_<FROM_DATE>_to_<TO_DATE>

השתמשו ב-URI שצוין על ידי המאפיין self כדי לעקוב אחר סטטוס המשימה כפי שמתואר בהצגת הסטטוס של בקשת ייצוא לניתוח נתונים.

דוגמה 3: ייצוא נתוני מונטיזציה

אם הופעלה מונטיזציה בסביבה בארגון, אפשר לבצע שני סוגים של ייצוא נתונים:

  • ייצוא נתונים סטנדרטיים, כמו שמתואר בשתי הדוגמאות הקודמות.
  • ייצוא של נתוני מונטיזציה כדי לייצא נתונים ספציפיים למונטיזציה.

כדי לייצא נתוני מונטיזציה, צריך לציין "dataset":"mint" במטען הייעודי (payload) של הבקשה. כדי להגדיר את האפשרות הזו, הארגון והסביבה צריכים לתמוך במונטיזציה, אחרת צריך להשמיט את המאפיין dataset ממטען הייעודי (payload):

  '{
    "name": "Export raw results to Cloud Storage",
    "description": "Export raw results to Cloud Storage for last 24 hours",
    "dateRange": {
      "start": "2018-06-08", 
      "end": "2018-06-09"
    },
    "outputFormat": "json",
    "datastoreName": "My Cloud Storage data repository",
    "dataset":"mint"
  }'

הסבר על מכסות לייצוא של ממשקי API

כדי למנוע שימוש יתר בקריאות יקרות ל-API לייצוא נתונים, Edge אוכפת מכסה על קריאות ל-API /analytics/exports:

  • בארגונים ובסביבות שלא הופעלה בהם מונטיזציה, המכסה היא:

    • 70 שיחות בחודש לכל ארגון/סביבה.

    לדוגמה, אם יש בארגון שתי סביבות, prod ו-test, תוכלו לבצע 70 קריאות ל-API בחודש לכל סביבה.

  • בארגונים ובסביבות שמופעלת בהם מונטיזציה, המכסה היא:

    • 70 שיחות בחודש לכל ארגון וסביבה עבור נתונים סטנדרטיים.
    • 70 שיחות בחודש לכל ארגון וסביבה לנתוני מונטיזציה.

    לדוגמה, אם מפעילים מונטיזציה בארגון prod, אפשר לבצע 70 קריאות ל-API עבור נתונים רגילים וגם 70 קריאות נוספות ל-API עבור נתוני מונטיזציה.

אם חורגים ממכסת השיחות, ה-API מחזיר תגובת HTTP 429.

הצגת הסטטוס של כל הבקשות לייצוא לניתוח נתונים

כדי להציג את הסטטוס של כל הבקשות לייצוא ניתוח נתונים, צריך לשלוח בקשת GET אל /analytics/exports.

לדוגמה, הבקשה הבאה מחזירה את הסטטוס של כל הבקשות לייצוא לניתוח נתונים עבור הסביבה test בארגון myorg:

curl -X GET \
  "https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/analytics/exports" \
  -u email:password

למטה מוצגת דוגמה לתגובה עם רשימה של שתי בקשות ייצוא: אחת נוספה לתור (נוצרה ובתור) ואחת הושלמה:

[
  {
    "self":
"/v1/organizations/myorg/environments/test/analytics/exports/e8b8db22-fe03-4364-aaf2-6d4f110444ba",
    "name": "Export results To Cloud Storage",
    "description": "One-time export to Google Cloud Storage",
    "userId": "my@email.com",
    "datastoreName": "My Cloud Storage data store",
    "executionTime": "36 seconds",
    "created": "2018-09-28T12:39:35Z",
    "updated": "2018-09-28T12:39:42Z",
    "state": "enqueued"
  },
  {
    "self":
"/v1/organizations/myorg/environments/test/analytics/exports/9870987089fe03-4364-aaf2-6d4f110444ba"
    "name": "Export raw results to BigQuery",
    "description": "One-time export to BigQuery",
    ... 
  }
]

הצגת הסטטוס של בקשת ייצוא לניתוח נתונים

כדי להציג את הסטטוס של בקשת ייצוא ספציפית מ-Analytics, צריך לשלוח בקשת GET אל /analytics/exports/{exportId}, כאשר {exportId} הוא המזהה שמשויך לבקשת הייצוא לניתוח נתונים.

לדוגמה, הבקשה הבאה מחזירה את הסטטוס של בקשת הייצוא לניתוח נתונים עם המזהה 4d6d94ad-a33b-4572-8dba-8677c9c4bd98.

curl -X GET \
"https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/analytics/exports/4d6d94ad-a33b-4572-8dba-8677c9c4bd98" \
-u email:password

למטה מוצגת דוגמה לתשובה:

{
  "self":
"/v1/organizations/myorg/environments/test/analytics/exports/4d6d94ad-a33b-4572-8dba-8677c9c4bd98",
  "name": "Export results To Cloud Storage",
  "description": "One-time export to Google Cloud Storage",
  "userId": "my@email.com",
  "datastoreName": "My Cloud Storage data store",
  "executionTime": "36 seconds",
  "created": "2018-09-28T12:39:35Z",
  "updated": "2018-09-28T12:39:42Z",
  "state": "enqueued"
}

אם הייצוא של ניתוח הנתונים לא מחזיר נתונים, הערך של executionTime מוגדר כ-'0 שניות'.

הפניה למאפיין של בקשה לייצוא

בטבלה הבאה מתוארים המאפיינים שניתן להעביר בגוף הבקשה בפורמט JSON כשמייצאים נתונים מ-Analytics.

מאפיין (property) תיאור חובה?
description תיאור של בקשת הייצוא. לא
name השם של בקשת הייצוא. כן
dateRange

מציינים את התאריכים (start) ו-end של הנתונים לייצוא, בפורמט yyyy-mm-dd. לדוגמה:

"dateRange": {
    "start": "2018-07-29",
    "end": "2018-07-30"
}

הערך של dateRange יכול להתפרס על פני יום אחד בלבד. טווח התאריכים מתחיל בשעה 00:00:00 UTC בתאריך start ומסתיים בשעה 00:00:00 UTC בתאריך end.

הערה: כדי לוודא שכל הנתונים מתועדים ביום הקודם, יכול להיות שתצטרכו לעכב את שעת ההתחלה של בקשת הייצוא (לדוגמה, 00:05:00 לפי שעון UTC).

כן
outputFormat צריך להגדיר כ-json או כ-csv. כן
csvDelimiter

תו מפריד שנמצא בשימוש בקובץ הפלט של ה-CSV, אם הערך של outputFormat הוא csv. ברירת המחדל היא התו , (פסיק). תווי המפריד הנתמכים כוללים פסיק (,), קו אנכי (|) וטאב (\t).

לא
datastoreName שם מאגר הנתונים המכיל את ההגדרה של מאגר הנתונים. כן

לדוגמה:

{
    "name": "Export raw results to Cloud Storage",
    "description": "Export raw results to Cloud Storage for last 24 hours",
    "dateRange": {
      "start": "2018-06-08", 
      "end": "2018-06-09"
    },
    "outputFormat": "json",
    "datastoreName": "My Cloud Storage data repository"
  }