Web Service: ContactService

Port type ContactServiceInterfaceSource code

1. createContacts
   Source code
   Description:
   Creates new {@link Contact} objects.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   createContactsRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type createContacts

   Creates new {@link Contact} objects.

   • contacts - optional, unbounded; type Contact - extension of type BaseContact
     A {@code Contact} represents a person who is affiliated with a single {@link Company}. A contact can have a variety of contact information associated to it, and can be invited to view their company's orders, line items, creatives, and reports.
     Base class for a {@link Contact}.
     • id - optional; type long
       The unique ID of the {@code Contact}. This value is readonly and is assigned by Google.
     • name - optional; type string
       The name of the contact. This attribute is required and has a maximum length of 127 characters.
     • companyId - optional; type long
       The ID of the {@link Company} that this contact is associated with. This attribute is required and immutable.
     • status - optional; type Contact.Status - type string with restriction - enum { 'UNINVITED', 'INVITE_PENDNG', 'INVITE_EXPIRED', 'INVITE_CANCELED', 'USER_ACTIVE', 'USER_DISABLED', 'UNKNOWN' }
       The status of the contact. This attribute is readonly and is assigned by Google.
     • address - optional; type string
       The address of the contact. This attribute is optional and has a maximum length of 1024 characters.
     • cellPhone - optional; type string
       The cell phone number where the contact can be reached. This attribute is optional.
     • comment - optional; type string
       A free-form text comment for the contact. This attribute is optional and has a maximum length of 1024 characters.
     • email - optional; type string
       The e-mail address where the contact can be reached. This attribute is optional.
     • faxPhone - optional; type string
       The fax number where the contact can be reached. This attribute is optional.
     • title - optional; type string
       The job title of the contact. This attribute is optional and has a maximum length of 1024 characters.
     • workPhone - optional; type string
       The work phone number where the contact can be reached. This attribute is optional.
   Output:
   createContactsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type createContactsResponse

   • rval - optional, unbounded; type Contact - extension of type BaseContact
     A {@code Contact} represents a person who is affiliated with a single {@link Company}. A contact can have a variety of contact information associated to it, and can be invited to view their company's orders, line items, creatives, and reports.
     Base class for a {@link Contact}.
     • id - optional; type long
       The unique ID of the {@code Contact}. This value is readonly and is assigned by Google.
     • name - optional; type string
       The name of the contact. This attribute is required and has a maximum length of 127 characters.
     • companyId - optional; type long
       The ID of the {@link Company} that this contact is associated with. This attribute is required and immutable.
     • status - optional; type Contact.Status - type string with restriction - enum { 'UNINVITED', 'INVITE_PENDNG', 'INVITE_EXPIRED', 'INVITE_CANCELED', 'USER_ACTIVE', 'USER_DISABLED', 'UNKNOWN' }
       The status of the contact. This attribute is readonly and is assigned by Google.
     • address - optional; type string
       The address of the contact. This attribute is optional and has a maximum length of 1024 characters.
     • cellPhone - optional; type string
       The cell phone number where the contact can be reached. This attribute is optional.
     • comment - optional; type string
       A free-form text comment for the contact. This attribute is optional and has a maximum length of 1024 characters.
     • email - optional; type string
       The e-mail address where the contact can be reached. This attribute is optional.
     • faxPhone - optional; type string
       The fax number where the contact can be reached. This attribute is optional.
     • title - optional; type string
       The job title of the contact. This attribute is optional and has a maximum length of 1024 characters.
     • workPhone - optional; type string
       The work phone number where the contact can be reached. This attribute is optional.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.
