Dostęp klienta

Ten przewodnik zawiera informacje o zasobach dostępu klienta, które umożliwiają zarządzanie kupującymi i powiązanymi użytkownikami klienta, którzy mają bezpośredni dostęp do Rynku w Authorized Buyers, gdzie mogą wyświetlać, negocjować i zatwierdzać umowy. Te zasoby umożliwiają Ci wykonywanie operacji ręcznych, które możesz wykonywać ręcznie w sekcji Klienci na karcie Ustawienia konta Authorized Buyers.

W imieniu klientów

Pole Client reprezentuje jednego z kupujących klientów i musi być powiązane ze znanym reklamodawcą, marką lub agencją. Z każdym elementem możesz powiązać wiele klientów, jeśli mają one unikalną nazwę.

Pobieranie listy klientów

Możesz pobrać wszystkich kupujących klientów powiązanych z danym kontem, wysyłając żądanie HTTP GET do identyfikatora URI zasobu accounts.clients, który ma następujący format:

https://adexchangebuyer.googleapis.com/v2beta1/accounts/accountId/clients

Żądanie

Oto przykład:

GET https://adexchangebuyer.googleapis.com/v2beta1/accounts/1000002/clients
Authorization: Bearer access token here

Odpowiedź

Jeśli żądanie się powiedzie, serwer wyśle kod stanu HTTP 200 OK i dane kupującego. Zwrócony identyfikator może służyć do uzyskiwania informacji o konkretnym kliencie, aktualizowania określonego klienta i zarządzania jego klientami zgodnie z opisem w sekcjach poniżej.

{
  "clients": [
    {
      "clientAccountId": "30000001",
      "accountId": "1000002",
      "role": "CLIENT_DEAL_APPROVER",
      "status": "ACTIVE",
      "visibleToSeller": true,
      "entityType": "ADVERTISER",
      "entityId": "3",
      "entityName": "Great Company"
    },
    {
      "clientAccountId": "30000000",
      "accountId": "1000002",
      "role": "CLIENT_DEAL_NEGOTIATOR",
      "status": "ACTIVE",
      "visibleToSeller": true,
      "entityType": "BRAND",
      "entityId": "4",
      "entityName": "Top Brand"
    }
  ]
}

Tworzenie nowego kupującego

Aby utworzyć nowego kupującego, wyślij żądanie POST do identyfikatora URI zasobu accounts.clients, który ma następujący format:

https://adexchangebuyer.googleapis.com/v2beta1/accounts/accountId/clients

Uwaga: każdy kupujący musi być powiązany ze znanym podmiotem gospodarczym – reklamodawcą, marką lub agencją. Określ typ podmiotu gospodarczego we właściwości entityType. Określ identyfikator podmiotu gospodarczego we właściwości entityId. Listy wszystkich znanych reklamodawców, marek i agencji korzystających z ich identyfikatorów znajdziesz w plikach advertisers.txt, brands.txt i agencies.txt.

Żądanie

Oto przykład żądania POST, które tworzy nowy zasób klienta:

POST https://adexchangebuyer.googleapis.com/v2beta1/accounts/1000002/clients
Authorization: Bearer access token here
Content-Type: application/json

{
  "role": "CLIENT_DEAL_APPROVER",
  "status": "ACTIVE",
  "visibleToSeller": true,
  "entityId": 2,
  "entityType": "AGENCY",
  "clientName": "Test"
}

Odpowiedź

Jeśli żądanie zostanie zrealizowane, serwer wyśle kod stanu 200 OK i pełną reprezentację utworzonego zasobu klienta.

{
  "clientAccountId": "30000004",
  "accountId": "1000002",
  "role": "CLIENT_DEAL_APPROVER",
  "status": "ACTIVE",
  "clientName": "Test",
  "visibleToSeller": true,
  "entityType": "ADVERTISER",
  "entityId": "2",
  "entityName": "Effective Agency"
}

Pozyskanie konkretnego klienta klienta

Informacje o konkretnym kliencie możesz pobrać, wysyłając żądanie HTTP GET do identyfikatora URI zasobu accounts.clients, który ma następujący format:

https://adexchangebuyer.googleapis.com/v2beta1/accounts/accountId/clients/clientAccountId

Żądanie

Oto przykład:

GET https://adexchangebuyer.googleapis.com/v2beta1/accounts/1000002/clients/30000001
Authorization: Bearer access token here

Odpowiedź

Jeśli żądanie się powiedzie, serwer wyśle kod stanu HTTP 200 OK i dane klienta:

{
  "clientAccountId": "30000001",
  "accountId": "1000002",
  "role": "CLIENT_DEAL_NEGOTIATOR",
  "status": "ACTIVE",
  "visibleToSeller": true,
  "entityType": "ADVERTISER",
  "entityId": "4",
  "entityName": "Disney"
}

Aktualizowanie kupującego

