Reports

برای لیست روش های این منبع، انتهای این صفحه را ببینید.

بازنمایی منابع

گزارش جستجوی DoubleClick. این شی شامل درخواست گزارش، برخی ابرداده های گزارش مانند کد ارز، و ردیف های گزارش تولید شده یا فایل های گزارش است.

{
  "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)
    }
  ]
}
نام ملک ارزش توضیحات یادداشت ها
files[] list فقط گزارش ناهمزمان حاوی لیستی از فایل های گزارش تولید شده پس از تکمیل موفقیت آمیز گزارش است.
files[]. byteCount long اندازه این فایل گزارش بر حسب بایت.
files[]. url string برای دانلود فایل گزارش از این آدرس استفاده کنید.
id string فقط گزارش ناهمزمان شناسه گزارش
isReportReady boolean فقط گزارش ناهمزمان درست است اگر و تنها در صورتی که گزارش با موفقیت تکمیل شده باشد و فایل های گزارش آماده دانلود باشند.
kind string این را به عنوان یک منبع گزارش شناسایی می کند. مقدار: رشته ثابت doubleclicksearch#report .
request nested object درخواستی که گزارش را ایجاد کرد. فیلدهای اختیاری که در درخواست اصلی مشخص نشده اند با مقادیر پیش فرض پر می شوند.
request. columns[] list ستون هایی که باید در گزارش گنجانده شوند. این شامل ستون‌های DoubleClick Search و ستون‌های ذخیره‌شده است. برای ستون‌های DoubleClick Search، فقط پارامتر columnName مورد نیاز است. برای ستون های ذخیره شده فقط پارامتر savedColumnName مورد نیاز است. columnName و savedColumnName را نمی توان در یک بند تنظیم کرد.

حداکثر تعداد ستون در هر درخواست 300 است.

request.columns[]. columnName string نام یک ستون DoubleClick Search برای درج در گزارش.
request.columns[]. customDimensionName string یک گزارش را بر اساس یک بعد سفارشی تقسیم می کند. محدوده گزارش باید به یک تبلیغ‌کننده یا کمتر باشد، و بعد سفارشی باید قبلاً در جستجوی DoubleClick تنظیم شده باشد. نام ابعاد سفارشی، که در جستجوی DoubleClick ظاهر می‌شود، به حروف کوچک و بزرگ حساس است.

اگر در گزارش تبدیل استفاده شود، در صورت تنظیم، مقدار بعد سفارشی مشخص شده برای تبدیل داده شده را برمی‌گرداند. این ستون گزارش تبدیل را بخش بندی نمی کند.

request.columns[]. customMetricName string نام یک سنجه سفارشی برای درج در گزارش. محدوده گزارش باید به یک تبلیغ‌کننده یا کمتر باشد، و معیار سفارشی باید قبلاً در جستجوی DoubleClick تنظیم شده باشد. نام متریک سفارشی، که در جستجوی DoubleClick ظاهر می‌شود، به حروف کوچک و بزرگ حساس است.
request.columns[]. endDate string روز فراگیر در قالب YYYY-MM-DD. در صورت ارائه، این بازه زمانی کلی گزارش را فقط برای این ستون لغو می‌کند. باید همراه با startDate ارائه شود.
request.columns[]. groupByColumn boolean فقط گزارش همزمان برای گروه بندی بر اساس این ستون روی true تنظیم کنید. پیش فرض ها به false .
request.columns[]. headerText string متن مورد استفاده برای شناسایی این ستون در خروجی گزارش. به طور پیش فرض columnName یا savedColumnName زمانی که مشخص نشده باشد. این می تواند برای جلوگیری از برخورد بین ستون های DoubleClick Search و ستون های ذخیره شده با همان نام استفاده شود.
request.columns[]. platformSource string پلتفرمی که برای ارائه داده برای بعد سفارشی استفاده می شود. مقادیر قابل قبول "فلور نور" هستند.
request.columns[]. productReportPerspective string معیارها را فقط برای نوع خاصی از فعالیت محصول برمی‌گرداند. مقادیر پذیرفته شده عبارتند از:
  • " sold ": معیارهای بازده فقط برای محصولاتی که فروخته شده اند
  • " advertised ": معیارها را فقط برای محصولاتی که در کمپین خرید تبلیغ شده اند و ممکن است فروخته شده باشند یا نه، برمی گرداند.
