CampaignSelector

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

ตัวอย่างการใช้งาน:

    var iterator = AdsApp.campaigns()
        .withCondition("ClickConversionRate > 0.3")
        .forDateRange("LAST_WEEK")
        .orderBy("Clicks DESC")
        .get();

    while (iterator.hasNext()) {
        var campaign = iterator.next();
        var metrics = campaign.getStats();
    }

วิธีการ

ชื่อวิธี ชนิดการส่งคืน คำอธิบาย
forDateRange(วัตถุ dateFrom, วัตถุ dateTo) CampaignSelector ใช้วันที่เริ่มต้นและสิ้นสุดสําหรับการเลือกเมตริกประสิทธิภาพ
forDateRange(สตริง dateRange) CampaignSelector ใช้ช่วงวันที่ที่กําหนดไว้ล่วงหน้าสําหรับการเลือกเมตริกประสิทธิภาพ
รับ CampaignIterator รับตัวทําซ้ําที่ใช้ในการคํานวณซ้ําในรายการแคมเปญ
orderBy(สตริง orderBy) CampaignSelector นําการเรียงลําดับที่ระบุไปใช้กับแคมเปญที่เลือก
withCondition(เงื่อนไขสตริง) CampaignSelector นําตัวกรองไปใช้กับรายการแคมเปญ
withIds(string[], ids) CampaignSelector รับแคมเปญด้วย ID ที่ระบุ
withLimit(int limit) CampaignSelector ได้รับ n แคมเปญยอดนิยมที่ตรงกับเกณฑ์การคัดเลือก

forDateRange(วัตถุ dateFrom, วัตถุ dateTo)

ใช้วันที่เริ่มต้นและสิ้นสุดสําหรับการเลือกเมตริกประสิทธิภาพ

ระบุช่วงวันที่ก็ต่อเมื่อ:

  • คุณนําเงื่อนไขหรือลําดับที่อ้างอิงเขตข้อมูลเมตริกประสิทธิภาพไปใช้
  • คุณต้องการรับข้อมูลประสิทธิภาพการทํางานสําหรับวัตถุที่คุณกําลังเลือก ตัวอย่างเช่น ถ้าคุณวางแผนที่จะเรียกใช้เม getStats() ธอด

คุณสามารถระบุพารามิเตอร์วันที่โดยใช้สตริงหรือวัตถุ เมื่อต้องการใช้สตริง ให้ระบุวันที่ในรูปแบบ YYYYMMDD ถ้าคุณใช้วัตถุ ให้สร้างวัตถุที่มีเขตข้อมูลต่อไปนี้:

  • ปี
  • เดือน
  • วัน

ตัวอย่างเช่น:

var date = {year: 2018, month: 5, day: 13};

เดือนเป็นฐานหนึ่ง โดยที่ 1 คือเดือนมกราคม และ 12 คือธันวาคม

ช่วงวันที่นี้รวมอยู่แล้ว ถ้าคุณระบุช่วงวันที่หลายช่วง ระบบจะใช้เฉพาะช่วงวันที่ล่าสุดเท่านั้น

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

ชื่อ พิมพ์ คำอธิบาย
วันที่จาก วัตถุ วันที่เริ่มต้นของช่วงวันที่ที่ระบุข้อมูลประสิทธิภาพที่จะรวมอยู่ในตัวเลือก
dateTo วัตถุ วันที่สิ้นสุดของช่วงวันที่ที่ระบุข้อมูลประสิทธิภาพที่จะรวมอยู่ในตัวเลือก

ส่งกลับ

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

forDateRange(สตริง dateRange)

ใช้ช่วงวันที่ที่กําหนดไว้ล่วงหน้าสําหรับการเลือกเมตริกประสิทธิภาพ

ค่าช่วงวันที่ที่สนับสนุน:

  • วันนี้
  • เมื่อวานนี้
  • LAST_WEEK
  • LAST_BUSINESS_WEEK
  • LAST_7_DAYS
  • THIS_WEEK_SUN_TODAY
  • LAST_14_DAYS
  • LAST_30_DAYS
  • LAST_WEEK_SUN_SAT
  • THIS_MONTH
  • LAST_MONTH
  • ALL_TIME

ระบุช่วงวันที่ก็ต่อเมื่อ:

  • คุณนําเงื่อนไขหรือลําดับที่อ้างอิงเขตข้อมูลเมตริกประสิทธิภาพไปใช้
  • คุณต้องการรับข้อมูลประสิทธิภาพการทํางานสําหรับวัตถุที่คุณกําลังเลือก ตัวอย่างเช่น ถ้าคุณวางแผนที่จะเรียกใช้เม getStats() ธอด

ถ้าคุณระบุช่วงวันที่หลายช่วง ระบบจะใช้เฉพาะช่วงวันที่ล่าสุดเท่านั้น

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

ชื่อ พิมพ์ คำอธิบาย
ช่วงวันที่: สตริง สตริงช่วงวันที่ที่กําหนดไว้ล่วงหน้าที่ระบุข้อมูลประสิทธิภาพการทํางานเพื่อรวมไว้ในตัวเลือก สตริงช่วงวันที่ที่กําหนดไว้ล่วงหน้าจะเป็นแบบตรงตามตัวพิมพ์ใหญ่-เล็ก

ส่งกลับ

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

รับ

