جستجو برای کاربران

می‌توانید کاربرانی را جستجو کنید که ویژگی‌های خاصی را با متد users.list() API Directory مطابقت دارند. این روش پارامتر query می پذیرد که عبارت جستجویی است که یک یا چند عبارت جستجو را ترکیب می کند. هر عبارت جستجو از 3 قسمت تشکیل شده است:

میدان

ویژگی کاربر که جستجو می شود. برای مثال givenName .

اپراتور

تستی که بر روی داده ها انجام می شود تا مطابقت ارائه شود. به عنوان مثال، عملگر : آزمایش می کند که آیا یک ویژگی متن حاوی مقدار است یا خیر.

ارزش

محتوای صفتی که آزمایش می شود. مثلا Jane .

برای جستجوی چندین فیلد در یک پرس و جو، هر عبارت جستجو را با فاصله از هم جدا کنید. این عملیات یک AND ضمنی است.

توجه: بیشتر داده‌های کاربر ظرف ۱ ساعت به‌روزرسانی می‌شوند، اما ممکن است تا ۳۶ ساعت طول بکشد تا داده‌های جدید در همه نتایج جستجو منعکس شود.

فیلدها

میدان	نوع ارزش	اپراتورها	توضیحات
هیچ کدام مشخص نشده است	رشته		با مقدار داده شده در givenName , familyName یا email مقایسه کنید .
name	رشته	=, :	مقدار به هم پیوسته givenName و familyName .
email	رشته	= , : , :{PREFIX}*	آدرس‌های ایمیل کاربر، از جمله نام‌های مستعار.
givenName	رشته	= , : , :{PREFIX}*	نام یا نام کاربر.
familyName	رشته	= , : , :{PREFIX}*	خانواده یا نام خانوادگی کاربر.
isAdmin	بولی	=	اینکه آیا یک کاربر دارای امتیازات فوق العاده سرپرست است.
isDelegatedAdmin	بولی	=	اینکه آیا یک کاربر امتیازات سرپرست را به وی تفویض کرده است یا خیر.
isSuspended	بولی	=	آیا حساب کاربری به حالت تعلیق درآمده است.
isArchived	بولی	=	آیا حساب کاربری بایگانی شده است یا خیر.
im	رشته	=, :	شناسه شبکه IM.
externalId	رشته	=, :	مقدار شناسه خارجی
manager	رشته	=	آدرس ایمیل مدیر یک کاربر یا مستقیماً یا در زنجیره مدیریت.
managerId	رشته	=	شناسه مدیر یک کاربر به طور مستقیم یا بالای زنجیره مدیریت.
directManager	رشته	=	آدرس ایمیل مدیر مستقیم یک کاربر.
directManagerId	رشته	=	شناسه مدیر مستقیم یک کاربر.
address	رشته	:	با تمام فیلدهای آدرس مطابقت دارد.
addressPoBox	رشته	=, :	یک صندوق پستی
addressExtended	رشته	=, :	یک آدرس گسترده، مانند آدرسی که شامل یک منطقه فرعی است.
addressStreet	رشته	=, :	یک آدرس خیابان
addressLocality	رشته	=, :	شهر یا شهر آدرس.
addressRegion	رشته	=, :	استان یا ایالت به اختصار.
addressPostalCode	رشته	=, :	یک کد پستی یا پستی
addressCountry	رشته	=, :	یک کشور
orgName	رشته	=, :	یک نام سازمان
orgTitle	رشته	=, :	عنوان یک کاربر در سازمان.
orgDepartment	رشته	=, :	یک بخش در سازمان
orgDescription	رشته	=, :	شرح یک سازمان
orgCostCenter	رشته	=, :	مرکز هزینه یک سازمان
phone	رشته	=	شماره تلفن یک کاربر
orgUnitPath	رشته	=	مسیر کامل یک واحد سازمانی. این با تمام زنجیره‌های واحد سازمانی زیر هدف مطابقت دارد. به عنوان مثال، 'orgUnitPath=/' همه کاربران سازمان را برمی گرداند. این فیلد فقط زمانی قابل استفاده است که viewType=admin_view .
isEnrolledIn2Sv	بولی	=	اینکه آیا کاربر در تأیید صحت 2 مرحله‌ای ثبت نام کرده است یا خیر.
isEnforcedIn2Sv	بولی	=	اینکه آیا تأیید صحت 2 مرحله ای برای کاربر اجرا می شود یا خیر.
schemaName.fieldName	?	?	یک ویژگی کاربر سفارشی که با طرح و نام فیلد آن ارجاع داده می شود. فیلد باید دارای ویژگی indexed آن به true باشد.

انواع ارزش

نوع ارزش	نوع فیلد طرحواره معادل	یادداشت ها
رشته	STRING ، EMAIL ، PHONE	اگر پرس و جو حاوی فضای خالی باشد ' آن را با گیومه های تکی احاطه کنید. از نقل‌قول‌های تکی در جستارها با \' ، برای مثال 'Valentine\'s Day' فرار کنید.
بولی	BOOL	باید مقدار true یا false داشته باشد. فقط از عملگر = پشتیبانی می کند.
شماره	INT64 ، DOUBLE	باید از نقطه به عنوان جداکننده اعشاری و بدون جداکننده هزاران استفاده کرد، برای مثال 150430.25 .
تاریخ	DATE	در قالب YYYY-MM-DD، برای مثال 2001-02-15 مشخص شده است.

اپراتورها

