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(Object dateFrom, Object dateTo) | CampaignSelector | ใช้วันที่เริ่มต้นและวันที่สิ้นสุดสําหรับการเลือกเมตริกประสิทธิภาพการทํางาน |
forDateRange(สตริง dateRange) | CampaignSelector | ใช้ช่วงวันที่ที่กําหนดไว้ล่วงหน้าสําหรับการเลือกเมตริกประสิทธิภาพการทํางาน |
รับ | CampaignIterator | รับตัวทําซ้ําที่ใช้ในการทําซ้ําผ่านรายการการส่งเสริมการขาย |
orderBy(string orderBy) | CampaignSelector | ใช้การเรียงลําดับที่ระบุกับการส่งเสริมการขายที่เลือก |
withCondition(เงื่อนไขสตริง) | CampaignSelector | ใช้ตัวกรองกับรายการการส่งเสริมการขาย |
withIds(string[] ids) | CampaignSelector | รับการส่งเสริมการขายที่มีรหัสที่ระบุ |
withLimit(ขีดจํากัด Int) | CampaignSelector | รับการส่งเสริมการขาย n อันดับแรกที่ตรงกับเกณฑ์การเลือก |
forDateRange(Object dateFrom, Object dateTo)
ใช้วันที่เริ่มต้นและวันที่สิ้นสุดสําหรับการเลือกเมตริกประสิทธิภาพการทํางาน
ระบุช่วงวันที่เฉพาะเมื่อ:
- คุณใช้เงื่อนไขหรือการจัดลําดับที่อ้างอิงเขตข้อมูลเมตริกประสิทธิภาพการทํางาน
- คุณต้องการรับข้อมูลประสิทธิภาพการทํางานสําหรับวัตถุที่คุณกําลังเลือก ตัวอย่างเช่น หากคุณวางแผนที่จะเรียกใช้
getStats()
วิธีการ
คุณสามารถระบุพารามิเตอร์วันที่โดยใช้สตริงหรือวัตถุได้ เมื่อต้องการใช้สตริง ให้ระบุวันที่ในแบบฟอร์ม YYYYMMDD ถ้าคุณใช้วัตถุ ให้สร้างวัตถุที่มีเขตข้อมูลต่อไปนี้:
- ปี
- เดือน
- วัน
ตัวอย่างเช่น:
var date = {year: 2018, month: 5, day: 13};
เดือนจะเป็นแบบหนึ่งโดยที่ 1 คือมกราคมและ 12 คือธันวาคม
ช่วงวันที่รวมอยู่ด้วย ถ้าคุณระบุช่วงวันที่หลายช่วง จะใช้ช่วงวันที่ล่าสุดเท่านั้น
อาร์กิวเมนต์
ชื่อ | ชนิด | คำอธิบาย |
---|---|---|
dateFrom | วัตถุ | วันที่เริ่มต้นของช่วงวันที่ที่ระบุข้อมูลประสิทธิภาพการทํางานที่จะรวมไว้ในตัวเลือก |
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()
วิธีการ
ถ้าคุณระบุช่วงวันที่หลายช่วง จะใช้ช่วงวันที่ล่าสุดเท่านั้น
อาร์กิวเมนต์
ชื่อ | ชนิด | คำอธิบาย |
---|---|---|
dateRange | สตริง | สตริงช่วงวันที่ที่กําหนดไว้ล่วงหน้าที่ระบุข้อมูลประสิทธิภาพการทํางานที่จะรวมไว้ในตัวเลือก สตริงช่วงวันที่ที่กําหนดไว้ล่วงหน้าต้องตรงตามตัวพิมพ์ใหญ่-เล็ก |
กลับ
ชนิด | คำอธิบาย |
---|---|
CampaignSelector | ตัวเลือกที่มีการใช้ช่วงวันที่ |
รับ
รับ ตัวทําซ้ํา ที่ใช้ในการทําซ้ําผ่านรายการการส่งเสริมการขาย
กลับ
ชนิด | คำอธิบาย |
---|---|
CampaignIterator | ตัวทําซ้ําที่ใช้ในการทําซ้ําผ่านการส่งเสริมการขายที่เลือก |
orderBy(string orderBy)
ใช้การเรียงลําดับที่ระบุกับการส่งเสริมการขายที่เลือก
ระบุพารามิเตอร์ orderBy ในแบบฟอร์ม "columnName orderDirection" ที่:
- columnName เป็นหนึ่งใน คอลัมน์ที่ได้รับการสนับสนุน
- orderDirection คือลําดับการเรียงลําดับผลลัพธ์ ตั้งค่าเป็น ASC เพื่อเรียงลําดับผลลัพธ์จากน้อยไปหามากหรือ DESC เพื่อเรียงลําดับผลลัพธ์จากมากไปหาน้อย ค่าเริ่มต้นคือ ASC
ตัวอย่างเช่น แคมเปญการส่งกลับการเรียกใช้ต่อไปนี้เรียงจากน้อยไปหามากตาม AverageCpc
selector = selector.orderBy("AverageCpc");
ตัวเลือกสนับสนุนการจัดลําดับเอนทิตีตามเขตข้อมูลเดียวเท่านั้น คุณไม่สามารถจัดลําดับรายการของเอนทิตีตามเขตข้อมูล x และภายใน x ตามเขตข้อมูล y และอื่น ๆ ถ้าคุณระบุการเรียกมากกว่าหนึ่งorderBy()
ครั้งในสายโซ่ หรือในการเรียกตัวเลือกที่แยกต่างหาก Scripts จะจัดลําดับรายการของเอนทิตีโดยใช้เขตข้อมูลที่ระบุในการเรียกใช้ครั้งล่าสุดorderBy()
อาร์กิวเมนต์
ชื่อ | ชนิด | คำอธิบาย |
---|---|---|
orderBy | สาย อักขระ | การเรียงลําดับที่จะนําไปใช้ |
กลับ
ชนิด | คำอธิบาย |
---|---|
CampaignSelector | ตัวเลือกที่มีการใช้การจัดลําดับ |
withCondition(เงื่อนไขสตริง)
ใช้ตัวกรองกับรายการการส่งเสริมการขาย
ระบุพารามิเตอร์ เงื่อนไข ในแบบฟอร์ม "ค่าตัวดําเนินการ columnName" ที่:
- columnName เป็นหนึ่งในคอลัมน์ที่ได้รับการสนับสนุน ถ้า columName ถูกตั้งค่าเป็นชื่อคอลัมน์เมตริกประสิทธิภาพการทํางาน คุณต้องระบุช่วงวันที่โดยใช้ forDateRange(String dateRange) หรือ forDateRange(Object dateFrom, Object dateTo)
- ตัวดําเนินการ เป็นหนึ่งใน ตัวดําเนินการที่ได้รับการสนับสนุน
ผู้ ประกอบการ
ตัวดําเนินการที่คุณใช้ขึ้นอยู่กับชนิดของคอลัมน์ ตัวดําเนินการต้องตรงตามตัวพิมพ์ใหญ่-เล็ก ตัวอย่างเช่น ใช้ STARTS_WITH แทน starts_with
ตัวดําเนินการสําหรับคอลัมน์ที่มีจํานวนเต็มและค่ายาว:
<
<=
>
>=
=
!=
ตัวดําเนินการสําหรับคอลัมน์ที่มีค่าสองค่า:
<
>
ตัวดําเนินการสําหรับคอลัมน์ที่มีค่าสตริง:
=
!=
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 สําหรับ 5% CTR |
อิมเพรสชัน | ยาว | withCondition("Impressions > 10") |
TopImpressionRate | คู่ | withCondition("TopImpressionRate > 0.25") |
ต่อไปนี้คือคุณสมบัติของเอนทิตีที่คุณอาจระบุ
คอลัมน์ | ชนิด | ตัว อย่าง เช่น |
---|---|---|
สถานะ | การแจงนับ | สถานะของแคมเปญ ค่าที่ตรงตามตัวพิมพ์ใหญ่-เล็กที่เป็นไปได้คือ:
withCondition("Status = ENABLED") |
ชื่อ | สาย อักขระ | ชื่อของแคมเปญwithCondition("Name CONTAINS_IGNORE_CASE 'clearance'") |
งบ ประมาณ | คู่ | งบประมาณของแคมเปญwithCondition("Budget > 500.0") |
BudgetType | การแจงนับ | ชนิดงบประมาณของแคมเปญ ค่าที่ตรงตามตัวพิมพ์ใหญ่-เล็กที่เป็นไปได้คือ:
withCondition("BudgetType = 'STANDARD'") |
สถานะของการนําส่ง | การแจงนับ | สถานะการจัดส่งของแคมเปญ ค่าที่ตรงตามตัวพิมพ์ใหญ่-เล็กที่เป็นไปได้คือ:
withCondition("DeliveryStatus NOT_IN ['LIMITED_BY_BUDGET', 'HOLD', 'CAMPAIGN_OUT_OF_BUDGET']") |
LabelNames | ชุดสตริง | รายการของชื่อป้ายชื่อแบบตรงตามตัวพิมพ์ใหญ่-เล็กอย่างน้อยหนึ่งชื่อ ใช้ เพื่อรับการส่งเสริมการขายที่เกี่ยวข้องกับป้ายชื่อที่มีชื่อwithCondition("LabelNames CONTAINS_ANY ['bar', 'foo']") |
ชนิด | การแจงนับ | ชนิดของแคมเปญ ค่าที่ตรงตามตัวพิมพ์ใหญ่-เล็กที่เป็นไปได้คือ:
withCondition("CampaignType = SHOPPING") |
อาร์กิวเมนต์
ชื่อ | ชนิด | คำอธิบาย |
---|---|---|
เงื่อนไข | สาย อักขระ | เงื่อนไขที่จะนําไปใช้กับตัวเลือก |
กลับ
ชนิด | คำอธิบาย |
---|---|
CampaignSelector | ตัวเลือกที่มีการใช้เงื่อนไข |
withIds(string[] ids)
รับการส่งเสริมการขายที่มีรหัสที่ระบุ
คุณอาจใช้เงื่อนไขอย่างน้อยหนึ่งข้อกับตัวเลือก ห่วงโซ่ของเงื่อนไขถือว่าเป็นการดําเนินการ AND ตัวอย่างเช่น เอนทิตีจะถูกเลือกเฉพาะเมื่อเงื่อนไข A เป็นจริงและเงื่อนไข B เป็นจริง ตัวอย่างเช่น การเรียกใช้ต่อไปนี้จะเลือกเฉพาะแคมเปญ 33333 เท่านั้น
AdsApp.campaigns()
.withIds(['11111', '22222', '33333'])
.withIds(['33333', '44444', '55555']);
อาร์กิวเมนต์
ชื่อ | ชนิด | คำอธิบาย |
---|---|---|
รหัส | string[] | อาร์เรย์ของรหัสการส่งเสริมการขาย สําหรับขีดจํากัด ดูขีดจํากัดการดําเนินการสคริปต์ |
กลับ
ชนิด | คำอธิบาย |
---|---|
CampaignSelector | ตัวเลือกที่มีการใช้รหัส |
withLimit(ขีดจํากัด Int)
รับการส่งเสริมการขาย n อันดับแรกที่ตรงกับเกณฑ์การเลือก
อาร์กิวเมนต์
ชื่อ | ชนิด | คำอธิบาย |
---|---|---|
จำกัด | Int | จํานวนการส่งเสริมการขายที่จะส่งคืน ตัวเลขจริงอาจน้อยกว่า |
กลับ
ชนิด | คำอธิบาย |
---|---|
CampaignSelector | ตัวเลือกที่มีการใช้ขีดจํากัด |