تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
أنشئ تطبيق سطر أوامر بلغة Python يرسل طلبات إلى Google Apps Script API.
توضّح أدلة التشغيل السريع كيفية إعداد تطبيق وتشغيله، وهو تطبيق يستدعي إحدى واجهات Google Workspace API. يستخدم دليل البدء السريع هذا أسلوبًا مبسطًا للمصادقة مناسبًا لبيئة الاختبار. بالنسبة إلى بيئة الإنتاج، ننصحك بالتعرّف على المصادقة والتفويض قبل اختيار بيانات اعتماد الوصول المناسبة لتطبيقك.
يستخدم هذا الدليل السريع مكتبات برامج Google Workspace API المقترَحة للتعامل مع بعض تفاصيل عملية المصادقة ومنح الإذن.
الأهداف
إعداد البيئة
ثبِّت مكتبة البرامج.
اضبط العيّنة.
تشغيل العيّنة
المتطلبات الأساسية
لتنفيذ هذا التشغيل السريع، يجب استيفاء المتطلبات الأساسية التالية:
إذا كنت تستخدم مشروعًا جديدًا على Google Cloud لإكمال هذا الدليل السريع، عليك إعداد شاشة موافقة OAuth. إذا سبق لك إكمال هذه الخطوة لمشروعك على السحابة الإلكترونية، انتقِل إلى القسم التالي.
في "وحدة تحكّم Google Cloud"، انتقِل إلى "القائمة" menu>>تحديد هوية العلامة التجارية.
إذا سبق لك ضبط ، يمكنك ضبط إعدادات "شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth" التالية في العلامة التجارية والجمهور والوصول إلى البيانات. إذا ظهرت لك الرسالة لم يتم الإعداد بعد، انقر على البدء:
ضمن معلومات التطبيق، في اسم التطبيق، أدخِل اسمًا للتطبيق.
في البريد الإلكتروني لدعم المستخدمين، اختَر عنوان بريد إلكتروني للدعم يمكن للمستخدمين التواصل معك من خلاله إذا كانت لديهم أسئلة حول موافقتهم.
انقر على التالي.
ضمن الجمهور، اختَر داخلي.
انقر على التالي.
ضمن معلومات الاتصال، أدخِل عنوان بريد إلكتروني يمكنك تلقّي إشعارات فيه بشأن أي تغييرات تطرأ على مشروعك.
يمكنك حاليًا تخطّي إضافة النطاقات. في المستقبل، عند إنشاء تطبيق لاستخدامه خارج مؤسسة Google Workspace، عليك تغيير نوع المستخدم إلى خارجي. بعد ذلك، أضِف نطاقات التفويض التي يتطلّبها تطبيقك. لمزيد من المعلومات، يُرجى الاطّلاع على الدليل الكامل حول ضبط موافقة OAuth.
تفويض بيانات اعتماد لتطبيق على الكمبيوتر
لمصادقة المستخدمين النهائيين والوصول إلى بيانات المستخدمين في تطبيقك، عليك إنشاء معرّف عميل واحد أو أكثر من معرّفات عملاء OAuth 2.0. يُستخدَم معرّف العميل لتحديد تطبيق واحد لخوادم OAuth من Google. إذا كان تطبيقك يعمل على منصات متعددة، عليك إنشاء معرّف عميل منفصل لكل منصة.
في "وحدة تحكّم Google Cloud"، انتقِل إلى "القائمة" menu>>العملاء.
"""Shows basic usage of the Apps Script API.Call the Apps Script API to create a new script project, upload a file to theproject, and log the script's URL to the user."""importos.pathfromgoogle.auth.transport.requestsimportRequestfromgoogle.oauth2.credentialsimportCredentialsfromgoogle_auth_oauthlib.flowimportInstalledAppFlowfromgoogleapiclientimporterrorsfromgoogleapiclient.discoveryimportbuild# If modifying these scopes, delete the file token.json.SCOPES=["https://www.googleapis.com/auth/script.projects"]SAMPLE_CODE="""function helloWorld() { console.log("Hello, world!");}""".strip()SAMPLE_MANIFEST="""{ "timeZone": "America/New_York", "exceptionLogging": "CLOUD"}""".strip()defmain():"""Calls the Apps Script API."""creds=None# The file token.json stores the user's access and refresh tokens, and is# created automatically when the authorization flow completes for the first# time.ifos.path.exists("token.json"):creds=Credentials.from_authorized_user_file("token.json",SCOPES)# If there are no (valid) credentials available, let the user log in.ifnotcredsornotcreds.valid:ifcredsandcreds.expiredandcreds.refresh_token:creds.refresh(Request())else:flow=InstalledAppFlow.from_client_secrets_file("credentials.json",SCOPES)creds=flow.run_local_server(port=0)# Save the credentials for the next runwithopen("token.json","w")astoken:token.write(creds.to_json())try:service=build("script","v1",credentials=creds)# Call the Apps Script API# Create a new projectrequest={"title":"My Script"}response=service.projects().create(body=request).execute()# Upload two files to the projectrequest={"files":[{"name":"hello","type":"SERVER_JS","source":SAMPLE_CODE},{"name":"appsscript","type":"JSON","source":SAMPLE_MANIFEST,},]}response=(service.projects().updateContent(body=request,scriptId=response["scriptId"]).execute())print("https://script.google.com/d/"+response["scriptId"]+"/edit")excepterrors.HttpErroraserror:# The API encountered a problem.print(error.content)if__name__=="__main__":main()
تشغيل العيّنة
في دليل العمل، أنشئ النموذج وشغِّله:
python3quickstart.py
في المرة الأولى التي تُشغّل فيها النموذج، سيُطلب منك السماح بالوصول:
سجِّل الدخول إلى حسابك على Google عندما يُطلب منك ذلك إذا لم يسبق لك تسجيل الدخول. إذا كنت مسجّلاً الدخول إلى حسابات متعددة، اختَر حسابًا واحدًا لاستخدامه في التفويض.
انقر على قبول.
يتم تشغيل تطبيق Python ويستدعي Google Apps Script API.
يتم تخزين معلومات التفويض في نظام الملفات، لذا لن يُطلب منك تقديم تفويض في المرة التالية التي تشغّل فيها نموذج الرمز.
تاريخ التعديل الأخير: 2025-08-21 (حسب التوقيت العالمي المتفَّق عليه)
[[["يسهُل فهم المحتوى.","easyToUnderstand","thumb-up"],["ساعَدني المحتوى في حلّ مشكلتي.","solvedMyProblem","thumb-up"],["غير ذلك","otherUp","thumb-up"]],[["لا يحتوي على المعلومات التي أحتاج إليها.","missingTheInformationINeed","thumb-down"],["الخطوات معقدة للغاية / كثيرة جدًا.","tooComplicatedTooManySteps","thumb-down"],["المحتوى قديم.","outOfDate","thumb-down"],["ثمة مشكلة في الترجمة.","translationIssue","thumb-down"],["مشكلة في العيّنات / التعليمات البرمجية","samplesCodeIssue","thumb-down"],["غير ذلك","otherDown","thumb-down"]],["تاريخ التعديل الأخير: 2025-08-21 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\u003cp\u003eThis guide demonstrates how to create a Python command-line application that interacts with the Google Apps Script API to create and manage script projects.\u003c/p\u003e\n"],["\u003cp\u003eBefore running the quickstart, you need to enable the Google Apps Script API in your Google Cloud project, configure the OAuth consent screen, and install the necessary Python libraries.\u003c/p\u003e\n"],["\u003cp\u003eThe provided sample code shows how to use the API to create a new Apps Script project, upload files, and retrieve the project URL.\u003c/p\u003e\n"],["\u003cp\u003eTo run the quickstart, execute the \u003ccode\u003equickstart.py\u003c/code\u003e file, which will guide you through the authorization process and execute the sample code.\u003c/p\u003e\n"],["\u003cp\u003eAfter authorization, your application can interact with the Google Apps Script API without further prompts, allowing you to manage and execute scripts programmatically.\u003c/p\u003e\n"]]],[],null,["Create a Python command-line application that makes requests to the\nGoogle Apps Script API.\n\nQuickstarts explain how to set up and run an app that calls a\nGoogle Workspace API. This quickstart uses a\nsimplified authentication approach that is appropriate for a testing\nenvironment. For a production environment, we recommend learning about\n[authentication and authorization](/workspace/guides/auth-overview)\nbefore\n[choosing the access credentials](/workspace/guides/create-credentials#choose_the_access_credential_that_is_right_for_you)\nthat are appropriate for your app.\n\nThis quickstart uses Google Workspace's recommended API client libraries\nto handle some details of the authentication and authorization flow.\n\nObjectives\n\n- Set up your environment.\n- Install the client library.\n- Set up the sample.\n- Run the sample.\n\nPrerequisites\n\nTo run this quickstart, you need the following prerequisites:\n\n- Python 3.10.7 or greater\n- The [pip](https://pypi.python.org/pypi/pip) package management tool\n- [A Google Cloud project](/workspace/guides/create-project).\n\n\n- A Google account with Google Drive enabled.\n\n\u003cbr /\u003e\n\nSet up your environment\n\nTo complete this quickstart, set up your environment.\n\nEnable the API Before using Google APIs, you need to turn them on in a Google Cloud project. You can turn on one or more APIs in a single Google Cloud project.\n\n- In the Google Cloud console, enable the Google Apps Script API.\n\n [Enable the API](https://console.cloud.google.com/apis/enableflow?apiid=script.googleapis.com)\n\nConfigure the OAuth consent screen\n\nIf you're using a new Google Cloud project to complete this quickstart, configure\nthe OAuth consent screen. If you've already\ncompleted this step for your Cloud project, skip to the next section.\n\n1. In the Google Cloud console, go to Menu menu \\\u003e **Google Auth platform** \\\u003e **Branding** .\n\n [Go to Branding](https://console.cloud.google.com/auth/branding)\n2. If you have already configured the Google Auth platform, you can configure the following OAuth Consent Screen settings in [Branding](https://console.cloud.google.com/auth/branding), [Audience](https://console.cloud.google.com/auth/audience), and [Data Access](https://console.cloud.google.com/auth/scopes). If you see a message that says **Google Auth platform not configured yet** , click **Get Started**:\n 1. Under **App Information** , in **App name**, enter a name for the app.\n 2. In **User support email**, choose a support email address where users can contact you if they have questions about their consent.\n 3. Click **Next**.\n 4. Under **Audience** , select **Internal**.\n 5. Click **Next**.\n 6. Under **Contact Information** , enter an **Email address** where you can be notified about any changes to your project.\n 7. Click **Next**.\n 8. Under **Finish** , review the [Google API Services User Data Policy](https://developers.google.com/terms/api-services-user-data-policy) and if you agree, select **I agree to the Google API Services: User Data Policy**.\n 9. Click **Continue**.\n 10. Click **Create**.\n3. For now, you can skip adding scopes. In the future, when you create an app for use outside of your Google Workspace organization, you must change the **User type** to **External** . Then add the authorization scopes that your app requires. To learn more, see the full [Configure OAuth consent](/workspace/guides/configure-oauth-consent) guide.\n\nAuthorize credentials for a desktop application To authenticate end users and access user data in your app, you need to create one or more OAuth 2.0 Client IDs. A client ID is used to identify a single app to Google's OAuth servers. If your app runs on multiple platforms, you must create a separate client ID for each platform.\n\n1. In the Google Cloud console, go to Menu menu \\\u003e **Google Auth platform** \\\u003e **Clients** .\n\n [Go to Clients](https://console.cloud.google.com/auth/clients)\n2. Click **Create Client**.\n3. Click **Application type** \\\u003e **Desktop app**.\n4. In the **Name** field, type a name for the credential. This name is only shown in the Google Cloud console.\n5. Click **Create** .\n\n\n The newly created credential appears under \"OAuth 2.0 Client IDs.\"\n6. Save the downloaded JSON file as `credentials.json`, and move the file to your working directory.\n\nInstall the Google client library\n\n- Install the Google client library for Python:\n\n pip install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib\n\nConfigure the sample\n\n1. In your working directory, create a file named `quickstart.py`.\n2. Include the following code in `quickstart.py`:\n\n\n apps_script/quickstart/quickstart.py \n [View on GitHub](https://github.com/googleworkspace/python-samples/blob/main/apps_script/quickstart/quickstart.py) \n\n ```python\n \"\"\"\n Shows basic usage of the Apps Script API.\n Call the Apps Script API to create a new script project, upload a file to the\n project, and log the script's URL to the user.\n \"\"\"\n import os.path\n\n from google.auth.transport.requests import Request\n from google.oauth2.credentials import Credentials\n from google_auth_oauthlib.flow import InstalledAppFlow\n from googleapiclient import errors\n from googleapiclient.discovery import build\n\n # If modifying these scopes, delete the file token.json.\n SCOPES = [\"https://www.googleapis.com/auth/script.projects\"]\n\n SAMPLE_CODE = \"\"\"\n function helloWorld() {\n console.log(\"Hello, world!\");\n }\n \"\"\".strip()\n\n SAMPLE_MANIFEST = \"\"\"\n {\n \"timeZone\": \"America/New_York\",\n \"exceptionLogging\": \"CLOUD\"\n }\n \"\"\".strip()\n\n\n def main():\n \"\"\"Calls the Apps Script API.\"\"\"\n creds = None\n # The file token.json stores the user's access and refresh tokens, and is\n # created automatically when the authorization flow completes for the first\n # time.\n if os.path.exists(\"token.json\"):\n creds = Credentials.from_authorized_user_file(\"token.json\", SCOPES)\n # If there are no (valid) credentials available, let the user log in.\n if not creds or not creds.valid:\n if creds and creds.expired and creds.refresh_token:\n creds.refresh(Request())\n else:\n flow = InstalledAppFlow.from_client_secrets_file(\n \"credentials.json\", SCOPES\n )\n creds = flow.run_local_server(port=0)\n # Save the credentials for the next run\n with open(\"token.json\", \"w\") as token:\n token.write(creds.to_json())\n\n try:\n service = build(\"script\", \"v1\", credentials=creds)\n\n # Call the Apps Script API\n # Create a new project\n request = {\"title\": \"My Script\"}\n response = service.projects().create(body=request).execute()\n\n # Upload two files to the project\n request = {\n \"files\": [\n {\"name\": \"hello\", \"type\": \"SERVER_JS\", \"source\": SAMPLE_CODE},\n {\n \"name\": \"appsscript\",\n \"type\": \"JSON\",\n \"source\": SAMPLE_MANIFEST,\n },\n ]\n }\n response = (\n service.projects()\n .updateContent(body=request, scriptId=response[\"scriptId\"])\n .execute()\n )\n print(\"https://script.google.com/d/\" + response[\"scriptId\"] + \"/edit\")\n except errors.HttpError as error:\n # The API encountered a problem.\n print(error.content)\n\n\n if __name__ == \"__main__\":\n main()\n ```\n\n \u003cbr /\u003e\n\n \u003cbr /\u003e\n\nRun the sample\n\n1. In your working directory, build and run the sample:\n\n python3 quickstart.py\n\n\u003c!-- --\u003e\n\n2. The first time you run the sample, it prompts you to authorize access:\n 1. If you're not already signed in to your Google Account, sign in when prompted. If you're signed in to multiple accounts, select one account to use for authorization.\n 2. Click **Accept**.\n\n\n Your Python application runs and calls the Google Apps Script API.\n\n\n Authorization information is stored in the file system, so the next time you run the sample\n code, you aren't prompted for authorization.\n\nNext steps\n\n- [Apps Script API reference documentation](/apps-script/api/reference/rest)\n- [Google APIs Client for Python documentation](/api-client-library/python)\n- [Google Apps Script API PyDoc documentation](https://developers.google.com/resources/api-libraries/documentation/script/v1/python/latest/index%2Ehtml)"]]
