Reports

للحصول على قائمة من الطرق لهذا المورد، راجِع نهاية هذه الصفحة.

تمثيلات الموارد

تقرير DoubleClick Search يحتوي هذا العنصر على طلب التقرير، وبعض البيانات الوصفية للتقارير مثل رمز العملة، وصفوف التقارير أو ملفات التقارير التي تم إنشاؤها.

{
  "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 استخدِم عنوان URL هذا لتنزيل ملف التقرير.
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 Search. يكون اسم السمة المخصّصة، الذي يظهر في DoubleClick Search، حسّاسًا لحالة الأحرف.

وإذا تم استخدامها في تقرير إحالات ناجحة، يتم عرض قيمة السمة المخصّصة المحدّدة للإحالة الناجحة المحدّدة، في حال ضبطها. لا يقسّم هذا العمود تقرير الإحالات الناجحة.
request.columns[].customMetricName string اسم المقياس المخصّص المطلوب تضمينه في التقرير يجب أن يكون التقرير محصورًا بمعلن أو أقل، ويجب أن يكون قد سبق إعداد المقياس المخصّص في DoubleClick Search. يكون اسم المقياس المخصّص الذي يظهر في DoubleClick Search حسّاسًا لحالة الأحرف.
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 النظام الأساسي المستخدَم لتقديم بيانات للسمة المخصّصة. القيم المقبولة هي "Floodlight".
request.columns[].productReportPerspective string تعرض المقاييس لنوع معيّن من نشاط المنتج فقط. القيم المقبولة هي:
  • "sold": تعرض مقاييس للمنتجات التي تم بيعها فقط
  • "advertised": تعرض مقاييس فقط للمنتجات التي تم الإعلان عنها في حملة Shopping والتي ربما تم بيعها أو لا
request.columns[].savedColumnName string اسم عمود محفوظ لتضمينه في التقرير. يجب أن يكون التقرير على مستوى المعلن أو على مستوى أقل، ويجب أن يكون هذا العمود المحفوظ قد سبق إنشاؤه في واجهة مستخدم DoubleClick Search.
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 Search. يكون اسم السمة المخصّصة، الذي يظهر في DoubleClick Search، حسّاسًا لحالة الأحرف.

وإذا تم استخدامها في تقرير إحالات ناجحة، يتم عرض قيمة السمة المخصّصة المحدّدة للإحالة الناجحة المحدّدة، في حال ضبطها. لا يقسّم هذا العمود تقرير الإحالات الناجحة.
request.filters[].column.customMetricName string اسم المقياس المخصّص المطلوب تضمينه في التقرير يجب أن يكون التقرير محصورًا بمعلن أو أقل، ويجب أن يكون قد سبق إعداد المقياس المخصّص في DoubleClick Search. يكون اسم المقياس المخصّص الذي يظهر في DoubleClick Search حسّاسًا لحالة الأحرف.
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 النظام الأساسي المستخدَم لتقديم بيانات للسمة المخصّصة. القيم المقبولة هي "Floodlight".
request.filters[].column.productReportPerspective string تعرض المقاييس لنوع معيّن من نشاط المنتج فقط. القيم المقبولة هي:
  • "sold": تعرض مقاييس للمنتجات التي تم بيعها فقط
  • "advertised": تعرض مقاييس فقط للمنتجات التي تم الإعلان عنها في حملة Shopping والتي ربما تم بيعها أو لا
request.filters[].column.savedColumnName string اسم عمود محفوظ لتضمينه في التقرير. يجب أن يكون التقرير على مستوى المعلن أو على مستوى أقل، ويجب أن يكون هذا العمود المحفوظ قد سبق إنشاؤه في واجهة مستخدم DoubleClick Search.
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 Search. يكون اسم السمة المخصّصة، الذي يظهر في DoubleClick Search، حسّاسًا لحالة الأحرف.

وإذا تم استخدامها في تقرير إحالات ناجحة، يتم عرض قيمة السمة المخصّصة المحدّدة للإحالة الناجحة المحدّدة، في حال ضبطها. لا يقسّم هذا العمود تقرير الإحالات الناجحة.
request.orderBy[].column.customMetricName string اسم المقياس المخصّص المطلوب تضمينه في التقرير يجب أن يكون التقرير محصورًا بمعلن أو أقل، ويجب أن يكون قد سبق إعداد المقياس المخصّص في DoubleClick Search. يكون اسم المقياس المخصّص الذي يظهر في DoubleClick Search حسّاسًا لحالة الأحرف.
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 النظام الأساسي المستخدَم لتقديم بيانات للسمة المخصّصة. القيم المقبولة هي "Floodlight".
request.orderBy[].column.productReportPerspective string تعرض المقاييس لنوع معيّن من نشاط المنتج فقط. القيم المقبولة هي:
  • "sold": تعرض مقاييس للمنتجات التي تم بيعها فقط
  • "advertised": تعرض مقاييس فقط للمنتجات التي تم الإعلان عنها في حملة Shopping والتي ربما تم بيعها أو لا
request.orderBy[].column.savedColumnName string اسم عمود محفوظ لتضمينه في التقرير. يجب أن يكون التقرير على مستوى المعلن أو على مستوى أقل، ويجب أن يكون هذا العمود المحفوظ قد سبق إنشاؤه في واجهة مستخدم DoubleClick Search.
request.orderBy[].column.startDate string التاريخ الشامل بتنسيق YYYY-MM-DD ويؤدي توفير هذا الحقل إلى إلغاء النطاق الزمني الإجمالي للتقرير لهذا العمود فقط. يجب تقديمها مع endDate.
request.orderBy[].sortOrder string اتجاه الترتيب، وهو إما ascending أو descending.
request.reportScope object تقرير "النطاق" هو مجموعة من أرقام التعريف المستخدمة لتحديد أي مجموعة فرعية من الكيانات سيتم عرضها في التقرير. يجب إدخال سلسلة أرقام التعريف الكاملة من أدنى مستوى نطاق مطلوب من خلال الوكالة.
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) يحتوي على عمليات ربط أرقام التعريف بين التجربتَين السابقة والجديدة من "إعلانات شبكة البحث 360". بالنسبة إلى المعلِن المطلوب، يتضمّن الملف جميع العناصر الثانوية (مثل حسابات محرّكات البحث والحملات والمجموعات الإعلانية وما إلى ذلك) المتوفّرة في التجربتَين السابقة والجديدة من "إعلانات شبكة البحث 360".
طلب
إدراج طلب تقرير في نظام إعداد التقارير.