Reports: request

إدراج طلب تقرير في نظام إعداد التقارير. التجربة الآن

طلب

طلب HTTP

POST https://www.googleapis.com/doubleclicksearch/v2/reports

التفويض

ويتطلب هذا الطلب تفويضًا من خلال النطاق التالي:

النطاق
https://www.googleapis.com/auth/doubleclicksearch

لمزيد من المعلومات، اطلع على صفحة المصادقة والتفويض.

نص الطلب

في نص الطلب، قدِّم البيانات بالبنية التالية:

{
  "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
}
اسم الموقع القيمة الوصف ملاحظات
reportScope object إن نطاق reportScope عبارة عن مجموعة من أرقام التعريف التي تُستخدَم لتحديد مجموعة فرعية من الكيانات التي سيتم عرضها في التقرير. يجب أن تتضمّن الوكالة السطر الكامل من أرقام التعريف من المستوى الأدنى ضمن النطاق المطلوب.
reportScope.agencyId long رقم تعريف وكالة DS.
reportScope.advertiserId long الرقم التعريفي لمعلن DS.
reportScope.engineAccountId long رقم تعريف حساب محرك DS.
reportScope.campaignId long رقم تعريف حملة DS.
reportScope.adGroupId long رقم تعريف المجموعة الإعلانية في DS.
reportScope.keywordId long رقم تعريف الكلمة الرئيسية في DS.
reportScope.adId long رقم تعريف الإعلان في DS.
reportType string لتحديد نوع الصفوف التي يتم عرضها في التقرير. على سبيل المثال، إذا حدّدت reportType: keyword، سيحتوي كل صف في التقرير على بيانات عن الكلمة الرئيسية. راجع مرجع أنواع التقارير للأعمدة المتوفرة لكل نوع.
columns[] list الأعمدة المراد تضمينها في التقرير. ويشمل هذا كلاً من أعمدة DoubleClick Search والأعمدة المحفوظة. بالنسبة إلى أعمدة DoubleClick Search، لا يلزم سوى المعلمة columnName. بالنسبة إلى الأعمدة المحفوظة، يجب استخدام المعلمة savedColumnName فقط. لا يمكن ضبط columnName وsavedColumnName في المقطع نفسه.

الحد الأقصى لعدد الأعمدة لكل طلب هو 300.

columns[].columnName string اسم عمود DoubleClick Search المراد تضمينه في التقرير.
columns[].savedColumnName string اسم العمود المحفوظ لتضمينه في التقرير. يجب تحديد نطاق التقرير على مستوى المعلن أو مستوى أقل، ويجب أن يكون هذا العمود المحفوظ قد تم إنشاؤه مسبقًا في واجهة مستخدم DoubleClick Search.
columns[].headerText string النص المستخدم لتحديد هذا العمود في مخرجات التقرير، ويتم تعيينه تلقائيًا على columnName أو savedColumnName عند عدم التحديد. يمكن استخدام ذلك لمنع التضاربات بين أعمدة DoubleClick Search والأعمدة المحفوظة التي تحمل الاسم نفسه.
columns[].startDate string التاريخ الشامل بالتنسيق يوم-شهر-سنة. وعند تقديمه، يتم إلغاء النطاق الزمني الإجمالي لتقرير هذا العمود فقط. يجب تقديمه مع endDate.
columns[].endDate string يوم شامل بالتنسيق يوم-شهر-سنة. وعند تقديمه، يتم إلغاء النطاق الزمني الإجمالي لتقرير هذا العمود فقط. يجب تقديمه مع startDate.
columns[].groupByColumn boolean التقرير المتزامن فقط. اضبط القيمة على true للتجميع حسب هذا العمود. ضبط القيمة التلقائية على false.
timeRange object إذا تم طلب المقاييس في تقرير، سيتم استخدام هذه الوسيطة لقصر المقاييس على نطاق زمني محدّد.
timeRange.startDate string التاريخ الشامل بالتنسيق يوم-شهر-سنة.
timeRange.endDate string التاريخ الشامل بالتنسيق يوم-شهر-سنة.
timeRange.changedMetricsSinceTimestamp datetime الطابع الزمني الشامل للتوقيت العالمي المنسق (UTC) بتنسيق RFC، على سبيل المثال، 2013-07-16T10:16:23.555Z. يمكنك الاطّلاع على مراجع إضافية حول كيفية عمل تقارير المقاييس التي تم تغييرها.
timeRange.changedAttributesSinceTimestamp datetime الطابع الزمني الشامل للتوقيت العالمي المنسق (UTC) بتنسيق RFC، على سبيل المثال، 2013-07-16T10:16:23.555Z. يمكنك الاطّلاع على مراجع إضافية حول آلية عمل تقارير السمات التي تم تغييرها.
filters[] list قائمة بالفلاتر التي سيتم تطبيقها على التقرير.