request.columns[]. savedColumnName string نام ستون ذخیره شده برای درج در گزارش. محدوده گزارش باید در آگهی‌دهنده یا پایین‌تر باشد، و این ستون ذخیره‌شده باید قبلاً در رابط کاربری جستجوی DoubleClick ایجاد شده باشد.
request.columns[]. startDate string تاریخ شامل در قالب YYYY-MM-DD. در صورت ارائه، این بازه زمانی کلی گزارش را فقط برای این ستون لغو می‌کند. باید همراه با endDate ارائه شود.
request. downloadFormat string قالبی که گزارش باید در آن بازگردانده شود. در حال حاضر csv یا tsv پشتیبانی می شود.
request. filters[] list فهرستی از فیلترهایی که باید در گزارش اعمال شوند.

حداکثر تعداد فیلتر در هر درخواست 300 عدد است.

request.filters[]. column nested object ستونی برای اجرای فیلتر روی. این می تواند یک ستون DoubleClick Search یا یک ستون ذخیره شده باشد.
request.filters[].column. columnName string نام یک ستون DoubleClick Search برای درج در گزارش.
request.filters[].column. customDimensionName string یک گزارش را بر اساس یک بعد سفارشی تقسیم می کند. محدوده گزارش باید به یک تبلیغ‌کننده یا کمتر باشد، و بعد سفارشی باید قبلاً در جستجوی DoubleClick تنظیم شده باشد. نام ابعاد سفارشی، که در جستجوی DoubleClick ظاهر می‌شود، به حروف کوچک و بزرگ حساس است.

اگر در گزارش تبدیل استفاده شود، در صورت تنظیم، مقدار بعد سفارشی مشخص شده برای تبدیل داده شده را برمی‌گرداند. این ستون گزارش تبدیل را بخش بندی نمی کند.

request.filters[].column. customMetricName string نام یک سنجه سفارشی برای درج در گزارش. محدوده گزارش باید به یک تبلیغ‌کننده یا کمتر باشد، و معیار سفارشی باید قبلاً در جستجوی DoubleClick تنظیم شده باشد. نام متریک سفارشی، که در جستجوی DoubleClick ظاهر می‌شود، به حروف کوچک و بزرگ حساس است.
request.filters[].column. endDate string روز فراگیر در قالب YYYY-MM-DD. در صورت ارائه، این بازه زمانی کلی گزارش را فقط برای این ستون لغو می‌کند. باید همراه با startDate ارائه شود.
request.filters[].column. groupByColumn boolean فقط گزارش همزمان برای گروه بندی بر اساس این ستون روی true تنظیم کنید. پیش فرض ها به false .
request.filters[].column. headerText string متن مورد استفاده برای شناسایی این ستون در خروجی گزارش. به طور پیش فرض columnName یا savedColumnName زمانی که مشخص نشده باشد. این می تواند برای جلوگیری از برخورد بین ستون های DoubleClick Search و ستون های ذخیره شده با همان نام استفاده شود.
request.filters[].column. platformSource string پلتفرمی که برای ارائه داده برای بعد سفارشی استفاده می شود. مقادیر قابل قبول "فلور نور" هستند.
request.filters[].column. productReportPerspective string معیارها را فقط برای نوع خاصی از فعالیت محصول برمی‌گرداند. مقادیر پذیرفته شده عبارتند از:
  • " sold ": معیارهای بازده فقط برای محصولاتی که فروخته شده اند
  • " advertised ": معیارها را فقط برای محصولاتی که در کمپین خرید تبلیغ شده اند و ممکن است فروخته شده باشند یا نه، برمی گرداند.
request.filters[].column. savedColumnName string نام ستون ذخیره شده برای درج در گزارش. محدوده گزارش باید در آگهی‌دهنده یا پایین‌تر باشد، و این ستون ذخیره‌شده باید قبلاً در رابط کاربری جستجوی DoubleClick ایجاد شده باشد.
request.filters[].column. startDate string تاریخ شامل در قالب YYYY-MM-DD. در صورت ارائه، این بازه زمانی کلی گزارش را فقط برای این ستون لغو می‌کند. باید همراه با endDate ارائه شود.
request.filters[]. operator string اپراتور برای استفاده در فیلتر. برای لیستی از اپراتورهای موجود به مرجع فیلتر مراجعه کنید.
request.filters[]. values[] list فهرستی از مقادیر برای فیلتر کردن مقدار ستون.

حداکثر تعداد مقادیر فیلتر در هر درخواست 300 عدد است.

