REST Resource: enterprises

منبع: اینترپرایز

پیکربندی اعمال شده برای یک شرکت.

نمایش JSON 
{
  "name": string,
  "enabledNotificationTypes": [
    enum (NotificationType)
  ],
  "pubsubTopic": string,
  "primaryColor": integer,
  "logo": {
    object (ExternalData)
  },
  "enterpriseDisplayName": string,
  "termsAndConditions": [
    {
      object (TermsAndConditions)
    }
  ],
  "appAutoApprovalEnabled": boolean,
  "signinDetails": [
    {
      object (SigninDetail)
    }
  ],
  "contactInfo": {
    object (ContactInfo)
  },
  "googleAuthenticationSettings": {
    object (GoogleAuthenticationSettings)
  },
  "enterpriseType": enum (EnterpriseType),
  "managedGooglePlayAccountsEnterpriseType": enum (ManagedGooglePlayAccountsEnterpriseType),
  "managedGoogleDomainType": enum (ManagedGoogleDomainType)
}
فیلدها
name

string

نام سازمانی که توسط سرور در حین ایجاد، به شکل enterprises/{enterpriseId} تولید می‌شود.

enabledNotificationTypes[]

enum ( NotificationType )

انواع اعلان‌های Google Pub/Sub که برای سازمان فعال شده‌اند.

pubsubTopic

string

موضوعی که اعلان‌های انتشار/زیرمجموعه در آن منتشر می‌شوند، در قالب projects/{project}/topics/{topic} . این فیلد فقط در صورتی الزامی است که اعلان‌های انتشار/زیرمجموعه فعال باشند .

primaryColor

integer

رنگی با فرمت RGB که نشان دهنده رنگ غالب برای نمایش در رابط کاربری برنامه مدیریت دستگاه است. اجزای رنگ به صورت زیر ذخیره می‌شوند: (red << 16) | (green << 8) | blue ، که در آن مقدار هر جزء بین 0 تا 255 است.

enterpriseDisplayName

string

نام شرکت که به کاربران نمایش داده می‌شود. حداکثر طول این فیلد ۱۰۰ کاراکتر است.

termsAndConditions[]

object ( TermsAndConditions )

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

appAutoApprovalEnabled
(deprecated)

boolean

مستهلک و بلااستفاده.

signinDetails[]

object ( SigninDetail )

جزئیات ورود به سیستم شرکت.

contactInfo

object ( ContactInfo )

اطلاعات تماس سازمانی یک شرکت تحت مدیریت EMM.

googleAuthenticationSettings

object ( GoogleAuthenticationSettings )

تنظیمات مربوط به احراز هویت کاربر ارائه شده توسط گوگل.

enterpriseType

enum ( EnterpriseType )

فقط خروجی. نوع شرکت.

managedGooglePlayAccountsEnterpriseType

enum ( ManagedGooglePlayAccountsEnterpriseType )

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

managedGoogleDomainType

enum ( ManagedGoogleDomainType )

فقط خروجی. نوع دامنه مدیریت‌شده گوگل.

نوع اعلان

انواع اعلان‌هایی که سرور مدیریت دستگاه ممکن است از طریق Google Pub/Sub ارسال کند.

انوم‌ها
NOTIFICATION_TYPE_UNSPECIFIED این مقدار نادیده گرفته می‌شود.
ENROLLMENT اعلانی که هنگام ثبت نام دستگاه ارسال می‌شود.
COMPLIANCE_REPORT

منسوخ شده.

STATUS_REPORT اعلانی که هنگام ارسال گزارش وضعیت توسط دستگاه ارسال می‌شود.
COMMAND اعلانی که پس از اتمام دستور دستگاه ارسال می‌شود.
USAGE_LOGS اعلانی ارسال می‌شود که دستگاه BatchUsageLogEvents را ارسال می‌کند.
ENTERPRISE_UPGRADE اعلانی برای ارتقاء سازمانی ارسال شد. ارتقاء سازمانی فرآیندی است که یک حساب کاربری گوگل پلی مدیریت‌شده سازمانی را به یک دامنه گوگل مدیریت‌شده ارتقا می‌دهد.

