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

Search Ads 360 Reporting API'ye yapılan çağrılar genellikle müşteri kitaplığınız aracılığıyla yapılır. Daha fazla bilgi için İstemci kitaplıklarının açıklanması 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 faydalı olabilir.

Search Ads 360 Reporting API, REST bağlamaları olan bir gRPC API'dir. Bu, API'ye iki alternatif yöntemle ç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.
  • Yanıtı bir protokol arabelleğine seri hale getirin.
  • Sonuçları yorumlama.
İsteğe bağlı alternatif yöntem
REST'i kullanma:
  • İsteğin gövdesini JSON nesnesi olarak oluşturun.
  • İsteği HTTP 1.1 kullanarak sunucuya gönderin.
  • Yanıtı JSON nesnesi olarak dize dışına çıkarın.
  • Sonuçları yorumlama.

Daha fazla bilgi için Google Cloud API'leri bölümüne bakın.

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

Kaynak adları

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

Desteklenen kaynaklar ve yol gösterimleriyle ilgili daha fazla bilgi için Referans > REST bölümüne bakın. Diğer hizmetler için de aynı biçim kullanılır.

Kompozit kimlikler

Bir nesnenin kimliği küresel olarak 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, üst öğe (reklam grubu) kimliği bu kimliğin önüne eklenir ve benzersiz bir birleşik kimlik oluşturulur.

Ö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 üst bilgileri (veya gRPC meta verileri), isteğin gövdesine dahil edilmelidir.

Yetkilendirme

Forma bir OAuth2 erişim jetonu eklemeniz gerekir:

Authorization: Bearer [OAUTH_2.0_ACCESS_TOKEN]

Jeton, bir 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 belirtmelidir. Daha fazla bilgi edinmek için Search Ads 360 yönetici hesapları hakkında ve Kimlik Doğrulama bölümlerine bakın.

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

Bir alt yönetici veya müşteri hesabına erişmek için yönetici hesabı kullanırken login-customer-id başlığı gereklidir. Doğrudan bir alt yönetici veya müşteri hesabına erişirken gerekli değildir. Kesinlikle gerekli olmasa da birden fazla hesaba erişimi olan kimliği doğrulanmış kullanıcılar için her zaman login-customer-id değerini belirtmenizi öneririz. Bu yöntem, belirsizliği önler ve bağlamı yanlışlıkla yanlış hesaba ayarlamayı önler.

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

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

login-customer-id değerini ayarlamak, oturum açtıktan veya sağ üstteki profil resminizi tıkladıktan sonra Search Ads 360 kullanıcı arayüzünde bir hesap seçmekle aynıdır.

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 günlüğe kaydetmenizi öneririz.

Talep numarası

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