صادر کردن داده‌ها از 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، روی افزودن کلیک کنید.
  5. در فیلد اصول جدید، نماینده سرویس value برگردانده‌شده در مرحله ۱ را وارد کنید. برای مثال، value نشان‌داده‌شده در مرحله ۱ service-9q1ibk@gcp-sa-apigee-uap.iam.gserviceaccount.com است.
  6. روی دکمه +افزودن نقش دیگر کلیک کنید و نقش‌های زیر را اضافه کنید:
    • کاربر BigQuery
    • سرپرست فضای ذخیره‌سازی
  7. روی ذخیره کلیک کنید.

داده‌های Apigee Analytics

‫Apigee Analytics طیف گسترده‌ای از داده‌هایی را که در سراسر میاناهای برنامه‌سازی کاربردی شما جریان دارد جمع‌آوری و تجزیه‌وتحلیل می‌کند و ابزارهای دیداری‌سازی، ازجمله داشبوردهای تعاملی، گزارش‌های سفارشی، و ابزارهای دیگری را که گرایش‌های عملکرد کارگزار نیابتی API را شناسایی می‌کنند ارائه می‌دهد. اکنون می‌توانید با صادر کردن داده‌های Analytics از Apigee Analytics به مخزن داده‌های خودتان، مثل Google Cloud Storage یا Google BigQuery، به این محتوای غنی دسترسی پیدا کنید. سپس می‌توانید از قابلیت‌های قدرتمند پُرسمان و یادگیری ماشین ارائه‌شده توسط Google BigQuery و TensorFlow برای انجام تجزیه‌وتحلیل داده‌های خودتان بهره ببرید. همچنین می‌توانید داده‌های تجزیه‌وتحلیل صادرشده را با داده‌های دیگر، مثل گزارش‌های وب، ترکیب کنید تا اطلاعات آماری جدیدی درباره کاربران، میاناهای برنامه‌سازی کاربردی، و برنامه‌هایتان به‌دست آورید.

قالب صادر کردن داده‌ها

داده‌های Analytics را به یکی از قالب‌های زیر صادر کنید:

  • مقادیر جداشده با کاما (CSV)

    جداکننده پیش‌فرض نویسه کاما (،) است. نویسه‌های جداکننده پشتیبانی‌شده شامل ویرگول (,)، خط عمودی (|)، و کلید جهش (\t) می‌شود. مقدار را بااستفاده از دارایی csvDelimiter، همان‌طور که در مرجع دارایی درخواست صادر کردن توضیح داده شده است، پیکربندی کنید .

  • JSON (محدودشده با خط جدید)

    به نویسه خط جدید اجازه می‌دهد به‌عنوان جداکننده استفاده شود.

داده‌های صادرشده شامل همه سنجه‌ها و ابعاد تجزیه‌وتحلیل تعبیه‌شده در Edge و هرگونه داده تجزیه‌وتحلیل سفارشی است که اضافه می‌کنید. برای شرح داده‌های صادرشده، به مرجع سنجه‌ها، ابعاد، و فیلترهای Analytics مراجعه کنید.

می‌توانید داده‌های Analytics را به مخازن داده زیر صادر کنید:

نمای کلی فرایند صادر کردن

مراحل زیر فرایند استفاده‌شده برای صادر کردن داده‌های Analytics را خلاصه می‌کند:

  1. مخزن داده (Cloud Storage یا BigQuery) را برای صادر کردن داده‌ها پیکربندی کنید. باید مطمئن شوید که مخزن داده‌هایتان به‌درستی پیکربندی شده است و حساب خدماتی که برای نوشتن داده‌ها در مخزن داده‌ها استفاده می‌شود اجازه‌های صحیح را دارد.

  2. ایجاد فروشگاه داده که ویژگی‌های مخزن داده (Cloud Storage یا BigQuery) را که داده‌هایتان را به آن صادر می‌کنید تعریف می‌کند، ازجمله اطلاعات اعتباری استفاده‌شده برای دسترسی به مخزن داده.

    وقتی فروشگاه داده‌ای ایجاد می‌کنید، اطلاعات اعتباری مخزن داده را در «انبار اطلاعات اعتباری Edge» بارگذاری می‌کنید تا به‌طور ایمن ذخیره شوند. سپس سازوکار برون‌برد داده از آن اطلاعات اعتباری برای نوشتن داده در مخزن داده شما استفاده می‌کند.

  3. از API صادر کردن داده‌ها برای شروع صادر کردن داده‌ها استفاده کنید. صادر کردن داده‌ها به‌صورت ناهمزمان در پس‌زمینه اجرا می‌شود.

  4. از API برون‌برد داده برای تعیین زمان تکمیل برون‌برد استفاده کنید.

  5. پس‌از تکمیل صادر کردن، در مخزن داده‌هایتان به داده‌های صادرشده دسترسی پیدا کنید.

