UserListSelector

ประกอบด้วยวิธีการกรองและการจัดลําดับรายการของผู้ใช้ในบัญชี สําหรับข้อมูลเกี่ยวกับ ตัวเลือก ให้ดูตัวเลือก

วิธีการ

ชื่อวิธี ชนิดการส่งคืน คำอธิบาย
รับ UserListIterator รับการทําซ้ําที่ใช้ในการดําเนินการวนซ้ําผ่านรายการของผู้ใช้
orderBy(สตริง orderBy) UserListSelector นําลําดับที่ระบุไปใช้กับรายชื่อผู้ใช้ที่เลือก
withCondition(เงื่อนไขสตริง) UserListSelector ใช้เงื่อนไขการกรองกับรายชื่อผู้ใช้
withIds(string[], ids) UserListSelector รับรายการผู้ใช้ด้วย ID ที่ระบุ
withLimit(int limit) UserListSelector รับรายชื่อผู้ใช้ n อันดับแรกที่ตรงกับเกณฑ์การเลือก

รับ

รับการ ทําซ้ํา ที่ใช้ในการดําเนินการวนซ้ําผ่านรายการของผู้ใช้

ส่งกลับ

พิมพ์ คำอธิบาย
UserListIterator iterator ใช้เพื่อวนซ้ําผ่านรายชื่อผู้ใช้ที่เลือก

orderBy(สตริง orderBy)

นําลําดับที่ระบุไปใช้กับรายชื่อผู้ใช้ที่เลือก

