Method: targetingTypes.targetingOptions.search

يبحث عن خيارات استهداف من نوع معيّن استنادًا إلى عبارات البحث المحدّدة.

طلب HTTP

POST https://displayvideo.googleapis.com/v3/targetingTypes/{targetingType}/targetingOptions:search

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المعلمات
targetingType

enum (TargetingType)

مطلوب. نوع خيارات الاستهداف المطلوب استردادها.

القيم المقبولة هي:

  • TARGETING_TYPE_GEO_REGION
  • TARGETING_TYPE_POI
  • TARGETING_TYPE_BUSINESS_CHAIN

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON 
{
  "advertiserId": string,
  "pageSize": integer,
  "pageToken": string,

  // Union field search_terms can be only one of the following:
  "poiSearchTerms": {
    object (PoiSearchTerms)
  },
  "businessChainSearchTerms": {
    object (BusinessChainSearchTerms)
  },
  "geoRegionSearchTerms": {
    object (GeoRegionSearchTerms)
  }
  // End of list of possible types for union field search_terms.
}
الحقول
advertiserId

string (int64 format)

مطلوب. المعلِن الذي يتم تقديم هذا الطلب في سياقه.
pageSize

integer

حجم الصفحة المطلوب. يجب أن تتراوح القيمة بين 1 و200. وفي حال عدم تحديد قيمة، سيتم ضبط القيمة تلقائيًا على "100". تعرض رمز الخطأ INVALID_ARGUMENT إذا تم تحديد قيمة غير صالحة.
pageToken

string

هو رمز مميز يحدد صفحة من النتائج التي يجب أن يعرضها الخادم. وعادةً ما تكون هذه هي قيمة nextPageToken التي يتم عرضها من الاستدعاء السابق لطريقة targetingOptions.search. وفي حال عدم تحديده، سيتم عرض الصفحة الأولى من النتائج.
حقل الاتحاد search_terms. طلبات البحث التي يمكن من خلالها البحث عن خيارات الاستهداف. يمكن ملء حقل واحد فقط في search_terms، ويجب أن يتوافق مع targeting_type. يمكن أن يكون search_terms واحدًا فقط مما يلي:
poiSearchTerms

object (PoiSearchTerms)

عبارات البحث لخيارات استهداف نقاط الاهتمام لا يمكن استخدام هذه السياسة إلا عند ضبط قيمة targetingType على TARGETING_TYPE_POI.
businessChainSearchTerms

object (BusinessChainSearchTerms)

عبارات البحث لخيارات استهداف "سلسلة الأنشطة التجارية" لا يمكن استخدام هذه السياسة إلا عند ضبط قيمة targetingType على TARGETING_TYPE_BUSINESS_CHAIN.
geoRegionSearchTerms

object (GeoRegionSearchTerms)

عبارات البحث لخيارات استهداف المنطقة الجغرافية لا يمكن استخدام هذه السياسة إلا عند ضبط قيمة targetingType على TARGETING_TYPE_GEO_REGION.

نص الاستجابة

رسالة ردّ على targetingOptions.search.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "targetingOptions": [
    {
      object (TargetingOption)
    }
  ],
  "nextPageToken": string
}
الحقول
targetingOptions[]

object (TargetingOption)

قائمة خيارات الاستهداف التي تتطابق مع معايير البحث.

لن تكون هذه القائمة فارغة إذا كانت فارغة.
nextPageToken

string

رمز مميز لاسترداد الصفحة التالية من النتائج. مرِّر هذه القيمة في الحقل pageToken في طريقة الاستدعاء التالية إلى targetingOptions.search لاسترداد الصفحة التالية من النتائج.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/display-video

لمزيد من المعلومات، يُرجى الاطِّلاع على نظرة عامة على OAuth 2.0.

PoiSearchTerms

عبارات البحث لخيارات استهداف نقاط الاهتمام

تمثيل JSON 
{
  "poiQuery": string
}
الحقول
poiQuery

string

طلب البحث عن اسم نقطة الاهتمام أو عنوان الشارع أو إحداثيات نقطة الاهتمام المطلوبة. يمكن أن يكون الاستعلام بادئة، على سبيل المثال: "Times squar" و"40.7505045,-73.99562" و"315 W 44th St" وما إلى ذلك.

BusinessChainSearchTerms

عبارات البحث لخيارات استهداف "سلسلة الأنشطة التجارية"

يجب تعبئة حقل واحد على الأقل.

تمثيل JSON 
{
  "businessChainQuery": string,
  "regionQuery": string
}
الحقول
businessChainQuery

string

طلب البحث عن سلسلة الأنشطة التجارية المطلوبة. يجب أن يكون طلب البحث هو الاسم الكامل للنشاط التجاري، على سبيل المثال: "KFC"، "مرسيدس بنز".
regionQuery

string

طلب البحث عن المنطقة الجغرافية المطلوبة، مثل "سياتل"، "الولايات المتحدة".

GeoRegionSearchTerms

عبارات البحث لخيارات استهداف المنطقة الجغرافية

تمثيل JSON 
{
  "geoRegionQuery": string
}
الحقول
geoRegionQuery

string

طلب البحث عن المنطقة الجغرافية المطلوبة يمكن أن يكون الاستعلام بادئة، على سبيل المثال: "نيويورك" و"سياتل" و"الولايات المتحدة" وما إلى ذلك