الحد الأقصى لعدد الفلاتر لكل طلب هو 300.

filters[].column nested object عمود لإجراء الفلتر عليه. وقد يكون هذا العمود أحد أعمدة DoubleClick Search أو عمودًا محفوظًا.
filters[].column.columnName string اسم عمود DoubleClick Search المراد تضمينه في التقرير.
filters[].column.savedColumnName string اسم العمود المحفوظ لتضمينه في التقرير. يجب تحديد نطاق التقرير على مستوى المعلن أو مستوى أقل، ويجب أن يكون هذا العمود المحفوظ قد تم إنشاؤه مسبقًا في واجهة مستخدم DoubleClick Search.
filters[].operator string عامل التشغيل المراد استخدامه في الفلتر. راجع مرجع الفلتر للحصول على قائمة بعوامل التشغيل المتاحة.
filters[].values[] list قائمة بالقيم المراد فلترة قيمة العمود وفقًا لها.

الحد الأقصى لعدد قيم الفلتر لكل طلب هو 300.

orderBy[] list التقرير المتزامن فقط. قائمة الأعمدة والاتجاهات التي تُحدِّد الترتيب المطلوب تنفيذه في صفوف التقرير.

الحد الأقصى لعدد الطلبات لكل طلب هو 300.

orderBy[].column nested object لإجراء الفرز على. يمكن أن يكون هذا العمود عمودًا من تحديد DoubleClick Search أو عمودًا محفوظًا.
orderBy[].column.columnName string اسم عمود DoubleClick Search المراد تضمينه في التقرير.
orderBy[].column.savedColumnName string اسم العمود المحفوظ لتضمينه في التقرير. يجب تحديد نطاق التقرير على مستوى المعلن أو مستوى أقل، ويجب أن يكون هذا العمود المحفوظ قد تم إنشاؤه مسبقًا في واجهة مستخدم DoubleClick Search.
orderBy[].sortOrder string اتجاه الترتيب، وهو إما ascending أو descending.
includeDeletedEntities boolean لتحديد ما إذا كان يجب تضمين الكيانات المُزالة في التقرير أم لا. ضبط القيمة التلقائية على false. تم الإيقاف، يُرجى استخدام includeRemovedEntities بدلاً من ذلك.
verifySingleTimeZone boolean إذا true، لن يتم إنشاء التقرير إلا إذا تم الحصول على جميع بيانات الإحصاءات المطلوبة من منطقة زمنية واحدة. ضبط القيمة التلقائية على false.
downloadFormat string التنسيق الذي يجب عرض التقرير به. يتوفّر حاليًا csv أو tsv.
statisticsCurrency string تحدد العملة التي سيتم إرجاع العملة بها. القيم المحتملة هي: usd، أو agency (صالحة إذا كان التقرير يتضمن نطاق وكالة أو أقل)، أو advertiser (صالحة إذا كان التقرير يتضمن نطاق * المعلن أو أقل)، أو account (صالحة في حالة تحديد نطاق التقرير على حساب محرك البحث أو أقل).
startRow integer التقرير المتزامن فقط. فهرس صفري للصف الأول المطلوب عرضه. القيم المقبولة هي 0 إلى 50000، بما في ذلك القيم الواقعة بينهما. ضبط القيمة التلقائية على 0.
rowCount integer التقرير المتزامن فقط. الحد الأقصى لعدد الصفوف المراد عرضها، ويتم تجاهل الصفوف الإضافية. القيم المقبولة هي 0 إلى 10000، بما في ذلك القيم الواقعة بينهما. ضبط القيمة التلقائية على 10000.
maxRowsPerFile integer التقرير غير المتزامن فقط. الحد الأقصى لعدد الصفوف لكل ملف تقرير. يتم تقسيم تقرير كبير إلى عدة ملفات بناءً على هذا الحقل. القيم المقبولة هي 1000000 إلى 100000000، بما في ذلك القيم الواقعة بينهما.
includeRemovedEntities boolean لتحديد ما إذا كان يجب تضمين الكيانات المُزالة في التقرير أم لا. ضبط القيمة التلقائية على false.
columns[].customDimensionName string يعمل التقرير على تقسيم التقرير حسب مكوّن مخصص. يجب تحديد نطاق التقرير لمعلن أو أقل، ويجب إعداد البُعد المخصّص من قبل في DoubleClick Search. اسم البُعد المخصّص الذي يظهر في DoubleClick Search حساس لحالة الأحرف.

