Search Ads 360 Reporting API'ye yapılan çağrılar genellikle müşteri kitaplığınız üzerinden yapılır. Daha fazla bilgi için İstemci kitaplıkları hakkında başlıklı makaleyi inceleyin. 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.
- 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 başlıklı makaleye göz atı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 olarak da kullanılı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: 123
için AdGroupId
+ 45678
için ~
+ AdGroupAdId
= 123~45678
için birleşik reklam grubu reklam kimliği.
İstek başlıkları
Aşağıdaki bölümlerdeki HTTP üstbilgileri (veya gRPC meta verileri) istek 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öneticisini ya da müşteri hesabını yöneten bir reklamvereni tanımlamalıdır. Daha fazla bilgi 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ı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 sayede, bağlamın yanlışlıkla yanlış hesaba ayarlanması önlenir ve belirsizlikler ortadan kaldırılır.
İ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.