Tworzenie listy odbiorców z kierowania na listę klientów

Utwórz listę odbiorców kierowania na listę klientów, wysyłając żądanie CreateUserListRequest.

Tworzenie treści żądania

Utwórz zasób UserList. Oto typowe pola, które należy ustawić.

displayName
Wymagane Wyświetlana nazwa listy. Nazwa musi być unikalna wśród wszystkich list należących do konta.
description
Krótki opis listy.
integrationCode
Identyfikator z Twojego systemu.
membershipDuration

Czas, przez jaki odbiorca pozostaje na liście po dodaniu. Wartość musi odpowiadać pełnym dniom. Jeśli nie jest ustawiony, przyjmuje się domyślnie wartość maksymalną.

Jeśli używasz formatu JSON, oblicz liczbę sekund, mnożąc liczbę dni przez 86400 (liczbę sekund w ciągu dnia). Następnie ustaw wartość na wynik mnożenia, a po nim s. Jeśli na przykład chcesz, aby okres członkostwa wynosił 90 dni, użyj wartości 7776000s, ponieważ 90 * 86400 = 7776000.

Jeśli używasz formatu bufora protokołu, użyj metody ułatwiającej tworzenie obiektu Duration na podstawie liczby dni, jeśli taka metoda istnieje. Na przykład biblioteka protobuf-java-util dla Javy ma wygodną metodę fromDays(). W przeciwnym razie oblicz liczbę sekund, mnożąc liczbę dni przez 86400 (liczbę sekund w dniu), i użyj wyniku, aby ustawić pole seconds obiektu Duration.

Pola wymagane w przypadku kierowania na listę klientów

Pole ingestedUserListInfo jest wymagane w przypadku odbiorców kierowania na listę klientów.

Oto pola, które należy ustawić w IngestedUserListInfo na podstawie typu danych, których chcesz użyć do dodawania odbiorców do listy.

Lista informacji kontaktowych

Jeśli chcesz używać informacji kontaktowych (zaszyfrowanych adresów e-mail, numerów telefonów lub adresów pocztowych) do definiowania odbiorców, ustaw te pola:

uploadKeyTypes

Ustaw listę zawierającą typ klucza przesyłania CONTACT_ID.

Lista uploadKeyTypes może zawierać tylko 1 wpis.

contactIdInfo

Ustaw na komunikat ContactIdInfo z polem dataSourceType ustawionym na odpowiednią wartość z typu wyliczeniowego DataSourceType.

Lista dokumentów Mobile ID

Jeśli chcesz używać identyfikatorów urządzeń mobilnych do definiowania odbiorców, ustaw te pola:

uploadKeyTypes

Ustaw listę zawierającą typ klucza przesyłania MOBILE_ID.

Lista uploadKeyTypes może zawierać tylko 1 wpis.

mobileIdInfo

Ustaw na wiadomość MobileIdInfo:

  • Ustaw dataSourceType na odpowiednią wartość z typu wyliczeniowego DataSourceType.

  • Ustaw wartość keySpace na IOS lub ANDROID.

  • Ustaw appId na ciąg znaków, który jednoznacznie identyfikuje aplikację mobilną, z której zebrano dane.

Lista identyfikatorów użytkowników

Jeśli chcesz definiować odbiorców za pomocą identyfikatorów użytkowników, ustaw te pola:

uploadKeyTypes

Ustaw listę zawierającą typ klucza przesyłania USER_ID.

Lista uploadKeyTypes może zawierać tylko 1 wpis.

Tworzenie żądania

Aby utworzyć listę odbiorców kierowania na listę klientów, utwórz żądanie create dla zasobu UserList.

  1. W polu parent ustaw nazwę zasobu konta. Nazwa zasobu musi mieć format accountTypes/{accountType}/accounts/{account}.

  2. Użyj obiektu UserList utworzonego na potrzeby treści żądania.

  3. Jeśli Twoje dane logowania nie dotyczą konta Google, które jest użytkownikiem w parent, ustaw nagłówki zgodnie z opisem w sekcji Konfigurowanie miejsc docelowych i nagłówków.

Poniżej znajdziesz przykładowe żądania w formacie JSON dotyczące różnych typów informacji o użytkownikach. Każde żądanie ustawia parametr membershipDuration na 2592000s, gdzie 2592000 to liczba sekund w ciągu 30 dni. Kliknij przycisk Otwórz w APIs Explorer, aby wypróbować żądanie.

Informacje kontaktowe

{
    "description": "Customer Match for contact info",
    "displayName": "Contact info audience",
    "ingestedUserListInfo": {
        "contactIdInfo": {
            "dataSourceType": "DATA_SOURCE_TYPE_FIRST_PARTY"
        },
        "uploadKeyTypes": [
            "CONTACT_ID"
        ]
    },
    "membershipDuration": "2592000s"
}

Dokumenty Mobile ID

{
    "description": "Customer Match for mobile IDs",
    "displayName": "Mobile ID audience",
    "ingestedUserListInfo": {
        "mobileIdInfo": {
            "dataSourceType": "DATA_SOURCE_TYPE_FIRST_PARTY",
            "keySpace": "ANDROID",
            "appId": "com.labpixies.flood"
        },
        "uploadKeyTypes": [
            "MOBILE_ID"
        ]
    },
    "membershipDuration": "2592000s"
}

Identyfikatory użytkowników

{
    "description": "Customer Match for user IDs",
    "displayName": "User ID audience",
    "ingestedUserListInfo": {
        "userIdInfo": {
            "dataSourceType": "DATA_SOURCE_TYPE_FIRST_PARTY"
        },
        "uploadKeyTypes": [
            "USER_ID"
        ]
    },
    "membershipDuration": "2592000s"
}

Wysyłanie żądania

Wyślij żądanie i, jeśli to konieczne, dołącz nagłówki żądania, takie jak login-account lub linked-account.

Jeśli żądanie się powiedzie, odpowiedź będzie zawierać utworzony obiekt UserList z wypełnionymi polami id i name, które są tylko do odczytu.

Jeśli żądanie się nie powiedzie, sprawdź błędy, aby ustalić przyczynę niepowodzenia, zaktualizuj żądanie i nagłówki, aby rozwiązać problemy, a następnie wyślij zaktualizowane żądanie i nagłówki.