بخش‌های زیر این مراحل را با جزئیات بیشتری توضیح می‌دهند.

پیکربندی مخزن داده

سازوکار برون‌برد داده‌های Analytics داده‌ها را در Cloud Storage یا BigQuery می‌نویسد. برای اینکه این نوشتن انجام شود، باید:

  • حساب خدمات Google Cloud Platform ایجاد کنید.
  • نقش حساب سرویس را طوری تنظیم کنید که بتواند به Cloud Storage یا BigQuery دسترسی داشته باشد.

ایجاد حساب خدمات برای Cloud Storage یا BigQuery

حساب خدمات نوعی حساب Google است که به‌جای کاربر شخصی به برنامه شما تعلق دارد. سپس برنامه شما از حساب سرویس برای دسترسی به سرویس استفاده می‌کند.

حساب سرویس دارای کلید حساب سرویس است که با رشته JSON نشان داده می‌شود. وقتی فروشگاه داده Edge را ایجاد می‌کنید که اتصال به مخزن داده‌هایتان را تعریف می‌کند، این کلید را به آن منتقل می‌کنید. سپس سازوکار برون‌برد داده از این کلید برای دسترسی به مخزن داده‌هایتان استفاده می‌کند.

حساب سرویس مرتبط با کلید باید مالک پروژه Google Cloud Platform باشد و به مخزن Google Cloud Storage دسترسی نوشتن داشته باشد. برای ایجاد کلید سرویس و بارگیری کردن داده‌بر موردنیاز، به ایجاد و مدیریت کلیدهای حساب سرویس در مستندات Google Cloud Platform مراجعه کنید.

برای مثال، وقتی برای اولین‌بار کلیدتان را بارگیری می‌کنید، به‌صورت شیء 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 صادر کنید:

  • مطمئن شوید که میاناهای برنامه‌سازی کاربردی BigQuery و مدیر منابع Cloud در پروژه Google Cloud Platform شما فعال باشند. برای دریافت دستورالعمل‌ها، به فعال کردن میاناهای برنامه‌سازی کاربردی مراجعه کنید. ‫Apigee از BigQuery API برای بهره‌گیری از ویژگی‌های برون‌برد BigQuery هنگام برون‌برد به Cloud Storage و از Cloud Resource Manager API برای بررسی اجازه قبل‌از هر برون‌برد استفاده می‌کند.
  • مطمئن شوید که حساب خدمات به نقش‌های زیر اختصاص داده شده است:

    • کاربر شغل BigQuery
    • سازنده شیء فضای ذخیره‌سازی
    • سرپرست فضای ذخیره‌سازی (فقط برای آزمایش کردن فضای ذخیره‌سازی داده‌ها همان‌طور که در آزمایش پیکربندی فضای ذخیره‌سازی داده‌ها توضیح داده شده است لازم است. اگر این نقش خیلی گسترده است، می‌توانید به‌جای آن، اجازه storage.buckets.get را به نقش موجود اضافه کنید.)

    یا اگر می‌خواهید نقش موجودی را تغییر دهید یا نقش سفارشی ایجاد کنید، اجازه‌های زیر را به نقش اضافه کنید:

پیکربندی Google BigQuery

