MS Graph API：calendarView的OData $filter组合And/Or语法问题

问题描述 #

调用MS Graph的calendarView端点时，单独使用$filter参数可正常筛选，但组合AND与OR逻辑运算符后无法得到预期结果。需求是筛选主题包含PTO或OOO，且组织者为John Doe的日历事件，尝试用括号分组条件仍未解决，相关VBA代码及错误filter语句如下：

尝试的VBA代码 #

Private Sub buildQuery()
    m_webQuery = "https://graph.microsoft.com/v1.0/me/calendars/calendar/calendarView"
    m_webQuery = m_webQuery & "?$select=subject,organizer, start,end"
    m_webQuery = m_webQuery & "&startDateTime=" & Format$(m_projectStart, "yyyy-mm-dd")
    m_webQuery = m_webQuery & "&endDateTime=" & Format$(m_projectStart + 365, "yyyy-mm-dd")
    m_webQuery = m_webQuery & "&$filter= (contains(subject,'PTO') or contains(subject,'OOO')) and organizer/emailAddress/name eq 'John Doe'"
    m_webQuery = m_webQuery & "&$orderby=organizer/emailAddress/name"
    m_webQuery = m_webQuery & "&$top=500"
End Sub

无法得到正确结果的filter语句 #

m_webQuery = m_webQuery & "&$filter= contains(subject,'PTO') or contains(subject,'OOO') and organizer/emailAddress/name eq 'Joe Smith'"

问题原因 #

1. 逻辑运算符优先级问题：OData中AND优先级高于OR，未加括号的错误filter语句会被解析为：

   (contains(subject,'OOO') and organizer/emailAddress/name eq 'Joe Smith') or contains(subject,'PTO')
   

   这会返回所有主题含PTO的事件（无论组织者是谁），或主题含OOO且组织者为Joe Smith的事件，完全不符合需求。

2. URL编码缺失：即使添加了括号分组，若不对$filter参数进行URL编码，字符串中的空格、括号等特殊字符可能导致Graph API解析错误，返回非预期结果。

解决方案 #

1. 正确分组逻辑条件 #

必须用括号将OR的两个条件括起来，确保先执行主题筛选，再与组织者条件进行AND判断，逻辑表达式应为：

(contains(subject,'PTO') or contains(subject,'OOO')) and organizer/emailAddress/name eq 'John Doe'

2. 对filter字符串进行URL编码 #

在VBA中拼接URL时，需将$filter部分转换为URL安全格式，避免特殊字符干扰解析。可通过自定义URLEncode函数实现。

修正后的VBA代码 #

Private Sub buildQuery()
    Dim filterStr As String
    m_webQuery = "https://graph.microsoft.com/v1.0/me/calendars/calendar/calendarView"
    m_webQuery = m_webQuery & "?$select=subject,organizer,start,end"
    m_webQuery = m_webQuery & "&startDateTime=" & Format$(m_projectStart, "yyyy-mm-dd")
    m_webQuery = m_webQuery & "&endDateTime=" & Format$(m_projectStart + 365, "yyyy-mm-dd")
    
    ' 构造正确的filter逻辑并编码
    filterStr = "(contains(subject,'PTO') or contains(subject,'OOO')) and organizer/emailAddress/name eq 'John Doe'"
    m_webQuery = m_webQuery & "&$filter=" & URLEncode(filterStr)
    
    m_webQuery = m_webQuery & "&$orderby=organizer/emailAddress/name"
    m_webQuery = m_webQuery & "&$top=500"
End Sub

' 自定义URL编码函数，处理特殊字符
Function URLEncode(str As String) As String
    Dim bytes() As Byte
    Dim i As Integer
    Dim char As String
    bytes = StrConv(str, vbUnicode)
    For i = 0 To UBound(bytes) Step 2
        char = Chr(bytes(i))
        Select Case char
            Case "A" To "Z", "a" To "z", "0" To "9", "-", "_", ".", "~"
                URLEncode = URLEncode & char
            Case " "
                URLEncode = URLEncode & "%20"
            Case Else
                URLEncode = URLEncode & "%" & Hex(bytes(i))
        End Select
    Next i
End Function

额外注意事项 #

• 确认组织者名称为精确匹配，若需模糊匹配可将eq替换为contains。
• 确保应用已获取足够权限（如Calendars.Read）以读取日历事件。

内容的提问来源于stack exchange，提问作者Joseph Smith