في حال استخدامه في تقرير الإحالات الناجحة، يتم عرض قيمة المكوّن المخصّص المحدّد للإحالة الناجحة المحدّدة، في حال ضبطها. لا يعمل هذا العمود على تقسيم تقرير الإحالات الناجحة.

columns[].platformSource string النظام الأساسي المستخدَم لتوفير البيانات للبُعد المخصّص. القيم المقبولة هي "Floodlight".
filters[].column.customDimensionName string يعمل التقرير على تقسيم التقرير حسب مكوّن مخصص. يجب تحديد نطاق التقرير لمعلن أو أقل، ويجب إعداد البُعد المخصّص من قبل في DoubleClick Search. اسم البُعد المخصّص الذي يظهر في DoubleClick Search حساس لحالة الأحرف.

في حال استخدامه في تقرير الإحالات الناجحة، يتم عرض قيمة المكوّن المخصّص المحدّد للإحالة الناجحة المحدّدة، في حال ضبطها. لا يعمل هذا العمود على تقسيم تقرير الإحالات الناجحة.

filters[].column.headerText string النص المستخدم لتحديد هذا العمود في مخرجات التقرير، ويتم تعيينه تلقائيًا على columnName أو savedColumnName عند عدم التحديد. يمكن استخدام ذلك لمنع التضاربات بين أعمدة DoubleClick Search والأعمدة المحفوظة التي تحمل الاسم نفسه.
filters[].column.startDate string التاريخ الشامل بالتنسيق يوم-شهر-سنة. وعند تقديمه، يتم إلغاء النطاق الزمني الإجمالي لتقرير هذا العمود فقط. يجب تقديمه مع endDate.
filters[].column.endDate string يوم شامل بالتنسيق يوم-شهر-سنة. وعند تقديمه، يتم إلغاء النطاق الزمني الإجمالي لتقرير هذا العمود فقط. يجب تقديمه مع startDate.
filters[].column.groupByColumn boolean التقرير المتزامن فقط. اضبط القيمة على true للتجميع حسب هذا العمود. ضبط القيمة التلقائية على false.
filters[].column.platformSource string النظام الأساسي المستخدَم لتوفير البيانات للبُعد المخصّص. القيم المقبولة هي "Floodlight".
orderBy[].column.customDimensionName string يعمل التقرير على تقسيم التقرير حسب مكوّن مخصص. يجب تحديد نطاق التقرير لمعلن أو أقل، ويجب إعداد البُعد المخصّص من قبل في DoubleClick Search. اسم البُعد المخصّص الذي يظهر في DoubleClick Search حساس لحالة الأحرف.

