Получить партнерские ссылки

Для получения ресурсов PartnerLink отправьте запрос SearchPartnerLinksRequest .

Поле parent » запроса является обязательным. В качестве parent укажите имя конкретной учетной записи в следующем формате:

accountTypes/{account_type}/accounts/{account}

Для обеспечения гибкости при использовании в различных сценариях, объект SearchPartnerLinksResponse содержит все ресурсы PartnerLink , в которых parent в запросе является либо:

  • Учетная запись, указанная в поле owner_account
  • Учетная запись, указанная в поле partner_account

Настройте заголовки запроса, если вы получаете доступ к parent аккаунту через партнерскую ссылку, родительский аккаунт Google Ads Manager или родительский партнерский аккаунт Display & Video 360.

Отфильтруйте результаты , чтобы ограничить отклик ресурсами с определенными атрибутами.

Метод Search возвращает страницы результатов. Чтобы получить все ресурсы для запроса, проверьте значение next_page_token и выполните пагинацию результатов .

Установить заголовки запроса

Метод Search поддерживает заголовки login-account и linked-account для определения пути доступа к parent учетной записи через ваши учетные данные. Подробную информацию и инструкции по настройке заголовков для различных сценариев доступа см. в разделе «Назначения и заголовки» .

Отфильтровать результаты

Используйте поле filter запроса для получения конкретных партнерских ссылок. Поле filter представляет собой строку, определяющую набор условий, которые вы хотите применить, а также то, следует ли API объединять условия с помощью AND или OR . Подробнее о параметрах фильтрации и синтаксисе см. в документе AIP-160: Фильтрация .

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 результатов в одном ответе. Возможно, API вернет меньше 10 результатов, если меньше 10 результатов соответствуют вашему запросу.

page_size по умолчанию равен 50, а максимальный — 1000.

Если результатов больше, чем помещается в один ответ, ответ будет содержать next_page_token . Чтобы получить следующую страницу или набор результатов, отправьте тот же запрос еще раз, установив значение поля page_token равным этому значению. Все остальные параметры должны быть такими же, как и в предыдущем запросе.

Если поле next_page_token отсутствует в ответе, это означает, что результатов больше нет.