قبل‌از اینکه بتوانید داده‌ها را به Google BigQuery صادر کنید:

  • مطمئن شوید که میاناهای برنامه‌سازی کاربردی BigQuery و مدیر منابع Cloud در پروژه Google Cloud Platform شما فعال باشند. برای دریافت دستورالعمل‌ها، به فعال کردن میاناهای برنامه‌سازی کاربردی مراجعه کنید. ‫Apigee از Cloud Resource Manager API برای بررسی اجازه قبل‌از هر برون‌برد استفاده می‌کند.
  • مطمئن شوید که BigQuery API در پروژه Google Cloud Platform شما فعال است. برای دریافت دستورالعمل‌ها، فعال و غیرفعال کردن میاناهای برنامه‌سازی کاربردی را ببینید.
  • مطمئن شوید که حساب خدمات به نقش‌های زیر اختصاص داده شده است:

    • کاربر شغل BigQuery
    • ویرایشگر داده‌های BigQuery

    اگر می‌خواهید نقش موجودی را اصلاح کنید یا نقش سفارشی ایجاد کنید، اجازه‌های زیر را به نقش اضافه کنید:

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

ایجاد فروشگاه داده

انبار داده اتصال به مخزن داده‌های صادراتی شما (Cloud Storage،‏ BigQuery) را تعریف می‌کند، ازجمله اطلاعات اعتباری استفاده‌شده برای دسترسی به مخزن داده.

درباره «انبار اعتبارنامه‌های Edge»

‫Edge از «انبار اطلاعات اعتباری» برای ذخیره ایمن اطلاعات اعتباری استفاده‌شده برای دسترسی به مخزن داده‌های صادراتی شما استفاده می‌کند. برای اینکه سرویسی بتواند به اطلاعات اعتباری در «انبار اطلاعات اعتباری Edge» دسترسی داشته باشد، باید مصرف‌کننده اطلاعات اعتباری را تعریف کنید.

هنگام ایجاد فروشگاه داده بااستفاده از «میانای کاربری Edge»، همان‌طور که در زیر توضیح داده شده است، Edge به‌طور خودکار مصرف‌کننده‌ای را که برای دسترسی به اطلاعات اعتباری استفاده می‌شود ایجاد می‌کند.

آزمایش پیکربندی فروشگاه داده

وقتی فروشگاه داده را ایجاد می‌کنید، Edge معتبر بودن اطلاعات اعتباری و پیکربندی مخزن داده شما را آزمایش یا اعتبارسنجی نمی‌کند. این یعنی می‌توانید فروشگاه داده را ایجاد کنید و تا زمانی که اولین برون‌برد داده را اجرا نکرده‌اید هیچ خطایی را تشخیص ندهید.

یا اینکه پیکربندی فروشگاه داده را قبل‌از ایجاد آن آزمایش کنید. آزمایش مفید است زیرا فرایند صادر کردن داده‌های بزرگ ممکن است زمان زیادی طول بکشد. با آزمایش کردن اطلاعات اعتباری و پیکربندی مخزن داده قبل‌از شروع بارگیری حجم زیادی از داده‌ها، می‌توانید به‌سرعت مشکلات تنظیماتتان را برطرف کنید.

اگر آزمایش موفقیت‌آمیز بود، فروشگاه داده را ایجاد کنید. اگر آزمایش ناموفق بود، خطاها را برطرف کنید و سپس پیکربندی را دوباره آزمایش کنید. فقط پس‌از موفقیت‌آمیز بودن آزمایش‌ها، مخزن داده را ایجاد می‌کنید.

برای فعال کردن ویژگی آزمایشی باید:

ایجاد فروشگاه داده

