REST Resource: platforms.accounts.events

    • The Event resource is used to record spam signals for platform sub-accounts.

    • An Event includes the event type, associated information, and the event timestamp.

    • EventInfo contains private information such as the publisher's email and billing address.

    • The Address resource provides structured fields for address data like street, city, state, zip, and region code.

    • The primary method available is create , which allows for creating an account event.

    Resource: Event

    A platform sub-account event to record spam signals.

    JSON representation 
     { 
 "eventType" 
 : 
 enum (  EventType 
 
) 
 , 
 "eventInfo" 
 : 
 { 
 object (  EventInfo 
 
) 
 } 
 , 
 "eventTime" 
 : 
 string 
 }
    Fields
    eventType

    enum ( EventType )

    Required. Event type.
    eventInfo

    object ( EventInfo )

    Required. Information associated with the event.
    eventTime

    string ( Timestamp format)

    Required. Event timestamp.

    Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    EventType

    Platform recorder event type.

    Enums
    EVENT_TYPE_UNSPECIFIED Do not use. You must set an event type explicitly.
    LOG_IN_VIA_PLATFORM Log in via platform.
    SIGN_UP_VIA_PLATFORM Sign up via platform.

    EventInfo

    Private information for partner recorded events (PII).

    JSON representation 
     { 
 "email" 
 : 
 string 
 , 
 "billingAddress" 
 : 
 { 
 object (  Address 
 
) 
 } 
 }
    Fields
    email

    string

    Required. The email address that is associated with the publisher when performing the event.
    billingAddress

    object ( Address )

    The billing address of the publisher associated with this event, if available.

    Address

    Address data.

    JSON representation 
     { 
 "address1" 
 : 
 string 
 , 
 "address2" 
 : 
 string 
 , 
 "city" 
 : 
 string 
 , 
 "state" 
 : 
 string 
 , 
 "zip" 
 : 
 string 
 , 
 "company" 
 : 
 string 
 , 
 "contact" 
 : 
 string 
 , 
 "phone" 
 : 
 string 
 , 
 "fax" 
 : 
 string 
 , 
 "regionCode" 
 : 
 string 
 }
    Fields
    address1

    string

    First line of address. Max length 64 bytes or 30 characters.
    address2

    string

    Second line of address. Max length 64 bytes or 30 characters.
    city

    string

    City. Max length 60 bytes or 30 characters.
    state

    string

    State. Max length 60 bytes or 30 characters.
    zip

    string

    Zip/post code. Max length 10 bytes or 10 characters.
    company

    string

    Name of the company. Max length 255 bytes or 34 characters.
    contact

    string

    Contact name of the company. Max length 128 bytes or 34 characters.
    phone

    string

    Phone number with international code (i.e. +441234567890).
    fax

    string

    Fax number with international code (i.e. +441234567890).
    regionCode

    string

    Country/Region code. The region is specified as a CLDR region code (e.g. "US", "FR").

    Methods

    create

    		Creates an account event.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: