مرجع اجزای داخلی

این سند گزینه‌ها، روش‌ها، ویژگی‌ها و رویدادها را برای همه اجزای داخلی Embed API توضیح می‌دهد.

اعتبار

gapi.analytics.auth

مؤلفه auth یک تک تن است که می تواند برای مجوز دادن به کاربر استفاده شود.

مواد و روش ها
authorize( options :Object)	بازگشت: gapi.analytics.auth یک دکمه ورود به سیستم Google Analytics را در داخل ظرف مشخص شده ارائه می دهد که به کاربر اجازه می دهد با حساب Google خود وارد شود.
isAuthorized()	بازگشت: boolean اگر کاربر با موفقیت مجوز داده باشد true ، در غیر این صورت false را برمی‌گرداند.
signOut()	بازگشت: gapi.analytics.auth کاربر فعلی را از سیستم خارج می کند. همچنین رویداد signOut فعال می کند.
getAuthResponse()	برمی گرداند: Object داده های احراز هویت را دریافت می کند که با درخواست مجوز اصلی بازگردانده شده است. شیء برگشتی شامل نشانه دسترسی است که معمولاً می تواند درخواست های تأیید شده را به صورت دستی انجام دهد.
getUserProfile()	برمی گرداند: Object اطلاعات اولیه نمایه را در مورد کاربر وارد شده فعلی دریافت می کند. این شامل نام کاربر، آدرس ایمیل و تصویر نمایه عمومی (در صورت تنظیم) است.

روش های ارثی
on
once
off

گزینه ها
clientId	نوع: string شناسه مشتری پروژه شما در کنسول توسعه دهندگان .
container	نوع: string|HTMLElement شناسه یک عنصر HTML در DOM که میزبان دکمه ورود به سیستم است. همچنین می توانید به خود عنصر ارجاع دهید.
userInfoLabel	نوع: string متنی که باید قبل از آدرس ایمیل کاربر وارد شده نمایش داده شود. پیش‌فرض 'You are logged in as: ' .
scopes	نوع: Array فهرستی از حوزه‌های تأیید اعتبار Google API که برنامه شما درخواست می‌کند. برای دیدن همه محدوده‌های موجود، از OAuth 2.0 Playground دیدن کنید. برای حوزه‌های احراز هویت API Google Analytics به راهنمای توسعه‌دهنده برای منابع پیکربندی و گزارش مراجعه کنید.
overwriteDefaultScopes	نوع: boolean نشان می دهد که آیا گزینه scopes جایگزین دامنه های پیش فرض Embed API می شود یا به آنها اضافه می کند. تعیین false (پیش‌فرض) به دامنه‌های پیش‌فرض اضافه می‌شود و با تعیین true ، مواردی که توسط گزینه scopes مشخص شده است جایگزین می‌شوند. مقدار دامنه های پیش فرض این است: ['https://www.googleapis.com/auth/analytics.readonly'] . توجه: احراز هویت از طریق Embed API نیاز به دسترسی به نمایه اصلی کاربر دارد. نمی توان آن دامنه ها را بازنویسی کرد.
serverAuth.access_token	نوع: string اگر از قبل یک نشانه دسترسی معتبر دارید، می‌توانید آن را مستقیماً به روش مجوز ارسال کنید و از کاربر درخواست مجوز نمی‌شود. برای جزئیات در مورد نحوه بازیابی رمز دسترسی، به مستندات OAuth 2.0 مراجعه کنید.

مناسبت ها
signIn	استدلال ها: هیچ زمانی فعال می شود که کاربر با موفقیت وارد سیستم شود.
signOut	استدلال ها: هیچ زمانی فعال می شود که کاربر با موفقیت از سیستم خارج شود.
needsAuthorization	استدلال ها: هیچ هنگام فراخوانی روش gapi.analytics.auth.authorize ، بررسی اولیه انجام می شود تا ببیند آیا کاربر در حال حاضر وارد سیستم شده است یا خیر. اگر کاربر وارد سیستم نشده باشد، این رویداد فعال می شود تا نشان دهد که مجوز بیشتری لازم است.
error	استدلال ها: response زمانی فعال می شود که در طی فرآیند احراز هویت خطایی رخ دهد. اگر می خواهید پیام خطا را از شی پاسخ دریافت کنید، در response.error.message خواهد بود.

رویدادهای منسوخ شده
success	استدلال ها: response این رویداد برای سازگاری به عقب وجود دارد و ممکن است در نسخه بعدی حذف شود. به جای آن از رویداد signIn استفاده کنید.

مثال

// Standard client-side authorization.

gapi.analytics.auth.authorize({
  clientId: 'XXXXXX',
  container: 'auth-button'
});

gapi.analytics.auth.on('signIn', function() {
  console.log(gapi.analytics.auth.getUserProfile());
});

// Authorization using an access token obtained server-side.
// You do not need to register an event handler because
// authorization happens immediately.

gapi.analytics.auth.authorize({
  serverAuth: {
    access_token: 'XXXXXX'
  }
});

توجه: مجوز بلافاصله هنگام استفاده از serverAuth.access_token انجام می‌شود، بنابراین نیازی به ثبت‌کننده رویداد نیست.

مهم: هنگام استفاده از serverAuth.access_token ، این به شما بستگی دارد که مطمئن شوید رمز معتبر است و منقضی نشده است. برای جزئیات در مورد نحوه بازخوانی یک نشانه دسترسی منقضی شده، به مستندات OAuth 2.0 مراجعه کنید.

داده ها

gapi.analytics.report.Data

سازنده
Data( options :Object)	مؤلفه Data به شما امکان می دهد از API گزارش هسته گوگل آنالیتیکس پرس و جو کنید و نتایج را دریافت کنید.

گزینه ها
query	نوع: Object یک شی حاوی پارامترهای پرس و جو از Core Reporting API . مقادیر پیش فرض زیر علاوه بر پیش فرض های معمولی ارائه شده توسط API استفاده می شود: { 'start-date': '7daysAgo', 'end-date': 'yesterday }

روش های ارثی
get
set
execute
on
once
off
emit

مناسبت ها
success	استدلال ها: response زمانی که پرس و جو با موفقیت تکمیل شد فعال شد.
error	استدلال ها: response هنگامی که خطایی در فرآیند پرس و جو رخ می دهد فعال می شود. اگر می خواهید پیام خطا را از شی پاسخ دریافت کنید، در response.error.message خواهد بود.

مثال

var report = new gapi.analytics.report.Data({
  query: {
    ids: 'ga:XXXX',
    metrics: 'ga:sessions',
    dimensions: 'ga:city'
  }
});

report.on('success', function(response) {
  console.log(response);
});

report.execute();

دیتاچارت

gapi.analytics.googleCharts.DataChart

سازنده
DataChart( options :Object)	DataChart یک نمودار استاندارد Google و یک مؤلفه داده را می‌پیچد تا بتوانید به راحتی از یک پرس‌وجو تصویری ایجاد کنید بدون اینکه نیازی به سیم‌کشی آن را خودتان داشته باشید.

گزینه ها
query	نوع: Object گزینه پرس و جو مولفه داده را ببینید.
chart	نوع: Object برای جزئیات گزینه نمودار فردی به زیر مراجعه کنید.
chart.container	نوع: string|HTMLElement شناسه یک عنصر HTML در DOM که میزبان DataChart است. همچنین می توانید به خود عنصر ارجاع دهید.
chart.type	نوع: string نوع نمودار گزینه های ممکن عبارتند از: LINE ، COLUMN ، BAR ، TABLE و GEO .
chart.options	نوع: Object هر گزینه ای که می تواند به شی نمودار Google مربوطه منتقل شود.

روش های ارثی
get
set
execute
on
once
off
emit

مناسبت ها
success	استدلال: result هنگامی که پرس و جو با موفقیت تکمیل شد و نمودار به طور کامل ارائه شد، فعال می شود. result.chart - نمونه Google Chart. result.data - پاسخ گزارش در قالب پارامتر داده . result.dataTable – نمونه DataTable ایجاد شده از شی result.data . result.response – شی پاسخ API خام.
error	استدلال ها: response هنگامی که خطایی در حین پرس و جو یا فرآیند رندر رخ می دهد فعال می شود. اگر می خواهید پیام خطا را از شی پاسخ دریافت کنید، در response.error.message خواهد بود.

مثال

var chart = new gapi.analytics.googleCharts.DataChart({
  query: {
    ids: 'ga:XXXX',
    metrics: 'ga:sessions',
    dimensions: 'ga:date'
  },
  chart: {
    type: 'LINE',
    container: 'line-chart',
    options: {
      title: 'Sessions over the past week.',
      fontSize: 12
    }
  }
});
chart.on('success', function(response) {
  // response.chart : the Google Chart instance.
  // response.data : the Google Chart data object.
});

chart.execute();

ViewSelector

gapi.analytics.ViewSelector

سازنده
ViewSelector( options :Object)	کامپوننت ViewSelector به شما امکان می‌دهد حساب، دارایی و نمای خود را از طریق منوهای کشویی انتخاب کنید.

گزینه ها
container	نوع: string|HTMLElement شناسه یک عنصر HTML در DOM که میزبان ViewSelector خواهد بود. همچنین می توانید به خود عنصر ارجاع دهید.

روش های ارثی
get
set
execute
on
once
off
emit

خواص نمونه
ids	نوع: string شناسه جدول منحصر به فرد از فرم ga:XXXX، که در آن XXXX شناسه نمای (نمایه) Analytics است.

مناسبت ها
change	استدلال ها: ids هر زمانی که کاربر نمای جدیدی را از منوهای کشویی انتخاب کند فعال می شود. همچنین هنگامی که نمونه ViewSelector برای اولین بار رندر می شود و نمای پیش فرض نمایش داده می شود، فعال می شود.

مثال

var viewSelector = new gapi.analytics.ViewSelector({
  container: 'view-selector'
});

viewSelector.on('change', function(ids) {
  console.log(ids);
});

viewSelector.execute();

روش های اجزای مشترک

مواد و روش ها
set(options)	برمی گرداند: this گزینه های پیکربندی مولفه را تنظیم یا به روز می کند (این را می توان در زمان ایجاد در سازنده نیز انجام داد).
get()	برمی گرداند: Object گزینه های پیکربندی فعلی یک جزء را برمی گرداند.
execute()	برمی گرداند: this عمل اولیه مولفه را فراخوانی می کند. این معمولاً رندر کردن چیزی در صفحه یا اجرای یک گزارش (یا هر دو) است.
on(event, handler)	برمی گرداند: this زمانی که کامپوننت رویداد مشخص شده را منتشر می کند، تابعی را ثبت می کند که باید فراخوانی شود.
once(event, handler)	برمی گرداند: this تابعی را ثبت می کند که فقط در وقوع بعدی رویداد مشخص شده فراخوانی شود. پس از اجرا شدن کنترلر، یک بار که به طور خودکار خود را لغو ثبت می کند.
off(opt_event, opt_handler)	بازده: undefined کنترل کننده رویداد را از یک جزء حذف می کند. اگر هیچ کنترل کننده ای ارسال نشود، همه کنترل کننده های رویداد تصویب شده را حذف می کند. اگر هیچ رویدادی تصویب نشود، همه کنترل‌کننده‌ها را برای همه رویدادها حذف می‌کند.
emit(event, ...opt_args)	بازده: undefined یک رویداد را منتشر می کند. شما می توانید به صورت اختیاری آرگومان هایی را که باید به هر کنترل کننده ثبت شده ارسال شود را مشخص کنید.

set

گزینه های پیکربندی مولفه را تنظیم یا به روز می کند (این را می توان در زمان ایجاد در سازنده نیز انجام داد).

استفاده

component.set(options);

مولفه های

نام	تایپ کنید	شرح
options	Object	گزینه های پیکربندی برای این جزء. گزینه های تصویب شده با گزینه های موجود ادغام می شوند.

برمی گرداند

this - نمونه جزء.

---

get

گزینه های پیکربندی فعلی یک جزء را برمی گرداند.

برمی گرداند

Object – گزینه های پیکربندی فعلی جزء.

---

execute()

عمل اولیه مولفه را فراخوانی می کند. این معمولاً رندر کردن چیزی در صفحه یا اجرای یک گزارش (یا هر دو) است.

برمی گرداند

this - نمونه جزء.

---

on(event, handler)

زمانی که کامپوننت رویداد مشخص شده را منتشر می کند، تابعی را ثبت می کند که باید فراخوانی شود.

مولفه های

نام	تایپ کنید	شرح
event	string	نام رویداد.
handler	Function	تابعی که باید هنگام وقوع رویداد فراخوانی شود. (برای جزئیات پارامتر به مراجع رویداد فردی مراجعه کنید.)

برمی گرداند

this - نمونه جزء.

---

once(event, handler)

تابعی را ثبت می کند که فقط در وقوع بعدی رویداد مشخص شده فراخوانی شود. پس از اجرا شدن کنترلر، یک بار که به طور خودکار خود را لغو ثبت می کند.

مولفه های

نام	تایپ کنید	شرح
event	string	نام رویداد.
handler	Function	تابعی که باید هنگام وقوع رویداد فراخوانی شود. (برای جزئیات پارامتر به مراجع رویداد فردی مراجعه کنید.)

برمی گرداند

this - نمونه جزء.

---

off(opt_event, opt_handler)

کنترل کننده رویداد را از یک جزء حذف می کند. اگر هیچ کنترل کننده ای ارسال نشود، همه کنترل کننده های رویداد تصویب شده را حذف می کند. اگر هیچ رویدادی تصویب نشود، همه کنترل‌کننده‌ها را برای همه رویدادها حذف می‌کند.

مولفه های

نام	تایپ کنید	شرح
opt_event	string	نام رویداد. اگر هیچ رویدادی مشخص نشده باشد، همه کنترل‌کننده‌ها برای همه رویدادها حذف می‌شوند. اختیاری.
opt_handler	Function	یک مرجع به کنترل کننده عملکرد که باید حذف شود. اگر هیچ تابعی ارسال نشود، همه کنترل کننده ها حذف می شوند. اختیاری.

برمی گرداند

undefined

---

emit(event, ...opt_args)

یک رویداد را منتشر می کند. شما می توانید به صورت اختیاری آرگومان هایی را که باید به هر کنترل کننده ثبت شده ارسال شود را مشخص کنید.

مولفه های

نام	تایپ کنید	شرح
event	string	نام رویداد.
...opt_args	*	آرگومان های اختیاری برای ارسال به هر کنترل کننده رویداد ثبت شده.

برمی گرداند

undefined