داده‌های خارجی

داده‌ها در یک مکان خارجی میزبانی می‌شوند. داده‌ها باید توسط Android Device Policy دانلود شده و با هش تأیید شوند.

نمایش JSON 
{
  "url": string,
  "sha256Hash": string
}
فیلدها
url

string

آدرس اینترنتی (URL) مطلق به داده‌ها، که باید از طرح http یا https استفاده کند. خط‌مشی دستگاه اندروید هیچ گونه اعتبارنامه‌ای را در درخواست GET ارائه نمی‌دهد، بنابراین URL باید به صورت عمومی قابل دسترسی باشد. گنجاندن یک جزء طولانی و تصادفی در URL می‌تواند برای جلوگیری از کشف URL توسط مهاجمان استفاده شود.

sha256Hash

string

هش SHA-256 با کدگذاری پایه ۶۴ از محتوای میزبانی شده در url. اگر محتوا با این هش مطابقت نداشته باشد، خط‌مشی دستگاه اندروید از داده‌ها استفاده نخواهد کرد.

شرایط و ضوابط

صفحه شرایط و ضوابط که باید در طول فرآیند تأمین منابع پذیرفته شود.

نمایش JSON 
{
  "header": {
    object (UserFacingMessage)
  },
  "content": {
    object (UserFacingMessage)
  }
}
فیلدها
header

object ( UserFacingMessage )

یک سربرگ کوتاه که بالای محتوای HTML ظاهر می‌شود.

content

object ( UserFacingMessage )

یک رشته HTML با قالب‌بندی مناسب. این رشته با استفاده از android.text.Html#fromHtml در سمت کلاینت تجزیه و تحلیل خواهد شد.

جزئیات ورود

منبعی حاوی جزئیات ورود به سیستم برای یک شرکت. enterprises برای مدیریت SigninDetail برای یک شرکت مشخص استفاده کنید.

برای یک سازمان، می‌توانیم هر تعداد SigninDetail داشته باشیم که به طور منحصر به فرد با ترکیب سه فیلد زیر ( signinUrl ، allowPersonalUsage ، tokenTag ) شناسایی می‌شوند. نمی‌توان دو SigninDetail با ( signinUrl ، allowPersonalUsage ، tokenTag ) یکسان ایجاد کرد ( tokenTag یک فیلد اختیاری است).

Patch : این عملیات، فهرست فعلی SigninDetails را با فهرست جدید SigninDetails به‌روزرسانی می‌کند.

  • اگر پیکربندی ذخیره‌شده‌ی SigninDetail ارسال شود، همان signinEnrollmentToken و qrCode را برمی‌گرداند.
  • اگر چندین پیکربندی SigninDetail یکسان را که ذخیره نشده‌اند ارسال کنیم، اولین مورد از بین آن پیکربندی‌های SigninDetail ذخیره می‌شود.
  • اگر پیکربندی از قبل وجود داشته باشد، نمی‌توانیم آن را بیش از یک بار در یک فراخوانی API پچ خاص درخواست کنیم، در غیر این صورت خطای کلید تکراری داده می‌شود و کل عملیات با شکست مواجه می‌شود.
  • اگر پیکربندی SigninDetail خاصی را از درخواست حذف کنیم، از حافظه حذف می‌شود. سپس می‌توانیم signinEnrollmentToken و qrCode دیگری را برای همان پیکربندی SigninDetail درخواست کنیم.
نمایش JSON 
{
  "signinUrl": string,
  "signinEnrollmentToken": string,
  "qrCode": string,
  "allowPersonalUsage": enum (AllowPersonalUsage),
  "defaultStatus": enum (SigninDetailDefaultStatus),
  "tokenTag": string
}
فیلدها
signinUrl

string

URL ورود برای احراز هویت زمانی که دستگاه با توکن ثبت نام ورود تجهیز شده است. نقطه پایانی ورود باید جریان احراز هویت را با URL ای به شکل https://enterprise.google.com/android/enroll?et= به پایان برساند. برای ورود موفقیت‌آمیز، یا برای ورود ناموفق، به آدرس https://enterprise.google.com/android/enroll/invalid مراجعه کنید.

