Reports: request

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ına göz atın.

İstek içeriği

İstek gövdesinde, verileri aşağıdaki yapıyla 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 varlıklar alt kümesinin döndürüleceğini belirlemek için kullanılan bir kimlik grubudur. Ajans aracılığıyla istenen en düşük kapsamlı düzeydeki kimliklerin tam sırası gereklidir.
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ürte kullanılabilecek 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 gerekir. Kayıtlı sütunlar için yalnızca savedColumnName parametresi gerekir. Hem columnName hem de savedColumnName aynı dize içinde 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ı sütunun adı. Raporun kapsamı reklamveren veya daha düşük bir kapsamda olmalı ve bu kayıtlı sütunun önceden DoubleClick Search kullanıcı arayüzünde oluşturulmuş olması gerekir.
columns[].headerText string Rapor çıktısında bu sütunu tanımlamak için kullanılan metin; belirtilmezse varsayılan olarak columnName veya savedColumnName değerine ayarlanır. Bu, 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 raporun yalnızca bu sütundaki genel zaman aralığını geçersiz kılar. 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 raporun yalnızca bu sütundaki genel zaman aralığını geçersiz kılar. 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 istenirse 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 kapsayıcı UTC zaman damgası, ör. 2013-07-16T10:16:23.555Z. Değiştirilen metrik raporlarının nasıl çalıştığıyla ilgili ek referansları inceleyin.
timeRange.changedAttributesSinceTimestamp datetime RFC biçiminde kapsayıcı UTC zaman damgası, ör. 2013-07-16T10:16:23.555Z. Değiştirilen özellik raporlarının nasıl çalıştığıyla ilgili ek referansları inceleyin.
filters[] list Rapora uygulanacak filtrelerin listesi.

İstek başına maksimum filtre sayısı 300'dür.
filters[].column nested object Filtrenin uygulanacağı 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ı sütunun adı. Raporun kapsamı reklamveren veya daha düşük bir kapsamda olmalı ve bu kayıtlı sütunun önceden DoubleClick Search kullanıcı arayüzünde oluşturulmuş olması gerekir.
filters[].operator string Filtrede kullanılacak operatör. Kullanılabilir operatörlerin listesi için filtre referansına bakın.
filters[].values[] list Sütun değerine göre filtrelenecek 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 yönlerin listesi.

İstek başına maksimum sipariş sayısı 300'dür.
orderBy[].column nested object Sıralamanın yapılacağı sütun. Bu, DoubleClick Search tarafından tanımlanmış 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ı sütunun adı. Raporun kapsamı reklamveren veya daha düşük bir kapsamda olmalı ve bu kayıtlı sütunun önceden DoubleClick Search kullanıcı arayüzünde 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 kullanın.
verifySingleTimeZone boolean true ise rapor yalnızca istenen tüm istatistik verilerinin kaynağı tek bir saat dilimindeyse 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 döndürüleceği para birimini belirtir. Olası değerler şunlardır: usd, agency (rapor ajans veya daha düşük bir kapsama ayarlıysa geçerlidir), advertiser (rapor * reklamveren veya daha düşük bir kapsama ayarlıysa geçerlidir) ya da account (rapor, arama motoru hesabı veya daha düşük bir kapsama ayarlıysa geçerlidir).
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 - 50000 (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ı; satır daha atılır. Kabul edilebilir değerler: 0 - 10000 (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 - 100000000 (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ı bir reklamverene veya daha düşük bir değere sahip olmalı ve özel boyut önceden DoubleClick Search'te ayarlanmış olmalıdır. 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, ayarlanmışsa belirli bir dönüşüm için belirtilen özel boyutun değerini döndürür. Bu sütun, dönüşüm raporunu segmentlere ayırmaz.
columns[].platformSource string Özel boyuta veri sağlamak için 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ı bir reklamverene veya daha düşük bir değere sahip olmalı ve özel boyut önceden DoubleClick Search'te ayarlanmış olmalıdır. 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, ayarlanmışsa belirli bir dönüşüm için belirtilen özel boyutun değerini 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; belirtilmezse varsayılan olarak columnName veya savedColumnName değerine ayarlanır. Bu, 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 raporun yalnızca bu sütundaki genel zaman aralığını geçersiz kılar. 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 raporun yalnızca bu sütundaki genel zaman aralığını geçersiz kılar. 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 boyuta veri sağlamak için 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ı bir reklamverene veya daha düşük bir değere sahip olmalı ve özel boyut önceden DoubleClick Search'te ayarlanmış olmalıdır. 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, ayarlanmışsa belirli bir dönüşüm için belirtilen özel boyutun değerini 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; belirtilmezse varsayılan olarak columnName veya savedColumnName değerine ayarlanır. Bu, 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 raporun yalnızca bu sütundaki genel zaman aralığını geçersiz kılar. 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 raporun yalnızca bu sütundaki genel zaman aralığını geçersiz kılar. 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 boyuta veri sağlamak için kullanılan platform. Kabul edilebilir değerler "floodlight"tır.
columns[].customMetricName string Rapora dahil edilecek özel metriğin adı. Raporun kapsamı bir reklamverene veya daha düşük bir değere ayarlanmalı ve özel metrik önceden DoubleClick Search'te ayarlanmış 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 reklamverene veya daha düşük bir değere ayarlanmalı ve özel metrik önceden DoubleClick Search'te ayarlanmış 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 reklamverene veya daha düşük bir değere ayarlanmalı ve özel metrik önceden DoubleClick Search'te ayarlanmış 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 bir ürün etkinliği türüne ilişkin metrikleri döndürür. Kabul edilen değerler şunlardır:
  • "sold": yalnızca satılan ürünlere ilişkin metrikleri döndürür
  • "advertised": Yalnızca bir Alışveriş kampanyasında reklamı yapılan ve satılmış olan veya olmayan ürünlere ilişkin metrikleri döndürür
filters[].column.productReportPerspective string Yalnızca belirli bir ürün etkinliği türüne ilişkin metrikleri döndürür. Kabul edilen değerler şunlardır:
  • "sold": yalnızca satılan ürünlere ilişkin metrikleri döndürür
  • "advertised": Yalnızca bir Alışveriş kampanyasında reklamı yapılan ve satılmış olan veya olmayan ürünlere ilişkin metrikleri döndürür
orderBy[].column.productReportPerspective string Yalnızca belirli bir ürün etkinliği türüne ilişkin metrikleri döndürür. Kabul edilen değerler şunlardır:
  • "sold": yalnızca satılan ürünlere ilişkin metrikleri döndürür
  • "advertised": Yalnızca bir Alışveriş kampanyasında reklamı yapılan ve satılmış olan veya olmayan ürünlere ilişkin metrikleri döndürür

Yanıt

Başarılı olursa bu yöntem yanıt gövdesinde bir Raporlar kaynağı döndürür.

Deneyin!

Canlı verilerde bu yöntemi çağırmak ve yanıtı görmek için aşağıdaki API Gezgini'ni kullanın. Alternatif olarak şunu da deneyebilirsiniz: bağımsız öğrenin.