برای ایجاد فروشگاه داده در میانای کاربری:

  1. به‌عنوان سرپرست سازمان به https://apigee.com/edge وارد شوید و سازمانتان را انتخاب کنید.

    NOTE: برای اینکه بتوانید فروشگاه داده ایجاد کنید، باید سرپرست سازمان Edge باشید.

  2. از نوار پیمایش سمت راست، سرپرست > مخزن داده Analytics را انتخاب کنید. صفحه مخازن داده Analytics نمایش داده می‌شود.

  3. دکمه + افزودن مخزن داده را انتخاب کنید. از شما خواسته می‌شود نوع فروشگاه داده را انتخاب کنید:

  4. نوع مقصد داده‌های صادرشده را انتخاب کنید:

    • Google Cloud Storage
    • Google BigQuery

    صفحه پیکربندی ظاهر می‌شود:

  5. نام فروشگاه داده را وارد کنید.

  6. اطلاعات اعتباری مورداستفاده برای دسترسی به مخزن داده را انتخاب کنید. فهرست کرکره‌ای اطلاعات اعتباری دردسترس نشان داده می‌شود.

    اطلاعات اعتباری مختص نوع مخزن داده است. برای اطلاعات بیشتر، ایجاد حساب خدمات برای Cloud Storage یا BigQuery را ببینید.

    • اگر قبلاً اطلاعات اعتباری را بارگذاری کرده‌اید، اطلاعات اعتباری را از فهرست کرکره‌ای انتخاب کنید. مطمئن شوید که اطلاعات اعتباری مناسب برای نوع مخزن داده را انتخاب کرده‌اید.

    • اگر اطلاعات اعتباری جدیدی به فروشگاه داده اضافه می‌کنید، افزودن جدید را انتخاب کنید. در چارگوش گفتگو، موارد زیر را وارد کنید:

      1. نام اعتبارنامه.
      2. محتوای اطلاعات اعتباری کلید حساب خدماتی JSON ویژه مخزن داده شما است که در ایجاد حساب خدماتی برای Cloud Storage یا BigQuery تعریف شده است.
      3. ساختن را انتخاب کنید.
  7. مشخصه‌های مربوط به نوع مخزن داده را وارد کنید:

    • برای Google Cloud Storage:
      دارایی شرح الزامی است؟
      شناسه پروژه شناسه پروژه Google Cloud Platform.

      برای ایجاد پروژه Google Cloud Platform، به ایجاد و مدیریت پروژه‌ها در مستندات Google Cloud Platform مراجعه کنید.

      بله
      نام سطل نام دسته‌ای که می‌خواهید داده‌های Analytics را به آن در Cloud Storage صادر کنید. قبل‌از انجام برون‌برد داده، باید وجود داشته باشد.

      برای ایجاد کردن Cloud Storage bucket، به ایجاد کردن Storage Buckets در اسناد Google Cloud Platform مراجعه کنید.

      بله
      مسیر دایرکتوری که داده‌های تجزیه‌وتحلیل در مخزن Cloud Storage در آن ذخیره می‌شود. بله
    • برای BigQuery:
      دارایی شرح الزامی است؟
      شناسه پروژه شناسه پروژه Google Cloud Platform.

      برای ایجاد پروژه Google Cloud Platform، به ایجاد و مدیریت پروژه‌ها در مستندات Google Cloud Platform مراجعه کنید.

      بله
      نام مجموعه داده نام مجموعه داده BigQuery که می‌خواهید داده‌های Analytics را به آن صادر کنید. مطمئن شوید که مجموعه داده قبل‌از درخواست برون‌برد گرفتن از داده‌ها ایجاد شده باشد.

      برای ایجاد مجموعه داده BigQuery، به ایجاد و استفاده از مجموعه‌های داده در مستندات Google Cloud Platform مراجعه کنید.

      بله
      پیشوند جدول پیشوند نام‌های جدول‌های ایجادشده برای داده‌های Analytics در مجموعه داده BigQuery. بله
  8. آزمایش کردن اتصال را انتخاب کنید تا مطمئن شوید که از اطلاعات اعتباری می‌توان برای دسترسی به مخزن داده استفاده کرد.

    اگر آزمایش موفقیت‌آمیز بود، فروشگاه داده‌تان را ذخیره کنید.

    اگر آزمایش ناموفق بود، مشکلات را برطرف کنید و آزمایش را دوباره امتحان کنید. ماوس را روی پیام خطا در واسط کاربر حرکت دهید تا اطلاعات اضافی در نکته‌ابزار نمایش داده شود.

  9. پس‌از موفقیت‌آمیز بودن آزمایش اتصال، فروشگاه داده را ذخیره کنید.