2. getContactsByStatement
   Source code
   Description:
   Gets a {@link ContactPage} of {@link Contact} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code name}	{@link Contact#name}
   {@code email}	{@link Contact#email}
   {@code id}	{@link Contact#id}
   {@code comment}	{@link Contact#comment}
   {@code companyId}	{@link Contact#companyId}
   {@code title}	{@link Contact#title}
   {@code cellPhone}	{@link Contact#cellPhone}
   {@code workPhone}	{@link Contact#workPhone}
   {@code faxPhone}	{@link Contact#faxPhone}
   {@code status}	{@link Contact#status}

   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   getContactsByStatementRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type getContactsByStatement

   Gets a {@link ContactPage} of {@link Contact} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code name}	{@link Contact#name}
   {@code email}	{@link Contact#email}
   {@code id}	{@link Contact#id}
   {@code comment}	{@link Contact#comment}
   {@code companyId}	{@link Contact#companyId}
   {@code title}	{@link Contact#title}
   {@code cellPhone}	{@link Contact#cellPhone}
   {@code workPhone}	{@link Contact#workPhone}
   {@code faxPhone}	{@link Contact#faxPhone}
   {@code status}	{@link Contact#status}

   • statement - optional; type Statement
     Captures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.

     An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.

     Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.

     An example of such a query might be {@code "WHERE id = :idValue"}.

     Statements also support use of the LIKE keyword. This provides wildcard string matching.

     An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.

     The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.
     • query - optional; type string
       Holds the query in PQL syntax. The syntax is:
       [WHERE {[AND | OR] ...}]
[ORDER BY [ASC | DESC]]
[LIMIT {[,] } | { OFFSET }]
       

       
            := {< | <= | > | >= | = | != }

     := {< | <= | > | >= | = | != }
:= IN
:= IS NULL
:= LIKE
:= :
       

     • values - optional, unbounded; type String_ValueMapEntry
       Holds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.

       In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.

       This represents an entry in a map with a key of type String and value of type Value.
       • key - optional; type string
       • value - optional; type Value
         {@code Value} represents a value.
   Output:
   getContactsByStatementResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type getContactsByStatementResponse

   • rval - optional; type ContactPage
     Captures a page of {@link Contact} objects.
     • totalResultSetSize - optional; type int
       The size of the total result set to which this page belongs.
     • startIndex - optional; type int
       The absolute index in the total result set on which this page begins.
     • results - optional, unbounded; type Contact - extension of type BaseContact
       A {@code Contact} represents a person who is affiliated with a single {@link Company}. A contact can have a variety of contact information associated to it, and can be invited to view their company's orders, line items, creatives, and reports.
       Base class for a {@link Contact}.
       • id - optional; type long
         The unique ID of the {@code Contact}. This value is readonly and is assigned by Google.
       • name - optional; type string
         The name of the contact. This attribute is required and has a maximum length of 127 characters.
       • companyId - optional; type long
         The ID of the {@link Company} that this contact is associated with. This attribute is required and immutable.
       • status - optional; type Contact.Status - type string with restriction - enum { 'UNINVITED', 'INVITE_PENDNG', 'INVITE_EXPIRED', 'INVITE_CANCELED', 'USER_ACTIVE', 'USER_DISABLED', 'UNKNOWN' }
         The status of the contact. This attribute is readonly and is assigned by Google.
       • address - optional; type string
         The address of the contact. This attribute is optional and has a maximum length of 1024 characters.
       • cellPhone - optional; type string
         The cell phone number where the contact can be reached. This attribute is optional.
       • comment - optional; type string
         A free-form text comment for the contact. This attribute is optional and has a maximum length of 1024 characters.
       • email - optional; type string
         The e-mail address where the contact can be reached. This attribute is optional.
       • faxPhone - optional; type string
         The fax number where the contact can be reached. This attribute is optional.
       • title - optional; type string
         The job title of the contact. This attribute is optional and has a maximum length of 1024 characters.
       • workPhone - optional; type string
         The work phone number where the contact can be reached. This attribute is optional.
       The collection of contacts contained within this page.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.
3. updateContacts
   Source code
   Description:
   Updates the specified {@link Contact} objects.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   updateContactsRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type updateContacts

   Updates the specified {@link Contact} objects.

   • contacts - optional, unbounded; type Contact - extension of type BaseContact
     A {@code Contact} represents a person who is affiliated with a single {@link Company}. A contact can have a variety of contact information associated to it, and can be invited to view their company's orders, line items, creatives, and reports.
     Base class for a {@link Contact}.
     • id - optional; type long
       The unique ID of the {@code Contact}. This value is readonly and is assigned by Google.
     • name - optional; type string
       The name of the contact. This attribute is required and has a maximum length of 127 characters.
     • companyId - optional; type long
       The ID of the {@link Company} that this contact is associated with. This attribute is required and immutable.
     • status - optional; type Contact.Status - type string with restriction - enum { 'UNINVITED', 'INVITE_PENDNG', 'INVITE_EXPIRED', 'INVITE_CANCELED', 'USER_ACTIVE', 'USER_DISABLED', 'UNKNOWN' }
       The status of the contact. This attribute is readonly and is assigned by Google.
     • address - optional; type string
       The address of the contact. This attribute is optional and has a maximum length of 1024 characters.
     • cellPhone - optional; type string
       The cell phone number where the contact can be reached. This attribute is optional.
     • comment - optional; type string
       A free-form text comment for the contact. This attribute is optional and has a maximum length of 1024 characters.
     • email - optional; type string
       The e-mail address where the contact can be reached. This attribute is optional.
     • faxPhone - optional; type string
       The fax number where the contact can be reached. This attribute is optional.
     • title - optional; type string
       The job title of the contact. This attribute is optional and has a maximum length of 1024 characters.
     • workPhone - optional; type string
       The work phone number where the contact can be reached. This attribute is optional.
   Output:
   updateContactsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type updateContactsResponse

   • rval - optional, unbounded; type Contact - extension of type BaseContact
     A {@code Contact} represents a person who is affiliated with a single {@link Company}. A contact can have a variety of contact information associated to it, and can be invited to view their company's orders, line items, creatives, and reports.
     Base class for a {@link Contact}.
     • id - optional; type long
       The unique ID of the {@code Contact}. This value is readonly and is assigned by Google.
     • name - optional; type string
       The name of the contact. This attribute is required and has a maximum length of 127 characters.
     • companyId - optional; type long
       The ID of the {@link Company} that this contact is associated with. This attribute is required and immutable.
     • status - optional; type Contact.Status - type string with restriction - enum { 'UNINVITED', 'INVITE_PENDNG', 'INVITE_EXPIRED', 'INVITE_CANCELED', 'USER_ACTIVE', 'USER_DISABLED', 'UNKNOWN' }
       The status of the contact. This attribute is readonly and is assigned by Google.
     • address - optional; type string
       The address of the contact. This attribute is optional and has a maximum length of 1024 characters.
     • cellPhone - optional; type string
       The cell phone number where the contact can be reached. This attribute is optional.
     • comment - optional; type string
       A free-form text comment for the contact. This attribute is optional and has a maximum length of 1024 characters.
     • email - optional; type string
       The e-mail address where the contact can be reached. This attribute is optional.
     • faxPhone - optional; type string
       The fax number where the contact can be reached. This attribute is optional.
     • title - optional; type string
       The job title of the contact. This attribute is optional and has a maximum length of 1024 characters.
     • workPhone - optional; type string
       The work phone number where the contact can be reached. This attribute is optional.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.