Получайте ресурсы PartnerLink, отправляя SearchPartnerLinksRequest.
Поле parent запроса является обязательным. Установите для параметра parent название ресурса определенного аккаунта в следующем формате:
accountTypes/{account_type}/accounts/{account}
Для гибкости в различных вариантах использования SearchPartnerLinksResponse содержит все ресурсы PartnerLink, где parent в запросе является:
- Аккаунт, указанный в поле
owner_account. - Аккаунт, указанный в поле
partner_account.
Задайте заголовки запросов, если вы получаете доступ к аккаунту parent с помощью партнерской ссылки, родительского управляющего аккаунта Google Рекламы или родительского партнерского аккаунта Дисплея и Видео 360.
Фильтры позволяют ограничить ответ ресурсами с определенными атрибутами.
Метод Search возвращает страницы результатов. Чтобы получить все ресурсы для запроса, проверьте next_page_token и разбейте результаты на страницы.
Как задать заголовки запросов
Метод Search поддерживает заголовок login-account, который позволяет определить путь доступа учетных данных к аккаунту parent в запросе. Заголовок linked-account не поддерживается для методов PartnerLinkService.
Подробную информацию и инструкции по настройке заголовков для разных сценариев доступа можно найти в разделе Целевые сервисы и заголовки.
Фильтры
Чтобы получить определенные ссылки партнеров, используйте поле filter в запросе. Поле filter представляет собой строку, в которой задан набор условий, которые вы хотите применить, а также указано, как API должен объединять условия – с помощью AND или OR.
Подробнее о вариантах фильтрации и синтаксисе можно узнать в AIP-160: Filtering.
Вы можете задать значение filter, используя account_id аккаунта владельца или партнерского аккаунта:
owning_account.account_id:account_idаккаунта владельца.partner_account.account_id–account_idпартнерского аккаунта.
Например, следующий запрос filter возвращает все ссылки партнеров, у которых идентификатор аккаунта владельца – OWNING_ACCOUNT_ID:
owning_account.account_id = OWNING_ACCOUNT_ID
Ещё один пример filter. В результате будут возвращены все партнерские ссылки, где аккаунт-владелец имеет идентификатор OWNING_ACCOUNT_ID или партнерский аккаунт имеет идентификатор PARTNER_ACCOUNT_ID:
owning_account.account_id = OWNING_ACCOUNT_ID OR partner_account.account_id = PARTNER_ACCOUNT_ID
Если изменить filter на AND вместо OR, то в ответе будут только ссылки на партнерские аккаунты, в которых и идентификатор аккаунта владельца равен OWNING_ACCOUNT_ID, и идентификатор партнерского аккаунта равен PARTNER_ACCOUNT_ID:
owning_account.account_id = OWNING_ACCOUNT_ID AND partner_account.account_id = PARTNER_ACCOUNT_ID
Разбивка результатов на страницы
Поле page_size позволяет управлять количеством результатов, возвращаемых в одном ответе. Например, если вы зададите для параметра page_size значение 10, API будет возвращать не более 10 результатов в ответе. Если по вашему запросу будет найдено меньше 10 результатов, API вернет их все.
Значение по умолчаниюpage_size – 50, максимальное значение – 1000.
Если результатов больше, чем может поместиться в одном ответе, в нем будет указан next_page_token. Чтобы получить следующую страницу или набор результатов, отправьте тот же запрос ещё раз, установив для поля page_token это значение. Все остальные параметры должны быть такими же, как в предыдущем запросе.
Если поле next_page_token отсутствует в ответе, значит больше результатов нет.