共用方式為

KeywordSelector

  • 發行項

包含篩選和排序關鍵字清單的方法。 如需選取器的相關資訊，請參閱 選取器。

範例使用方式：

    var iterator = AdsApp.keywords()
        .withCondition("AdGroupName = 'AD GROUP NAME GOES HERE'")
        .withCondition("CampaignName = 'CAMPAIGN NAME GOES HERE'")
        .get();

    while (iterator.hasNext()) {
        var keyword = iterator.next();
    }

方法

方法名稱 傳回類型 說明
forDateRange (Object dateFrom， Object dateTo) KeywordSelector 套用開始和結束日期以選取效能計量。
forDateRange (字串 dateRange) KeywordSelector 套用預先定義的日期範圍，以選取效能計量。
get KeywordIterator 取得用來逐一查看關鍵字清單的反覆運算器。
orderBy (字串 orderBy) KeywordSelector 將指定的順序套用至選取的關鍵字。
withCondition (字串條件) KeywordSelector 將篩選準則套用至 關鍵字。
withIds (string[] ids) KeywordSelector 取得具有指定識別碼的關鍵字。
withLimit (int 限制) KeywordSelector 取得符合選取準則的前 n 個關鍵字。

forDateRange (Object dateFrom， Object dateTo)

套用開始和結束日期以選取效能計量。

只有在下列狀況下，才指定日期範圍：

  • 您可以套用參考效能計量欄位的條件或順序。
  • 您想要取得所選物件的效能資料。 例如，如果您打算呼叫 getStats() 方法。

您可以使用字串或物件來指定日期參數。 若要使用字串，請以 YYYYMMDD 格式指定日期。 如果您使用 物件，請使用下欄欄位建立 物件：

  • 年
  • 月
  • 一天

例如：

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

月份是以一為基底，其中 1 是 1 月，12 是 12 月。

日期範圍包含在內。 如果您指定多個日期範圍，則只會使用最後一個日期範圍。

引數

名稱 類型 說明
dateFrom 物件 日期範圍的開始日期，指定要包含在選取器中的效能資料。
dateTo 物件 日期範圍的結束日期，指定要包含在選取器中的效能資料。

傳回

類型 說明
KeywordSelector 已套用日期範圍的選取器。