اصلاح کردن فروشگاه داده

برای اصلاح کردن فروشگاه داده:

  1. به‌عنوان سرپرست سازمان به https://apigee.com/edge وارد شوید و سازمانتان را انتخاب کنید.

  2. از نوار پیمایش سمت راست، سرپرست > مخزن داده Analytics را انتخاب کنید. صفحه Analytics Datastores نمایش داده می‌شود.

  3. نشانگر موشواره را روی ستون اصلاح‌شده گزارش حرکت دهید تا اصلاح کنید. نماد ویرایش و حذف ظاهر می‌شود.

  4. فروشگاه داده را ویرایش یا حذف کنید.

  5. اگر فروشگاه داده را ویرایش کردید، آزمایش اتصال را انتخاب کنید تا مطمئن شوید که از اطلاعات اعتباری می‌توان برای دسترسی به فروشگاه داده استفاده کرد.

    اگر آزمایش موفقیت‌آمیز باشد، می‌توانید داده‌های نمونه را در مخزن داده‌تان مشاهده کنید.

    اگر آزمایش ناموفق بود، مشکلات را برطرف کنید و آزمایش را دوباره امتحان کنید.

  6. پس‌از موفقیت‌آمیز بودن آزمایش اتصال، فروشگاه داده را به‌روز کنید.

صادر کردن داده‌های Analytics

برای صادر کردن داده‌های Analytics، درخواست POST را به /analytics/exports API صادر کنید. اطلاعات زیر را در بدنه درخواست ارسال کنید:

  • نام و شرح درخواست صادر کردن
  • محدوده تاریخ داده‌های صادرشده (مقدار فقط می‌تواند یک روز را دربر بگیرد)
  • قالب داده‌های صادرشده
  • نام فروشگاه داده‌ها
  • آیا درآمدزایی در سازمان فعال است یا خیر

نمونه‌هایی از درخواست‌های صادر کردن در زیر ارائه شده است. برای شرح کامل ویژگی‌های بدنه درخواست، به مرجع ویژگی درخواست برون‌برد مراجعه کنید.

پاسخ 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.

از نشانی وب برگشتی در دارایی self برای مشاهده وضعیت درخواست صادر کردن داده‌ها، همان‌گونه که در مشاهده وضعیت درخواست صادر کردن Analytics توضیح داده شده است، استفاده کنید. وقتی درخواست تکمیل می‌شود، مقدار دارایی state در پاسخ روی completed تنظیم می‌شود. سپس می‌توانید به داده‌های تجزیه‌وتحلیل در مخزن داده‌هایتان دسترسی پیدا کنید.

مثال ۱: صادر کردن داده‌ها به Cloud Storage

درخواست زیر مجموعه کاملی از داده‌های خام را برای ۲۴ ساعت گذشته از محیط آزمایشی در سازمان myorg صادر می‌کند. محتوا در قالب 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

از شناسه منبع یکنواخت مشخص‌شده توسط دارایی self برای پایش وضعیت کار همان‌گونه که در مشاهده وضعیت درخواست برون‌برد Analytics توضیح داده شده است استفاده کنید.

مثال ۲: صادر کردن داده‌ها به BigQuery

درخواست زیر فایل CSV با جداکننده کاما را به BigQuery صادر می‌کند:

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>

از نشانی وب مشخص‌شده توسط دارایی self برای پایش وضعیت کار همان‌طور که در مشاهده وضعیت درخواست برون‌برد Analytics توضیح داده شده است استفاده کنید.

مثال ۳: صادر کردن داده‌های درآمدزایی

اگر درآمدزایی در محیطی در سازمان فعال باشد، می‌توانید دو نوع برون‌برد داده انجام دهید:

  • برون‌برد داده‌های استاندارد همان‌طور که در دو مثال قبلی نشان داده شد.
  • صادر کردن داده‌های درآمدزایی برای صادر کردن داده‌های خاص درآمدزایی.

