Class UrlField

    • UrlField is deprecated and the People API advanced service should be used instead.

    • A UrlField represents a URL field within a Contact.

    • Methods are available to get and set the address and label of a UrlField, and to check or set if it is the primary field value.

    • The deleteUrlField() method is deprecated and should not be used.
    Url Field

    Deprecated.Instead, use the People API advanced service

    A URL field in a Contact.

    Methods

    Method Return type Brief description
    get Address()
    		String Get the address for this field.
    get Label()
    		Object Gets the label for this field.
    is Primary()
    		Boolean Gets whether this is the primary field value.
    set Address(address)
    		Url Field Sets the address of this field.
    set As Primary()
    		Url Field Sets this field to primary.
    set Label(field)
    		Url Field Sets the label of this field.
    set Label(label)
    		Url Field Sets the label of this field.

    Detailed documentation

    get Address()

    Get the address for this field.

     // Logs the address for the 'Home Address' field for contact 'John Doe'. 
 // Can be used similarly for other fields that contain addresses. 
 const 
  
 contacts 
  
 = 
  
 ContactsApp 
 . 
 getContactsByName 
 ( 
 'John Doe' 
 ); 
 const 
  
 homeAddress 
  
 = 
  
 contacts 
 [ 
 0 
 ]. 
 getAddresses 
 ( 
 ContactsApp 
 . 
 Field 
 . 
 HOME_ADDRESS 
 ); 
 Logger 
 . 
 log 
 ( 
 homeAddress 
 [ 
 0 
 ]. 
 getAddress 
 ());

    Return

    String — the address as a string

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

    • https://www.google.com/m8/feeds

    get Label()

    Gets the label for this field. This may be a Field, ExtendedField, or a String.

     // Logs the label for all the address fields associated with contact 
 // 'John Doe'. This method can be similarly called for any field that has 
 // a label. 
 const 
  
 contacts 
  
 = 
  
 ContactsApp 
 . 
 getContactsByName 
 ( 
 'John Doe' 
 ); 
 const 
  
 addressFields 
  
 = 
  
 contacts 
 [ 
 0 
 ]. 
 getAddresses 
 (); 
 for 
  
 ( 
 let 
  
 i 
  
 = 
  
 0 
 ; 
  
 i 
 < 
 addressFields 
 . 
 length 
 ; 
  
 i 
 ++ 
 ) 
  
 { 
  
 Logger 
 . 
 log 
 ( 
 addressFields 
 [ 
 i 
 ]. 
 getLabel 
 ()); 
 }

    Return

    Object — the label for this field

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

    • https://www.google.com/m8/feeds

    is Primary()

    Gets whether this is the primary field value.

     // Logs whether or not the first address field associated with contact 
 // 'John Doe' is labeled as primary. This method can be similarly called 
 // for any field. 
 const 
  
 contacts 
  
 = 
  
 ContactsApp 
 . 
 getContactsByName 
 ( 
 'John Doe' 
 ); 
 const 
  
 addressFields 
  
 = 
  
 contacts 
 [ 
 0 
 ]. 
 getAddresses 
 (); 
 Logger 
 . 
 log 
 ( 
 addressFields 
 [ 
 0 
 ]. 
 isPrimary 
 ());

    Return

    Boolean — whether this is primary

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

    • https://www.google.com/m8/feeds

    set Address(address)

    Sets the address of this field.

     // Sets the address for the 'Home Address' field for contact 'John Doe'. 
 // Can be used similarly for other fields that contain addresses. 
 const 
  
 contacts 
  
 = 
  
 ContactsApp 
 . 
 getContactsByName 
 ( 
 'John Doe' 
 ); 
 const 
  
 homeAddress 
  
 = 
  
 contacts 
 [ 
 0 
 ]. 
 getAddresses 
 ( 
 ContactsApp 
 . 
 Field 
 . 
 HOME_ADDRESS 
 ); 
 homeAddress 
 [ 
 0 
 ]. 
 setAddress 
 ( 
 '123 Main St, Raleigh, NC, 27601' 
 );

    Parameters

    Name Type Description
    address
    		String the new address

    Return

    Url Field — this field, useful for chaining

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

    • https://www.google.com/m8/feeds

    set As Primary()

    Sets this field to primary.

     // Sets the first address field associated with contact 'John Doe' 
 // as primary. This method can be similarly called for any field. 
 const 
  
 contacts 
  
 = 
  
 ContactsApp 
 . 
 getContactsByName 
 ( 
 'John Doe' 
 ); 
 const 
  
 addressFields 
  
 = 
  
 contacts 
 [ 
 0 
 ]. 
 getAddresses 
 (); 
 addressFields 
 [ 
 0 
 ]. 
 setAsPrimary 
 ();

    Return

    Url Field — this FieldValue for chaining

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

    • https://www.google.com/m8/feeds

    set Label(field)

    Sets the label of this field.

     // Sets the label to 'Work' for the first address field associated 
 // with contact 'John Doe'. This method can be similarly called for any 
 // field that has a label. 
 const 
  
 contacts 
  
 = 
  
 ContactsApp 
 . 
 getContactsByName 
 ( 
 'John Doe' 
 ); 
 const 
  
 addressFields 
  
 = 
  
 contacts 
 [ 
 0 
 ]. 
 getAddresses 
 (); 
 addressFields 
 [ 
 0 
 ]. 
 setLabel 
 ( 
 ContactsApp 
 . 
 Field 
 . 
 WORK_ADDRESS 
 );

    Parameters

    Name Type Description
    field
    		Field the new standard label

    Return

    Url Field — this FieldValue for chaining

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

    • https://www.google.com/m8/feeds

    set Label(label)

    Sets the label of this field.

     // Sets the label to 'Apartment' for the first address field associated 
 // with contact 'John Doe'. This method can be similarly called for any 
 // field that has a label. 
 const 
  
 contacts 
  
 = 
  
 ContactsApp 
 . 
 getContactsByName 
 ( 
 'John Doe' 
 ); 
 const 
  
 addressFields 
  
 = 
  
 contacts 
 [ 
 0 
 ]. 
 getAddresses 
 (); 
 addressFields 
 [ 
 0 
 ]. 
 setLabel 
 ( 
 'Apartment' 
 );

    Parameters

    Name Type Description
    label
    		String the new label for this field

    Return

    Url Field — this field, useful for chaining

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

    • https://www.google.com/m8/feeds

    Deprecated methods
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: