Cuidado: você está vendo a documentação da interface REST da API. A maioria das nossas bibliotecas de cliente oficiais usa o gRPC. Consulte Introdução ao REST para ver mais detalhes.
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Esta página pressupõe familiaridade com os guias para desenvolvedores Projeto orientado a recursos e Nomes de recursos, além de complementar esses guias com detalhes específicos da implementação da API Google Ads.
Design voltado a recursos
Em geral, a API Google Ads segue um design orientado a recursos, modelado como conjuntos de recursos endereçáveis individualmente (os substantivos da API).
Os recursos são referenciados pelos respectivos nomes e manipulados usando um pequeno conjunto de métodos (também conhecidos como verbos ou operações).
Esses nomes de recursos e métodos, combinados com um prefixo de versão da API específico, compõem os URLs da interface REST.
Por exemplo, o URL abaixo pode ser dividido nesses componentes individuais de acordo com a tabela a seguir:
Todos os URLs REST de uma versão específica da API (por exemplo, v21)
compartilham um prefixo comum de versão da API. O nome do recurso e o método juntos
identificam qual serviço de API está sendo chamado.
A API Google Ads usa muito métodos personalizados, ao contrário da maioria das APIs REST tradicionais, que usam métodos REST padrão, como list, get, create, update e delete. Exemplos de métodos personalizados na API Google Ads
incluem search, searchStream e mutate.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Não contém as informações de que eu preciso","missingTheInformationINeed","thumb-down"],["Muito complicado / etapas demais","tooComplicatedTooManySteps","thumb-down"],["Desatualizado","outOfDate","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Problema com as amostras / o código","samplesCodeIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-09-05 UTC."],[[["\u003cp\u003eThis guide provides Google Ads API implementation details, assuming familiarity with Resource Oriented Design and Resource Names.\u003c/p\u003e\n"],["\u003cp\u003eThe Google Ads API uses a resource-oriented design with resources organized into collections and accessed using resource names and methods.\u003c/p\u003e\n"],["\u003cp\u003eREST URLs in the API consist of an API version prefix, resource name, and method, with custom methods often used.\u003c/p\u003e\n"],["\u003cp\u003eRefer to linked resources for further details on resource names, service methods, and JSON naming conventions within the Google Ads API.\u003c/p\u003e\n"],["\u003cp\u003eExamples in the guide use HTTP; see the Examples page for \u003ccode\u003ecurl\u003c/code\u003e usage.\u003c/p\u003e\n"]]],[],null,["# REST Interface Design\n\nThis page assumes a familiarity with the [Resource Oriented\nDesign](//cloud.google.com/apis/design/resources) and [Resource\nNames](//cloud.google.com/apis/design/resource_names) developer guides and\ncomplements them with specific implementation details of the Google Ads API.\n| **Key Point:** The examples throughout this guide use HTTP protocol to demonstrate how to call the API. See the [Examples](/google-ads/api/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 Google Ads 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](/google-ads/api/rest/design/resource-names) and [methods](/google-ads/api/rest/design/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://googleads.googleapis.com/v21/customers/1234567890:mutate\n\n| API Version Prefix | Resource Name (relative) | Method |\n|----------------------------------------|--------------------------|----------|\n| `https://googleads.googleapis.com/v21` | `customers/1234567890` | `mutate` |\n\nAll REST URLs for a particular version of the API (e.g., `v21`)\nshare a common API version prefix. The resource name and method together\nidentifies which API service is being called.\n\nThe Google Ads API makes heavy use of *custom methods* , as opposed to most\ntraditional REST APIs that use standard REST methods such as `list`, `get`,\n`create`, `update`, and `delete`. Examples of custom methods in the Google Ads API\ninclude `search`, `searchStream`, and `mutate`.\n\nThe following pages go into more details about the Google Ads API's [resource\nnames](/google-ads/api/rest/design/resource-names), [service methods](/google-ads/api/rest/design/service-methods), and\n[JSON naming conventions](/google-ads/api/rest/design/json-mappings) to illustrate how they're used\ntogether to define REST interface endpoints."]]
