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ıyla ilgilenmeniz gerekir. Ancak, hakkında biraz bilgi sahibi olmak, test ve hata ayıklama sırasında faydalı olabilir.
Google Ads API bir gRPC API'dir ve REST bağlamaları. Bu, API'ye çağrı yapmanın iki yolu olduğu anlamına gelir.
[Tercih Edilen] İsteğin gövdesini protokol arabelleğini kullanıyorsanız bunu HTTP/2, bir protokol yanıtının serisini devre dışı bırak ve sonuçları yorumlayabilir. Dokümanlarımızın çoğunda gRPC.
[İsteğe bağlı] İsteğin gövdesini JSON nesnesini HTTP 1.1 kullanarak sunucuya gönderin, yanıtı JSON nesnesi olarak seri durumdan çıkarır ve sonuçları yorumla. Referans hakkında daha fazla bilgi edinmek için REST arayüzü rehberine REST.
Kaynak adları
API'deki çoğu nesne, kaynak adı dizeleriyle tanımlanır. Bu dizeler REST arayüzü kullanılırken URL işlevi görür. REST'i görün arayüzünün Kaynak Adları inceleyeceğiz.
Birleşik kimlikler
Bir nesnenin kimliği genel olarak benzersiz değilse söz konusu nesnenin bileşik kimliği başına üst kimliği ve yaklaşık işareti (~) eklenerek oluşturulur.
Örneğin, bir reklam grubu reklam kimliği genel olarak benzersiz olmadığından, benzersiz bir birleşik kimlik oluşturmak için üst nesne (reklam grubu) kimliğini ekleyin:
AdGroupId/123+~+AdGroupAdId/45678= birleşik reklam123~45678grup reklam kimliği.
İstek başlıkları
Bunlar HTTP üstbilgileri (veya grpc) meta verileri) istekteki gövde:
Yetkilendirme
OAuth2 erişim jetonunu şu biçimde eklemeniz gerekir:
Authorization: Bearer YOUR_ACCESS_TOKEN
doğrudan bir müşteri veya reklamveren adına hareket eden yönetici hesabı
yönetmelerine yardımcı oluyor. Erişim jetonu alma talimatları
OAuth2 kılavuzunda bulabilirsiniz.
Erişim jetonunuz, jetonu almanızdan itibaren bir saat boyunca geçerlidir; ne zaman
yeni bir jeton almak için erişim jetonunu yenileyin. Lütfen
istemci kitaplıklarımız süresi dolmuş jetonları otomatik olarak yeniler.
developer-token
Geliştirici jetonu, bir kullanıcıyı benzersiz bir şekilde tanımlayan 22 karakterli bir dizedir.
Google Ads API geliştiricisi. Örnek bir geliştirici jetonu dizesi
ABcdeFGH93KL-NOPQ_STUv Geliştirici jetonu,
developer-token : ABcdeFGH93KL-NOPQ_STUv biçiminde olmalıdır.
login-customer-id
Bu, istekte kullanılacak yetkili müşterinin müşteri kimliğidir.
tire olmadan (-) kullanın. Müşteri hesabına bir
yönetici hesabı söz konusuysa bu başlık zorunludur ve şu müşteri kimliğine ayarlanmalıdır:
yönetici hesabıyla ilişkilidir.
https://googleads.googleapis.com/v17/customers/1234567890/campaignBudgets:mutate
login-customer-id ayarını yapmanız, şuradan bir hesap seçmekle eşdeğerdir:
Oturum açtıktan veya üstteki profil resminizi tıkladıktan sonra Google Ads kullanıcı arayüzü
sağ. Bu üstbilgiyi dahil etmezseniz varsayılan olarak çalışan
müşteri.
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'e yükleyerek hesap.
A hesabındaki kullanıcıların okuma ve düzenleme erişimi sağladığı senaryoyu inceleyin
tüzel kişiliklerine, B hesabı için bir
ThirdPartyAppAnalyticsLink.
Bağlantı kurulduğunda B hesabındaki bir kullanıcı A hesabıyla API çağrıları yapabilir.
bağlantının sağladığı izinlere tabidir. Bu durumda, API çağrısı
A hesabına yönelik izinler, B hesabına yönelik üçüncü taraf bağlantısı tarafından belirlenir.
.
Üçüncü taraf uygulama analizi sağlayıcısı, aşağıdaki şekilde bir API çağrısı yapar:
linked-customer-id: Yükleme işlemi yapan üçüncü taraf uygulama analizi hesabı verilerinize (hesapB).customer-id: Verilerin yüklendiği Google Ads hesabı (hesapA) tıklayın.login-customer-idveAuthorizationüstbilgisi:Bhesabına erişimi olan bir kullanıcıyı tanımlamak
Yanıt başlıkları
Aşağıdaki başlıklar (veya grpc sondaki-metadata) yanıt gövdesiyle döndürülür. Bu hedefleri değerlerini kullanabilirsiniz.
istek kimliği
request-id, bu isteği benzersiz şekilde tanımlayan bir dizedir.