Получите ресурсы 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 так, чтобы вместо OR использовался оператор AND, то будут возвращены только те ресурсы, у которых и аккаунт-владелец имеет идентификатор аккаунта 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 вернет меньше 10 результатов.
Значение по умолчанию для page_size – 50, а максимальное – 1000.
Если результатов больше, чем может поместиться в одном ответе, ответ будет включать next_page_token. Чтобы получить следующую страницу или набор результатов, отправьте тот же запрос, указав это значение в поле page_token. Все остальные параметры должны быть такими же, как в предыдущем запросе.
Если поле next_page_token не включено в ответ, это означает, что результатов больше нет.