קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
בדף הזה נעזרים במדריכים למפתחים בנושא עיצוב שמתמקד במשאבים ושמות משאבים, ומוסיפים להם פרטי הטמעה ספציפיים של Search Ads 360 Reporting API.
עיצוב ממוקד משאבים
באופן כללי, Search Ads 360 Reporting API מבוסס על תכנון שמתמקד במשאבים, ומתבסס על אוספים של משאבים שניתן לגשת אליהם בנפרד (השמות העצם של ה-API).
ההפניות למשאבים מתבצעות באמצעות שמות המשאבים, והפעולות עליהם מתבצעות באמצעות קבוצה קטנה של שיטות (שנקראות גם פעלים או פעולות).
שמות המשאבים וה-methods האלה, בשילוב עם קידומת ספציפית של גרסת API, מהווים את כתובות ה-URL של ממשק ה-REST.
לדוגמה, אפשר לפרק את כתובת ה-URL הבאה לרכיבים הנפרדים האלה לפי הטבלה הבאה:
כל כתובות ה-URL ל-REST של גרסת API מסוימת (למשל, v0) יש להם קידומת משותפת של גרסת API. השם והשיטה של המשאב מזהים יחד לאיזה שירות API מתבצעת הקריאה.
ב-Search Ads 360 Reporting API נעשה שימוש נרחב בשיטות בהתאמה אישית, בניגוד לרוב ממשקי ה-API הרגילים מסוג REST שמשתמשים בשיטות רגילות של REST כמו list ו-get. Search Ads 360 Reporting API כולל שתי שיטות בהתאמה אישית: search ו-searchStream.
בדפים הבאים מוסבר בפירוט על שמות המשאבים, שיטות השירות וכללי השמות של JSON ב-Search Ads 360 Reporting API, כדי להמחיש איך משתמשים בהם יחד כדי להגדיר נקודות קצה של ממשק REST.
[null,null,["עדכון אחרון: 2025-08-29 (שעון UTC)."],[[["\u003cp\u003eThe Search Ads 360 Reporting API uses a resource-oriented design, where data is organized into collections of resources that can be accessed and manipulated.\u003c/p\u003e\n"],["\u003cp\u003eThe API primarily uses custom methods like \u003ccode\u003esearch\u003c/code\u003e and \u003ccode\u003esearchStream\u003c/code\u003e instead of traditional REST methods.\u003c/p\u003e\n"],["\u003cp\u003eAPI endpoints are constructed using an API version prefix, resource name, and method, which are detailed further in linked documentation.\u003c/p\u003e\n"],["\u003cp\u003eThe guide's examples demonstrate API calls using HTTP, with further instructions available for using the \u003ccode\u003ecurl\u003c/code\u003e command-line utility.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers should be familiar with Resource Oriented Design and Resource Names before using this API.\u003c/p\u003e\n"]]],["The Search Ads 360 Reporting API uses a resource-oriented design with collections of resources accessed via resource names. API calls use HTTP protocol and are structured with a version prefix, resource name, and method. This API primarily employs custom methods, specifically `search` and `searchStream`, instead of standard REST methods. URLs are constructed using the version prefix (e.g., `v0`), a resource name, and a method, defining the specific API service. Further details are available on resource names, service methods, and JSON conventions.\n"],null,["# REST Interface Design\n\nThis page assumes a familiarity with the [Resource Oriented\nDesign](https://cloud.google.com/apis/design/resources) and [Resource\nNames](https://cloud.google.com/apis/design/resource_names) developer guides and\ncomplements them with specific implementation details of the Search Ads 360 Reporting API.\n| **Key Point:** The examples throughout this guide use HTTP protocol to demonstrate how to call the API. See the [Examples](/search-ads/reporting/api/reference/rest/examples) page for how you can make these same API calls using the [`curl`](https://curl.haxx.se/) command line utility.\n\nResource-oriented design\n------------------------\n\nGenerally, the Search Ads 360 Reporting API follows a resource-oriented design, modeled as\n*collections* of individually-addressable *resources* (the *nouns* of the API).\nResources are referenced with their resource names and manipulated using a small\nset of *methods* (also known as *verbs* or *operations*).\n\nThese [resource names](/search-ads/reporting/api/reference/rest/resource-names) and [methods](/search-ads/reporting/api/reference/rest/service-methods), combined\nwith a specific *API version prefix*, comprise the URLs of the REST interface.\nFor example, the URL below can be broken down into these individual components\naccording to the following table: \n\n https://searchads360.googleapis.com/v0/customers/1234567890/searchAds360:search\n\n| API Version Prefix | Resource Name (relative) | Method |\n|------------------------------------------|--------------------------|----------|\n| `https://searchads360.googleapis.com/v0` | `customers/1234567890` | `search` |\n\nAll REST URLs for a particular version of the API (e.g., `v0`)\nshare a common API version prefix. The resource name and method together\nidentifies which API service is being called.\n\nThe Search Ads 360 Reporting API makes heavy use of *custom methods* , as opposed to most\ntraditional REST APIs that use standard REST methods such as `list` and `get`. The Search Ads 360 Reporting API\nincludes two custom methods: `search` and `searchStream`.\n\nThe following pages go into more details about the Search Ads 360 Reporting API's [resource\nnames](/search-ads/reporting/api/reference/rest/resource-names), [service methods](/search-ads/reporting/api/reference/rest/service-methods), and\n[JSON naming conventions](/search-ads/reporting/api/reference/rest/json-mappings) to illustrate how they're used\ntogether to define REST interface endpoints."]]
