للحصول على قائمة بالطرق لهذا المورد، اطلع على نهاية هذه الصفحة.
تمثيلات الموارد
تقرير 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 |
يوم شامل بالتنسيق يوم-شهر-سنة. وعند تقديمه، يتم إلغاء النطاق الزمني الإجمالي لتقرير هذا العمود فقط. يجب تقديمه مع startDate . |
|
request.columns[].groupByColumn |
boolean |
التقرير المتزامن فقط. اضبط القيمة على true للتجميع حسب هذا العمود. ضبط القيمة التلقائية على false . |
|
request.columns[].headerText |
string |
النص المستخدم لتحديد هذا العمود في مخرجات التقرير، ويتم تعيينه تلقائيًا على columnName أو savedColumnName عند عدم التحديد. يمكن استخدام ذلك لمنع التضاربات بين أعمدة DoubleClick Search والأعمدة المحفوظة التي تحمل الاسم نفسه. |
|
request.columns[].platformSource |
string |
النظام الأساسي المستخدَم لتوفير البيانات للبُعد المخصّص. القيم المقبولة هي "Floodlight". | |
request.columns[].productReportPerspective |
string |
لا تعرض المقاييس إلا لنوع معين من نشاط المنتج. القيم المقبولة هي:
|
|
request.columns[].savedColumnName |
string |
اسم العمود المحفوظ لتضمينه في التقرير. يجب تحديد نطاق التقرير على مستوى المعلن أو مستوى أقل، ويجب أن يكون هذا العمود المحفوظ قد تم إنشاؤه مسبقًا في واجهة مستخدم DoubleClick Search. | |
request.columns[].startDate |
string |
التاريخ الشامل بالتنسيق يوم-شهر-سنة. وعند تقديمه، يتم إلغاء النطاق الزمني الإجمالي لتقرير هذا العمود فقط. يجب تقديمه مع 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 |
يوم شامل بالتنسيق يوم-شهر-سنة. وعند تقديمه، يتم إلغاء النطاق الزمني الإجمالي لتقرير هذا العمود فقط. يجب تقديمه مع 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 |
لا تعرض المقاييس إلا لنوع معين من نشاط المنتج. القيم المقبولة هي:
|
|
request.filters[].column.savedColumnName |
string |
اسم العمود المحفوظ لتضمينه في التقرير. يجب تحديد نطاق التقرير على مستوى المعلن أو مستوى أقل، ويجب أن يكون هذا العمود المحفوظ قد تم إنشاؤه مسبقًا في واجهة مستخدم DoubleClick Search. | |
request.filters[].column.startDate |
string |
التاريخ الشامل بالتنسيق يوم-شهر-سنة. وعند تقديمه، يتم إلغاء النطاق الزمني الإجمالي لتقرير هذا العمود فقط. يجب تقديمه مع 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 |
يوم شامل بالتنسيق يوم-شهر-سنة. وعند تقديمه، يتم إلغاء النطاق الزمني الإجمالي لتقرير هذا العمود فقط. يجب تقديمه مع 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 |
لا تعرض المقاييس إلا لنوع معين من نشاط المنتج. القيم المقبولة هي:
|
|
request.orderBy[].column.savedColumnName |
string |
اسم العمود المحفوظ لتضمينه في التقرير. يجب تحديد نطاق التقرير على مستوى المعلن أو مستوى أقل، ويجب أن يكون هذا العمود المحفوظ قد تم إنشاؤه مسبقًا في واجهة مستخدم DoubleClick Search. | |
request.orderBy[].column.startDate |
string |
التاريخ الشامل بالتنسيق يوم-شهر-سنة. وعند تقديمه، يتم إلغاء النطاق الزمني الإجمالي لتقرير هذا العمود فقط. يجب تقديمه مع 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 |
التاريخ الشامل بالتنسيق يوم-شهر-سنة. | |
request.timeRange.startDate |
string |
التاريخ الشامل بالتنسيق يوم-شهر-سنة. | |
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" الجديدة. بالنسبة إلى المعلِن المطلوب، يتضمّن الملف جميع الكيانات الفرعية (مثل حسابات محركات البحث والحملات والمجموعات الإعلانية وغيرها) التي تتوفّر في كلٍّ من تجربة "إعلانات شبكة البحث 360" السابقة و"إعلانات شبكة البحث 360" الجديدة.
- طلب
- إدراج طلب تقرير في نظام إعداد التقارير.