برای انجام برون‌برد داده‌های درآمدزایی، "dataset":"mint" را در بار درخواست مشخص کنید. سازمان و محیط باید از درآمدزایی پشتیبانی کنند تا بتوانید این گزینه را تنظیم کنید، درغیراین‌صورت دارایی dataset را از بار محموله حذف کنید:

  '{
    "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 صادر کردن

برای جلوگیری از استفاده بیش‌ازحد از فراخوانی‌های میانای برنامه‌سازی کاربردی برون‌برد داده گران‌قیمت، ‫Edge سهمیه‌ای را برای فراخوانی‌های میانای برنامه‌سازی کاربردی /analytics/exports اعمال می‌کند:

  • برای سازمان‌ها و محیط‌هایی که درآمدزایی فعال نیست، سهمیه به این صورت است:

    • ‫۷۰ تماس در ماه برای هر سازمان/محیط.

    برای مثال، اگر دو محیط در سازمانتان دارید، prod و test، می‌توانید برای هر محیط در ماه ۷۰ تماس «میانای برنامه‌سازی کاربردی» برقرار کنید.

  • برای سازمان‌ها و محیط‌های دارای درآمدزایی فعال، سهمیه به این صورت است:

    • ‫۷۰ تماس در ماه برای هر سازمان و محیط برای داده‌های استاندارد.
    • ‫۷۰ تماس در ماه برای هر سازمان و محیط برای داده‌های درآمدزایی.

    برای مثال، اگر درآمدزایی را در سازمان prod خود فعال کنید، می‌توانید ۷۰ تماس API برای داده‌های استاندارد و ۷۰ تماس API اضافی برای داده‌های درآمدزایی داشته باشید.

اگر از سهمیه تماس فراتر بروید، API پاسخ HTTP 429 برمی‌گرداند.

مشاهده وضعیت همه درخواست‌های صادر کردن Analytics

برای مشاهده وضعیت همه درخواست‌های صادر کردن Analytics، درخواست GET را به /analytics/exports ارسال کنید.

برای مثال، درخواست زیر وضعیت همه درخواست‌های برون‌برد Analytics را برای محیط 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

برای مشاهده وضعیت یک درخواست برون‌برد Analytics خاص، درخواست GET را به /analytics/exports/{exportId} ارسال کنید، که در آن {exportId} شناسه مرتبط با درخواست برون‌برد Analytics است.

برای مثال، درخواست زیر وضعیت درخواست برون‌برد Analytics با شناسه 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 روی «۰ ثانیه» تنظیم می‌شود.

مرجع دارایی درخواست صادر کردن

جدول زیر ویژگی‌هایی را که می‌توانید هنگام صادر کردن داده‌های Analytics در قالب JSON در بدنه درخواست بگذرانید شرح می‌دهد.

دارایی شرح الزامی است؟
description شرح درخواست صادر کردن. نه
name نام درخواست صادر کردن. بله
dateRange

تاریخ start و end داده‌های موردنظر برای صادر کردن را در قالب yyyy-mm-dd مشخص کنید. برای مثال:

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

مقدار dateRange فقط می‌تواند یک روز را دربر بگیرد. محدوده تاریخ در ساعت ۰۰:۰۰:۰۰ به وقت «ساعت هماهنگ جهانی» در تاریخ start شروع می‌شود و در ساعت ۰۰:۰۰:۰۰ به وقت «ساعت هماهنگ جهانی» در تاریخ end پایان می‌یابد.

توجه: برای اطمینان از اینکه همه داده‌های روز قبل ضبط شده است، ممکن است لازم باشد زمان شروع درخواست صادر کردن را به‌تأخیر بیندازید (برای مثال، ۰۰:۰۵:۰۰ به وقت هماهنگ جهانی).

بله
outputFormat آن را به‌عنوان json یا csv مشخص کنید. بله
csvDelimiter

اگر outputFormat روی csv تنظیم شده باشد، از جداکننده در فایل برونداد 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"
  }