Bu kaynakla ilgili yöntemlerin listesi için bu sayfanın sonuna bakın.
Kaynak temsilleri
DoubleClick Search raporu. Bu nesne, rapor isteğini, para birimi kodu gibi bazı rapor meta verilerini ve oluşturulan rapor satırlarını veya rapor dosyalarını içerir.
{ "kind": "doubleclicksearch#report", "id": string, "isReportReady": boolean, "request": { "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 }, "statisticsCurrencyCode": string, "statisticsTimeZone": string, "rowCount": integer, "files": [ { "url": string, "byteCount": long } ], "rows": [ { (key): (value) } ] }
Mülk adı | Değer | Açıklama | Notlar |
---|---|---|---|
files[] |
list |
Yalnızca eşzamansız rapor. Rapor başarıyla tamamlandıktan sonra oluşturulan rapor dosyalarının bir listesini içerir. | |
files[].byteCount |
long |
Bu rapor dosyasının bayt cinsinden boyutu. | |
files[].url |
string |
Rapor dosyasını indirmek için bu URL'yi kullanın. | |
id |
string |
Yalnızca eşzamansız rapor. Raporun kimliği. | |
isReportReady |
boolean |
Yalnızca eşzamansız rapor. Yalnızca rapor başarıyla tamamlandıysa ve rapor dosyaları indirilmeye hazırsa doğru değerini alır. | |
kind |
string |
Bunu Rapor kaynağı olarak tanımlar. Değer: doubleclicksearch#report sabit dizesi. |
|
request |
nested object |
Raporu oluşturan istek. Orijinal istekte belirtilmeyen isteğe bağlı alanlar varsayılan değerlerle doldurulur. | |
request.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. |
|
request.columns[].columnName |
string |
Rapora dahil edilecek DoubleClick Search sütununun adı. | |
request.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. |
|
request.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. | |
request.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. |
|
request.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. |
|
request.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. |
|
request.columns[].platformSource |
string |
Özel boyut için veri sağlamak amacıyla kullanılan platform. Kabul edilebilir değerler "floodlight"tır. | |
request.columns[].productReportPerspective |
string |
Yalnızca belirli türdeki ürün etkinlikleri için metrikleri döndürür. Kabul edilen değerler şunlardır:
|
|
request.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. | |
request.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. |
|
request.downloadFormat |
string |
Raporun döndürülmesi gereken biçim. Şu anda csv veya tsv desteklenmektedir. |
|
request.filters[] |
list |
Rapora uygulanacak filtrelerin listesi. İstek başına maksimum filtre sayısı 300'dür. |
|
request.filters[].column |
nested object |
Filtrenin çalıştırılacağı sütun. Bu bir DoubleClick Search sütunu veya kayıtlı bir sütun olabilir. | |
request.filters[].column.columnName |
string |
Rapora dahil edilecek DoubleClick Search sütununun adı. | |
request.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. |
|
request.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. | |
request.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. |
|
request.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. |
|
request.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. |
|
request.filters[].column.platformSource |
string |
Özel boyut için veri sağlamak amacıyla kullanılan platform. Kabul edilebilir değerler "floodlight"tır. | |
request.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:
|
|
request.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. | |
request.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. |
|
request.filters[].operator |
string |
Filtrede kullanılacak operatör. Kullanılabilir operatörlerin listesi için filtre referansını inceleyin. | |
request.filters[].values[] |
list |
Sütun değerinin filtreleneceği değerlerin listesi. İstek başına maksimum filtre değeri sayısı 300'dür. |
|
request.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. |
|
request.includeRemovedEntities |
boolean |
Kaldırılan öğelerin rapora dahil edilip edilmeyeceğini belirler. Varsayılan olarak false değerine ayarlanır. |
|
request.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). |
|
request.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. |
|
request.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. | |
request.orderBy[].column.columnName |
string |
Rapora dahil edilecek DoubleClick Search sütununun adı. | |
request.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. |
|
request.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. | |
request.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. |
|
request.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. |
|
request.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. |
|
request.orderBy[].column.platformSource |
string |
Özel boyut için veri sağlamak amacıyla kullanılan platform. Kabul edilebilir değerler "floodlight"tır. | |
request.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:
|
|
request.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. | |
request.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. |
|
request.orderBy[].sortOrder |
string |
Sıralama yönü: ascending veya descending . |
|
request.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. | |
request.reportScope.adGroupId |
long |
DS reklam grubu kimliği. | |
request.reportScope.adId |
long |
DS reklam kimliği. | |
request.reportScope.advertiserId |
long |
DS reklamveren kimliği. | |
request.reportScope.agencyId |
long |
DS ajans kimliği. | |
request.reportScope.campaignId |
long |
DS kampanya kimliği. | |
request.reportScope.engineAccountId |
long |
DS motor hesabı kimliği. | |
request.reportScope.keywordId |
long |
DS anahtar kelime kimliği. | |
request.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. |
|
request.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. |
|
request.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. |
|
request.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). |
|
request.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. | |
request.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. |
|
request.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. |
|
request.timeRange.endDate |
string |
YYYY-AA-GG biçiminde kapsayıcı tarih. | |
request.timeRange.startDate |
string |
YYYY-AA-GG biçiminde kapsayıcı tarih. | |
request.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. |
|
rowCount |
integer |
Rapor tarafından oluşturulan, başlıklar hariç rapor satırlarının sayısı. | |
rows[] |
list |
Yalnızca eşzamanlı rapor. Oluşturulan rapor satırları. | |
rows[].(key) |
any value |
Bu satırda gösterilen sütunları belirtir. Yani her anahtar, bu satırda boş olmayan bir hücre bulunan bir sütuna karşılık gelir. | |
statisticsCurrencyCode |
string |
Kullanıcılar tarafından belirlenen değerler (ör. anahtar kelime teklif ayarları) ve metrikler (ör. maliyet ve gelir) dahil olmak üzere, raporda oluşturulan tüm parasal değerlerin para birimi kodu. Bir raporun para birimi kodu, rapor isteğinin statisticsCurrency alanı tarafından belirlenir. |
|
statisticsTimeZone |
string |
Rapordaki tüm istatistikler aynı saat diliminden alınıyorsa, doğru olan budur. Aksi takdirde alan ayarlanmamış olur. |
Yöntemler
- oluştur
- Hemen rapor oluşturur ve döndürür.
- edin
- Rapor isteğinin durumu için anketler.
- getFile
- UTF-8 olarak kodlanmış bir rapor dosyası indirir.
- getIdMappingFile
- Önceki Search Ads 360 ile yeni Search Ads 360 arasında kimlik eşlemeleri içeren bir CSV dosyası (UTF-8 olarak kodlanmıştır) indirir. İstenen reklamveren için dosya, önceki Search Ads 360'ta ve yeni Search Ads 360'ta bulunan tüm alt varlıkları (ör. arama motoru hesapları, kampanyalar, reklam grupları vb.) içerir.
- istek
- Raporlama sistemine bir rapor isteği ekler.