รับตัว ทําซ้ํา ที่ใช้ในการคํานวณซ้ําในรายการแคมเปญ

ส่งกลับ

พิมพ์ คำอธิบาย
CampaignIterator ตัวทําซ้ําที่ใช้เพื่อทําซ้ําแคมเปญที่เลือก

orderBy(สตริง orderBy)

นําการเรียงลําดับที่ระบุไปใช้กับแคมเปญที่เลือก

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

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

ตัวอย่างเช่น การโทรต่อไปนี้จะส่งกลับแคมเปญจากน้อยไปหามากโดย AverageCpc

selector = selector.orderBy("AverageCpc");

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

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

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

ส่งกลับ

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

withCondition(เงื่อนไขสตริง)

นําตัวกรองไปใช้กับรายการแคมเปญ แคมเปญ

ระบุพารามิเตอร์ เงื่อนไข ในรูปแบบ "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

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

ต่อไปนี้คือคอลัมน์เมตริกประสิทธิภาพที่คุณอาจระบุได้

คอลัมน์ พิมพ์ ตัวอย่าง
AbsoluteTopImpressionRate สองเท่า withCondition("AbsoluteTopImpressionRate > 0.25")
AverageCpc สองเท่า withCondition("AverageCpc < 2.75")
AverageCpm สองเท่า withCondition("AverageCpm > 0.65")
ClickConversionRate สองเท่า withCondition("ClickConversionRate > 0.25")
คลิก แบบยาว withCondition("Clicks >= 33")
ConvertedClicks แบบยาว withCondition("ConvertedClicks >= 10")
ต้นทุน สองเท่า withCondition("Cost > 3.25")

ค่าใช้จ่ายเป็นสกุลเงินของบัญชี
Ctr สองเท่า withCondition("Ctr > 0.05")

CTR อยู่ในช่วง 0..1 ดังนั้นใช้ 0.05 สําหรับ CTR 5%
ความประทับใจ แบบยาว withCondition("Impressions > 10")
อัตราการแสดงผลสูงสุด สองเท่า withCondition("TopImpressionRate > 0.25")

ต่อไปนี้คือคุณสมบัติของเอนทิตีที่คุณอาจระบุ

คอลัมน์ พิมพ์ ตัวอย่าง
สถานะ การแจงนับ สถานะของแคมเปญ ค่าตรงตามตัวพิมพ์ใหญ่-เล็กที่เป็นไปได้ ได้แก่
  • เปิดใช้งาน
  • หยุดชั่วคราว
  • เอาออก
  • BUDGET_PAUSED
  • BUDGET_AND_USER_PAUSED
ตัวอย่างนี้ส่งคืนว่า Enabled เท่านั้น

withCondition("Status = ENABLED")
ชื่อ สตริง ชื่อของแคมเปญ

withCondition("Name CONTAINS_IGNORE_CASE 'clearance'")
งบประมาณ สองเท่า งบประมาณของแคมเปญ

withCondition("Budget > 500.0")
ชนิดงบประมาณ การแจงนับ ชนิดงบประมาณของแคมเปญ ค่าตรงตามตัวพิมพ์ใหญ่-เล็กที่เป็นไปได้ ได้แก่
  • มาตรฐาน
  • เร่งความเร็ว
withCondition("BudgetType = 'STANDARD'")
DeliveryStatus การแจงนับ สถานะการจัดส่งของแคมเปญ ค่าตรงตามตัวพิมพ์ใหญ่-เล็กที่เป็นไปได้ ได้แก่
  • มีสิทธิ์
  • LIMITED_BY_BUDGET
  • การหยุด
  • CAMPAIGN_OUT_OF_BUDGET
  • CAMPAIGN_SUSPENDED
  • CAMPAIGN_PAUSED
withCondition("DeliveryStatus NOT_IN ['LIMITED_BY_BUDGET', 'HOLD', 'CAMPAIGN_OUT_OF_BUDGET']")
LabelNames ชุดสตริง รายการของชื่อป้ายชื่อแบบตรงตามตัวพิมพ์ใหญ่-เล็กอย่างน้อยหนึ่งชื่อ ใช้เพื่อรับแคมเปญที่เชื่อมโยงกับป้ายชื่อ

withCondition("LabelNames CONTAINS_ANY ['bar', 'foo']")
พิมพ์ การแจงนับ ชนิดของแคมเปญ ค่าตรงตามตัวพิมพ์ใหญ่-เล็กที่เป็นไปได้ ได้แก่
  • SEARCH_AND_CONTENT
  • ช้อปปิ้ง
  • DYNAMIC_SEARCH_ADS
ตัวอย่างนี้จะส่งกลับเฉพาะแคมเปญที่มีประเภท Shopping เท่านั้น

withCondition("CampaignType = SHOPPING")

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

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

ส่งกลับ

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

withIds(string[], ids)

รับแคมเปญด้วย ID ที่ระบุ

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

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

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

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

ส่งกลับ

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

withLimit(int limit)

ได้รับ n แคมเปญยอดนิยมที่ตรงกับเกณฑ์การคัดเลือก

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

ชื่อ พิมพ์ คำอธิบาย
ขีดจํากัด int จํานวนแคมเปญที่จะส่งคืน จํานวนจริงอาจน้อยกว่า

ส่งกลับ

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

ดูเพิ่มเติม