Aby zaktualizować i całkowicie zastąpić istniejący zasób kupującego, wykonaj te czynności:

  1. Pobierz zasób, który chcesz zaktualizować.
  2. Właściwości, które chcesz zmienić.
  3. Wyślij żądanie PUT do identyfikatora URI zasobu accounts.clients i podaj zmodyfikowany zasób jako treść wiadomości.

Identyfikator URI zasobu klienta ma następujący format:

https://adexchangebuyer.googleapis.com/v2beta1/accounts/accountId/clients/clientAccountId

Żądanie

Oto przykład żądania PUT (ostatni krok powyżej), które aktualizuje i zastępuje zasób konta:

PUT https://adexchangebuyer.googleapis.com/v2beta1/accounts/1000002/clients/30000003
Authorization: Bearer access token here
Content-Type: application/json

{
  "visibleToSeller": true,
  "status": "DISABLED",
  "role": "CLIENT_DEAL_NEGOTIATOR",
  "entityId": 3,
  "entityType": "ADVERTISER"
}

Odpowiedź

Jeśli żądanie zostanie zrealizowane, serwer wyśle kod stanu 200 OK i pełną reprezentację zmodyfikowanego zasobu klienta.

{
  "clientAccountId": "30000003",
  "accountId": "1000002",
  "role": "CLIENT_DEAL_NEGOTIATOR",
  "status": "DISABLED",
  "visibleToSeller": true,
  "entityType": "ADVERTISER",
  "entityId": "3",
  "entityName": "Microsoft"
}

Zaproszenia

ClientUserInvitation to zaproszenie wysłane na dany adres e-mail potencjalnego klienta klienta. Jeśli zostanie zaakceptowane, zaproszenie zostanie usunięte i utworzony powiązany z nim element ClientUser.

Wysyłanie zaproszenia

Aby zaprosić nowego użytkownika klienta do korzystania z Authorized Buyers, wyślij żądanie POST do identyfikatora URI zasobu accounts.clients.invitations, który ma taki format:

https://adexchangebuyer.googleapis.com/v2beta1/accounts/accountId/clients/clientAccountId/invitations

Zaproszenie będzie zawierać nazwę konta, do którego użytkownik otrzymał zaproszenie, krótki opis roli dostępu oraz link umożliwiający zaakceptowanie zaproszenia i dostęp do interfejsu usługi Authorized Buyers.

Żądanie

Oto przykład żądania POST, które powoduje utworzenie nowego elementu ClientUserInvitation i wysłanie zaproszenia na podany adres e-mail:

POST https://adexchangebuyer.googleapis.com/v2beta1/accounts/1000002/clients/30000000/invitations
Authorization: Bearer access token here
Content-Type: application/json

{
  "email":"user@domain.com"
}

Odpowiedź

Jeśli żądanie się powiedzie i e-mail z zaproszeniem zostanie wysłany, serwer wyśle kod stanu 200 OK i utworzony ClientUserInvitation.

{
  "invitationId": "10000002",
  "email": "user@domain.com",
  "clientAccountId": "30000000"
}

Przykład e-maila z zaproszeniem

Cześć, użytkownik@example.com,

prosimy o dostęp do Rynku w Authorized Buyers przy użyciu konta przykładowego licytującego. To zaproszenie daje Ci dostęp tylko do wyświetlania ofert, co pozwala wyświetlać na platformie handlowej dostępne usługi i profile wydawców oraz mieć ograniczony dostęp do narzędzi do debugowania i raportowania.

Aby zaakceptować i zacząć korzystać z Authorized Buyers, kliknij przycisk poniżej. Pojawi się prośba o zalogowanie się na konto Google, które możesz szybko utworzyć przy użyciu istniejącego konta Gmail lub dowolnego innego adresu e-mail i hasła. Gdy skończysz konfigurację konta, możesz uzyskać dostęp do usługi Authorized Buyers bezpośrednio na stronie www.google.com/authorizedbuyers.

PRZYJMIJ ZAPROSZENIE


Dostępem podlegają warunki dotyczące usługi Authorized Buyers. Aby uzyskać dodatkowe informacje lub pomoc dotyczącą korzystania z programu Authorized Buyers, odwiedź Centrum pomocy Authorized Buyers.

Witamy w Authorized Buyers!

Pobieranie listy zaproszeń użytkowników

Możesz pobrać wszystkie zaległe zaproszenia do Authorized Buyers Marketplace dla danego klienta, wysyłając żądanie HTTP GET do identyfikatora URI zasobu accounts.clients.invitations, który ma następujący format:

https://adexchangebuyer.googleapis.com/v2beta1/accounts/accountId/clients/clientAccountId/invitations

Żądanie

Oto przykład:

GET https://adexchangebuyer.googleapis.com/v2beta1/accounts/1000002/clients/30000000/invitations
Authorization: Bearer access token here

