Reports

Bu kaynağa yönelik yöntem 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 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 döndürür.
kind string Bunu bir Rapor kaynağı olarak tanımlar. Değer: sabit doubleclicksearch#report 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 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.
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ı 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.
request.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.
request.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.
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; 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.
request.columns[].platformSource string Özel boyuta veri sağlamak için kullanılan platform. Kabul edilebilir değerler "floodlight"tır.
request.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
request.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.
request.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.
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 uygulanacağı 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ı 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.
request.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.
request.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.
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; 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.
request.filters[].column.platformSource string Özel boyuta veri sağlamak için kullanılan platform. Kabul edilebilir değerler "floodlight"tır.
request.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
request.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.
request.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.
request.filters[].operator string Filtrede kullanılacak operatör. Kullanılabilir operatörlerin listesi için filtre referansına bakın.
request.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.
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 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 - 100000000 (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 yönlerin listesi.

İstek başına maksimum sipariş sayısı 300'dür.
request.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.
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ı 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.
request.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.
request.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.
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; 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.
request.orderBy[].column.platformSource string Özel boyuta veri sağlamak için kullanılan platform. Kabul edilebilir değerler "floodlight"tır.
request.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
request.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.
request.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.
request.orderBy[].sortOrder string Sıralama yönü (ascending veya descending).
request.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.
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ürte kullanılabilecek 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ı; satır daha atılır. Kabul edilebilir değerler: 0 - 10000 (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 - 50000 (bu değerler dahil). Varsayılan olarak 0 değerine ayarlanır.
request.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).
request.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.
request.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.
request.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.
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 ise rapor yalnızca istenen tüm istatistik verilerinin kaynağı tek bir saat dilimindeyse oluşturulur. Varsayılan olarak false değerine ayarlanır.
rowCount integer Başlıklar hariç, rapor tarafından oluşturulan 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 temsil edilen sütunları belirtir. Yani her anahtar, bu satırda boş olmayan bir hücre içeren 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, 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 Rapora ait tüm istatistiklerin kaynağı aynı saat dilimindeyse bu durum söz konusu olabilir. Aksi takdirde, alan ayarlanmaz.

Yöntemler

üret
Hemen rapor oluşturur ve raporu döndürür.
al
Rapor isteğinin durumuyla ilgili 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ış) indirir. İstenen reklamveren için dosya, hem önceki Search Ads 360'ta hem de yeni Search Ads 360'ta bulunan tüm alt öğeleri (ör. arama motoru hesapları, kampanyalar, reklam grupları vb.) içerir.
istek
Raporlama sistemine bir rapor isteği ekler.