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

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

Tworzenie treści żądania

Utwórz UserList zasób. 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 użytkownik pozostaje na liście po dodaniu. Wartość musi odpowiadać pełnym dniom. Jeśli nie jest ustawiona, domyślnie jest ustawiana na maksymalną wartość.

Jeśli używasz formatu JSON, oblicz liczbę sekund, mnożąc liczbę dni trwania przez 86400 (liczbę sekund w ciągu dnia). Następnie ustaw wartość na wynik mnożenia, a po niej dodaj 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 pomocniczej do tworzenia obiektu Duration na podstawie liczby dni, jeśli taka metoda istnieje. Na przykład biblioteka protobuf-java-util dla języka Java ma fromDays() metodę pomocniczą. W przeciwnym razie oblicz liczbę sekund, mnożąc liczbę dni trwania przez 86400 (liczbę sekund w ciągu dnia), i użyj wyniku, aby ustawić pole seconds obiektu Duration.

Pola wymagane w przypadku kierowania na listę klientów

W przypadku grupy odbiorców kierowania na listę klientów wymagane jest pole ingestedUserListInfo.

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

Lista informacji kontaktowych

Jeśli chcesz użyć informacji kontaktowych (zaszyfrowanych adresów e-mail, numerów telefonów lub adresów) do zdefiniowania użytkowników, ustaw te pola:

uploadKeyTypes

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

Lista uploadKeyTypes musi zawierać tylko 1 wpis.

contactIdInfo

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

Lista Mobile ID

Jeśli chcesz użyć identyfikatorów wyświetlania reklam mobilnych do zdefiniowania użytkowników, ustaw te pola:

uploadKeyTypes

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

Lista uploadKeyTypes musi zawierać tylko 1 wpis.

mobileIdInfo

Ustaw na komunikat:MobileIdInfo

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

• Ustaw keySpace na IOS lub ANDROID.

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

  • W systemie iOS ciąg znaków identyfikatora to 9-cyfrowy ciąg widoczny na końcu adresu URL w App Store. Na przykład 476943146 w przypadku aplikacji „Flood-It!” z linkiem do App Store https://apps.apple.com/us/app/flood-it/id476943146.

  • W przypadku Androida ciągiem znaków identyfikatora jest nazwa pakietu aplikacji. Na przykład com.labpixies.flood w przypadku aplikacji „Flood-It!” z linkiem do Google Play https://play.google.com/store/apps/details?id=com.labpixies.flood.

Lista identyfikatorów użytkowników

Jeśli chcesz użyć identyfikatorów użytkowników do zdefiniowania użytkowników, ustaw te pola:

uploadKeyTypes

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

Lista uploadKeyTypes musi zawierać tylko 1 wpis.

Tworzenie żądania

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

1. Ustaw pole parent na nazwę zasobu konta. Nazwa zasobu musi mieć format accountTypes/{accountType}/accounts/{account_id}.

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

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

Oto przykładowe żądania w formacie JSON dotyczące różnych typów informacji o użytkownikach. Każde żądanie ustawia membershipDuration na 2592000s, gdzie 2592000 to liczba sekund w 30 dniach. Aby wypróbować żądanie, kliknij przycisk Otwórz w narzędziu APIs Explorer.

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

{
    "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"
}

{
    "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.

Jeśli żądanie się powiedzie, odpowiedź będzie zawierać utworzoną UserList z wypełnionymi polami id i name. Zanotuj wartości w tych polach, ponieważ będą one potrzebne w żądaniach dodawania użytkowników do grupy odbiorców.

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.