البدء السريع بلغة Java

تشرح مشاريع Quickstart كيفية إعداد وتشغيل تطبيق يستدعي واجهة برمجة تطبيقات Google Workspace.

تستخدم مشاريع البدء السريع في Google Workspace مكتبات عميل واجهة برمجة التطبيقات لمعالجة بعض تفاصيل عملية المصادقة والتفويض. وننصح باستخدام مكتبات العملاء في تطبيقاتك الخاصة يستخدم البدء السريع هذا أسلوب مصادقة مبسطًا ومناسبًا لبيئة الاختبار. بالنسبة إلى بيئة الإنتاج، ننصحك بالتعرّف على معلومات حول المصادقة والتفويض قبل اختيار بيانات اعتماد الوصول المناسبة لتطبيقك.

يمكنك إنشاء تطبيق سطر أوامر Java لإرسال طلبات إلى واجهة برمجة التطبيقات لبرمجة تطبيقات Google.

الأهداف

• إعداد البيئة
• ابدأ إعداد العيّنة.
• شغِّل النموذج.

المتطلبات الأساسية

• الإصدار 1.8 من لغة Java أو إصدار أحدث
• الإصدار 7.0 من Gradle أو الإصدارات الأحدث
• مشروع على Google Cloud:

• حساب Google مع تفعيل Google Drive

إعداد البيئة

لإكمال عملية البدء السريع هذه، عليك إعداد بيئتك.

تفعيل واجهة برمجة التطبيقات

قبل استخدام Google APIs، عليك تفعيلها في مشروع على Google Cloud. يمكنك تفعيل واجهة برمجة تطبيقات واحدة أو أكثر في مشروع واحد على Google Cloud.

• في Google Cloud Console، فعِّل واجهة برمجة التطبيقات لبرمجة تطبيقات Google.

  تفعيل واجهة برمجة التطبيقات

ضبط شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth

إذا كنت تستخدم مشروعًا جديدًا على Google Cloud لإكمال عملية البدء السريع هذه، يمكنك ضبط شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth وإضافة نفسك كمستخدم تجريبي. إذا كنت قد أكملت هذه الخطوة لمشروعك على Google Cloud بالفعل، فانتقل إلى القسم التالي.

1. في Google Cloud Console، انتقِل إلى القائمة > واجهات برمجة التطبيقات والخدمات > شاشة موافقة OAuth.

   الانتقال إلى شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth

2. اختر نوع المستخدِم لتطبيقك، ثم انقر على إنشاء.
3. أكمل نموذج تسجيل التطبيق، ثم انقر على حفظ ومتابعة.

4. في الوقت الحالي، يمكنك تخطّي إضافة النطاقات والنقر على حفظ ومتابعة. في المستقبل، عند إنشاء تطبيق للاستخدام خارج مؤسستك على Google Workspace، عليك إضافة نطاقات التفويض التي يتطلبها تطبيقك والتحقّق منها.

5. إذا اخترت خارجي لنوع المستخدم، أضِف المستخدمين الاختباريين:
   1. ضمن اختبار المستخدمين، انقر على إضافة مستخدمين.
   2. أدخِل عنوان بريدك الإلكتروني وأي مستخدمين مختبِرين معتمدين آخرين، ثم انقر على حفظ ومتابعة.
6. مراجعة ملخص تسجيل التطبيق. لإجراء تغييرات، انقر على تعديل. إذا كان تسجيل التطبيق يبدو على ما يرام، انقر على الرجوع إلى لوحة البيانات.

تفويض بيانات الاعتماد لتطبيق سطح المكتب

للمصادقة كمستخدم نهائي والوصول إلى بيانات المستخدم في تطبيقك، عليك إنشاء معرّف عميل OAuth 2.0 واحد أو أكثر. يُستخدم معرّف العميل لتحديد تطبيق واحد لخوادم OAuth من Google. إذا كان تطبيقك يعمل على أنظمة أساسية متعددة، يجب عليك إنشاء معرِّف عميل منفصل لكل نظام أساسي.