signinEnrollmentToken

string

یک توکن ثبت‌نام در سطح سازمانی که برای راه‌اندازی جریان ورود سفارشی استفاده می‌شود. این یک فیلد فقط خواندنی است که توسط سرور تولید می‌شود.

qrCode

string

یک رشته JSON که نمایش UTF-8 آن می‌تواند برای تولید یک کد QR جهت ثبت دستگاه با این توکن ثبت استفاده شود. برای ثبت دستگاه با استفاده از NFC، رکورد NFC باید حاوی یک نمایش سریالی java.util.Properties از ویژگی‌های موجود در JSON باشد. این یک فیلد فقط خواندنی است که توسط سرور تولید می‌شود.

allowPersonalUsage

enum ( AllowPersonalUsage )

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

برای دستگاه‌های متعلق به شرکت:

  • فعال کردن حالت استفاده شخصی به کاربر اجازه می‌دهد تا یک پروفایل کاری روی دستگاه تنظیم کند.
  • غیرفعال کردن استفاده شخصی مستلزم آن است که کاربر دستگاه را به عنوان یک دستگاه کاملاً مدیریت‌شده ارائه دهد.

برای دستگاه‌های شخصی:

  • فعال کردن حالت استفاده شخصی به کاربر اجازه می‌دهد تا یک پروفایل کاری روی دستگاه تنظیم کند.
  • غیرفعال کردن استفاده شخصی مانع از ارائه خدمات به دستگاه می‌شود. امکان غیرفعال کردن استفاده شخصی در دستگاه شخصی وجود ندارد.
defaultStatus

enum ( SigninDetailDefaultStatus )

اختیاری. اینکه آیا URL ورود باید به طور پیش‌فرض برای شرکت استفاده شود یا خیر. SigninDetail با defaultStatus تنظیم شده روی SIGNIN_DETAIL_IS_DEFAULT برای روش ثبت‌نام حساب گوگل استفاده می‌شود. فقط یکی از signinDetails های یک شرکت می‌تواند defaultStatus تنظیم شده روی SIGNIN_DETAIL_IS_DEFAULT داشته باشد. اگر یک Enterprise حداقل یک signinDetails داشته باشد و defaultStatus هیچ‌کدام از آنها روی SIGNIN_DETAIL_IS_DEFAULT تنظیم نشده باشد، اولین مورد از لیست انتخاب می‌شود و defaultStatus را روی SIGNIN_DETAIL_IS_DEFAULT تنظیم کرده است. اگر هیچ signinDetails برای Enterprise مشخص نشده باشد، ثبت‌نام دستگاه حساب گوگل با شکست مواجه خواهد شد.

tokenTag

string

یک فراداده مشخص شده توسط EMM برای تمایز بین نمونه‌های SigninDetail .

جزئیات ورودوضعیت پیش‌فرض

اینکه آیا آدرس اینترنتی ورود به سیستم باید به طور پیش‌فرض برای شرکت استفاده شود یا خیر.

انوم‌ها
SIGNIN_DETAIL_DEFAULT_STATUS_UNSPECIFIED معادل SIGNIN_DETAIL_IS_NOT_DEFAULT است.
SIGNIN_DETAIL_IS_DEFAULT آدرس اینترنتی ورود به سیستم به طور پیش‌فرض برای شرکت استفاده خواهد شد.
SIGNIN_DETAIL_IS_NOT_DEFAULT آدرس اینترنتی ورود به سیستم به طور پیش‌فرض برای شرکت استفاده نخواهد شد.

اطلاعات تماس

اطلاعات تماس برای شرکت‌های مدیریت‌شده‌ی Google Play.

نمایش JSON 
{
  "contactEmail": string,
  "dataProtectionOfficerName": string,
  "dataProtectionOfficerEmail": string,
  "dataProtectionOfficerPhone": string,
  "euRepresentativeName": string,
  "euRepresentativeEmail": string,
  "euRepresentativePhone": string
}
فیلدها
contactEmail

string

