Google 服务客户端 (PHP) 方法文档如何工作？

Question

我在使用任何未在某处明确举例说明的客户端服务方法时都遇到困难。尽管遵循了文档，甚至阅读了源代码，但我提出的遵循方案的类或方法名永远不会正确。

Packagist 的文档（请参阅“发出请求”）说客户端库类是从 Google 端点自动生成的，这与 library's docs on Github 中的描述一致，即访问方法的模式应该是“@987654324 @"。

那么为什么会出现以下情况？

// works:
// I get a countable object of active classrooms owner by the specified id
$response = $this->ClassroomService->courses->listCourses([
            'courseStates' =>   'ACTIVE',
            'teacherId'     => 'me']);

// works:
// I get an instance of the single classroom's object containing lots of meta data
$response = $this->ClassroomService->courses->get( $id );

// does not work:
// 500 error, obj has no such method
$response = $this->ClassroomService->topics->listCoursesTopics( $id  );

根据API Explorer，这三个都应该没问题。

我在使用客户端服务对象时缺少什么？

编辑 最终，我将示例中的资源确定为“courses_topics”；根据文档，该方法是正确的。感谢@ebram 的想法。 问题仍然是这些方法是如何命名的。 courseWork 是我的下一个挑战，它不符合 topics 的命名模式。

Answer 1

• topics 没有ClassroomService 的成员。
• 成员名为courses_topics。
  • 这记录在the Classroom documentation 底部的“属性摘要”中。

您的代码应如下所示：

$response = $this->ClassroomService->courses_topics->listCoursesTopics( $id  );

• Google_Service_Classroom_CoursesTopics_Resource 的文档确实错误地提供了成员名为 ->topics 的示例代码。
• 鉴于 API 文档是从源代码生成的，但示例代码（通常）是手工编写的，我会假设 API 文档是正确的，而示例代码是不正确的。我会向 Google 提交文档错误。

更新：

我查看了the PHP source code for Google_Service_Classroom in GitHub 并验证该属性名为courses_topics 而不是topics，因此结论是：示例代码错误。

有趣的是实际源代码中的资源类型是Google_Service_Classroom_Resource_CoursesTopics，但文档将其称为Google_Service_Classroom_CoursesTopics_Resource - 所以文档肯定是错误的。