Method: targetingTypes.targetingOptions.search

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

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
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 )

عبارت های جستجو برای گزینه های هدف گذاری POI. فقط زمانی قابل استفاده است که 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 مراجعه کنید.

PoiSearch Terms

عبارت های جستجو برای گزینه های هدف گذاری POI.

نمایندگی JSON
{
  "poiQuery": string
}
زمینه های
poiQuery

string

عبارت جستجو برای نام POI مورد نظر، آدرس خیابان، یا مختصات POI مورد نظر. پرس و جو می تواند یک پیشوند باشد، به عنوان مثال "Times Squar"، "40.7505045،-73.99562"، "315 W 44th St"، و غیره.

BusinessChainSearch Terms

عبارات جستجو برای گزینه های هدف گذاری زنجیره کسب و کار.

حداقل یکی از فیلدها باید پر باشد.

نمایندگی JSON
{
  "businessChainQuery": string,
  "regionQuery": string
}
زمینه های
businessChainQuery

string

جستجوی زنجیره کسب و کار مورد نظر. درخواست باید نام کامل کسب و کار باشد، به عنوان مثال "KFC"، "mercedes-benz".

regionQuery

string

عبارت جستجو برای منطقه جغرافیایی مورد نظر، به عنوان مثال "Seattle"، "United State".

GeoRegionSearch Terms

عبارت‌های جستجو برای گزینه‌های هدف‌یابی منطقه جغرافیایی.

نمایندگی JSON
{
  "geoRegionQuery": string
}
زمینه های
geoRegionQuery

string

عبارت جستجو برای منطقه جغرافیایی مورد نظر. پرس و جو می تواند یک پیشوند باشد، به عنوان مثال "New Yor"، "Seattle"، "USA"، و غیره.