Odpowiedź

Jeśli żądanie się powiedzie, serwer wyśle kod stanu HTTP 200 OK i listę zaproszeń dla określonego klienta.

{
  "invitations": [
    {
      "invitationId": "10000000",
      "email": "user1@domain.com",
      "clientAccountId": "30000000"
    },
    {
      "invitationId": "10000001",
      "email": "user2@domain.com",
      "clientAccountId": "30000000"
    },
    {
      "invitationId": "10000002",
      "email": "user3@domain.com",
      "clientAccountId": "30000000"
    }
  ]
}

Otrzymywanie zaproszenia do konkretnego użytkownika

Informacje o konkretnym zaproszeniu użytkownika możesz uzyskać, wysyłając żądanie HTTP GET do identyfikatora URI zasobu accounts.clients.invitations, który ma następujący format:

https://adexchangebuyer.googleapis.com/v2beta1/accounts/accountId/clients/clientAccountId/invitations/invitationId

Żądanie

Oto przykład:

GET https://adexchangebuyer.googleapis.com/v2beta1/accounts/1000002/clients/30000000/invitations/10000002
Authorization: Bearer access token here

Odpowiedź

Jeśli żądanie się powiedzie, serwer wyśle kod stanu HTTP 200 OK i dane zaproszenia:

{
  "invitationId": "10000002",
  "email": "user@domain.com",
  "clientAccountId": "30000000"
}

Użytkownicy

ClientUser to użytkownik, który po zalogowaniu się na konto Google ma dostęp do interfejsu Rynku Authorized Buyers w imieniu obiektu Client. Każde konto Authorized Buyers może mieć wiele klientów, a każdy z nich może mieć wielu użytkowników upoważnionych do korzystania z interfejsu Rynku w Authorized Buyers.

Pobierz listę użytkowników klienta

Możesz pobrać listę wszystkich użytkowników klienta dla danego klienta, wysyłając żądanie HTTP GET do identyfikatora URI zasobu accounts.clients.users w formacie:

https://adexchangebuyer.googleapis.com/v2beta1/accounts/accountId/clients/clientAccountId/users

Żądanie

Oto przykład:

GET https://adexchangebuyer.googleapis.com/v2beta1/accounts/1000002/clients/30000001/users
Authorization: Bearer access token here

Odpowiedź

Jeśli żądanie się powiedzie, serwer wyśle kod stanu HTTP 200 OK i listę użytkowników klienta. Możesz użyć zwróconego identyfikatora, aby uzyskać informacje o konkretnym użytkowniku, wyłączyć go lub ponownie włączyć, zgodnie z opisem w sekcjach poniżej.

{
  "users": [
    {
      "userId": "1000006",
      "clientAccountId": "30000001",
      "status": "ACTIVE",
      "email": "test_102@example.com"
    }
  ]
}

Uzyskiwanie informacji o konkretnym użytkowniku klienta

Informacje o konkretnym użytkowniku klienta możesz pobrać, wysyłając żądanie HTTP GET do identyfikatora URI zasobu accounts.clients.users o następującym formacie:

https://adexchangebuyer.googleapis.com/v2beta1/accounts/accountId/clients/clientAccountId/users/userId

Żądanie

Oto przykład:

GET https://adexchangebuyer.googleapis.com/v2beta1/accounts/1000002/clients/30000001/users/1000006 HTTP/1.1
Authorization: Bearer access token here

Odpowiedź

Jeśli żądanie się powiedzie, serwer wyśle kod stanu HTTP 200 OK i dane użytkownika klienta:

{
  "userId": "1000006",
  "clientAccountId": "30000001",
  "status": "ACTIVE",
  "email": "test_102@example.com"
}

Wyłączanie i ponowne włączanie użytkownika klienta

Aby wyłączyć użytkownika klienta, wyślij żądanie PUT do identyfikatora URI zasobu accounts.clients.users i ustaw właściwość status na DISABLED. Aby ponownie włączyć użytkownika klienta, wyślij żądanie PUT do identyfikatora URI zasobu i ustaw właściwość status na ACTIVE.

Identyfikator URI zasobu klienta ma taki format:

https://adexchangebuyer.googleapis.com/v2beta1/accounts/accountId/clients/clientAccountId/users/userId

Żądanie

Oto przykład żądania PUT, które wyłącza użytkownika klienta:

PUT https://adexchangebuyer.googleapis.com/v2beta1/accounts/1000002/clients/30000001/users/1000006
Authorization: Bearer access token here
Content-Type: application/json

{
  status: "DISABLED"
}

Odpowiedź

Jeśli żądanie zostanie zrealizowane, serwer wyśle kod stanu 200 OK i zmodyfikowany zasób użytkownika klienta.

{
  "userId": "1000006",
  "clientAccountId": "30000001",
  "status": "DISABLED",
  "email": "test_102@example.com"
}