זהירות: אתה צופה בתיעוד עבור ממשק ה-API ל-REST. רוב ספריות הלקוחות הרשמיות שלנו משתמשות ב-gRPC. פרטים נוספים זמינים ב
מבוא ל-REST.
שיטות אחרות
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
Mutate, Search ו-SearchStream הן השיטות הנפוצות ביותר ב-Google Ads API, אבל יש עוד הרבה שיטות למטרות ספציפיות. כל השירותים וממשקי ה-API שלהם מתועדים במסמכי העזר.
מיפויים של Protocol buffer RPC ל-REST
כל נקודות הקצה (endpoints) של השירות (בין אם נעשה שימוש ב-REST או ב-gRPC) מוגדרות בסופו של דבר בקובצי ה-proto של חבילת השירותים באמצעות שפת ההגדרה של ממשק proto3.
דוגמה: ListAccessibleCustomers
לדוגמה, בקובץ customer_service.proto מוגדרת שיטה ListAccessibleCustomers, בנוסף לשיטה הרגילה Mutate. ההערה google.api.http שלו מתארת איך המיפוי של ה-method מתבצע ל-HTTP. היא משתמשת ב-HTTP GET עם הפועל המותאם אישית
listAccessibleCustomers:
rpc ListAccessibleCustomers(ListAccessibleCustomersRequest)
returns (ListAccessibleCustomersResponse) {
option (google.api.http) = {
get: "/v21/customers:listAccessibleCustomers"
};
}
המיפוי הזה מתבצע לשיטת ה-REST customers.listAccessibleCustomers.
דוגמה: CreateCustomerClient
דוגמה נוספת מ-customer_service.proto היא השיטה CreateCustomerClient. ההערה google.api.http שלו מתארת HTTP POST באמצעות הפועל המותאם אישית createCustomerClient:
rpc CreateCustomerClient(CreateCustomerClientRequest)
returns (CreateCustomerClientResponse) {
option (google.api.http) = {
post: "/v21/customers/{customer_id=*}:createCustomerClient"
body: "*"
};
option (google.api.method_signature) = "customer_id,customer_client";
}
המיפוי הזה מתבצע לשיטת ה-REST customers.createCustomerClient.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-08-27 (שעון UTC).
[null,null,["עדכון אחרון: 2025-08-27 (שעון UTC)."],[[["\u003cp\u003eWhile \u003ccode\u003eMutate\u003c/code\u003e, \u003ccode\u003eSearch\u003c/code\u003e, and \u003ccode\u003eSearchStream\u003c/code\u003e are commonly used, the Google Ads API offers a wide range of methods for specific tasks, all documented in the REST reference documentation.\u003c/p\u003e\n"],["\u003cp\u003eAll Google Ads API service endpoints, including REST and gRPC, are defined in .proto files using the proto3 Interface Definition Language.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003egoogle.api.http\u003c/code\u003e annotation within these .proto files details how each method maps to HTTP for RESTful interactions, including examples like \u003ccode\u003eListAccessibleCustomers\u003c/code\u003e and \u003ccode\u003eCreateCustomerClient\u003c/code\u003e.\u003c/p\u003e\n"]]],["The Google Ads API includes various methods beyond `Mutate`, `Search`, and `SearchStream`, all detailed in REST documentation. Service endpoints are defined in `.proto` files using proto3. `ListAccessibleCustomers` is a GET method, mapped using the `google.api.http` annotation in the `customer_service.proto` file, and uses custom verb `listAccessibleCustomers`. Similarly, `CreateCustomerClient`, a POST method, uses custom verb `createCustomerClient`, also defined in the same file.\n"],null,["# Other Methods\n\nWhile `Mutate`, `Search`, and `SearchStream` are the most common methods\nin the Google Ads API, there are many others for specific purposes. All services and\ntheir APIs are documented in the\n[reference documentation](/google-ads/api/reference/rpc/v21/overview).\n\nProtocol buffer RPC to REST mappings\n------------------------------------\n\nAll the service endpoints (whether using REST and gRPC) are ultimately defined\nin the\n[.proto files of the services package](https://github.com/googleapis/googleapis/tree/master/google/ads/googleads/v21/services)\nusing the\n[proto3 Interface Definition Language](//cloud.google.com/apis/design/proto3).\n\n### Example: ListAccessibleCustomers\n\nFor example, the [`customer_service.proto`](https://github.com/googleapis/googleapis/tree/master/google/ads/googleads/v21/services/customer_service.proto) file\ndefines a `ListAccessibleCustomers` method, in addition to the standard `Mutate`\n. Its [`google.api.http`](//google.aip.dev/127) annotation describes\nhow the method maps to HTTP. It uses an HTTP `GET` with the custom verb\n`listAccessibleCustomers`: \n\n```css+lasso\nrpc ListAccessibleCustomers(ListAccessibleCustomersRequest)\n returns (ListAccessibleCustomersResponse) {\n option (google.api.http) = {\n get: \"/v21/customers:listAccessibleCustomers\"\n };\n}\n```\n\nThis maps to the\n[customers.listAccessibleCustomers](/google-ads/api/reference/rpc/v21/CustomerService/ListAccessibleCustomers)\nREST method.\n\n### Example: CreateCustomerClient\n\nAnother example from [`customer_service.proto`](https://github.com/googleapis/googleapis/tree/master/google/ads/googleads/v21/services/customer_service.proto) is\nthe `CreateCustomerClient` method. Its `google.api.http` annotation describes an\nHTTP `POST` using the custom verb `createCustomerClient`: \n\n```css+lasso\nrpc CreateCustomerClient(CreateCustomerClientRequest)\n returns (CreateCustomerClientResponse) {\n option (google.api.http) = {\n post: \"/v21/customers/{customer_id=*}:createCustomerClient\"\n body: \"*\"\n };\n option (google.api.method_signature) = \"customer_id,customer_client\";\n}\n```\n\nThis maps to the [customers.createCustomerClient](/google-ads/api/reference/rpc/v21/CustomerService/CreateCustomerClient)\nREST method."]]
