Search Ads 360 Reporting API çağrı yapısı

Search Ads 360 Reporting API'ye yapılan çağrılar genellikle istemci kitaplığınız üzerinden yapılır. Daha fazla bilgi için İstemci kitaplıklarının açıklaması bölümüne bakın. Ancak temel istek ayrıntılarının yapısı hakkında bilgi sahibi olmak, test ve hata ayıklama sırasında yararlı olabilir.

Search Ads 360 Reporting API, REST bağlamaları olan bir gRPC API'dir. Bu, API'ye iki alternatif şekilde çağrı yapabileceğiniz anlamına gelir:

Tercih edilen yöntem
İstemci kitaplığı kullanma:
  • İsteğin gövdesini protokol arabelleği olarak oluşturun.
  • İsteği HTTP/2 kullanarak sunucuya gönderin.
  • Bir protokol arabelleğine verilen yanıtı seri durumdan çıkarın.
  • Sonuçları yorumlama.
İsteğe bağlı alternatif yöntem
REST'i kullanın:
  • İstek gövdesini JSON nesnesi olarak oluşturun.
  • HTTP 1.1 kullanarak isteği sunucuya gönderin.
  • Yanıtı bir JSON nesnesi olarak seri durumdan çıkarın.
  • Sonuçları yorumlama.

Daha fazla bilgi için Google Cloud API'leri sayfasına bakın.

Aşağıdaki bölümler hem gRPC hem REST protokolleri için geçerlidir.

Kaynak adları

API'deki nesnelerin çoğu kaynak adı dizeleriyle tanımlanır. Bu dizeler, REST arayüzünü kullanırken URL görevi de görür.

Desteklenen kaynaklar ve bunların yol temsili hakkında daha fazla bilgi edinmek için Referans > REST bölümünü inceleyin. Aynı biçim diğer hizmetler için de kullanılır.

Birleşik kimlikler

Bir nesnenin kimliği genel olarak benzersiz değilse, başına üst kimliği ve yaklaşık işareti (~) getirilerek söz konusu nesnenin birleşik bir kimliği oluşturulur.

Örneğin, reklam grubu reklam kimliği genel olarak benzersiz olmadığından üst nesne (reklam grubu) kimliği bunun başına eklenir. Böylece benzersiz bir bileşik kimlik elde edilir.

Örnek: AdGroupId / 123 + ~ + AdGroupAdId / 45678 = 123~45678 birleşik reklam grubu reklam kimliği.

İstek başlıkları

Aşağıdaki bölümlerde yer alan HTTP üstbilgileri (veya gRPC meta verileri) isteğin gövdesine eklenmelidir.

Yetkilendirme

Şu forma bir OAuth2 erişim jetonu eklemeniz gerekir:

Authorization: Bearer [OAUTH_2.0_ACCESS_TOKEN]

Jeton, müşteri adına hareket eden bir yönetici hesabını veya doğrudan kendi alt yönetici ya da müşteri hesabını yöneten bir reklamvereni tanımlamalıdır. Daha fazla bilgi edinmek için Search Ads 360 yönetici hesapları hakkında ve Kimlik doğrulama başlıklı makaleleri inceleyin.

Giriş müşteri kimliği başlığı

Bir alt yönetici veya müşteri hesabına erişmek için yönetici hesabı kullanılırken login-customer-id başlığı gereklidir. Doğrudan bir alt yönetici veya müşteri hesabına erişirken gerekli değildir. Mutlaka gerekli olmamakla birlikte, birden fazla hesaba erişimi olan kimliği doğrulanmış kullanıcılar için login-customer-id değerinin belirtilmesini her zaman öneririz. Bu, belirsizliği önler ve bağlamın istemeden yanlış hesaba ayarlanmasını önler.

İstek, yetkili kullanıcının müşteri kimliğini kısa çizgi (-) olmadan içermelidir. Örneğin:

https://searchads360.googleapis.com/VERSION_NUMBER/customers/CUSTOMER_ID/campaignBudgets

login-customer-id öğesinin ayarlanması, oturum açtıktan veya sağ üstteki profil resminizi tıkladıktan sonra Search Ads 360 kullanıcı arayüzünde bir hesap seçmeye eşdeğerdir.

Yanıt başlıkları

Aşağıdaki üstbilgiler (veya gRPC izleme meta verileri) yanıt gövdesiyle birlikte döndürülür. Bu değerleri hata ayıklama amacıyla günlüğe kaydetmenizi öneririz.

Talep numarası

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