1. في وحدة تحكُّم Google Cloud، انتقِل إلى القائمة > واجهات برمجة التطبيقات والخدمات > بيانات الاعتماد.

   الانتقال إلى "بيانات الاعتماد"

2. انقر على إنشاء بيانات اعتماد > معرِّف عميل OAuth.
3. انقر على نوع التطبيق > تطبيق سطح المكتب.
4. في الحقل الاسم، اكتب اسمًا لبيانات الاعتماد. ولا يظهر هذا الاسم إلا في Google Cloud Console.
5. انقر على إنشاء. تظهر الشاشة التي تم إنشاؤها من خلال عميل OAuth، وتعرض معرِّف العميل وسر العميل الجديدين.
6. انقر على OK (حسنًا). تظهر بيانات الاعتماد التي تم إنشاؤها حديثًا ضمن معرّفات عميل OAuth 2.0.
7. احفظ ملف JSON الذي تم تنزيله بتنسيق credentials.json، وانقله إلى دليل العمل.

تجهيز مساحة العمل

1. في دليل العمل، أنشئ بنية مشروع جديدة:

   gradle init --type basic
   mkdir -p src/main/java src/main/resources 
   

2. في دليل src/main/resources/، انسخ ملف credentials.json الذي سبق لك تنزيله.

3. افتح ملف build.gradle التلقائي واستبدل محتواه بالرمز التالي:

   AppsScript/Quickstart/build.gradele

   العرض على GitHub

   apply plugin: 'java'
   apply plugin: 'application'
   
   mainClassName = 'AppsScriptQuickstart'
   sourceCompatibility = 11
   targetCompatibility = 11
   version = '1.0'
   
   repositories {
       mavenCentral()
   }
   
   dependencies {
       implementation 'com.google.api-client:google-api-client:2.0.0'
       implementation 'com.google.oauth-client:google-oauth-client-jetty:1.34.1'
       implementation 'com.google.apis:google-api-services-script:v1-rev20220323-2.0.0'
   }
   

إعداد العيّنة

1. في دليل src/main/java/، أنشئ ملف Java جديدًا باسم يطابق القيمة mainClassName في ملف build.gradle.

2. ضمّن الرمز التالي في ملف Java الجديد:

   appsScript/quickstart/src/main/java/AppsScriptQuickstart.java

   العرض على GitHub

   import com.google.api.client.auth.oauth2.Credential;
   import com.google.api.client.extensions.java6.auth.oauth2.AuthorizationCodeInstalledApp;
   import com.google.api.client.extensions.jetty.auth.oauth2.LocalServerReceiver;
   import com.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeFlow;
   import com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets;
   import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
   import com.google.api.client.http.javanet.NetHttpTransport;
   import com.google.api.client.json.JsonFactory;
   import com.google.api.client.json.gson.GsonFactory;
   import com.google.api.client.util.store.FileDataStoreFactory;
   import com.google.api.services.script.Script;
   import com.google.api.services.script.model.Content;
   import com.google.api.services.script.model.CreateProjectRequest;
   import com.google.api.services.script.model.File;
   import com.google.api.services.script.model.Project;
   import java.io.FileNotFoundException;
   import java.io.IOException;
   import java.io.InputStream;
   import java.io.InputStreamReader;
   import java.security.GeneralSecurityException;
   import java.util.Arrays;
   import java.util.Collections;
   import java.util.List;
   
   public class AppsScriptQuickstart {
     private static final String APPLICATION_NAME = "Apps Script API Java Quickstart";
     private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance();
     private static final String TOKENS_DIRECTORY_PATH = "tokens";
   
     /**
      * Global instance of the scopes required by this quickstart.
      * If modifying these scopes, delete your previously saved credentials folder at /secret.
      */
     private static final List<String> SCOPES =
         Collections.singletonList("https://www.googleapis.com/auth/script.projects");
     private static final String CREDENTIALS_FILE_PATH = "/credentials.json";
   
     /**
      * Creates an authorized Credential object.
      *
      * @param HTTP_TRANSPORT The network HTTP Transport.
      * @return An authorized Credential object.
      * @throws IOException If the credentials.json file cannot be found.
      */
     private static Credential getCredentials(final NetHttpTransport HTTP_TRANSPORT)
         throws IOException {
       // Load client secrets.
       InputStream in = AppsScriptQuickstart.class.getResourceAsStream(CREDENTIALS_FILE_PATH);
       if (in == null) {
         throw new FileNotFoundException("Resource not found: " + CREDENTIALS_FILE_PATH);
       }
       GoogleClientSecrets clientSecrets =
           GoogleClientSecrets.load(JSON_FACTORY, new InputStreamReader(in));
   
       // Build flow and trigger user authorization request.
       GoogleAuthorizationCodeFlow flow = new GoogleAuthorizationCodeFlow.Builder(
           HTTP_TRANSPORT, JSON_FACTORY, clientSecrets, SCOPES)
           .setDataStoreFactory(new FileDataStoreFactory(new java.io.File(TOKENS_DIRECTORY_PATH)))
           .setAccessType("offline")
           .build();
       LocalServerReceiver receiver = new LocalServerReceiver.Builder().setPort(8888).build();
       return new AuthorizationCodeInstalledApp(flow, receiver).authorize("user");
     }
   
     public static void main(String... args) throws IOException, GeneralSecurityException {
       // Build a new authorized API client service.
       final NetHttpTransport HTTP_TRANSPORT = GoogleNetHttpTransport.newTrustedTransport();
       Script service =
           new Script.Builder(HTTP_TRANSPORT, JSON_FACTORY, getCredentials(HTTP_TRANSPORT))
               .setApplicationName(APPLICATION_NAME)
               .build();
       Script.Projects projects = service.projects();
   
       // Creates a new script project.
       Project createOp = projects.create(new CreateProjectRequest().setTitle("My Script")).execute();
   
       // Uploads two files to the project.
       File file1 = new File()
           .setName("hello")
           .setType("SERVER_JS")
           .setSource("function helloWorld() {\n  console.log(\"Hello, world!\");\n}");
       File file2 = new File()
           .setName("appsscript")
           .setType("JSON")
           .setSource("{\"timeZone\":\"America/New_York\",\"exceptionLogging\":\"CLOUD\"}");
       Content content = new Content().setFiles(Arrays.asList(file1, file2));
       Content updatedContent = projects.updateContent(createOp.getScriptId(), content).execute();
   
       // Logs the project URL.
       System.out.printf("https://script.google.com/d/%s/edit\n", updatedContent.getScriptId());
     }
   }

تشغيل العيّنة

1. تشغيل النموذج:

   gradle run
   

2. في المرة الأولى التي يتم فيها تشغيل العيّنة، يُطلب منك منح الإذن بالوصول إليها:
   1. سجِّل الدخول إلى حسابك على Google إذا لم يسبق لك تسجيل الدخول عندما يُطلب منك ذلك. إذا سجّلت الدخول إلى حسابات متعددة، اختَر حسابًا واحدًا لاستخدامه للحصول على الإذن.
   2. انقر على قبول.

   يتم تشغيل تطبيق Java وطلب واجهة برمجة تطبيقات Google Apps Script API.

   يتم تخزين معلومات التفويض في نظام الملفات، وبالتالي عند تشغيل نموذج الرمز في المرة التالية، لا يُطلب منك منح الإذن.

الخطوات التالية

• المستندات المرجعية لواجهة برمجة التطبيقات لبرمجة التطبيقات
• مستندات عميل Google APIs لـ Java
• مستندات JavaScript لواجهة برمجة التطبيقات لبرمجة تطبيقات Google