Uwaga: przeglądasz dokumentację interfejsu REST interfejsu API. Większość oficjalnych bibliotek klienta używa gRPC. Więcej informacji znajdziesz we wprowadzeniu do REST.

Inne metody

Zadbaj o dobrą organizację dzięki kolekcji Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.

Najczęściej spotykanymi metodami w interfejsie Google Ads API są Mutate, Search i SearchStream, ale jest też wiele innych zastosowań. Wszystkie usługi i ich interfejsy API są wymienione w dokumentacji REST.

Mapowanie RPC bufora protokołu na mapowania REST

Wszystkie punkty końcowe usługi (niezależnie od tego, czy używają REST i gRPC) są ostatecznie zdefiniowane w plikach.proto pakietu usług, używając języka definiowania interfejsu proto3 interfejsu.

Przykład: ListAccessibleCustomers

Na przykład plik customer_service.proto określa nie tylko standardową wartość Mutate, ale też metodę ListAccessibleCustomers. Adnotacja google.api.http opisuje, jak metoda jest mapowana na HTTP. Wykorzystuje on HTTP GET z czasownikiem niestandardowym listAccessibleCustomers:

rpc ListAccessibleCustomers(ListAccessibleCustomersRequest) returns (ListAccessibleCustomersResponse) {
  option (google.api.http) = {
    get: "/v12/customers:listAccessibleCustomers"
  };
}

Jest on mapowany na metodę REST customers.listAccessibleCustomers.

Przykład: CreateCustomerClient

Inny przykład z customer_service.proto to metoda CreateCustomerClient. Adnotacja google.api.http opisuje HTTP POST przy użyciu czasownika createCustomerClient:

rpc CreateCustomerClient(CreateCustomerClientRequest) returns (CreateCustomerClientResponse) {
  option (google.api.http) = {
    post: "/v12/customers/{customer_id=*}:createCustomerClient"
    body: "*"
  };
  option (google.api.method_signature) = "customer_id,customer_client";
}

Jest to mapowane do metody REST customers.createCustomerClient.