API Çağrısı Yapısı

Bu kılavuzda, tüm API çağrılarının ortak yapısı açıklanmaktadır.

API ile etkileşim kurmak için bir istemci kitaplığı kullanıyorsanız temel istek ayrıntılarını bilmeniz gerekmez. Ancak API çağrısı yapısı hakkında bilgi sahibi olmak, test ve hata ayıklama sırasında işinize yarayabilir.

Google Ads API, REST bağlamalarına sahip bir gRPC API'dir. Bu, API'ye çağrı yapmanın iki yolu olduğu anlamına gelir.

Tercih edilen:

  1. İsteğin gövdesini protokol arabelleği olarak oluşturun.

  2. HTTP/2 kullanarak sunucuya gönderin.

  3. Yanıtı bir protokol arabelleğine seri hale getirin.

  4. Sonuçları yorumlama.

Belgelerimizin çoğunda gRPC'nin kullanımı açıklanmaktadır.

İsteğe bağlı:

  1. İsteğin gövdesini JSON nesnesi olarak oluşturun.

  2. HTTP 1.1 kullanarak sunucuya gönderin.

  3. Yanıtı JSON nesnesi olarak dize dönüştürün.

  4. Sonuçları yorumlama.

REST'i kullanma hakkında daha fazla bilgi için REST arayüzü kılavuzunu inceleyin.

Kaynak adları

API'deki çoğu nesne, kaynak adı dizeleriyle tanımlanır. Bu dizeler, REST arayüzü kullanılırken URL olarak da kullanılır. Yapıları için REST arayüzünün Kaynak Adları bölümüne bakın.

Kompozit kimlikler

Bir nesnenin kimliği dünya genelinde benzersiz değilse bu nesne için birleşik kimlik, üst öğesinin kimliği ve tilde (~) işareti eklenerek oluşturulur.

Örneğin, bir reklam grubu reklam kimliği dünya genelinde benzersiz olmadığından benzersiz bir birleşik kimlik oluşturmak için üst öğe (reklam grubu) kimliğini önüne ekleriz:

  • 123 için AdGroupId + 45678 için ~ + AdGroupAdId = 123~45678 için birleşik reklam grubu reklam kimliği.

İstek başlıkları

Bunlar, istekteki gövdeye eşlik eden HTTP üst bilgileri (veya grpc meta verileri)dir:

Yetkilendirme

Müşteri adına hareket eden bir yönetici hesabını veya doğrudan kendi hesabını yöneten bir reklamvereni tanımlayan Authorization: Bearer YOUR_ACCESS_TOKEN biçiminde bir OAuth2 erişim jetonu eklemeniz gerekir. Erişim jetonu alma talimatlarını OAuth2 kılavuzunda bulabilirsiniz. Erişim jetonu, aldıktan sonra bir saat boyunca geçerlidir. Süresi dolan erişim jetonunu yenilemek için yeni bir jeton alın. İstemci kitaplıklarımızın süresi dolmuş jetonları otomatik olarak yenilediğini unutmayın.

developer-token

Geliştirici jetonu, Google Ads API geliştiricisini benzersiz şekilde tanımlayan 22 karakterlik bir dizedir. Örnek bir geliştirici jetonu dizesi ABcdeFGH93KL-NOPQ_STUv şeklindedir. Geliştirici jetonu, developer-token : ABcdeFGH93KL-NOPQ_STUv biçiminde eklenmelidir.

login-customer-id

Bu, istekte kullanılacak yetkili müşterinin müşteri kimliğidir ve kısa çizgi (-) içermez. Müşteri hesabına erişiminiz bir yönetici hesabı üzerindense bu başlık zorunludur ve yönetici hesabının müşteri kimliğine ayarlanmalıdır.

https://googleads.googleapis.com/v21/customers/1234567890/campaignBudgets:mutate

login-customer-id değerini ayarlamak, oturum açtıktan veya sağ üstteki profil resminizi tıkladıktan sonra Google Ads kullanıcı arayüzünde bir hesap seçmekle aynıdır. Bu üstbilgi eklenmezse varsayılan olarak operasyonel müşteri kullanılır.

linked-customer-id

Bu başlık yalnızca [üçüncü taraf uygulama analizi sağlayıcıları tarafından dönüşümleri bağlı bir Google Ads hesabına yüklerken kullanılır.

A hesabındaki kullanıcıların, ThirdPartyAppAnalyticsLink aracılığıyla öğelerine okuma ve düzenleme erişimi sağladığı senaryoyu düşünün.B Bağlantı kurulduktan sonra B hesabındaki bir kullanıcı, bağlantı tarafından sağlanan izinlere tabi olarak A hesabına API çağrıları yapabilir. Bu durumda, A hesabına yönelik API çağrısı izinleri, diğer API çağrılarında kullanılan yönetici hesabı ilişkisi yerine B hesabına yönelik üçüncü taraf bağlantısı tarafından belirlenir.

Üçüncü taraf uygulama analizi sağlayıcısı aşağıdaki gibi bir API çağrısı yapar:

  • linked-customer-id: Verileri yükleyen üçüncü taraf uygulama analizi hesabı (B hesabı).
  • customer-id: Verilerin yüklendiği Google Ads hesabı (A hesabı).
  • login-customer-id ve Authorization başlığı: B hesabına erişimi olan bir kullanıcıyı tanımlamak için kullanılan bir değer kombinasyonu.

Yanıt başlıkları

Aşağıdaki üstbilgiler (veya grpc trailing-metadata) yanıt gövdesiyle birlikte döndürülür. Hata ayıklama amacıyla bu değerleri kaydetmenizi öneririz.

request-id

request-id, bu isteği benzersiz şekilde tanımlayan bir dizedir.

Önceki
Kaynak meta verileri