forDateRange (String 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 字串 預先定義的日期範圍字串，指定要包含在選取器中的效能資料。 預先定義的日期範圍字串會區分大小寫。

傳回

類型 說明
KeywordSelector 已套用日期範圍的選取器。

獲取

取得用來逐一查看關鍵字清單的 反覆運算器 。

傳回

類型 說明
KeywordIterator 用來逐一查看所選關鍵字的反覆運算器。

orderBy (字串 orderBy)

將指定的順序套用至選取的關鍵字。

以 「columnName orderDirection」 格式指定 orderBy 參數，其中：

  • columnName 是其中一個 支援的資料行。
  • orderDirection 是排序結果的順序。 設定為 ASC，以遞增順序排序結果或 DESC，以遞減順序排序結果。 預設值為 ASC。

例如，下列呼叫會以 AverageCpc 的遞增順序傳回結果。

selector = selector.orderBy("AverageCpc");

選取器僅支援依一個欄位排序實體。 您不能依欄位 x 排序實體清單，也無法依欄位 y 排序 x 中的實體清單，依此類推。 如果您在鏈結或個別選取器呼叫中指定多個呼叫，則腳本會使用上 orderBy() 一個 orderBy() 呼叫中指定的欄位來排序實體清單。 

引數

名稱 類型 說明
orderBy 字串 要套用的順序。

傳回

類型 說明
KeywordSelector 已套用排序的選取器。

withCondition (字串條件)

將篩選準則套用至 關鍵字。

指定 「columnName 運算子值」 格式 的條件 參數，其中：

運算子

您使用的運算子取決於資料行的類型。 運算子會區分大小寫。 例如，使用 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

支援的關鍵字篩選資料行。 資料行名稱會區分大小寫。

以下是您可以指定的效能計量資料行。

欄位 類型 範例 Microsoft Advertising Web UI 篩選
AbsoluteTopImpressionRate double withCondition("AbsoluteTopImpressionRate > 0.25") Abs. Top Impr. Rate
AverageCpc double withCondition("AverageCpc < 2.75") 平均值
AverageCpm double withCondition("AverageCpm > 0.65") 平均 CPM
ClickConversionRate double withCondition("ClickConversionRate > 0.25") Conv. Rate
點擊 long withCondition("Clicks >= 33") 點擊
ConvertedClicks long withCondition("ConvertedClicks >= 10") Conv。
成本 double withCondition("Cost > 3.25")

成本是以帳戶的貨幣為單位。		 花
點擊率 double withCondition("Ctr > 0.05")

CTR 的範圍為 0..1，因此使用 0.05 表示 5% CTR。		 點擊率
閱聽 long withCondition("Impressions > 10") Impr。
TopImpressionRate double withCondition("TopImpressionRate > 0.25") Top Impr。 Rate

以下是您可以指定的實體屬性。

欄位 類型 範例 Microsoft Advertising Web UI 篩選
狀態 枚舉 關鍵字的狀態。 可能區分大小寫的值為：
  • 啟用
  • 暫停
  • 刪除
withCondition("Status = ENABLED")		 狀態
CombinedApprovalStatus 字串 關鍵字的核准狀態。 可能區分大小寫的值為：
  • 批准
  • APPROVED_LIMITED
  • UNDER_REVIEW
  • 反對
如需這些值的相關資訊，請 參閱編輯核准狀態值。

此範例會傳回需要注意的關鍵字。

withCondition("CombinedApprovalStatus IN ['APPROVED_LIMITED', 'DISAPPROVED']")
文字 字串 關鍵字的文字。 只包含關鍵字的文字。 請勿在文字中包含關鍵字的比對類型。 例如，如果 關鍵字是完全相符的關鍵字，例如 [books]，請使用 非[books] 的書籍。

withCondition("Text STARTS_WITH 'flowers'")		 關鍵字文字
KeywordMatchType 枚舉 關鍵字的相符類型。 可能區分大小寫的值為：
  • 廣泛
  • 確切
  • 短語
withCondition("KeywordMatchType = EXACT")		 符合類型
MaxCpc double 關鍵字的最大一個的一個的檢定金額。 一種是帳戶的貨幣。

withCondition("MaxCpc > 0.40")		 出價
DestinationUrl 字串 withCondition("DestinationUrl STARTS_WITH 'http://www.contoso.com'") 目的地 URL
FinalUrls 字串 withCondition("FinalUrls CONTAINS 'http://www.contoso.com'")
QualityScore int withCondition("QualityScore > 5") Qual。 得分
FirstPageCpc double 每當廣告出現在提要欄位上時，每次按一下廣告時，廣告客戶的平均收費金額。 例如，如果廣告商按下 300 次時總共支付 $48.35 美元，則廣告商的平均值是 $0.16。 使用此資訊來協助決定是否要增加關鍵字的報價，以改善您的廣告出現在提要欄位上的機會。 一種是帳戶的貨幣。

withCondition("FirstPageCpc > 6.00")		 Est。 第一頁的報價
TopOfPageCpc double 每當廣告顯示在組織搜尋結果上方時，每次按一下廣告時，廣告客戶的平均費用金額。 例如，如果廣告商按下 300 次時總共支付 $48.35 美元，則廣告商的平均值是 $0.16。 使用此資訊來協助決定是否要增加關鍵字的報價，以改善您的廣告顯示在組織搜尋結果上方的機會。 一種是目前帳戶的貨幣。

withCondition("TopOfPageCpc > 8.00")		 最佳位置
AdGroupName 字串 包含關鍵字的廣告組名。

withCondition("AdGroupName = 'foo'")
AdGroupStatus 枚舉 廣告群組的狀態。 可能區分大小寫的值為：
  • 啟用
  • 暫停
  • 刪除
withCondition("AdGroupStatus = ENABLED")
CampaignName 字串 包含關鍵字的行銷活動名稱。

withCondition("CampaignName = 'bar'")
CampaignStatus 枚舉 行銷活動的狀態。 可能區分大小寫的值為：
  • 啟用
  • 暫停
  • 刪除
withCondition("CampaignStatus = ENABLED")
LabelNames 字串集 一或多個區分大小寫的標籤名稱清單。 使用 取得與具名標籤相關聯的關鍵字。

withCondition("LabelNames CONTAINS_ANY ['bar', 'foo']")
識別碼 Long 要測試的關鍵字識別碼。 例如，您可以使用此資料行來檢查識別碼大於指定識別碼的關鍵字。

withCondition('Id > 1234')

引數

名稱 類型 說明
條件 字串 要新增至選取器的條件。

傳回

類型 說明
KeywordSelector 已套用條件的選取器。

withIds (string[] ids)

取得具有指定識別碼的關鍵字。

您可以將一或多個條件套用至選取器。 條件鏈結會被視為 AND 作業。 例如，只有在條件 A 為 true 且條件 B 為 true 時，才會選取實體。 例如，下列呼叫只會選取關鍵字 33333。

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

引數

名稱 類型 說明
Id string[] 關鍵字識別碼的陣列。 如需限制，請參閱 腳本執行限制。

傳回

類型 說明
KeywordSelector 已套用識別碼的選取器。

withLimit (int 限制)

取得符合選取準則的前 n 個關鍵字。

引數

名稱 類型 說明
限制 int 要傳回的關鍵字數目。 實際數目可能較少。

傳回

類型 說明
KeywordSelector 已套用限制的選取器。

另請參閱