Raporlama sistemine bir rapor isteği ekler. Şimdi deneyin.
İstek
HTTP isteği
POST https://www.googleapis.com/doubleclicksearch/v2/reports
Yetkilendirme
Bu istek, aşağıdaki kapsamla yetkilendirme gerektiriyor:
Kapsam |
---|
https://www.googleapis.com/auth/doubleclicksearch |
Daha fazla bilgi edinmek için kimlik doğrulama ve yetkilendirme sayfasını inceleyin.
İstek metni
İstek gövdesinde, aşağıdaki yapıya sahip verileri sağlayın:
{ "reportScope": { "agencyId": long, "advertiserId": long, "engineAccountId": long, "campaignId": long, "adGroupId": long, "keywordId": long, "adId": long }, "reportType": string, "columns": [ { "columnName": string, "savedColumnName": string, "customDimensionName": string, "customMetricName": string, "headerText": string, "startDate": string, "endDate": string, "groupByColumn": boolean, "platformSource": string, "productReportPerspective": string } ], "timeRange": { "startDate": string, "endDate": string, "changedMetricsSinceTimestamp": datetime, "changedAttributesSinceTimestamp": datetime }, "filters": [ { "column": { "columnName": string, "savedColumnName": string, "customDimensionName": string, "customMetricName": string, "headerText": string, "startDate": string, "endDate": string, "groupByColumn": boolean, "platformSource": string, "productReportPerspective": string }, "operator": string, "values": [ (value) ] } ], "orderBy": [ { "column": { "columnName": string, "savedColumnName": string, "customDimensionName": string, "customMetricName": string, "headerText": string, "startDate": string, "endDate": string, "groupByColumn": boolean, "platformSource": string, "productReportPerspective": string }, "sortOrder": string } ], "includeDeletedEntities": boolean, "includeRemovedEntities": boolean, "verifySingleTimeZone": boolean, "downloadFormat": string, "statisticsCurrency": string, "startRow": integer, "rowCount": integer, "maxRowsPerFile": integer }
Mülk adı | Değer | Açıklama | Notlar |
---|---|---|---|
reportScope |
object |
reportScope, raporda hangi öğe alt kümesinin döndürüleceğini belirlemek için kullanılan bir kimlik grubudur. Kimliklerin, ajansa kadar istenen en düşük kapsam düzeyinden eksiksiz olarak tam olarak belirtilmesi gerekir. | |
reportScope.agencyId |
long |
DS ajans kimliği. | |
reportScope.advertiserId |
long |
DS reklamveren kimliği. | |
reportScope.engineAccountId |
long |
DS motor hesabı kimliği. | |
reportScope.campaignId |
long |
DS kampanya kimliği. | |
reportScope.adGroupId |
long |
DS reklam grubu kimliği. | |
reportScope.keywordId |
long |
DS anahtar kelime kimliği. | |
reportScope.adId |
long |
DS reklam kimliği. | |
reportType |
string |
Raporda döndürülen satırların türünü belirler. Örneğin, reportType: keyword değerini belirtirseniz rapordaki her satır bir anahtar kelimeyle ilgili verileri içerir. Her bir tür için kullanılabilen sütunlar için Rapor Türleri referansına bakın. |
|
columns[] |
list |
Rapora dahil edilecek sütunlar. Buna hem DoubleClick Search sütunları hem de kayıtlı sütunlar dahildir. DoubleClick Search sütunları için yalnızca columnName parametresi gereklidir. Kayıtlı sütunlarda yalnızca savedColumnName parametresi gereklidir. columnName ve savedColumnName aynı kıtada ayarlanamaz. İstek başına maksimum sütun sayısı 300'dür. |
|
columns[].columnName |
string |
Rapora dahil edilecek DoubleClick Search sütununun adı. | |
columns[].savedColumnName |
string |
Rapora eklenecek kayıtlı bir sütunun adı. Raporun reklamveren veya daha düşük bir kapsama dahil edilmesi ve bu kayıtlı sütunun DoubleClick Search kullanıcı arayüzünde önceden oluşturulmuş olması gerekir. | |
columns[].headerText |
string |
Rapor çıktısında bu sütunu tanımlamak için kullanılan metin. Belirtilmediğinde varsayılan olarak columnName veya savedColumnName değerine ayarlanır. Bu özellik, DoubleClick Search sütunları ile aynı ada sahip kayıtlı sütunlar arasındaki çakışmaları önlemek için kullanılabilir. |
|
columns[].startDate |
string |
YYYY-AA-GG biçiminde kapsayıcı tarih. Bu değer sağlandığında, yalnızca bu sütun için raporun genel zaman aralığı geçersiz kılınır. endDate ile birlikte sağlanmalıdır. |
|
columns[].endDate |
string |
YYYY-AA-GG biçiminde kapsayıcı gün. Bu değer sağlandığında, yalnızca bu sütun için raporun genel zaman aralığı geçersiz kılınır. startDate ile birlikte sağlanmalıdır. |
|
columns[].groupByColumn |
boolean |
Yalnızca eşzamanlı rapor. Bu sütuna göre gruplandırmak için true olarak ayarlayın. Varsayılan olarak false değerine ayarlanır. |
|
timeRange |
object |
Bir raporda metrikler istendiğinde bu bağımsız değişken, metrikleri belirli bir zaman aralığıyla kısıtlamak için kullanılır. | |
timeRange.startDate |
string |
YYYY-AA-GG biçiminde kapsayıcı tarih. | |
timeRange.endDate |
string |
YYYY-AA-GG biçiminde kapsayıcı tarih. | |
timeRange.changedMetricsSinceTimestamp |
datetime |
RFC biçiminde UTC zaman damgası (ör. 2013-07-16T10:16:23.555Z . Değiştirilen metrik raporlarının işleyiş şekliyle ilgili ek referansları görün. |
|
timeRange.changedAttributesSinceTimestamp |
datetime |
RFC biçiminde UTC zaman damgası (ör. 2013-07-16T10:16:23.555Z . Değiştirilen özellik raporlarının işleyiş şekliyle ilgili ek referanslara bakın. |
|
filters[] |
list |
Rapora uygulanacak filtrelerin listesi. İstek başına maksimum filtre sayısı 300'dür. |
|
filters[].column |
nested object |
Filtrenin çalıştırılacağı sütun. Bu bir DoubleClick Search sütunu veya kayıtlı bir sütun olabilir. | |
filters[].column.columnName |
string |
Rapora dahil edilecek DoubleClick Search sütununun adı. | |
filters[].column.savedColumnName |
string |
Rapora eklenecek kayıtlı bir sütunun adı. Raporun reklamveren veya daha düşük bir kapsama dahil edilmesi ve bu kayıtlı sütunun DoubleClick Search kullanıcı arayüzünde önceden oluşturulmuş olması gerekir. | |
filters[].operator |
string |
Filtrede kullanılacak operatör. Kullanılabilir operatörlerin listesi için filtre referansını inceleyin. | |
filters[].values[] |
list |
Sütun değerinin filtreleneceği değerlerin listesi. İstek başına maksimum filtre değeri sayısı 300'dür. |
|
orderBy[] |
list |
Yalnızca eşzamanlı rapor. Rapor satırlarında gerçekleştirilecek sıralamayı tanımlayan sütun ve yol tariflerinin listesi. İstek başına maksimum sipariş sayısı 300'dür. |
|
orderBy[].column |
nested object |
Sıralamanın gerçekleştirileceği sütun. Bu, DoubleClick Search tanımlı bir sütun veya kayıtlı bir sütun olabilir. | |
orderBy[].column.columnName |
string |
Rapora dahil edilecek DoubleClick Search sütununun adı. | |
orderBy[].column.savedColumnName |
string |
Rapora eklenecek kayıtlı bir sütunun adı. Raporun reklamveren veya daha düşük bir kapsama dahil edilmesi ve bu kayıtlı sütunun DoubleClick Search kullanıcı arayüzünde önceden oluşturulmuş olması gerekir. | |
orderBy[].sortOrder |
string |
Sıralama yönü: ascending veya descending . |
|
includeDeletedEntities |
boolean |
Kaldırılan öğelerin rapora dahil edilip edilmeyeceğini belirler. Varsayılan olarak false değerine ayarlanır. Kullanımdan kaldırıldı, lütfen bunun yerine includeRemovedEntities politikasını kullanın. |
|
verifySingleTimeZone |
boolean |
true değeri kullanıldığında, rapor yalnızca istenen tüm istatistik verileri tek bir saat diliminden alındıysa oluşturulur. Varsayılan olarak false değerine ayarlanır. |
|
downloadFormat |
string |
Raporun döndürülmesi gereken biçim. Şu anda csv veya tsv desteklenmektedir. |
|
statisticsCurrency |
string |
Paranın iade edileceği para birimini belirtir. Olası değerler: usd , agency (raporun kapsamı daha dar bir ajanssa veya daha düşükse geçerli), advertiser (rapor * reklamverenler veya daha düşük bir kapsamı kapsarsa geçerli olur) veya account (rapor, arama motoru hesabını veya daha düşük bir kapsamı kapsarsa geçerli olur). |
|
startRow |
integer |
Yalnızca eşzamanlı rapor. Döndürülecek ilk satırın sıfır tabanlı dizini. Kabul edilebilir değerler 0 ile 50000 arasındadır (bu değerler dahil). Varsayılan olarak 0 değerine ayarlanır. |
|
rowCount |
integer |
Yalnızca eşzamanlı rapor. Döndürülecek maksimum satır sayısı. Daha fazla satır çıkarılır. Kabul edilebilir değerler 0 ile 10000 arasındadır (bu değerler dahil). Varsayılan olarak 10000 değerine ayarlanır. |
|
maxRowsPerFile |
integer |
Yalnızca eşzamansız rapor. Rapor dosyası başına maksimum satır sayısı. Büyük bir rapor bu alana göre birçok dosyaya bölünür. Kabul edilebilir değerler 1000000 ile 100000000 arasındadır (bu değerler dahil). |
|
includeRemovedEntities |
boolean |
Kaldırılan öğelerin rapora dahil edilip edilmeyeceğini belirler. Varsayılan olarak false değerine ayarlanır. |
|
columns[].customDimensionName |
string |
Raporu özel bir boyuta göre segmentlere ayırır. Raporun kapsamının bir reklamveren veya daha düşük bir kapsamı kapsaması ve özel boyutun DoubleClick Search'te önceden oluşturulmuş olması gerekir. DoubleClick Search'te görünen özel boyut adı büyük/küçük harfe duyarlıdır. Bir dönüşüm raporunda kullanılıyorsa, belirtilen dönüşüm için belirtilen özel boyutun değerini (ayarlanmışsa) döndürür. Bu sütun, dönüşüm raporunu segmentlere ayırmaz. |
|
columns[].platformSource |
string |
Özel boyut için veri sağlamak amacıyla kullanılan platform. Kabul edilebilir değerler "floodlight"tır. | |
filters[].column.customDimensionName |
string |
Raporu özel bir boyuta göre segmentlere ayırır. Raporun kapsamının bir reklamveren veya daha düşük bir kapsamı kapsaması ve özel boyutun DoubleClick Search'te önceden oluşturulmuş olması gerekir. DoubleClick Search'te görünen özel boyut adı büyük/küçük harfe duyarlıdır. Bir dönüşüm raporunda kullanılıyorsa, belirtilen dönüşüm için belirtilen özel boyutun değerini (ayarlanmışsa) döndürür. Bu sütun, dönüşüm raporunu segmentlere ayırmaz. |
|
filters[].column.headerText |
string |
Rapor çıktısında bu sütunu tanımlamak için kullanılan metin. Belirtilmediğinde varsayılan olarak columnName veya savedColumnName değerine ayarlanır. Bu özellik, DoubleClick Search sütunları ile aynı ada sahip kayıtlı sütunlar arasındaki çakışmaları önlemek için kullanılabilir. |
|
filters[].column.startDate |
string |
YYYY-AA-GG biçiminde kapsayıcı tarih. Bu değer sağlandığında, yalnızca bu sütun için raporun genel zaman aralığı geçersiz kılınır. endDate ile birlikte sağlanmalıdır. |
|
filters[].column.endDate |
string |
YYYY-AA-GG biçiminde kapsayıcı gün. Bu değer sağlandığında, yalnızca bu sütun için raporun genel zaman aralığı geçersiz kılınır. startDate ile birlikte sağlanmalıdır. |
|
filters[].column.groupByColumn |
boolean |
Yalnızca eşzamanlı rapor. Bu sütuna göre gruplandırmak için true olarak ayarlayın. Varsayılan olarak false değerine ayarlanır. |
|
filters[].column.platformSource |
string |
Özel boyut için veri sağlamak amacıyla kullanılan platform. Kabul edilebilir değerler "floodlight"tır. | |
orderBy[].column.customDimensionName |
string |
Raporu özel bir boyuta göre segmentlere ayırır. Raporun kapsamının bir reklamveren veya daha düşük bir kapsamı kapsaması ve özel boyutun DoubleClick Search'te önceden oluşturulmuş olması gerekir. DoubleClick Search'te görünen özel boyut adı büyük/küçük harfe duyarlıdır. Bir dönüşüm raporunda kullanılıyorsa, belirtilen dönüşüm için belirtilen özel boyutun değerini (ayarlanmışsa) döndürür. Bu sütun, dönüşüm raporunu segmentlere ayırmaz. |
|
orderBy[].column.headerText |
string |
Rapor çıktısında bu sütunu tanımlamak için kullanılan metin. Belirtilmediğinde varsayılan olarak columnName veya savedColumnName değerine ayarlanır. Bu özellik, DoubleClick Search sütunları ile aynı ada sahip kayıtlı sütunlar arasındaki çakışmaları önlemek için kullanılabilir. |
|
orderBy[].column.startDate |
string |
YYYY-AA-GG biçiminde kapsayıcı tarih. Bu değer sağlandığında, yalnızca bu sütun için raporun genel zaman aralığı geçersiz kılınır. endDate ile birlikte sağlanmalıdır. |
|
orderBy[].column.endDate |
string |
YYYY-AA-GG biçiminde kapsayıcı gün. Bu değer sağlandığında, yalnızca bu sütun için raporun genel zaman aralığı geçersiz kılınır. startDate ile birlikte sağlanmalıdır. |
|
orderBy[].column.groupByColumn |
boolean |
Yalnızca eşzamanlı rapor. Bu sütuna göre gruplandırmak için true olarak ayarlayın. Varsayılan olarak false değerine ayarlanır. |
|
orderBy[].column.platformSource |
string |
Özel boyut için veri sağlamak amacıyla kullanılan platform. Kabul edilebilir değerler "floodlight"tır. | |
columns[].customMetricName |
string |
Rapora dahil edilecek özel metriğin adı. Raporun kapsamı bir veya daha düşük bir kapsama alınmalıdır ve özel metrik DoubleClick Search'te önceden oluşturulmuş olmalıdır. DoubleClick Search'te görünen özel metrik adı büyük/küçük harfe duyarlıdır. | |
filters[].column.customMetricName |
string |
Rapora dahil edilecek özel metriğin adı. Raporun kapsamı bir veya daha düşük bir kapsama alınmalıdır ve özel metrik DoubleClick Search'te önceden oluşturulmuş olmalıdır. DoubleClick Search'te görünen özel metrik adı büyük/küçük harfe duyarlıdır. | |
orderBy[].column.customMetricName |
string |
Rapora dahil edilecek özel metriğin adı. Raporun kapsamı bir veya daha düşük bir kapsama alınmalıdır ve özel metrik DoubleClick Search'te önceden oluşturulmuş olmalıdır. DoubleClick Search'te görünen özel metrik adı büyük/küçük harfe duyarlıdır. | |
columns[].productReportPerspective |
string |
Yalnızca belirli türdeki ürün etkinlikleri için metrikleri döndürür. Kabul edilen değerler şunlardır:
|
|
filters[].column.productReportPerspective |
string |
Yalnızca belirli türdeki ürün etkinlikleri için metrikleri döndürür. Kabul edilen değerler şunlardır:
|
|
orderBy[].column.productReportPerspective |
string |
Yalnızca belirli türdeki ürün etkinlikleri için metrikleri döndürür. Kabul edilen değerler şunlardır:
|
Yanıt
Başarılı olursa bu yöntem, yanıt gövdesinde bir Raporlar kaynağı döndürür.
Deneyin.
Bu yöntemi canlı verilerde çağırmak ve yanıtı görmek için aşağıdaki API Gezgini'ni kullanın. Alternatif olarak bağımsız gezgini de deneyebilirsiniz.