ระบุพารามิเตอร์ orderBy ในฟอร์ม "columnName orderDirection" โดยที่:

  • columnName เป็นหนึ่งใน [คอลัมน์ที่สนับสนุน] (#supported-รายการคอลัมน์ของผู้ใช้)
  • orderDirection คือลําดับในการเรียงลําดับผลลัพธ์ ตั้งค่าเป็น ASC เพื่อเรียงลําดับผลลัพธ์จากน้อยไปหามาก หรือ DESC เพื่อเรียงลําดับผลลัพธ์จากมากไปหาน้อย ค่าเริ่มต้นคือ ASC

ตัวอย่างเช่น การโทรต่อไปนี้จะส่งกลับผลลัพธ์จากน้อยไปหามากตามชื่อของรายการผู้ใช้

selector = selector.orderBy("Name");

ตัวเลือกสนับสนุนการจัดลําดับเอนทิตีตามหนึ่งเขตข้อมูลเท่านั้น คุณไม่สามารถจัดลําดับรายการของเอนทิตีตามเขตข้อมูล x และภายใน x ตามเขตข้อมูล y และอื่นๆ ถ้าคุณระบุการโทรมากกว่าหนึ่งครั้งorderBy()ในสายโซ่หรือในสายตัวเลือกที่แยกต่างหาก สคริปต์จะเรียงลําดับรายการของเอนทิตีโดยใช้เขตข้อมูลที่ระบุในการโทรล่าสุดorderBy() 

อาร์กิวเมนต์

ชื่อ พิมพ์ คำอธิบาย
orderBy สตริง ลําดับที่จะนําไปใช้

ส่งกลับ

พิมพ์ คำอธิบาย
UserListSelector ตัวเลือกที่มีการเรียงลําดับ

withCondition(String condition)

ใช้เงื่อนไขการกรองกับรายชื่อผู้ใช้

ระบุพารามิเตอร์ เงื่อนไข ในรูปแบบ "columnName operator value" โดยที่:

ตัวดําเนินการ

ตัวดําเนินการที่คุณใช้จะขึ้นอยู่กับชนิดของคอลัมน์ ตัวดําเนินการต้องตรงตามตัวพิมพ์ใหญ่-เล็ก ตัวอย่างเช่น ใช้ STARTS_WITH แทน starts_with

ตัวดําเนินการสําหรับคอลัมน์ที่มีจํานวนเต็มและค่าแบบยาว:

<
<=
>
>=
=
!=

ตัวดําเนินการสําหรับคอลัมน์ที่มีค่า double:

<
>

ตัวดําเนินการสําหรับคอลัมน์ที่มีค่าสตริง มีดังนี้

=
!=
STARTS_WITH
STARTS_WITH_IGNORE_CASE
CONTAINS
CONTAINS_IGNORE_CASE
DOES_NOT_CONTAIN
DOES_NOT_CONTAIN_IGNORE_CASE

ตัวดําเนินการสําหรับคอลัมน์ที่ประกอบด้วยค่าการแจงนับ มีดังนี้

=
!=
IN []
NOT_IN []

ตัวดําเนินการสําหรับคอลัมน์ที่มีอาร์เรย์ของสตริง มีดังนี้

CONTAINS_ALL
CONTAINS_ANY
CONTAINS_NONE

คอลัมน์ที่สนับสนุนสําหรับการกรองรายการผู้ใช้ ชื่อคอลัมน์เป็นแบบตรงตามตัวพิมพ์ใหญ่-เล็ก

คอลัมน์ พิมพ์ ตัวอย่าง
คำอธิบาย สตริง คําอธิบายของรายการผู้ใช้

withCondition("Description = 'foo'")
สมาชิก LifeSpan int ย้อนเวลากลับไปนานเท่าใด (จํานวนวัน) Microsoft Advertising ควรค้นหาการดําเนินการที่ตรงกับข้อกําหนดรายชื่อผู้ใช้นี้

withCondition("MembershipLifeSpan > 10")
ชื่อ สตริง ชื่อรายการผู้ใช้

withCondition("Name = 'foo'")
SizeForAudienceNetwork แบบยาว ขนาดของรายการผู้ใช้ในเครือข่ายผู้ชม

withCondition("SizeForAudienceNetwork > 1000")
SizeForSearch แบบยาว ขนาดของรายการผู้ใช้ในเครือข่ายผู้ชม

withCondition("SizeForSearch > 1000")
พิมพ์ สตริง ชนิดที่ได้รับสิทธิ์ของรายการผู้ใช้ ค่าตรงตามตัวพิมพ์ใหญ่-เล็กที่เป็นไปได้ ได้แก่
  • กําหนดเอง
  • CUSTOMER_LIST
  • IN_MARKET
  • ตรรกะ
  • ผลิตภัณฑ์
  • RULE_BASED
  • คล้ายกัน
ตัวอย่างนี้จะส่งกลับเฉพาะรายชื่อลูกค้าเท่านั้น

withCondition("Type = CUSTOMER_LIST")

อาร์กิวเมนต์

ชื่อ พิมพ์ คำอธิบาย
เงื่อนไข สตริง เงื่อนไขที่จะเพิ่มลงในตัวเลือก

ส่งกลับ

พิมพ์ คำอธิบาย
UserListSelector ตัวเลือกที่มีเงื่อนไขที่ใช้

withIds(string[], ids)

รับรายการผู้ใช้ด้วย ID ที่ระบุ

คุณสามารถใช้เงื่อนไขอย่างน้อยหนึ่งข้อกับตัวเลือกได้ ห่วงโซ่ของเงื่อนไขจะถือว่าเป็นการดําเนินการ AND ตัวอย่างเช่น เอนทิตีจะถูกเลือกก็ต่อเมื่อเงื่อนไข A เป็นจริง และเงื่อนไข B เป็นจริง ตัวอย่างเช่น การโทรต่อไปนี้จะเลือกเฉพาะรายชื่อผู้ใช้ 33333 เท่านั้น

AdsApp.userLists()
    .withIds(['11111', '22222', '33333'])
    .withIds(['33333', '44444', '55555']);

อาร์กิวเมนต์

ชื่อ พิมพ์ คำอธิบาย
รหัส สตริง[] อาร์เรย์ของ ID รายชื่อผู้ใช้ สําหรับขีดจํากัด โปรดดูขีดจํากัดการดําเนินการสคริปต์

ส่งกลับ

พิมพ์ คำอธิบาย
UserListSelector ตัวเลือกที่มี ID ที่นําไปใช้

withLimit(int limit)

รับรายชื่อผู้ใช้ n อันดับแรกที่ตรงกับเกณฑ์การเลือก

อาร์กิวเมนต์

ชื่อ พิมพ์ คำอธิบาย
ขีดจํากัด int จํานวนรายการของผู้ใช้ที่จะส่งกลับ จํานวนจริงอาจน้อยกว่า

ส่งกลับ

พิมพ์ คำอธิบาย
UserListSelector ตัวเลือกที่มีการใช้ขีดจํากัด

ดูเพิ่มเติม