في حال استخدامه في تقرير الإحالات الناجحة، يتم عرض قيمة المكوّن المخصّص المحدّد للإحالة الناجحة المحدّدة، في حال ضبطها. لا يعمل هذا العمود على تقسيم تقرير الإحالات الناجحة.

orderBy[].column.headerText string النص المستخدم لتحديد هذا العمود في مخرجات التقرير، ويتم تعيينه تلقائيًا على columnName أو savedColumnName عند عدم التحديد. يمكن استخدام ذلك لمنع التضاربات بين أعمدة DoubleClick Search والأعمدة المحفوظة التي تحمل الاسم نفسه.
orderBy[].column.startDate string التاريخ الشامل بالتنسيق يوم-شهر-سنة. وعند تقديمه، يتم إلغاء النطاق الزمني الإجمالي لتقرير هذا العمود فقط. يجب تقديمه مع endDate.
orderBy[].column.endDate string يوم شامل بالتنسيق يوم-شهر-سنة. وعند تقديمه، يتم إلغاء النطاق الزمني الإجمالي لتقرير هذا العمود فقط. يجب تقديمه مع startDate.
orderBy[].column.groupByColumn boolean التقرير المتزامن فقط. اضبط القيمة على true للتجميع حسب هذا العمود. ضبط القيمة التلقائية على false.
orderBy[].column.platformSource string النظام الأساسي المستخدَم لتوفير البيانات للبُعد المخصّص. القيم المقبولة هي "Floodlight".
columns[].customMetricName string اسم مقياس مخصّص لتضمينه في التقرير. يجب تحديد نطاق التقرير لمعلن أو أقل، ويجب إعداد المقياس المخصّص من قبل في DoubleClick Search. اسم المقياس المخصّص الذي يظهر في DoubleClick Search حساس لحالة الأحرف.
filters[].column.customMetricName string اسم مقياس مخصّص لتضمينه في التقرير. يجب تحديد نطاق التقرير لمعلن أو أقل، ويجب إعداد المقياس المخصّص من قبل في DoubleClick Search. اسم المقياس المخصّص الذي يظهر في DoubleClick Search حساس لحالة الأحرف.
orderBy[].column.customMetricName string اسم مقياس مخصّص لتضمينه في التقرير. يجب تحديد نطاق التقرير لمعلن أو أقل، ويجب إعداد المقياس المخصّص من قبل في DoubleClick Search. اسم المقياس المخصّص الذي يظهر في DoubleClick Search حساس لحالة الأحرف.
columns[].productReportPerspective string لا تعرض المقاييس إلا لنوع معين من نشاط المنتج. القيم المقبولة هي:
  • "sold": عرض مقاييس فقط للمنتجات التي تم بيعها
  • "advertised": يعرض مقاييس فقط للمنتجات التي تم الإعلان عنها في حملة Shopping والتي يُحتمل أن تكون قد تم بيعها أو لا
filters[].column.productReportPerspective string لا تعرض المقاييس إلا لنوع معين من نشاط المنتج. القيم المقبولة هي:
  • "sold": عرض مقاييس فقط للمنتجات التي تم بيعها
  • "advertised": يعرض مقاييس فقط للمنتجات التي تم الإعلان عنها في حملة Shopping والتي يُحتمل أن تكون قد تم بيعها أو لا
orderBy[].column.productReportPerspective string لا تعرض المقاييس إلا لنوع معين من نشاط المنتج. القيم المقبولة هي:
  • "sold": عرض مقاييس فقط للمنتجات التي تم بيعها
  • "advertised": يعرض مقاييس فقط للمنتجات التي تم الإعلان عنها في حملة Shopping والتي يُحتمل أن تكون قد تم بيعها أو لا

الإجابة

وفي حال نجاح ذلك، تعرض هذه الطريقة مورد التقارير في نص الاستجابة.

جرِّب هذه الميزة الآن.

استخدم مستكشف واجهات برمجة التطبيقات أدناه لاستدعاء هذه الطريقة في البيانات المباشرة والاطلاع على الاستجابة. ويمكنك بدلاً من ذلك استخدام المستكشف المستقل.