request. includeDeletedEntities boolean تعیین می کند که آیا نهادهای حذف شده باید در گزارش گنجانده شوند یا خیر. پیش فرض ها به false . منسوخ شده است، لطفاً به جای آن از includeRemovedEntities استفاده کنید.
request. includeRemovedEntities boolean تعیین می کند که آیا نهادهای حذف شده باید در گزارش گنجانده شوند یا خیر. پیش فرض ها به false .
request. maxRowsPerFile integer فقط گزارش ناهمزمان حداکثر تعداد ردیف در هر فایل گزارش. یک گزارش بزرگ بر اساس این فیلد به فایل های زیادی تقسیم می شود. مقادیر قابل قبول شامل 1000000 تا 100000000 می باشد.
request. orderBy[] list فقط گزارش همزمان فهرستی از ستون‌ها و جهت‌ها که مرتب‌سازی را برای انجام در ردیف‌های گزارش تعریف می‌کنند.

حداکثر تعداد سفارش در هر درخواست 300 عدد می باشد.

request.orderBy[]. column nested object ستون برای انجام مرتب سازی بر روی. این می تواند یک ستون تعریف شده توسط DoubleClick Search یا یک ستون ذخیره شده باشد.
request.orderBy[].column. columnName string نام یک ستون DoubleClick Search برای درج در گزارش.
request.orderBy[].column. customDimensionName string یک گزارش را بر اساس یک بعد سفارشی تقسیم می کند. محدوده گزارش باید به یک تبلیغ‌کننده یا کمتر باشد، و بعد سفارشی باید قبلاً در جستجوی DoubleClick تنظیم شده باشد. نام ابعاد سفارشی، که در جستجوی DoubleClick ظاهر می‌شود، به حروف کوچک و بزرگ حساس است.

اگر در گزارش تبدیل استفاده شود، در صورت تنظیم، مقدار بعد سفارشی مشخص شده برای تبدیل داده شده را برمی‌گرداند. این ستون گزارش تبدیل را بخش بندی نمی کند.

request.orderBy[].column. customMetricName string نام یک سنجه سفارشی برای درج در گزارش. محدوده گزارش باید به یک تبلیغ‌کننده یا کمتر باشد، و معیار سفارشی باید قبلاً در جستجوی DoubleClick تنظیم شده باشد. نام متریک سفارشی، که در جستجوی DoubleClick ظاهر می‌شود، به حروف کوچک و بزرگ حساس است.
request.orderBy[].column. endDate string روز فراگیر در قالب YYYY-MM-DD. در صورت ارائه، این بازه زمانی کلی گزارش را فقط برای این ستون لغو می‌کند. باید همراه با startDate ارائه شود.
request.orderBy[].column. groupByColumn boolean فقط گزارش همزمان برای گروه بندی بر اساس این ستون روی true تنظیم کنید. پیش فرض ها به false .
request.orderBy[].column. headerText string متن مورد استفاده برای شناسایی این ستون در خروجی گزارش. به طور پیش فرض columnName یا savedColumnName زمانی که مشخص نشده باشد. این می تواند برای جلوگیری از برخورد بین ستون های DoubleClick Search و ستون های ذخیره شده با همان نام استفاده شود.
request.orderBy[].column. platformSource string پلتفرمی که برای ارائه داده برای بعد سفارشی استفاده می شود. مقادیر قابل قبول "فلور نور" هستند.
request.orderBy[].column. productReportPerspective string معیارها را فقط برای نوع خاصی از فعالیت محصول برمی‌گرداند. مقادیر پذیرفته شده عبارتند از:
  • " sold ": معیارهای بازده فقط برای محصولاتی که فروخته شده اند
  • " advertised ": معیارها را فقط برای محصولاتی که در کمپین خرید تبلیغ شده اند و ممکن است فروخته شده باشند یا نه، برمی گرداند.