اپراتور	انواع ارزش پشتیبانی شده	یادداشت ها
=	رشته، بولی، عدد، تاریخ	فیلد و مقدار دقیقا مطابقت دارند. به عنوان مثال، givenName=Jane همه کاربران را با ویژگی givenName "Jane" مطابقت می دهد، اما نه "Jane Ann" . در اکثر فیلدهای رشته پشتیبانی می شود ( به بالا مراجعه کنید ).
:	رشته	فیلد به ترتیب شامل کل کلمات درون مقدار است. به‌عنوان مثال، یک پرس و جو با givenName:Jane ، کاربرانی را با مقادیر givenName "Jane" و "Jane Ann" مطابقت می‌دهد، اما نه "Janet" . یک جستار چند کلمه ای برای 'givenName:Mary Ann' با مقادیر "Mary Ann Evans" و "Sarah Mary Ann" مطابقت دارد اما نه "Ann Mary" . در اکثر فیلدهای رشته پشتیبانی می شود ( به بالا مراجعه کنید ).
:{PREFIX}*	رشته	فیلد با مقدار شروع می شود. به‌عنوان مثال، یک پرس و جو با givenName:Jane* کاربرانی را با مقادیر givenName "Jane" ، "Jane Ann" و "Janet" منطبق می‌کند اما "Sarah Jane" را ندارد. فقط در مجموعه محدودی از فیلدهای رشته ای پشتیبانی می شود ( به بالا مراجعه کنید ). در ویژگی های سفارشی پشتیبانی نمی شود.
:[{MIN},{MAX}]	شماره، تاریخ	میدان در یک محدوده است. برای مطابقت، مقدار فیلد باید بزرگتر یا مساوی با {MIN} و کمتر از {MAX} باشد. ویژگی های شماره سفارشی باید یک numericIndexingSpec را برای پشتیبانی از این عملگر مشخص کند.
>	شماره، تاریخ	فیلد بزرگتر از مقدار است. ویژگی های شماره سفارشی باید یک numericIndexingSpec را برای پشتیبانی از این عملگر مشخص کند.
>=	شماره، تاریخ	فیلد بزرگتر یا مساوی مقدار است. ویژگی های شماره سفارشی باید یک numericIndexingSpec را برای پشتیبانی از این عملگر مشخص کند.
<	شماره، تاریخ	فیلد کمتر از مقدار است. ویژگی های شماره سفارشی باید یک numericIndexingSpec را برای پشتیبانی از این عملگر مشخص کند.
<=	شماره، تاریخ	فیلد کمتر یا مساوی مقدار است. ویژگی های شماره سفارشی باید یک numericIndexingSpec را برای پشتیبانی از این عملگر مشخص کند.

توجه: استفاده از عملگر محدوده :[min,max] با پیوستن به >=min AND <max برای فیلدهای چند مقداری یکسان نیست. به عنوان مثال، اگر یک فیلد چند ارزشی با دو مقدار 10 و 20 وجود داشته باشد، با field>12 field<15 مطابقت دارد زیرا حداقل یک مقدار مطابق با هر عبارت وجود دارد اما field:[12,15] زیرا هیچ مقدار واحدی در این محدوده وجود ندارد.

نمونه ها

همه پرس و جوها از متد users.list استفاده می کنند که درخواست HTTP مشابه موارد زیر دارد (شکاف خط برای خوانایی گنجانده شده است):

GET https://admin.googleapis.com/admin/directory/v1/users?domain=DOMAIN_NAME&query=QUERY_PARAMETERS

توجه: پارامترهای query باید با URL رمزگذاری شوند. برای مثال، query=givenName:Jane* با URL به صورت query=givenName%3AJane* رمزگذاری شده است. تمام مثال های موجود در این صفحه پارامترهای query رمزگذاری نشده را نشان می دهند. کتابخانه های سرویس گیرنده این کدگذاری URL را به طور خودکار مدیریت می کنند.

یک کاربر را با نام جستجو کنید

فیلد پرس و جوی name مقدار به هم پیوسته givenName و familyName را آزمایش می کند. پرس و جو برای name='Jane' هیچ نتیجه ای برای کاربری با givenName='Jane' و familyName='Smith' به دست نمی دهد.

name='Jane Smith'

کاربرانی را با givenName یا familyName که حاوی یک مقدار است جستجو کنید

name:'Jane'

جستجوی کاربرانی که با پیشوند ایمیل مطابقت دارند

email:admin*

همه مدیران فوق العاده را جستجو کنید

isAdmin=true

جستجوی کاربران با orgTitles حاوی "Manager"

orgTitle:Manager

کاربرانی را با یک مدیر مشترک در زنجیره گزارش آنها جستجو کنید

manager='[e-mail]'

کاربران را با همان مدیر مستقیم جستجو کنید

directManager='[e-mail]'

جستجوی کاربران در یک کشور خاص

addressCountry='Sweden'

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

orgName='Human Resources'

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

orgName=Engineering orgTitle:Manager

ویژگی های کاربر سفارشی را جستجو کنید

توجه: مثال‌های زیر یک طرح کاربری به نام EmploymentData را با فیلدهای projects ، location و jobLevel فرض می‌کنند.

همه کارکنانی که روی یک پروژه خاص کار می کنند را جستجو کنید

EmploymentData.projects:'GeneGnomes'

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

EmploymentData.location='Atlanta'

همه کارمندان بالاتر از سطح شغلی 7 را جستجو کنید

EmploymentData.jobLevel>=7

همه کارمندان با سطوح شغلی >= 5 و < 8 را جستجو کنید

EmploymentData.jobLevel:[5,8]

همه کارمندانی را که در 2-Step vVerification ثبت نام کرده اند جستجو کنید

isEnrolledIn2Sv=true

همه کارمندانی را جستجو کنید که تأیید صحت 2 مرحله‌ای را اجرا کرده‌اند

isEnforcedIn2Sv=true