آدرس ایمیل برای ارتباط با شما، که برای ارسال اطلاعیه‌های مهم مربوط به Google Play مدیریت‌شده استفاده خواهد شد.

dataProtectionOfficerName

string

نام مسئول حفاظت از داده‌ها.

dataProtectionOfficerEmail

string

ایمیل مسئول حفاظت از داده‌ها. ایمیل اعتبارسنجی شده اما تأیید نشده است.

dataProtectionOfficerPhone

string

شماره تلفن مسئول حفاظت از داده‌ها. شماره تلفن اعتبارسنجی شده اما تأیید نشده است.

euRepresentativeName

string

نام نماینده اتحادیه اروپا

euRepresentativeEmail

string

ایمیل نماینده اتحادیه اروپا. ایمیل معتبر است اما تأیید نشده است.

euRepresentativePhone

string

شماره تلفن نماینده اتحادیه اروپا. شماره تلفن اعتبارسنجی شده اما تأیید نشده است.

تنظیمات احراز هویت گوگل

شامل تنظیماتی برای احراز هویت کاربر ارائه شده توسط گوگل است.

نمایش JSON 
{
  "googleAuthenticationRequired": enum (GoogleAuthenticationRequired)
}
فیلدها
googleAuthenticationRequired

enum ( GoogleAuthenticationRequired )

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

احراز هویت گوگل الزامی است

تنظیم اینکه آیا احراز هویت گوگل برای این شرکت لازم است یا خیر.

انوم‌ها
GOOGLE_AUTHENTICATION_REQUIRED_UNSPECIFIED این مقدار استفاده نمی‌شود.
NOT_REQUIRED احراز هویت گوگل لازم نیست.
REQUIRED کاربر باید با موفقیت توسط گوگل احراز هویت شود.

نوع سازمانی

نوع بنگاه اقتصادی.

انوم‌ها
ENTERPRISE_TYPE_UNSPECIFIED این مقدار استفاده نمی‌شود.
MANAGED_GOOGLE_DOMAIN این شرکت متعلق به یک دامنه مدیریت‌شده گوگل است.
MANAGED_GOOGLE_PLAY_ACCOUNTS_ENTERPRISE این شرکت، یک شرکت مدیریت‌شده‌ی حساب‌های گوگل پلی است.

حساب‌های کاربری مدیریت‌شده‌ی گوگل‌پلینوع سازمانی

نوع حساب‌های گوگل پلی مدیریت‌شده‌ی سازمانی.

انوم‌ها
MANAGED_GOOGLE_PLAY_ACCOUNTS_ENTERPRISE_TYPE_UNSPECIFIED نوع سازمانی حساب‌های گوگل پلی مدیریت‌شده مشخص نشده است.
CUSTOMER_MANAGED این شرکت توسط مشتری مدیریت می‌شود
EMM_MANAGED این سازمان توسط EMM مدیریت می‌شود (منسوخ شده).

مدیریت‌شدهگوگلدامنهنوع

نوع دامنه مدیریت‌شده گوگل.

انوم‌ها
MANAGED_GOOGLE_DOMAIN_TYPE_UNSPECIFIED نوع دامنه مدیریت‌شده گوگل مشخص نشده است.
TYPE_TEAM دامنه مدیریت‌شده گوگل، یک تیم تأییدشده از طریق ایمیل است.
TYPE_DOMAIN دامنه مدیریت‌شده گوگل، توسط دامنه تأیید شده است.

روش‌ها

create

 یک بنگاه اقتصادی ایجاد می‌کند.

delete

 یک شرکت و تمام حساب‌ها و داده‌های مرتبط با آن را به‌طور دائم حذف می‌کند.

generateEnterpriseUpgradeUrl

 یک URL ارتقاء سازمانی ایجاد می‌کند تا یک حساب کاربری گوگل پلی مدیریت‌شده سازمانی موجود را به یک دامنه گوگل مدیریت‌شده ارتقا دهد.

get

 یک بنگاه اقتصادی به دست می‌آورد.

list

 شرکت‌های تحت مدیریت EMM را فهرست می‌کند.

patch

 یک شرکت را به‌روزرسانی می‌کند.