Bu kılavuzda, tüm API çağrılarının ortak yapısı açıklanmaktadır.
API ile etkileşime geçmek için istemci kitaplığı kullanıyorsanız temel istek ayrıntılarıyla ilgili endişelenmenize gerek yoktur. Ancak bunlar hakkında biraz bilgi sahibi olmak test ve hata ayıklama açısından kullanışlı olabilir.
Google Ads API, REST bağlamaya sahip bir gRPC API'dir. Bu, API'ye çağrı yapmanın iki yolu olduğu anlamına gelir.
[Tercih edilen] İsteğin gövdesini bir protokol arabelleği olarak oluşturun, HTTP/2 kullanarak sunucuya gönderin, bir protokol arabelleğine verilen yanıtı seri durumdan çıkarın ve sonuçları yorumlayın. Belgelerimizin çoğunda gRPC kullanımı açıklanmaktadır.
[İsteğe bağlı] İsteğin gövdesini bir JSON nesnesi olarak oluşturun, HTTP 1.1 kullanarak sunucuya gönderin, yanıtı bir JSON nesnesi olarak seri durumdan çıkarın ve sonuçları yorumlayın. REST kullanımıyla ilgili 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ünü kullanırken URL görevi de görür. Yapıları için REST arayüzünün Kaynak Adları bölümüne bakın.
Bileşik kimlikler
Bir nesnenin kimliği genel olarak benzersiz değilse, başına üst kimliği ve yaklaşık işareti (~) getirilerek o nesnenin bileşik kimliği oluşturulur.
Örneğin, bir reklam grubu reklam kimliği genel olarak benzersiz olmadığından, benzersiz bir bileşik kimlik oluşturmak için üst nesne (reklam grubu) kimliğini başına ekleriz:
AdGroupId/123+~+AdGroupAdId/45678= birleşik reklam grubu reklam kimliği:123~45678.
İstek başlıkları
Bunlar, istek gövdesine eşlik eden HTTP üst bilgileridir (veya grpc meta verileri):
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, edinildikten sonra bir saat süreyle geçerlidir. Süresi dolduğunda yeni bir jeton almak için erişim jetonunu yenileyin. İstemci kitaplıklarımızın süresi dolmuş jetonları otomatik olarak yenilediğini unutmayın.
geliştirici jetonu
Geliştirici jetonu, bir Google Ads API geliştiricisini benzersiz şekilde tanımlayan 22 karakterli bir dizedir. Geliştirici jetonu dizesine örnek olarak ABcdeFGH93KL-NOPQ_STUv verilebilir. Geliştirici jetonu developer-token : ABcdeFGH93KL-NOPQ_STUv biçiminde eklenmelidir.
login-customer-id
İstekte kullanılacak yetkili müşterinin müşteri kimliğidir, kısa çizgi (-) olmadan. Müşteri hesabına erişiminiz bir yönetici hesabı üzerinden gerçekleşiyorsa bu başlık zorunludur ve yönetici hesabının müşteri kimliği olarak ayarlanmalıdır.
https://googleads.googleapis.com/v16/customers/1234567890/campaignBudgets:mutate
login-customer-id ayarlamak, oturum açtıktan veya sağ üstteki profil resminizi tıkladıktan sonra Google Ads kullanıcı arayüzünde hesap seçmekle eşdeğerdir. Bu üst bilgiyi eklemezseniz varsayılan olarak çalışan müşteri olur.
bağlı-müşteri-kimliği
Bu başlık yalnızca üçüncü taraf uygulama analizi sağlayıcıları tarafından bağlı bir Google Ads hesabına dönüşüm yüklerken kullanılır.
A hesabındaki kullanıcıların bir ThirdPartyAppAnalyticsLink üzerinden B hesabı varlıklarına okuma ve düzenleme erişimi sağladığı senaryoyu düşünün.
Bağlantı kurulduğunda, 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ı için API çağrısı izinleri, diğer API çağrılarında kullanılan yönetici hesabı ilişkisi yerine B hesabının üçüncü taraf bağlantısıyla belirlenir.
Üçüncü taraf uygulama analizi sağlayıcısı, aşağıdaki şekilde bir API çağrısı yapar:
linked-customer-id: Verileri yükleyen üçüncü taraf uygulama analizi hesabı (Bhesabı).customer-id: Verilerin yüklendiği Google Ads hesabı (Ahesabı).login-customer-idveAuthorizationüst bilgisi:Bhesabına erişimi olan bir kullanıcıyı tanımlamak için kullanılan değerlerin kombinasyonu.
Yanıt başlıkları
Aşağıdaki üstbilgiler (veya grpc posting-metadata) yanıt gövdesiyle birlikte döndürülür. Bu değerleri hata ayıklama amacıyla günlüğe kaydetmenizi öneririz.
request-id
request-id, bu isteği benzersiz bir şekilde tanımlayan bir dizedir.