request.orderBy[].column. savedColumnName string نام ستون ذخیره شده برای درج در گزارش. محدوده گزارش باید در آگهی‌دهنده یا پایین‌تر باشد، و این ستون ذخیره‌شده باید قبلاً در رابط کاربری جستجوی DoubleClick ایجاد شده باشد.
request.orderBy[].column. startDate string تاریخ شامل در قالب YYYY-MM-DD. در صورت ارائه، این بازه زمانی کلی گزارش را فقط برای این ستون لغو می‌کند. باید همراه با endDate ارائه شود.
request.orderBy[]. sortOrder string جهت مرتب سازی که یا ascending یا descending است.
request. reportScope object ReportScope مجموعه ای از شناسه هایی است که برای تعیین زیرمجموعه موجودیت ها در گزارش استفاده می شود. نسب کامل شناسنامه ها از پایین ترین سطح دامنه مورد نظر از طریق آژانس مورد نیاز است.
request.reportScope. adGroupId long شناسه گروه تبلیغات DS.
request.reportScope. adId long شناسه آگهی DS.
request.reportScope. advertiserId long شناسه تبلیغ کننده DS.
request.reportScope. agencyId long شناسه نمایندگی DS.
request.reportScope. campaignId long شناسه کمپین DS.
request.reportScope. engineAccountId long شناسه حساب موتور DS.
request.reportScope. keywordId long شناسه کلمه کلیدی DS.
request. reportType string نوع ردیف هایی که در گزارش برگردانده می شوند را تعیین می کند. برای مثال، اگر reportType: keyword مشخص کنید، هر ردیف در گزارش حاوی داده‌هایی درباره یک کلمه کلیدی است. برای ستون هایی که برای هر نوع موجود است، به مرجع انواع گزارش ها مراجعه کنید.
request. rowCount integer فقط گزارش همزمان حداکثر تعداد ردیف برای بازگشت؛ ردیف های اضافی حذف می شوند. مقادیر قابل قبول شامل 0 تا 10000 است. پیش فرض 10000 است.
request. startRow integer فقط گزارش همزمان شاخص مبتنی بر صفر از اولین سطر برای بازگشت. مقادیر قابل قبول شامل 0 تا 50000 است. پیش‌فرض 0 است.
request. statisticsCurrency string ارزی را مشخص می کند که پول با آن بازگردانده می شود. مقادیر ممکن عبارتند از: usd ، agency (معتبر اگر گزارش به نمایندگی یا کمتر باشد)، advertiser (معتبر اگر محدوده گزارش به * تبلیغ‌کننده یا پایین‌تر باشد)، یا account (معتبر اگر گزارش به حساب موتور یا پایین‌تر باشد) .
request. timeRange object اگر معیارها در یک گزارش درخواست شوند، از این آرگومان برای محدود کردن معیارها به یک محدوده زمانی خاص استفاده می‌شود.
request.timeRange. changedAttributesSinceTimestamp datetime مهر زمانی UTC شامل در قالب RFC، به عنوان مثال، 2013-07-16T10:16:23.555Z . به منابع اضافی در مورد نحوه عملکرد گزارش های ویژگی تغییر یافته مراجعه کنید.
request.timeRange. changedMetricsSinceTimestamp datetime مهر زمانی UTC شامل در قالب RFC، به عنوان مثال، 2013-07-16T10:16:23.555Z . به منابع اضافی در مورد نحوه عملکرد گزارش های معیارهای تغییر یافته مراجعه کنید.
request.timeRange. endDate string تاریخ شامل در قالب YYYY-MM-DD.
request.timeRange. startDate string تاریخ شامل در قالب YYYY-MM-DD.
request. verifySingleTimeZone boolean اگر true ، گزارش تنها در صورتی ایجاد می‌شود که همه داده‌های آماری درخواستی از یک منطقه زمانی منفرد تهیه شده باشند. پیش فرض ها به false .
rowCount integer تعداد ردیف‌های گزارش تولید شده توسط گزارش، بدون احتساب سرصفحه.
rows[] list فقط گزارش همزمان ایجاد ردیف های گزارش
rows[]. (key) any value ستون هایی را که در این سطر نشان داده شده اند نشان می دهد. یعنی هر کلید مربوط به یک ستون با یک سلول غیر خالی در این سطر است.
statisticsCurrencyCode string کد ارز تمام مقادیر پولی تولید شده در گزارش، از جمله مقادیری که توسط کاربران تنظیم شده است (به عنوان مثال، تنظیمات پیشنهاد قیمت کلمه کلیدی) و معیارها (مانند هزینه و درآمد). کد ارز یک گزارش توسط قسمت statisticsCurrency درخواست گزارش تعیین می شود.
statisticsTimeZone string اگر همه آمار گزارش از یک منطقه زمانی تهیه شده باشد، این همان خواهد بود. در غیر این صورت فیلد تنظیم نشده است.

روش ها

تولید کند
بلافاصله گزارشی را ایجاد و برمی گرداند.
دریافت کنید
نظرسنجی برای وضعیت درخواست گزارش.
getFile
یک فایل گزارش کدگذاری شده در UTF-8 را دانلود می کند.
getIdMappingFile
یک فایل CSV (کدگذاری‌شده در UTF-8) را دانلود می‌کند که حاوی نگاشت‌های شناسه بین Search Ads 360 قبلی و Search Ads 360 جدید است. برای تبلیغ‌کننده درخواست‌شده، این فایل شامل همه موجودیت‌های کودک (مانند حساب‌های موتور، کمپین‌ها، گروه‌های تبلیغاتی و غیره می‌شود). .) که هم در Search Ads 360 قبلی و هم در Search Ads 360 جدید وجود دارد.
درخواست کنید
درخواست گزارش را در سیستم گزارش دهی درج می کند.